@finsemble/finsemble-ui 10.0.0-beta.3 → 10.0.0-iocd.2

package/typedefs/FDC3/context/ContextTypes.d.ts

@@ -0,0 +1,762 @@
+export interface Action {
+    app?: ActionApp;
+    context: ActionContext;
+    customConfig?: {
+        [key: string]: any;
+    };
+    /**
+     * A reference an intent type name, such as those defined in the FDC3 Standard
+     */
+    intent?: string;
+    title: string;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface ActionApp {
+    appId: string;
+    instanceId?: string;
+    [property: string]: any;
+}
+export interface ActionContext {
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+export interface Chart {
+    instruments: InstrumentElement[];
+    otherConfig?: ContextElement[];
+    range?: TimeRangeObject;
+    style?: Style;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface InstrumentElement {
+    id: PurpleID;
+    market?: OrganizationMarket;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface PurpleID {
+    BBG?: string;
+    CUSIP?: string;
+    FDS_ID?: string;
+    FIGI?: string;
+    ISIN?: string;
+    PERMID?: string;
+    RIC?: string;
+    SEDOL?: string;
+    ticker?: string;
+    [property: string]: any;
+}
+export interface OrganizationMarket {
+    BBG?: string;
+    COUNTRY_ISOALPHA2?: string;
+    MIC?: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface ContextElement {
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+export interface TimeRangeObject {
+    endTime?: Date;
+    startTime?: Date;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export declare enum Style {
+    Bar = "bar",
+    Candle = "candle",
+    Custom = "custom",
+    Heatmap = "heatmap",
+    Histogram = "histogram",
+    Line = "line",
+    Mountain = "mountain",
+    Pie = "pie",
+    Scatter = "scatter",
+    StackedBar = "stacked-bar"
+}
+export interface ChatInitSettings {
+    chatName?: string;
+    members?: ContactListObject;
+    message?: MessageObject | string;
+    options?: Options;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface ContactListObject {
+    contacts: ContactElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface ContactElement {
+    id: FluffyID;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface FluffyID {
+    email?: string;
+    FDS_ID?: string;
+    [property: string]: any;
+}
+export interface MessageObject {
+    entities?: {
+        [key: string]: PurpleAction;
+    };
+    text?: PurpleText;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface PurpleAction {
+    app?: EntityApp;
+    context?: EntityContext;
+    customConfig?: {
+        [key: string]: any;
+    };
+    /**
+     * A reference an intent type name, such as those defined in the FDC3 Standard
+     */
+    intent?: string;
+    title?: string;
+    type: any;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    data?: PurpleData;
+    [property: string]: any;
+}
+export interface EntityApp {
+    appId: string;
+    instanceId?: string;
+    [property: string]: any;
+}
+export interface EntityContext {
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+export interface PurpleData {
+    dataUri: string;
+    name: string;
+    [property: string]: any;
+}
+export interface PurpleText {
+    'text/markdown'?: string;
+    'text/plain'?: string;
+    [property: string]: any;
+}
+export interface Options {
+    allowAddUser?: boolean;
+    allowHistoryBrowsing?: boolean;
+    allowMessageCopy?: boolean;
+    groupRecipients?: boolean;
+    isPublic?: boolean;
+    [property: string]: any;
+}
+export interface ChatMessage {
+    chatRoom: ChatRoomObject;
+    message: MessageObject;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface ChatRoomObject {
+    id: {
+        [key: string]: any;
+    };
+    name?: string;
+    providerName: string;
+    type: string;
+    url?: string;
+    [property: string]: any;
+}
+export interface ChatRoom {
+    id: {
+        [key: string]: any;
+    };
+    name?: string;
+    providerName: string;
+    type: string;
+    url?: string;
+    [property: string]: any;
+}
+export interface ChatSearchCriteria {
+    criteria: Array<OrganizationObject | string>;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface OrganizationObject {
+    id: TentacledID;
+    market?: OrganizationMarket;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface TentacledID {
+    BBG?: string;
+    CUSIP?: string;
+    FDS_ID?: string;
+    FIGI?: string;
+    ISIN?: string;
+    PERMID?: string;
+    RIC?: string;
+    SEDOL?: string;
+    ticker?: string;
+    LEI?: string;
+    email?: string;
+    [property: string]: any;
+}
+export interface Contact {
+    id: StickyID;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface StickyID {
+    email?: string;
+    FDS_ID?: string;
+    [property: string]: any;
+}
+export interface ContactList {
+    contacts: ContactElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface Context {
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+export interface Country {
+    id: CountryID;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface CountryID {
+    COUNTRY_ISOALPHA2?: string;
+    COUNTRY_ISOALPHA3?: string;
+    ISOALPHA2?: string;
+    ISOALPHA3?: string;
+    [property: string]: any;
+}
+export interface Currency {
+    id: CurrencyID;
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+export interface CurrencyID {
+    CURRENCY_ISOCODE?: string;
+    [property: string]: any;
+}
+export interface Email {
+    recipients: RecipientsObject;
+    subject?: string;
+    textBody?: string;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface RecipientsObject {
+    id?: RecipientsID;
+    type: string;
+    name?: string;
+    contacts?: ContactElement[];
+    [property: string]: any;
+}
+export interface RecipientsID {
+    email?: string;
+    FDS_ID?: string;
+    [property: string]: any;
+}
+export interface Instrument {
+    id: IndigoID;
+    market?: PurpleMarket;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface IndigoID {
+    BBG?: string;
+    CUSIP?: string;
+    FDS_ID?: string;
+    FIGI?: string;
+    ISIN?: string;
+    PERMID?: string;
+    RIC?: string;
+    SEDOL?: string;
+    ticker?: string;
+    [property: string]: any;
+}
+export interface PurpleMarket {
+    BBG?: string;
+    COUNTRY_ISOALPHA2?: string;
+    MIC?: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface InstrumentList {
+    instruments: InstrumentElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface Interaction {
+    description: string;
+    initiator?: ContactElement;
+    interactionType: string;
+    origin?: string;
+    participants: ContactListObject;
+    timeRange: TimeRangeObject;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface Message {
+    entities?: {
+        [key: string]: FluffyAction;
+    };
+    text?: FluffyText;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface FluffyAction {
+    app?: EntityApp;
+    context?: EntityContext;
+    customConfig?: {
+        [key: string]: any;
+    };
+    /**
+     * A reference an intent type name, such as those defined in the FDC3 Standard
+     */
+    intent?: string;
+    title?: string;
+    type: any;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    data?: FluffyData;
+    [property: string]: any;
+}
+export interface FluffyData {
+    dataUri: string;
+    name: string;
+    [property: string]: any;
+}
+export interface FluffyText {
+    'text/markdown'?: string;
+    'text/plain'?: string;
+    [property: string]: any;
+}
+export interface Nothing {
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing an order. To be used with OMS and EMS systems.
+ *
+ * This type currently only defines a required `id` field, which should provide a reference
+ * to the order in one or more systems, an optional human readable `name` field to be used
+ * to summarize the order and an optional `details` field that may be used to provide
+ * additional detail about the order, including a context representing a `product`, which
+ * may be extended with arbitrary properties. The `details.product` field is currently typed
+ * as a unspecified Context type, but both `details` and `details.product` are expected to
+ * be standardized in future.
+ */
+export interface Order {
+    /**
+     * Optional additional details about the order, which may include a product element that is
+     * an, as yet undefined but extensible, Context
+     */
+    details?: PurpleOrderDetails;
+    /**
+     * One or more identifiers that refer to the order in an OMS, EMS or related system.
+     * Specific key names for systems are expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * An optional human-readable summary of the order.
+     */
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+/**
+ * Optional additional details about the order, which may include a product element that is
+ * an, as yet undefined but extensible, Context
+ */
+export interface PurpleOrderDetails {
+    product?: ProductObject;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing a tradable product. To be used with OMS and EMS
+ * systems.
+ *
+ * This type is currently only loosely defined as an extensible context object, with an
+ * optional instrument field.
+ */
+export interface ProductObject {
+    /**
+     * One or more identifiers that refer to the product. Specific key names for systems are
+     * expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * A human-readable summary of the product.
+     */
+    name?: string;
+    type: string;
+    instrument?: InstrumentElement;
+    [property: string]: any;
+}
+/**
+ * @experimental A list of orders
+ */
+export interface OrderList {
+    orders: OrderElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing an order. To be used with OMS and EMS systems.
+ *
+ * This type currently only defines a required `id` field, which should provide a reference
+ * to the order in one or more systems, an optional human readable `name` field to be used
+ * to summarize the order and an optional `details` field that may be used to provide
+ * additional detail about the order, including a context representing a `product`, which
+ * may be extended with arbitrary properties. The `details.product` field is currently typed
+ * as a unspecified Context type, but both `details` and `details.product` are expected to
+ * be standardized in future.
+ */
+export interface OrderElement {
+    /**
+     * Optional additional details about the order, which may include a product element that is
+     * an, as yet undefined but extensible, Context
+     */
+    details?: FluffyOrderDetails;
+    /**
+     * One or more identifiers that refer to the order in an OMS, EMS or related system.
+     * Specific key names for systems are expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * An optional human-readable summary of the order.
+     */
+    name?: string;
+    type: string;
+    [property: string]: any;
+}
+/**
+ * Optional additional details about the order, which may include a product element that is
+ * an, as yet undefined but extensible, Context
+ */
+export interface FluffyOrderDetails {
+    product?: ProductObject;
+    [property: string]: any;
+}
+export interface Organization {
+    id: IndecentID;
+    type: string;
+    name?: string;
+    [property: string]: any;
+}
+export interface IndecentID {
+    FDS_ID?: string;
+    LEI?: string;
+    PERMID?: string;
+    [property: string]: any;
+}
+export interface Portfolio {
+    positions: PositionElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface PositionElement {
+    holding: number;
+    instrument: InstrumentElement;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export interface Position {
+    holding: number;
+    instrument: InstrumentElement;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing a tradable product. To be used with OMS and EMS
+ * systems.
+ *
+ * This type is currently only loosely defined as an extensible context object, with an
+ * optional instrument field.
+ */
+export interface Product {
+    /**
+     * One or more identifiers that refer to the product. Specific key names for systems are
+     * expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * A human-readable summary of the product.
+     */
+    name?: string;
+    type: string;
+    instrument?: InstrumentElement;
+    [property: string]: any;
+}
+export interface TimeRange {
+    endTime?: Date;
+    startTime?: Date;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing a trade. To be used with execution systems.
+ *
+ * This type currently only defines a required `id` field, which should provide a reference
+ * to the trade in one or more systems, an optional human readable `name` field to be used
+ * to summarize the trade and a required `product` field that may be used to provide
+ * additional detail about the trade, which is currently typed as a unspecified Context
+ * type, but `product` is expected to be standardized in future.
+ */
+export interface Trade {
+    /**
+     * One or more identifiers that refer to the trade in an OMS, EMS or related system.
+     * Specific key names for systems are expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * A human-readable summary of the trade.
+     */
+    name?: string;
+    product: ProductObject;
+    type: string;
+    [property: string]: any;
+}
+/**
+ * @experimental A list of trades.
+ */
+export interface TradeList {
+    trades: TradeElement[];
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+/**
+ * @experimental context type representing a trade. To be used with execution systems.
+ *
+ * This type currently only defines a required `id` field, which should provide a reference
+ * to the trade in one or more systems, an optional human readable `name` field to be used
+ * to summarize the trade and a required `product` field that may be used to provide
+ * additional detail about the trade, which is currently typed as a unspecified Context
+ * type, but `product` is expected to be standardized in future.
+ */
+export interface TradeElement {
+    /**
+     * One or more identifiers that refer to the trade in an OMS, EMS or related system.
+     * Specific key names for systems are expected to be standardized in future.
+     */
+    id: {
+        [key: string]: string;
+    };
+    /**
+     * A human-readable summary of the trade.
+     */
+    name?: string;
+    product: ProductObject;
+    type: string;
+    [property: string]: any;
+}
+export interface TransactionResult {
+    context?: ContextElement;
+    status: Status;
+    type: string;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export declare enum Status {
+    Created = "Created",
+    Deleted = "Deleted",
+    Failed = "Failed",
+    Updated = "Updated"
+}
+export interface Valuation {
+    CURRENCY_ISOCODE: string;
+    expiryTime?: Date;
+    price?: number;
+    type: string;
+    valuationTime?: Date;
+    value: number;
+    id?: {
+        [key: string]: any;
+    };
+    name?: string;
+    [property: string]: any;
+}
+export declare class Convert {
+    static toAction(json: string): Action;
+    static actionToJson(value: Action): string;
+    static toChart(json: string): Chart;
+    static chartToJson(value: Chart): string;
+    static toChatInitSettings(json: string): ChatInitSettings;
+    static chatInitSettingsToJson(value: ChatInitSettings): string;
+    static toChatMessage(json: string): ChatMessage;
+    static chatMessageToJson(value: ChatMessage): string;
+    static toChatRoom(json: string): ChatRoom;
+    static chatRoomToJson(value: ChatRoom): string;
+    static toChatSearchCriteria(json: string): ChatSearchCriteria;
+    static chatSearchCriteriaToJson(value: ChatSearchCriteria): string;
+    static toContact(json: string): Contact;
+    static contactToJson(value: Contact): string;
+    static toContactList(json: string): ContactList;
+    static contactListToJson(value: ContactList): string;
+    static toContext(json: string): Context;
+    static contextToJson(value: Context): string;
+    static toCountry(json: string): Country;
+    static countryToJson(value: Country): string;
+    static toCurrency(json: string): Currency;
+    static currencyToJson(value: Currency): string;
+    static toEmail(json: string): Email;
+    static emailToJson(value: Email): string;
+    static toInstrument(json: string): Instrument;
+    static instrumentToJson(value: Instrument): string;
+    static toInstrumentList(json: string): InstrumentList;
+    static instrumentListToJson(value: InstrumentList): string;
+    static toInteraction(json: string): Interaction;
+    static interactionToJson(value: Interaction): string;
+    static toMessage(json: string): Message;
+    static messageToJson(value: Message): string;
+    static toNothing(json: string): Nothing;
+    static nothingToJson(value: Nothing): string;
+    static toOrder(json: string): Order;
+    static orderToJson(value: Order): string;
+    static toOrderList(json: string): OrderList;
+    static orderListToJson(value: OrderList): string;
+    static toOrganization(json: string): Organization;
+    static organizationToJson(value: Organization): string;
+    static toPortfolio(json: string): Portfolio;
+    static portfolioToJson(value: Portfolio): string;
+    static toPosition(json: string): Position;
+    static positionToJson(value: Position): string;
+    static toProduct(json: string): Product;
+    static productToJson(value: Product): string;
+    static toTimeRange(json: string): TimeRange;
+    static timeRangeToJson(value: TimeRange): string;
+    static toTrade(json: string): Trade;
+    static tradeToJson(value: Trade): string;
+    static toTradeList(json: string): TradeList;
+    static tradeListToJson(value: TradeList): string;
+    static toTransactionResult(json: string): TransactionResult;
+    static transactionResultToJson(value: TransactionResult): string;
+    static toValuation(json: string): Valuation;
+    static valuationToJson(value: Valuation): string;
+}
+//# sourceMappingURL=ContextTypes.d.ts.map