import {BaseMessage} from "../BaseMessage";
import {StockSupportedRoutes} from "./StockSupportedRoutes";

/**
 * Configuration for routes allowed for client.
 */
export interface RoutesConfiguration extends BaseMessage {
    /**
     * Name of the routes that will be displayed for client when it's account option UseSmartRoute is enabled.
     * @type {String}
     */
    SmartRouteName: string;

    /**
     * Routes allowed for stocks that are not enumerated in StocksSupportedRoutes.
     * @type {String[]}
     */
    DefaultRoutes: Array<string>;

    /**
     * Collection of routes configuration for special stocks.
     * @type {StockSupportedRoutes[]}
     */
    StocksSupportedRoutes: Array<StockSupportedRoutes>;
}