lusid-sdk 2.1.760__py3-none-any.whl → 2.1.761__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/__init__.py +2 -0
- lusid/configuration.py +1 -1
- lusid/models/__init__.py +2 -0
- lusid/models/accumulation_event.py +2 -2
- lusid/models/adjust_global_commitment_event.py +2 -2
- lusid/models/bond_coupon_event.py +2 -2
- lusid/models/bond_default_event.py +2 -2
- lusid/models/bond_principal_event.py +2 -2
- lusid/models/bonus_issue_event.py +2 -2
- lusid/models/call_on_intermediate_securities_event.py +2 -2
- lusid/models/capital_distribution_event.py +2 -2
- lusid/models/cash_dividend_event.py +2 -2
- lusid/models/cds_credit_event.py +1 -1
- lusid/models/cdx_credit_event.py +1 -1
- lusid/models/contract_initialisation_event.py +2 -2
- lusid/models/credit_premium_cash_flow_event.py +2 -2
- lusid/models/deposit_close_event.py +2 -2
- lusid/models/deposit_interest_payment_event.py +3 -3
- lusid/models/dividend_option_event.py +2 -2
- lusid/models/dividend_reinvestment_event.py +2 -2
- lusid/models/drawdown_event.py +2 -2
- lusid/models/expiry_event.py +2 -2
- lusid/models/future_expiry_event.py +1 -1
- lusid/models/future_mark_to_market_event.py +1 -1
- lusid/models/fx_forward_settlement_event.py +1 -1
- lusid/models/intermediate_securities_distribution_event.py +2 -2
- lusid/models/loan_facility_contract_rollover_event.py +2 -2
- lusid/models/loan_interest_repayment_event.py +2 -2
- lusid/models/loan_principal_repayment_event.py +1 -1
- lusid/models/maturity_event.py +2 -2
- lusid/models/mbs_coupon_event.py +2 -2
- lusid/models/mbs_interest_deferral_event.py +2 -2
- lusid/models/mbs_interest_shortfall_event.py +2 -2
- lusid/models/mbs_principal_event.py +2 -2
- lusid/models/mbs_principal_write_off_event.py +2 -2
- lusid/models/merger_event.py +2 -2
- lusid/models/option_exercise_cash_event.py +2 -2
- lusid/models/option_exercise_physical_event.py +2 -2
- lusid/models/protection_payout_cash_flow_event.py +2 -2
- lusid/models/reverse_stock_split_event.py +2 -2
- lusid/models/scrip_dividend_event.py +2 -2
- lusid/models/spin_off_event.py +2 -2
- lusid/models/stock_dividend_event.py +2 -2
- lusid/models/stock_split_event.py +2 -2
- lusid/models/swap_cash_flow_event.py +2 -2
- lusid/models/swap_principal_event.py +2 -2
- lusid/models/tender_event.py +2 -2
- lusid/models/term_deposit_interest_event.py +1 -1
- lusid/models/term_deposit_principal_event.py +1 -1
- lusid/models/update_deposit_amount_event.py +2 -2
- lusid/models/upsert_instrument_event_request.py +22 -2
- lusid/models/year_month_day.py +81 -0
- {lusid_sdk-2.1.760.dist-info → lusid_sdk-2.1.761.dist-info}/METADATA +2 -1
- {lusid_sdk-2.1.760.dist-info → lusid_sdk-2.1.761.dist-info}/RECORD +55 -54
- {lusid_sdk-2.1.760.dist-info → lusid_sdk-2.1.761.dist-info}/WHEEL +0 -0
lusid/__init__.py
CHANGED
@@ -1303,6 +1303,7 @@ from lusid.models.workspace_item_creation_request import WorkspaceItemCreationRe
|
|
1303
1303
|
from lusid.models.workspace_item_update_request import WorkspaceItemUpdateRequest
|
1304
1304
|
from lusid.models.workspace_update_request import WorkspaceUpdateRequest
|
1305
1305
|
from lusid.models.workspace_visibility import WorkspaceVisibility
|
1306
|
+
from lusid.models.year_month_day import YearMonthDay
|
1306
1307
|
from lusid.models.yield_curve_data import YieldCurveData
|
1307
1308
|
|
1308
1309
|
# import extensions into sdk package
|
@@ -2595,6 +2596,7 @@ __all__ = [
|
|
2595
2596
|
"WorkspaceItemUpdateRequest",
|
2596
2597
|
"WorkspaceUpdateRequest",
|
2597
2598
|
"WorkspaceVisibility",
|
2599
|
+
"YearMonthDay",
|
2598
2600
|
"YieldCurveData",
|
2599
2601
|
"ApiClient",
|
2600
2602
|
"Configuration",
|
lusid/configuration.py
CHANGED
@@ -445,7 +445,7 @@ class Configuration:
|
|
445
445
|
return "Python SDK Debug Report:\n"\
|
446
446
|
"OS: {env}\n"\
|
447
447
|
"Python Version: {pyversion}\n"\
|
448
|
-
"Version of the API: 0.11.
|
448
|
+
"Version of the API: 0.11.7669\n"\
|
449
449
|
"SDK Package Version: {package_version}".\
|
450
450
|
format(env=sys.platform, pyversion=sys.version, package_version=package_version)
|
451
451
|
|
lusid/models/__init__.py
CHANGED
@@ -1218,6 +1218,7 @@ from lusid.models.workspace_item_creation_request import WorkspaceItemCreationRe
|
|
1218
1218
|
from lusid.models.workspace_item_update_request import WorkspaceItemUpdateRequest
|
1219
1219
|
from lusid.models.workspace_update_request import WorkspaceUpdateRequest
|
1220
1220
|
from lusid.models.workspace_visibility import WorkspaceVisibility
|
1221
|
+
from lusid.models.year_month_day import YearMonthDay
|
1221
1222
|
from lusid.models.yield_curve_data import YieldCurveData
|
1222
1223
|
|
1223
1224
|
|
@@ -2426,5 +2427,6 @@ __all__ = [
|
|
2426
2427
|
"WorkspaceItemUpdateRequest",
|
2427
2428
|
"WorkspaceUpdateRequest",
|
2428
2429
|
"WorkspaceVisibility",
|
2430
|
+
"YearMonthDay",
|
2429
2431
|
"YieldCurveData"
|
2430
2432
|
]
|
@@ -29,8 +29,8 @@ class AccumulationEvent(InstrumentEvent):
|
|
29
29
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
|
30
30
|
dividend_currency: StrictStr = Field(...,alias="dividendCurrency", description="Payment currency")
|
31
31
|
dividend_rate: Union[StrictFloat, StrictInt] = Field(..., alias="dividendRate", description="Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05")
|
32
|
-
ex_date: datetime = Field(
|
33
|
-
payment_date: datetime = Field(
|
32
|
+
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.")
|
33
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company pays out dividends to shareholders.")
|
34
34
|
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")
|
35
35
|
additional_properties: Dict[str, Any] = {}
|
36
36
|
__properties = ["instrumentEventType", "announcementDate", "dividendCurrency", "dividendRate", "exDate", "paymentDate"]
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict, Union
|
21
|
+
from typing import Any, Dict, Optional, Union
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictFloat, StrictInt, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -27,7 +27,7 @@ class AdjustGlobalCommitmentEvent(InstrumentEvent):
|
|
27
27
|
Event to adjust the limit/balance of a LoanFacility. Used to initially set up the facility, but also used to increase/reduce the associated limit and balance. # noqa: E501
|
28
28
|
"""
|
29
29
|
amount: Union[StrictFloat, StrictInt] = Field(..., description="Amount that the limit and balance are changed by. A positive number signifies an increase, and a negative number here signifies a decrease.")
|
30
|
-
var_date: datetime = Field(
|
30
|
+
var_date: Optional[datetime] = Field(None, alias="date", description="Date of the adjustment. Signifies when the facility begins to accrue interest.")
|
31
31
|
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")
|
32
32
|
additional_properties: Dict[str, Any] = {}
|
33
33
|
__properties = ["instrumentEventType", "amount", "date"]
|
@@ -26,8 +26,8 @@ class BondCouponEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a Bond Coupon Event This is an event that describes the occurence of a cashflow due to a fixed rate bond coupon payment. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Ex-Dividend date of the coupon payment")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Payment date of the coupon payment")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the coupon payment")
|
32
32
|
coupon_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="couponPerUnit", description="CouponRate*Principal")
|
33
33
|
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")
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict
|
21
|
+
from typing import Any, Dict, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -26,7 +26,7 @@ class BondDefaultEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Indicates when an issuer has defaulted on an obligation due to technical default, missed payments, or bankruptcy filing. # noqa: E501
|
28
28
|
"""
|
29
|
-
effective_date: datetime = Field(
|
29
|
+
effective_date: Optional[datetime] = Field(None, alias="effectiveDate", description="The date the bond default occurred.")
|
30
30
|
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")
|
31
31
|
additional_properties: Dict[str, Any] = {}
|
32
32
|
__properties = ["instrumentEventType", "effectiveDate"]
|
@@ -27,8 +27,8 @@ class BondPrincipalEvent(InstrumentEvent):
|
|
27
27
|
Definition of a Bond Principal Event This is an event that describes the occurence of a cashflow due to the principal payment. # noqa: E501
|
28
28
|
"""
|
29
29
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the principal payment")
|
30
|
-
ex_date: datetime = Field(
|
31
|
-
payment_date: datetime = Field(
|
30
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Ex-Dividend date of the principal payment")
|
31
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Payment date of the principal payment")
|
32
32
|
principal_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="principalPerUnit", description="Principal per unit")
|
33
33
|
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")
|
34
34
|
additional_properties: Dict[str, Any] = {}
|
@@ -30,9 +30,9 @@ class BonusIssueEvent(InstrumentEvent):
|
|
30
30
|
Representation of a Bonus Issue corporate action. # noqa: E501
|
31
31
|
"""
|
32
32
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="The date the Bonus Issue is announced.")
|
33
|
-
ex_date: datetime = Field(
|
33
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex-date of the Bonus Issue.")
|
34
34
|
record_date: Optional[datetime] = Field(None, alias="recordDate", description="The record date of the Bonus Issue.")
|
35
|
-
payment_date: datetime = Field(
|
35
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the Bonus Issue is executed.")
|
36
36
|
fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="Optional. Used in calculating cash-in-lieu of fractional shares.")
|
37
37
|
fractional_units_cash_currency: Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="Optional. Used in calculating cash-in-lieu of fractional shares.")
|
38
38
|
security_offer_elections: Optional[conlist(SecurityOfferElection)] = Field(None, alias="securityOfferElections", description="Possible SecurityElections for this Bonus Issue event, if any.")
|
@@ -30,8 +30,8 @@ class CallOnIntermediateSecuritiesEvent(InstrumentEvent):
|
|
30
30
|
"""
|
31
31
|
CallOnIntermediateSecuritiesEvent event (EXRI), representing an exercise on intermediate securities resulting from an intermediate securities distribution. # noqa: E501
|
32
32
|
"""
|
33
|
-
expiry_date: datetime = Field(
|
34
|
-
payment_date: datetime = Field(
|
33
|
+
expiry_date: Optional[datetime] = Field(None, alias="expiryDate", description="The date on which the issue ends.")
|
34
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the event.")
|
35
35
|
new_instrument: NewInstrument = Field(..., alias="newInstrument")
|
36
36
|
units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
|
37
37
|
price: Union[StrictFloat, StrictInt] = Field(..., description="The price at which new units are purchased.")
|
@@ -29,8 +29,8 @@ class CapitalDistributionEvent(InstrumentEvent):
|
|
29
29
|
"""
|
30
30
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
|
31
31
|
cash_elections: conlist(CashElection) = Field(..., alias="cashElections", description="Possible elections for this event, each keyed with a unique identifier.")
|
32
|
-
ex_date: datetime = Field(
|
33
|
-
payment_date: datetime = Field(
|
32
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first business day on which the dividend is not owed to the buying party.")
|
33
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company begins distributing the dividend.")
|
34
34
|
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.")
|
35
35
|
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")
|
36
36
|
additional_properties: Dict[str, Any] = {}
|
@@ -27,8 +27,8 @@ class CashDividendEvent(InstrumentEvent):
|
|
27
27
|
"""
|
28
28
|
A cash distribution paid out to shareholders. # noqa: E501
|
29
29
|
"""
|
30
|
-
payment_date: datetime = Field(
|
31
|
-
ex_date: datetime = Field(
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company begins distributing the dividend.")
|
31
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first business day on which the dividend is not owed to the buying party.")
|
32
32
|
cash_elections: conlist(CashElection) = Field(..., alias="cashElections", description="Possible elections for this event, each keyed with a unique identifier.")
|
33
33
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend is announced by the company.")
|
34
34
|
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.")
|
lusid/models/cds_credit_event.py
CHANGED
@@ -26,7 +26,7 @@ class CdsCreditEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a credit event for credit default swap (CDS) instruments. # noqa: E501
|
28
28
|
"""
|
29
|
-
effective_date: datetime = Field(
|
29
|
+
effective_date: Optional[datetime] = Field(None, alias="effectiveDate", description="The date of the credit default - i.e. date on which the debt issuer defaulted on its repayment obligation.")
|
30
30
|
auction_date: Optional[datetime] = Field(None, alias="auctionDate", description="The date of the credit event auction - i.e. date on which the defaulted debt is sold via auction, and a recovery rate determined.")
|
31
31
|
recovery_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="recoveryRate", description="The fraction of the defaulted debt that can be recovered.")
|
32
32
|
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/cdx_credit_event.py
CHANGED
@@ -26,7 +26,7 @@ class CdxCreditEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a credit event for credit default swap index (CDX) instruments. # noqa: E501
|
28
28
|
"""
|
29
|
-
effective_date: datetime = Field(
|
29
|
+
effective_date: Optional[datetime] = Field(None, alias="effectiveDate", description="The date of the credit default - i.e. date on which the debt issuer defaulted on its repayment obligation.")
|
30
30
|
auction_date: Optional[datetime] = Field(None, alias="auctionDate", description="The date of the credit event auction - i.e. date on which the defaulted debt is sold via auction, and a recovery rate determined.")
|
31
31
|
recovery_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="recoveryRate", description="The fraction of the defaulted debt that can be recovered.")
|
32
32
|
constituent_weight: Union[StrictFloat, StrictInt] = Field(..., alias="constituentWeight", description="The relative weight of the CDX constituent.")
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict, Union
|
21
|
+
from typing import Any, Dict, Optional, Union
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictFloat, StrictInt, StrictStr, validator
|
23
23
|
from lusid.models.contract_details import ContractDetails
|
24
24
|
from lusid.models.instrument_event import InstrumentEvent
|
@@ -28,7 +28,7 @@ class ContractInitialisationEvent(InstrumentEvent):
|
|
28
28
|
Event to initialise a contract with a given limit against a LoanFacility. # noqa: E501
|
29
29
|
"""
|
30
30
|
limit: Union[StrictFloat, StrictInt] = Field(..., description="Limit of this contract. Must be positive.")
|
31
|
-
var_date: datetime = Field(
|
31
|
+
var_date: Optional[datetime] = Field(None, alias="date", description="Initialisation date of the contract.")
|
32
32
|
contract_details: ContractDetails = Field(..., alias="contractDetails")
|
33
33
|
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")
|
34
34
|
additional_properties: Dict[str, Any] = {}
|
@@ -26,8 +26,8 @@ class CreditPremiumCashFlowEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a credit premium cash flow event. This event describes a premium cashflow for credit default instruments (CDS or CDX). # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex-dividend date of the cashflow.")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the cashflow.")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the cashflow is paid.")
|
32
32
|
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.")
|
33
33
|
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")
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict
|
21
|
+
from typing import Any, Dict, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -26,7 +26,7 @@ class DepositCloseEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Event to trigger the termination of a deposit. # noqa: E501
|
28
28
|
"""
|
29
|
-
effective_date: datetime = Field(
|
29
|
+
effective_date: Optional[datetime] = Field(None, alias="effectiveDate", description="Date on which the deposit is terminated.")
|
30
30
|
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")
|
31
31
|
additional_properties: Dict[str, Any] = {}
|
32
32
|
__properties = ["instrumentEventType", "effectiveDate"]
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict
|
21
|
+
from typing import Any, Dict, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -26,8 +26,8 @@ class DepositInterestPaymentEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Event to signify the repayment of interest accrued against a deposit holding. # noqa: E501
|
28
28
|
"""
|
29
|
-
payment_date: datetime = Field(
|
30
|
-
ex_date: datetime = Field(
|
29
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date that the interest is due to be paid.")
|
30
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Date that the accrued interest is calculated up until.")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the repayment.")
|
32
32
|
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")
|
33
33
|
additional_properties: Dict[str, Any] = {}
|
@@ -30,8 +30,8 @@ class DividendOptionEvent(InstrumentEvent):
|
|
30
30
|
"""
|
31
31
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
|
32
32
|
cash_elections: conlist(CashElection) = Field(..., alias="cashElections", description="CashElection for this DividendReinvestmentEvent")
|
33
|
-
ex_date: datetime = Field(
|
34
|
-
payment_date: datetime = Field(
|
33
|
+
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.")
|
34
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company pays out dividends to shareholders.")
|
35
35
|
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.")
|
36
36
|
security_elections: conlist(SecurityElection) = Field(..., alias="securityElections", description="SecurityElection for this DividendReinvestmentEvent")
|
37
37
|
security_settlement_date: Optional[datetime] = Field(None, alias="securitySettlementDate", description="The settlement date of the additional units. Equal to the PaymentDate if not provided.")
|
@@ -30,8 +30,8 @@ class DividendReinvestmentEvent(InstrumentEvent):
|
|
30
30
|
"""
|
31
31
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Date on which the dividend was announced / declared.")
|
32
32
|
cash_elections: conlist(CashElection) = Field(..., alias="cashElections", description="CashElection for this DividendReinvestmentEvent")
|
33
|
-
ex_date: datetime = Field(
|
34
|
-
payment_date: datetime = Field(
|
33
|
+
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.")
|
34
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The date the company pays out dividends to shareholders.")
|
35
35
|
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.")
|
36
36
|
security_elections: conlist(SecurityElection) = Field(..., alias="securityElections", description="SecurityElection for this DividendReinvestmentEvent")
|
37
37
|
security_settlement_date: Optional[datetime] = Field(None, alias="securitySettlementDate", description="The settlement date of the additional units. Equal to the PaymentDate if not provided.")
|
lusid/models/drawdown_event.py
CHANGED
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict, Union
|
21
|
+
from typing import Any, Dict, Optional, Union
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictFloat, StrictInt, StrictStr, validator
|
23
23
|
from lusid.models.contract_details import ContractDetails
|
24
24
|
from lusid.models.instrument_event import InstrumentEvent
|
@@ -28,7 +28,7 @@ class DrawdownEvent(InstrumentEvent):
|
|
28
28
|
Event to draw down balance from a LoanFacility to a FlexLoan contract holding. # noqa: E501
|
29
29
|
"""
|
30
30
|
amount: Union[StrictFloat, StrictInt] = Field(..., description="Amount to be drawn down. Must be positive.")
|
31
|
-
var_date: datetime = Field(
|
31
|
+
var_date: Optional[datetime] = Field(None, alias="date", description="Initialisation date of the contract.")
|
32
32
|
contract_details: ContractDetails = Field(..., alias="contractDetails")
|
33
33
|
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")
|
34
34
|
additional_properties: Dict[str, Any] = {}
|
lusid/models/expiry_event.py
CHANGED
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict
|
21
|
+
from typing import Any, Dict, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -26,7 +26,7 @@ class ExpiryEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an Expiry Event This is an event that describes the expiry of the instrument. # noqa: E501
|
28
28
|
"""
|
29
|
-
expiry_date: datetime = Field(
|
29
|
+
expiry_date: Optional[datetime] = Field(None, alias="expiryDate", description="Expiry date of the instrument")
|
30
30
|
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")
|
31
31
|
additional_properties: Dict[str, Any] = {}
|
32
32
|
__properties = ["instrumentEventType", "expiryDate"]
|
@@ -26,7 +26,7 @@ class FutureExpiryEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a Future Expiry Event. This is an event that describes the expiry of a Future instrument. # noqa: E501
|
28
28
|
"""
|
29
|
-
expiry_date: datetime = Field(
|
29
|
+
expiry_date: Optional[datetime] = Field(None, alias="expiryDate", description="Expiry date of the Future instrument.")
|
30
30
|
settlement_currency: StrictStr = Field(...,alias="settlementCurrency", description="Settlement currency of the Future instrument.")
|
31
31
|
notional_amount_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="notionalAmountPerUnit", description="The notional amount of each unit in the Future instrument.")
|
32
32
|
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")
|
@@ -26,7 +26,7 @@ class FutureMarkToMarketEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a Future Mark to Market Event. Represents 'Mark to Market' daily settlement of Future instruments. # noqa: E501
|
28
28
|
"""
|
29
|
-
effective_date: datetime = Field(
|
29
|
+
effective_date: Optional[datetime] = Field(None, alias="effectiveDate", description="The date of the mark to market event.")
|
30
30
|
settlement_currency: StrictStr = Field(...,alias="settlementCurrency", description="The currency in which the Future contract is paid.")
|
31
31
|
notional_amount_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="notionalAmountPerUnit", description="The notional value of the contract on the effective date.")
|
32
32
|
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")
|
@@ -26,7 +26,7 @@ class FxForwardSettlementEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Settlement for FX Forward, including NDF and deliverable. # noqa: E501
|
28
28
|
"""
|
29
|
-
maturity_date: datetime = Field(
|
29
|
+
maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="Maturity date of the forward")
|
30
30
|
dom_amount_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="domAmountPerUnit", description="Amount per unit in the DomCcy (domestic currency)")
|
31
31
|
dom_ccy: StrictStr = Field(...,alias="domCcy", description="The domestic currency of the forward")
|
32
32
|
fgn_amount_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="fgnAmountPerUnit", description="Amount per unit in the FgnCcy (foreign currency)")
|
@@ -29,9 +29,9 @@ class IntermediateSecuritiesDistributionEvent(InstrumentEvent):
|
|
29
29
|
IntermediateSecuritiesDistribution event (RHDI), representing the distribution of securities. # noqa: E501
|
30
30
|
"""
|
31
31
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="Optional. The date the spin-off is announced.")
|
32
|
-
ex_date: datetime = Field(
|
32
|
+
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.")
|
33
33
|
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.")
|
34
|
-
payment_date: datetime = Field(
|
34
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date on which the distribution of shares takes place.")
|
35
35
|
new_instrument: NewInstrument = Field(..., alias="newInstrument")
|
36
36
|
units_ratio: UnitsRatio = Field(..., alias="unitsRatio")
|
37
37
|
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.")
|
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict, List
|
21
|
+
from typing import Any, Dict, List, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictBool, StrictStr, conlist, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
from lusid.models.rollover_constituent import RolloverConstituent
|
@@ -27,7 +27,7 @@ class LoanFacilityContractRolloverEvent(InstrumentEvent):
|
|
27
27
|
"""
|
28
28
|
Event for rolling over one or more FlexibleLoan contracts into one or more different FlexibleLoan contracts against the same facility. # noqa: E501
|
29
29
|
"""
|
30
|
-
var_date: datetime = Field(
|
30
|
+
var_date: Optional[datetime] = Field(None, alias="date", description="Effective date of the event.")
|
31
31
|
rollover_constituents: conlist(RolloverConstituent) = Field(..., alias="rolloverConstituents", description="Source and target contracts of the rollover. That is, a set of contracts and their respective changes to balance Expect at least one contract to as the source of the rollover and at least one target contract.")
|
32
32
|
with_interest: StrictBool = Field(..., alias="withInterest", description="If set to true, then active contracts whose balance is reduced by the rollover will have their accrued interest repaid pro rata to the balance reduction.")
|
33
33
|
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")
|
@@ -27,8 +27,8 @@ class LoanInterestRepaymentEvent(InstrumentEvent):
|
|
27
27
|
"""
|
28
28
|
Event to signify the repayment of interest accrued against a loan holding. # noqa: E501
|
29
29
|
"""
|
30
|
-
payment_date: datetime = Field(
|
31
|
-
ex_date: datetime = Field(
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date that the interest is due to be paid.")
|
31
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="Date that the accrued interest is calculated up until.")
|
32
32
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the repayment.")
|
33
33
|
fraction: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Fraction of the accrued on the holding to be repaid. Must be between 0 and 1, inclusive. Defaults to 1 if not set.")
|
34
34
|
lapse_elections: Optional[conlist(LapseElection)] = Field(None, alias="lapseElections", description="Election for controlling whether the interest is paid automatically or not. Exactly one election must be provided.")
|
@@ -27,7 +27,7 @@ class LoanPrincipalRepaymentEvent(InstrumentEvent):
|
|
27
27
|
"""
|
28
28
|
Event to signify the repayment of some or all of the principal balance of a loan contract. # noqa: E501
|
29
29
|
"""
|
30
|
-
payment_date: datetime = Field(
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date that the Principal is due to be paid.")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="Currency of the repayment.")
|
32
32
|
lapse_elections: Optional[conlist(LapseElection)] = Field(None, alias="lapseElections", description="Election for controlling whether the Principal is paid automatically or not. Exactly one election must be provided.")
|
33
33
|
fraction: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Fraction of the principal balance to be repaid. Must be between 0 and 1, inclusive. Defaults to 1 if not set.")
|
lusid/models/maturity_event.py
CHANGED
@@ -18,7 +18,7 @@ import re # noqa: F401
|
|
18
18
|
import json
|
19
19
|
|
20
20
|
from datetime import datetime
|
21
|
-
from typing import Any, Dict
|
21
|
+
from typing import Any, Dict, Optional
|
22
22
|
from pydantic.v1 import StrictStr, Field, Field, StrictStr, validator
|
23
23
|
from lusid.models.instrument_event import InstrumentEvent
|
24
24
|
|
@@ -26,7 +26,7 @@ class MaturityEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of a Maturity Event This is an event that describes the maturity of the instrument. # noqa: E501
|
28
28
|
"""
|
29
|
-
maturity_date: datetime = Field(
|
29
|
+
maturity_date: Optional[datetime] = Field(None, alias="maturityDate", description="Maturity date of the instrument")
|
30
30
|
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")
|
31
31
|
additional_properties: Dict[str, Any] = {}
|
32
32
|
__properties = ["instrumentEventType", "maturityDate"]
|
lusid/models/mbs_coupon_event.py
CHANGED
@@ -26,8 +26,8 @@ class MbsCouponEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an MBS Coupon Event This is an event that describes the occurence of a cashflow due to a mortgage-backed security coupon payment. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the coupon")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the coupon")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the coupon is paid")
|
32
32
|
coupon_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="couponPerUnit", description="The coupon amount received for each unit of the instrument held on the ex date")
|
33
33
|
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")
|
@@ -26,8 +26,8 @@ class MbsInterestDeferralEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an MBS Interest Deferral Event This is an event that describes the occurence of a cashflow due to unpaid interest that was deferred and capitalised into the outstanding principal balance of a mortgage-backed security. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the interest payment, usually several weeks prior to the payment date")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the interest that is deferred and capitalised")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the interest amount is notated")
|
32
32
|
interest_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="interestPerUnit", description="The interest amount to be deferred and capitalised for each unit of the instrument held on the ex date")
|
33
33
|
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")
|
@@ -26,8 +26,8 @@ class MbsInterestShortfallEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an MBS Interest Shortfall Event This is an event that describes the occurence of a cashflow due to unpaid interest that was deferred and not capitalised into the outstanding principal balance of a mortgage-backed security. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the interest payment, usually several weeks prior to the payment date")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the interest")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the interest amount is notated")
|
32
32
|
interest_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="interestPerUnit", description="The amount by which the coupon amount will fall short for each unit of the instrument held on the ex date")
|
33
33
|
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")
|
@@ -26,8 +26,8 @@ class MbsPrincipalEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an MBS Principal Event This is an event that describes the occurence of a cashflow due to a mortgage-backed security principal payment. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the principal payment, usually several weeks prior to the payment date")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the principal")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the principal is paid")
|
32
32
|
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")
|
33
33
|
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")
|
@@ -26,8 +26,8 @@ class MbsPrincipalWriteOffEvent(InstrumentEvent):
|
|
26
26
|
"""
|
27
27
|
Definition of an MBS Principal Write Off Event This is an event that describes the occurence of a cashflow due to a mortgage-backed security principal write off. # noqa: E501
|
28
28
|
"""
|
29
|
-
ex_date: datetime = Field(
|
30
|
-
payment_date: datetime = Field(
|
29
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The ex date (entitlement date) of the principal payment, usually several weeks prior to the payment date")
|
30
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="The payment date of the principal that is written off")
|
31
31
|
currency: StrictStr = Field(...,alias="currency", description="The currency in which the principal write off is notated")
|
32
32
|
principal_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="principalPerUnit", description="The principal amount to be written off for each unit of the instrument held on the ex date")
|
33
33
|
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/merger_event.py
CHANGED
@@ -33,11 +33,11 @@ class MergerEvent(InstrumentEvent):
|
|
33
33
|
announcement_date: Optional[datetime] = Field(None, alias="announcementDate", description="The date the merger is announced.")
|
34
34
|
cash_and_security_offer_elections: Optional[conlist(CashAndSecurityOfferElection)] = Field(None, alias="cashAndSecurityOfferElections", description="List of possible CashAndSecurityOfferElections for this merger event")
|
35
35
|
cash_offer_elections: Optional[conlist(CashOfferElection)] = Field(None, alias="cashOfferElections", description="List of possible CashOfferElections for this merger event")
|
36
|
-
ex_date: datetime = Field(
|
36
|
+
ex_date: Optional[datetime] = Field(None, alias="exDate", description="The first date on which the holder of record of the original shares has entitled ownership of the new shares.")
|
37
37
|
fractional_units_cash_currency: Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="Optional. Used in calculating cash-in-lieu of fractional shares.")
|
38
38
|
fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="fractionalUnitsCashPrice", description="Optional. Used in calculating cash-in-lieu of fractional shares.")
|
39
39
|
new_instrument: NewInstrument = Field(..., alias="newInstrument")
|
40
|
-
payment_date: datetime = Field(
|
40
|
+
payment_date: Optional[datetime] = Field(None, alias="paymentDate", description="Date on which the merger takes place.")
|
41
41
|
record_date: Optional[datetime] = Field(None, alias="recordDate", description="Optional. Date you have to be the holder of record of the original shares in order to receive the new shares.")
|
42
42
|
security_offer_elections: Optional[conlist(SecurityOfferElection)] = Field(None, alias="securityOfferElections", description="List of possible SecurityOfferElections for this merger event")
|
43
43
|
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")
|