lusid-sdk 2.1.760__py3-none-any.whl → 2.1.762__py3-none-any.whl

lusid/models/option_exercise_cash_event.py

@@ -31,11 +31,11 @@ class OptionExerciseCashEvent(InstrumentEvent):
     exercise_date: Optional[datetime] = Field(None, alias="exerciseDate", description="The exercise date of the option.")
     delivery_date: Optional[datetime] = Field(None, alias="deliveryDate", description="The delivery date of the option.")
     exercise_type:  StrictStr = Field(...,alias="exerciseType", description="The optionality type of the underlying option e.g. American, European.    Supported string (enumeration) values are: [European, Bermudan, American].") 
-    maturity_date: datetime = Field(..., alias="maturityDate", description="The maturity date of the option.")
+    maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="The maturity date of the option.")
     moneyness:  Optional[StrictStr] = Field(None,alias="moneyness", description="The moneyness of the option e.g. InTheMoney, OutOfTheMoney.    Supported string (enumeration) values are: [InTheMoney, OutOfTheMoney, AtTheMoney].") 
     option_exercise_elections: Optional[conlist(OptionExerciseElection)] = Field(None, alias="optionExerciseElections", description="Option exercise election for this OptionExercisePhysicalEvent.")
     option_type:  StrictStr = Field(...,alias="optionType", description="Type of optionality that is present e.g. call, put.    Supported string (enumeration) values are: [Call, Put].") 
-    start_date: datetime = Field(..., alias="startDate", description="The start date of the option.")
+    start_date: Optional[datetime] = Field(None, alias="startDate", description="The start date of the option.")
     strike_currency:  StrictStr = Field(...,alias="strikeCurrency", description="The strike currency of the equity option.") 
     strike_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="strikePerUnit", description="The strike of the equity option times the number of shares to exchange if exercised.")
     underlying_value_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="underlyingValuePerUnit", description="The underlying price times the number of shares to exchange if exercised.")

lusid/models/option_exercise_physical_event.py

@@ -32,12 +32,12 @@ class OptionExercisePhysicalEvent(InstrumentEvent):
     exercise_date: Optional[datetime] = Field(None, alias="exerciseDate", description="The exercise date of the option.")
     delivery_date: Optional[datetime] = Field(None, alias="deliveryDate", description="The delivery date of the option.")
     exercise_type:  StrictStr = Field(...,alias="exerciseType", description="The optionality type of the underlying option e.g. American, European.    Supported string (enumeration) values are: [European, Bermudan, American].") 
-    maturity_date: datetime = Field(..., alias="maturityDate", description="The maturity date of the option.")
+    maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="The maturity date of the option.")
     moneyness:  Optional[StrictStr] = Field(None,alias="moneyness", description="The moneyness of the option e.g. InTheMoney, OutOfTheMoney.    Supported string (enumeration) values are: [InTheMoney, OutOfTheMoney, AtTheMoney].") 
     new_instrument: NewInstrument = Field(..., alias="newInstrument")
     option_exercise_elections: Optional[conlist(OptionExerciseElection)] = Field(None, alias="optionExerciseElections", description="Option exercise election for this OptionExercisePhysicalEvent.")
     option_type:  StrictStr = Field(...,alias="optionType", description="Type of optionality that is present e.g. call, put.    Supported string (enumeration) values are: [Call, Put].") 
-    start_date: datetime = Field(..., alias="startDate", description="The trade date of the option.")
+    start_date: Optional[datetime] = Field(None, alias="startDate", description="The trade date of the option.")
     strike_currency:  StrictStr = Field(...,alias="strikeCurrency", description="The strike currency of the equity option.") 
     strike_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="strikePerUnit", description="The strike of the equity option times the number of shares to exchange if exercised.")
     underlying_value_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="underlyingValuePerUnit", description="The underlying price times the number of shares to exchange if exercised.")

lusid/models/protection_payout_cash_flow_event.py

@@ -26,8 +26,8 @@ class ProtectionPayoutCashFlowEvent(InstrumentEvent):
     """
     Protection payout cashflow for credit default instruments (CDS or CDX).  # noqa: E501
     """
-    ex_date: datetime = Field(..., alias="exDate", description="The ex-dividend date of the cashflow.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The payment date of the cashflow.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex-dividend date of the cashflow.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the cashflow.")
     currency:  StrictStr = Field(...,alias="currency", description="The currency in which the cashflow is paid.") 
     cash_flow_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="cashFlowPerUnit", description="The cashflow amount received for each unit of the instrument held on the ex date.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 

lusid/models/reverse_stock_split_event.py

@@ -27,8 +27,8 @@ class ReverseStockSplitEvent(InstrumentEvent):
     """
     A reverse split in the company's shares. Shareholders have their number of shares reduced based on the terms of the stock split.  # noqa: E501
     """
-    payment_date: datetime = Field(..., alias="paymentDate", description="Date on which the stock split takes effect.")
-    ex_date: datetime = Field(..., alias="exDate", description="The first date on which the shares will trade at the post-split price.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date on which the stock split takes effect.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first date on which the shares will trade at the post-split price.")
     units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Date you have to be the holder of record in order to have their shares merged.")
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date the reverse stock split was announced.")

lusid/models/scrip_dividend_event.py

@@ -28,9 +28,9 @@ class ScripDividendEvent(InstrumentEvent):
     A scrip dividend issued to shareholders.  # noqa: E501
     """
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
-    ex_date: datetime = Field(..., alias="exDate", description="The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Date you have to be the holder of record in order to participate in the tender.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The date the company pays out dividends to shareholders.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company pays out dividends to shareholders.")
     fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="The cash price per unit paid in lieu when fractional units can not be distributed.")
     fractional_units_cash_currency:  Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="The currency of the cash paid in lieu of fractional units.") 
     units_ratio: UnitsRatio = Field(..., alias="unitsRatio")

lusid/models/spin_off_event.py

@@ -29,9 +29,9 @@ class SpinOffEvent(InstrumentEvent):
     Spin-off event (SOFF), representing the distribution of securities issued by another company.  # noqa: E501
     """
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Optional.  The date the spin-off is announced.")
-    ex_date: datetime = Field(..., alias="exDate", description="The first date on which the holder of record has entitled ownership of the new shares.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first date on which the holder of record has entitled ownership of the new shares.")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Optional.  Date you have to be the holder of record in order to receive the additional shares.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="Date on which the distribution of shares takes place.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date on which the distribution of shares takes place.")
     new_instrument: NewInstrument = Field(..., alias="newInstrument")
     units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
     cost_factor: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="costFactor", description="Optional. The fraction of cost that is transferred from the existing shares to the new shares.")

lusid/models/stock_dividend_event.py

@@ -28,8 +28,8 @@ class StockDividendEvent(InstrumentEvent):
     A payment to shareholders that consists of additional shares rather than cash.  # noqa: E501
     """
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
-    ex_date: datetime = Field(..., alias="exDate", description="The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The date the company pays out dividends to shareholders.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company pays out dividends to shareholders.")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Date you have to be the holder of record in order to participate in the tender.")
     fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="The cash price paid in lieu of fractionalUnits.")
     fractional_units_cash_currency:  Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="The currency of the cash paid in lieu of fractionalUnits.") 

lusid/models/stock_split_event.py

@@ -27,8 +27,8 @@ class StockSplitEvent(InstrumentEvent):
     """
     A split in the company's shares. Shareholders are given additional company shares based on the terms of the stock split.  # noqa: E501
     """
-    payment_date: datetime = Field(..., alias="paymentDate", description="Date on which the stock split takes effect.")
-    ex_date: datetime = Field(..., alias="exDate", description="The first date on which the shares will trade at the post-split price.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date on which the stock split takes effect.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first date on which the shares will trade at the post-split price.")
     units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Date you have to be the holder of record in order to receive the additional shares.")
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date the stock split was announced.")

lusid/models/swap_cash_flow_event.py

@@ -26,8 +26,8 @@ class SwapCashFlowEvent(InstrumentEvent):
     """
     Definition of a swap cash flow event.  This event describes the cashflow generated from either an interest rate swap or inflation swap instrument.  # noqa: E501
     """
-    ex_date: datetime = Field(..., alias="exDate", description="The ex-dividend date of the cashflow.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The payment date of the cashflow.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex-dividend date of the cashflow.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the cashflow.")
     currency:  StrictStr = Field(...,alias="currency", description="The currency in which the cashflow is paid.") 
     cash_flow_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="cashFlowPerUnit", description="The cashflow amount received for each unit of the instrument held on the ex date.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 

lusid/models/swap_principal_event.py

@@ -26,8 +26,8 @@ class SwapPrincipalEvent(InstrumentEvent):
     """
     Definition of a Swap Principal Event.  This is an event that describes the occurence of a cashflow due to the principal payment.  # noqa: E501
     """
-    ex_date: datetime = Field(..., alias="exDate", description="The entitlement date of the principal payment.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The payment date of the principal.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The entitlement date of the principal payment.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the principal.")
     currency:  StrictStr = Field(...,alias="currency", description="The currency in which the principal is paid.") 
     principal_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="principalPerUnit", description="The principal amount received for each unit of the instrument held on the ex date.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 

lusid/models/tender_event.py

@@ -31,9 +31,9 @@ class TenderEvent(InstrumentEvent):
     Tender Event (TEND).  # noqa: E501
     """
     announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="The date the tender is announced.")
-    ex_date: datetime = Field(..., alias="exDate", description="The ex date (entitlement date) of the event.")
+    ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the event.")
     record_date: Optional[datetime] = Field(None, alias="recordDate", description="Date you have to be the holder of record in order to participate in the tender.")
-    payment_date: datetime = Field(..., alias="paymentDate", description="The payment date of the event.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the event.")
     new_instrument: NewInstrument = Field(..., alias="newInstrument")
     fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="The cash price paid in lieu of fractionalUnits.")
     fractional_units_cash_currency:  Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="The currency of the cash paid in lieu of fractionalUnits.") 

lusid/models/term_deposit_interest_event.py

@@ -28,7 +28,7 @@ class TermDepositInterestEvent(InstrumentEvent):
     """
     currency:  StrictStr = Field(...,alias="currency", description="Currency of the interest payment.") 
     interest_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="interestPerUnit", description="The interest payment made per unit of the held .")
-    payment_date: datetime = Field(..., alias="paymentDate", description="Payment date of the interest payment.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Payment date of the interest payment.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 
     additional_properties: Dict[str, Any] = {}
     __properties = ["instrumentEventType", "currency", "interestPerUnit", "paymentDate"]

lusid/models/term_deposit_principal_event.py

@@ -27,7 +27,7 @@ class TermDepositPrincipalEvent(InstrumentEvent):
     Definition of a Term Deposit Interest Event.  This is an event that describes the occurence of principal on a term deposit ().  # noqa: E501
     """
     currency:  StrictStr = Field(...,alias="currency", description="Currency of the principal payment.") 
-    payment_date: datetime = Field(..., alias="paymentDate", description="Payment date of the principal payment.")
+    payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Payment date of the principal payment.")
     principal_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="principalPerUnit", description="The principal payment made per unit of the held .")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 
     additional_properties: Dict[str, Any] = {}

lusid/models/update_deposit_amount_event.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict, Union
+from typing import Any, Dict, Optional, Union
 from pydantic.v1 import StrictStr, Field, Field, StrictFloat, StrictInt, StrictStr, validator 
 from lusid.models.instrument_event import InstrumentEvent
 
@@ -26,7 +26,7 @@ class UpdateDepositAmountEvent(InstrumentEvent):
     """
     Event to update the deposit be a given amount.  # noqa: E501
     """
-    var_date: datetime = Field(..., alias="date", description="The date of the adjustment to the deposit.")
+    var_date: Optional[datetime] = Field(None, alias="date", description="The date of the adjustment to the deposit.")
     amount: Union[StrictFloat, StrictInt] = Field(..., description="The signed amount of the adjustment to make to the deposit. Positive implies an increase, and negative implies a decrease.")
     instrument_event_type:  StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent") 
     additional_properties: Dict[str, Any] = {}

lusid/models/upsert_instrument_event_request.py

@@ -22,6 +22,7 @@ from typing import Any, Dict, List, Optional
 from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictInt, StrictStr, conlist, constr, validator 
 from lusid.models.instrument_event import InstrumentEvent
 from lusid.models.perpetual_property import PerpetualProperty
+from lusid.models.year_month_day import YearMonthDay
 
 class UpsertInstrumentEventRequest(BaseModel):
     """
@@ -34,7 +35,8 @@ class UpsertInstrumentEventRequest(BaseModel):
     properties: Optional[conlist(PerpetualProperty)] = Field(None, description="The properties attached to this instrument event.")
     sequence_number: Optional[StrictInt] = Field(None, alias="sequenceNumber", description="The order of the instrument event relative others on the same date (0 being processed first). Must be non negative.")
     participation_type:  Optional[StrictStr] = Field(None,alias="participationType", description="Is participation in this event Mandatory, MandatoryWithChoices, or Voluntary.") 
-    __properties = ["instrumentEventId", "instrumentIdentifiers", "description", "instrumentEvent", "properties", "sequenceNumber", "participationType"]
+    event_date_stamps: Optional[Dict[str, YearMonthDay]] = Field(None, alias="eventDateStamps", description="The date stamps corresponding to the relevant date-time fields for the instrument event. The key for each provided date stamp must match the field name of a valid datetime field from the InstrumentEvent DTO.")
+    __properties = ["instrumentEventId", "instrumentIdentifiers", "description", "instrumentEvent", "properties", "sequenceNumber", "participationType", "eventDateStamps"]
 
     class Config:
         """Pydantic configuration"""
@@ -78,6 +80,13 @@ class UpsertInstrumentEventRequest(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['properties'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each value in event_date_stamps (dict)
+        _field_dict = {}
+        if self.event_date_stamps:
+            for _key in self.event_date_stamps:
+                if self.event_date_stamps[_key]:
+                    _field_dict[_key] = self.event_date_stamps[_key].to_dict()
+            _dict['eventDateStamps'] = _field_dict
         # set to None if description (nullable) is None
         # and __fields_set__ contains the field
         if self.description is None and "description" in self.__fields_set__:
@@ -93,6 +102,11 @@ class UpsertInstrumentEventRequest(BaseModel):
         if self.participation_type is None and "participation_type" in self.__fields_set__:
             _dict['participationType'] = None
 
+        # set to None if event_date_stamps (nullable) is None
+        # and __fields_set__ contains the field
+        if self.event_date_stamps is None and "event_date_stamps" in self.__fields_set__:
+            _dict['eventDateStamps'] = None
+
         return _dict
 
     @classmethod
@@ -111,6 +125,12 @@ class UpsertInstrumentEventRequest(BaseModel):
             "instrument_event": InstrumentEvent.from_dict(obj.get("instrumentEvent")) if obj.get("instrumentEvent") is not None else None,
             "properties": [PerpetualProperty.from_dict(_item) for _item in obj.get("properties")] if obj.get("properties") is not None else None,
             "sequence_number": obj.get("sequenceNumber"),
-            "participation_type": obj.get("participationType") if obj.get("participationType") is not None else 'Mandatory'
+            "participation_type": obj.get("participationType") if obj.get("participationType") is not None else 'Mandatory',
+            "event_date_stamps": dict(
+                (_k, YearMonthDay.from_dict(_v))
+                for _k, _v in obj.get("eventDateStamps").items()
+            )
+            if obj.get("eventDateStamps") is not None
+            else None
         })
         return _obj

lusid/models/year_month_day.py

@@ -0,0 +1,81 @@
+# 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
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictInt 
+
+class YearMonthDay(BaseModel):
+    """
+    A date in component form.  # noqa: E501
+    """
+    year: StrictInt = Field(..., description="The year of the date.")
+    month: StrictInt = Field(..., description="The month of the date.")
+    day: StrictInt = Field(..., description="The day in month of the date.")
+    __properties = ["year", "month", "day"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    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) -> YearMonthDay:
+        """Create an instance of YearMonthDay 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) -> YearMonthDay:
+        """Create an instance of YearMonthDay from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return YearMonthDay.parse_obj(obj)
+
+        _obj = YearMonthDay.parse_obj({
+            "year": obj.get("year"),
+            "month": obj.get("month"),
+            "day": obj.get("day")
+        })
+        return _obj

{lusid_sdk-2.1.760.dist-info → lusid_sdk-2.1.762.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.760
+Version: 2.1.762
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -1855,6 +1855,7 @@ Class | Method | HTTP request | Description
  - [WorkspaceItemUpdateRequest](docs/WorkspaceItemUpdateRequest.md)
  - [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
  - [WorkspaceVisibility](docs/WorkspaceVisibility.md)
+ - [YearMonthDay](docs/YearMonthDay.md)
  - [YieldCurveData](docs/YieldCurveData.md)