@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
89 lines (88 loc) • 5.32 kB
TypeScript
import { FlowConventions } from './flowConventions';
import { InstrumentLeg } from './instrumentLeg';
import { LusidInstrument } from './lusidInstrument';
/**
* LUSID representation of an Equity Swap.
*/
export interface EquitySwap {
/**
* The start date of the EquitySwap.
*/
startDate: Date;
/**
* The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.
*/
maturityDate: Date;
/**
* The code of the underlying.
*/
code: string;
equityFlowConventions: FlowConventions;
fundingLeg: InstrumentLeg;
/**
* Dividend inclusion flag, if true dividends are included in the equity leg (total return).
*/
includeDividends: boolean;
/**
* The initial equity price of the Equity Swap.
*/
initialPrice: number;
/**
* Notional reset flag, if true the notional of the funding leg is reset at the start of every coupon to match the value of the equity leg (equity price at start of coupon times quantity).
*/
notionalReset: boolean;
/**
* The quantity or number of shares in the Equity Swap.
*/
quantity: number;
/**
* external market codes and identifiers for the EquitySwap, e.g. RIC. Supported string (enumeration) values are: [LusidInstrumentId, Isin, Sedol, Cusip, ClientInternal, Figi, RIC, QuotePermId, REDCode, BBGId, ICECode].
*/
underlyingIdentifier: string;
/**
* Determines how the payment of dividends is handled for the equity swap. Defaults to paying at the next Equity coupon date. Supported string (enumeration) values are: [PayAtNextEquityCouponDate, PayAtMaturityOfSwap, PayAtNextFundingLegCouponDate, PayAtPaymentDateOfDividendEvent].
*/
equitySwapDividendPaymentTiming?: string | null;
/**
* The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap
*/
instrumentType: EquitySwap.InstrumentTypeEnum;
}
export declare namespace EquitySwap {
type InstrumentTypeEnum = 'QuotedSecurity' | 'InterestRateSwap' | 'FxForward' | 'Future' | 'ExoticInstrument' | 'FxOption' | 'CreditDefaultSwap' | 'InterestRateSwaption' | 'Bond' | 'EquityOption' | 'FixedLeg' | 'FloatingLeg' | 'BespokeCashFlowsLeg' | 'Unknown' | 'TermDeposit' | 'ContractForDifference' | 'EquitySwap' | 'CashPerpetual' | 'CapFloor' | 'CashSettled' | 'CdsIndex' | 'Basket' | 'FundingLeg' | 'FxSwap' | 'ForwardRateAgreement' | 'SimpleInstrument' | 'Repo' | 'Equity' | 'ExchangeTradedOption' | 'ReferenceInstrument' | 'ComplexBond' | 'InflationLinkedBond' | 'InflationSwap';
const InstrumentTypeEnum: {
QuotedSecurity: LusidInstrument.InstrumentTypeEnum;
InterestRateSwap: LusidInstrument.InstrumentTypeEnum;
FxForward: LusidInstrument.InstrumentTypeEnum;
Future: LusidInstrument.InstrumentTypeEnum;
ExoticInstrument: LusidInstrument.InstrumentTypeEnum;
FxOption: LusidInstrument.InstrumentTypeEnum;
CreditDefaultSwap: LusidInstrument.InstrumentTypeEnum;
InterestRateSwaption: LusidInstrument.InstrumentTypeEnum;
Bond: LusidInstrument.InstrumentTypeEnum;
EquityOption: LusidInstrument.InstrumentTypeEnum;
FixedLeg: LusidInstrument.InstrumentTypeEnum;
FloatingLeg: LusidInstrument.InstrumentTypeEnum;
BespokeCashFlowsLeg: LusidInstrument.InstrumentTypeEnum;
Unknown: LusidInstrument.InstrumentTypeEnum;
TermDeposit: LusidInstrument.InstrumentTypeEnum;
ContractForDifference: LusidInstrument.InstrumentTypeEnum;
EquitySwap: LusidInstrument.InstrumentTypeEnum;
CashPerpetual: LusidInstrument.InstrumentTypeEnum;
CapFloor: LusidInstrument.InstrumentTypeEnum;
CashSettled: LusidInstrument.InstrumentTypeEnum;
CdsIndex: LusidInstrument.InstrumentTypeEnum;
Basket: LusidInstrument.InstrumentTypeEnum;
FundingLeg: LusidInstrument.InstrumentTypeEnum;
FxSwap: LusidInstrument.InstrumentTypeEnum;
ForwardRateAgreement: LusidInstrument.InstrumentTypeEnum;
SimpleInstrument: LusidInstrument.InstrumentTypeEnum;
Repo: LusidInstrument.InstrumentTypeEnum;
Equity: LusidInstrument.InstrumentTypeEnum;
ExchangeTradedOption: LusidInstrument.InstrumentTypeEnum;
ReferenceInstrument: LusidInstrument.InstrumentTypeEnum;
ComplexBond: LusidInstrument.InstrumentTypeEnum;
InflationLinkedBond: LusidInstrument.InstrumentTypeEnum;
InflationSwap: LusidInstrument.InstrumentTypeEnum;
};
}