@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
89 lines (88 loc) • 5.19 kB
TypeScript
import { LusidInstrument } from './lusidInstrument';
/**
* LUSID representation of an FX Forward. Including FX Spot and Non-Deliverable Forwards.
*/
export interface FxForward {
/**
* The start date of the instrument. This is normally synonymous with the trade-date.
*/
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 amount that is to be paid in the domestic currency on the maturity date.
*/
domAmount: number;
/**
* The domestic currency of the instrument.
*/
domCcy: string;
/**
* The amount that is to be paid in the foreign currency on the maturity date.
*/
fgnAmount: number;
/**
* The foreign (other) currency of the instrument. In the NDF case, only payments are made in the domestic currency. For the outright forward, currencies are exchanged. By domestic is then that of the portfolio.
*/
fgnCcy: string;
/**
* The reference Fx Spot rate for currency pair Foreign-Domestic that was seen on the trade start date (time).
*/
refSpotRate?: number;
/**
* Is the contract an Fx-Forward of \"Non-Deliverable\" type, meaning a single payment in the domestic currency based on the change in fx-rate vs a reference rate is used.
*/
isNdf?: boolean;
/**
* The fixing date.
*/
fixingDate?: Date;
/**
* The settlement currency. If provided, present value will be calculated in settlement currency, otherwise the domestic currency. Applies only to non-deliverable FX Forwards.
*/
settlementCcy?: 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: FxForward.InstrumentTypeEnum;
}
export declare namespace FxForward {
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;
};
}