@openmarket/market-data-proto 12.64.0 → 12.64.1

package/dist/tsdb-gateway/v3/common_pb.d.ts

@@ -0,0 +1,911 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { AggregationInterval, Category, Exchange, Issuer, OptionType, SortDirection, Tenor } from "../../enums_pb.js";
+import type { GroupByType, MnavMode } from "../../transform_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file tsdb-gateway/v3/common.proto.
+ */
+export declare const file_tsdb_gateway_v3_common: GenFile;
+/**
+ * @generated from message gateway.v3.TimeWindow
+ */
+export type TimeWindow = Message<"gateway.v3.TimeWindow"> & {
+    /**
+     * required > 0 on points/books methods
+     *
+     * @generated from field: int64 fromUnixS = 1;
+     */
+    fromUnixS: bigint;
+    /**
+     * 0 means now
+     *
+     * @generated from field: int64 toUnixS = 2;
+     */
+    toUnixS: bigint;
+};
+/**
+ * Describes the message gateway.v3.TimeWindow.
+ * Use `create(TimeWindowSchema)` to create a new message.
+ */
+export declare const TimeWindowSchema: GenMessage<TimeWindow>;
+/**
+ * Catalog pagination.
+ *
+ * @generated from message gateway.v3.Paging
+ */
+export type Paging = Message<"gateway.v3.Paging"> & {
+    /**
+     * @generated from field: int32 limit = 1;
+     */
+    limit: number;
+    /**
+     * @generated from field: int32 offset = 2;
+     */
+    offset: number;
+};
+/**
+ * Describes the message gateway.v3.Paging.
+ * Use `create(PagingSchema)` to create a new message.
+ */
+export declare const PagingSchema: GenMessage<Paging>;
+/**
+ * Bar-count pagination for points methods, anchored on the window's from.
+ * Manifest-gated: only (metric, venue) cells where the plan can page by bar
+ * count accept it.
+ *
+ * @generated from message gateway.v3.BarPaging
+ */
+export type BarPaging = Message<"gateway.v3.BarPaging"> & {
+    /**
+     * @generated from field: int32 limit = 1;
+     */
+    limit: number;
+    /**
+     * @generated from field: SortDirection direction = 2;
+     */
+    direction: SortDirection;
+};
+/**
+ * Describes the message gateway.v3.BarPaging.
+ * Use `create(BarPagingSchema)` to create a new message.
+ */
+export declare const BarPagingSchema: GenMessage<BarPaging>;
+/**
+ * @generated from message gateway.v3.Symbols
+ */
+export type Symbols = Message<"gateway.v3.Symbols"> & {
+    /**
+     * Literal raw-symbol matches. Never patterns (decision N2).
+     *
+     * @generated from field: repeated string raw = 1;
+     */
+    raw: string[];
+    /**
+     * @generated from field: repeated string normalized = 2;
+     */
+    normalized: string[];
+    /**
+     * SQL LIKE patterns against the raw symbol. The v2 behavior of a '%' in
+     * a raw entry lands here explicitly.
+     *
+     * @generated from field: repeated string patterns = 3;
+     */
+    patterns: string[];
+};
+/**
+ * Describes the message gateway.v3.Symbols.
+ * Use `create(SymbolsSchema)` to create a new message.
+ */
+export declare const SymbolsSchema: GenMessage<Symbols>;
+/**
+ * @generated from message gateway.v3.NumericRange
+ */
+export type NumericRange = Message<"gateway.v3.NumericRange"> & {
+    /**
+     * @generated from field: optional double lt = 1;
+     */
+    lt?: number;
+    /**
+     * @generated from field: optional double lte = 2;
+     */
+    lte?: number;
+    /**
+     * @generated from field: optional double gt = 3;
+     */
+    gt?: number;
+    /**
+     * @generated from field: optional double gte = 4;
+     */
+    gte?: number;
+    /**
+     * @generated from field: optional double eq = 5;
+     */
+    eq?: number;
+    /**
+     * @generated from field: optional double neq = 6;
+     */
+    neq?: number;
+};
+/**
+ * Describes the message gateway.v3.NumericRange.
+ * Use `create(NumericRangeSchema)` to create a new message.
+ */
+export declare const NumericRangeSchema: GenMessage<NumericRange>;
+/**
+ * @generated from message gateway.v3.StringCriteria
+ */
+export type StringCriteria = Message<"gateway.v3.StringCriteria"> & {
+    /**
+     * @generated from field: optional string eq = 1;
+     */
+    eq?: string;
+    /**
+     * @generated from field: optional string neq = 2;
+     */
+    neq?: string;
+};
+/**
+ * Describes the message gateway.v3.StringCriteria.
+ * Use `create(StringCriteriaSchema)` to create a new message.
+ */
+export declare const StringCriteriaSchema: GenMessage<StringCriteria>;
+/**
+ * Explicit intraday session window for TPO profiles: an HH:MM range in a named
+ * timezone, the alternative to the fixed tpoSession windows.
+ *
+ * @generated from message gateway.v3.CustomTimeRange
+ */
+export type CustomTimeRange = Message<"gateway.v3.CustomTimeRange"> & {
+    /**
+     * "HH:MM", e.g. "09:30"
+     *
+     * @generated from field: string startTime = 1;
+     */
+    startTime: string;
+    /**
+     * "HH:MM", e.g. "16:00"
+     *
+     * @generated from field: string endTime = 2;
+     */
+    endTime: string;
+    /**
+     * "UTC", "ET", or an IANA name like "America/New_York"
+     *
+     * @generated from field: string timezone = 3;
+     */
+    timezone: string;
+};
+/**
+ * Describes the message gateway.v3.CustomTimeRange.
+ * Use `create(CustomTimeRangeSchema)` to create a new message.
+ */
+export declare const CustomTimeRangeSchema: GenMessage<CustomTimeRange>;
+/**
+ * v3 replacement for Transform.groupBy: the field vocabulary is a v3 enum,
+ * so the wire stops leaning on the v2 Transform message.
+ *
+ * @generated from message gateway.v3.GroupBy
+ */
+export type GroupBy = Message<"gateway.v3.GroupBy"> & {
+    /**
+     * @generated from field: repeated gateway.v3.GroupBy.Field fields = 1;
+     */
+    fields: GroupBy_Field[];
+    /**
+     * @generated from field: GroupByType type = 2;
+     */
+    type: GroupByType;
+    /**
+     * @generated from field: bool excludeTimestamp = 3;
+     */
+    excludeTimestamp: boolean;
+};
+/**
+ * Describes the message gateway.v3.GroupBy.
+ * Use `create(GroupBySchema)` to create a new message.
+ */
+export declare const GroupBySchema: GenMessage<GroupBy>;
+/**
+ * @generated from enum gateway.v3.GroupBy.Field
+ */
+export declare enum GroupBy_Field {
+    /**
+     * @generated from enum value: FIELD_UNSPECIFIED = 0;
+     */
+    FIELD_UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: VENUE = 1;
+     */
+    VENUE = 1,
+    /**
+     * @generated from enum value: CATEGORY = 2;
+     */
+    CATEGORY = 2,
+    /**
+     * @generated from enum value: COIN = 3;
+     */
+    COIN = 3,
+    /**
+     * @generated from enum value: RAW_SYMBOL = 4;
+     */
+    RAW_SYMBOL = 4,
+    /**
+     * @generated from enum value: NORMALIZED_SYMBOL = 5;
+     */
+    NORMALIZED_SYMBOL = 5,
+    /**
+     * @generated from enum value: SIDE = 6;
+     */
+    SIDE = 6,
+    /**
+     * @generated from enum value: OPTION_TYPE = 7;
+     */
+    OPTION_TYPE = 7,
+    /**
+     * @generated from enum value: SERIES_ID = 8;
+     */
+    SERIES_ID = 8,
+    /**
+     * @generated from enum value: FRED_CATEGORY = 9;
+     */
+    FRED_CATEGORY = 9
+}
+/**
+ * Describes the enum gateway.v3.GroupBy.Field.
+ */
+export declare const GroupBy_FieldSchema: GenEnum<GroupBy_Field>;
+/**
+ * @generated from message gateway.v3.Normalize
+ */
+export type Normalize = Message<"gateway.v3.Normalize"> & {
+    /**
+     * @generated from field: int64 fundingInterval = 1;
+     */
+    fundingInterval: bigint;
+    /**
+     * @generated from field: string quote = 2;
+     */
+    quote: string;
+    /**
+     * @generated from field: MnavMode mnavMode = 3;
+     */
+    mnavMode: MnavMode;
+};
+/**
+ * Describes the message gateway.v3.Normalize.
+ * Use `create(NormalizeSchema)` to create a new message.
+ */
+export declare const NormalizeSchema: GenMessage<Normalize>;
+/**
+ * Per-instrument, per-metric served shape, carried by instruments rows.
+ *
+ * @generated from message gateway.v3.MetricAvailability
+ */
+export type MetricAvailability = Message<"gateway.v3.MetricAvailability"> & {
+    /**
+     * value name of the class's nested Metric enum
+     *
+     * @generated from field: string metric = 1;
+     */
+    metric: string;
+    /**
+     * @generated from field: bool raw = 2;
+     */
+    raw: boolean;
+    /**
+     * @generated from field: bool agg = 3;
+     */
+    agg: boolean;
+    /**
+     * block-book metrics
+     *
+     * @generated from field: repeated double blockSizes = 4;
+     */
+    blockSizes: number[];
+    /**
+     * options metrics
+     *
+     * @generated from field: repeated Tenor tenors = 5;
+     */
+    tenors: Tenor[];
+};
+/**
+ * Describes the message gateway.v3.MetricAvailability.
+ * Use `create(MetricAvailabilitySchema)` to create a new message.
+ */
+export declare const MetricAvailabilitySchema: GenMessage<MetricAvailability>;
+/**
+ * Typed refusal detail beside the byte-stable error string. The string is
+ * the compatibility surface; this adds structure, never replaces it.
+ *
+ * @generated from message gateway.v3.ErrorDetail
+ */
+export type ErrorDetail = Message<"gateway.v3.ErrorDetail"> & {
+    /**
+     * @generated from oneof gateway.v3.ErrorDetail.detail
+     */
+    detail: {
+        /**
+         * @generated from field: gateway.v3.ErrorDetail.BarLimit barLimit = 1;
+         */
+        value: ErrorDetail_BarLimit;
+        case: "barLimit";
+    } | {
+        /**
+         * @generated from field: gateway.v3.ErrorDetail.EntitlementDenial entitlement = 2;
+         */
+        value: ErrorDetail_EntitlementDenial;
+        case: "entitlement";
+    } | {
+        /**
+         * @generated from field: gateway.v3.ErrorDetail.NotFound notFound = 3;
+         */
+        value: ErrorDetail_NotFound;
+        case: "notFound";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message gateway.v3.ErrorDetail.
+ * Use `create(ErrorDetailSchema)` to create a new message.
+ */
+export declare const ErrorDetailSchema: GenMessage<ErrorDetail>;
+/**
+ * @generated from message gateway.v3.ErrorDetail.BarLimit
+ */
+export type ErrorDetail_BarLimit = Message<"gateway.v3.ErrorDetail.BarLimit"> & {
+    /**
+     * @generated from field: int64 maxBars = 1;
+     */
+    maxBars: bigint;
+    /**
+     * @generated from field: int64 maxSinceUnixS = 2;
+     */
+    maxSinceUnixS: bigint;
+    /**
+     * @generated from field: AggregationInterval interval = 3;
+     */
+    interval: AggregationInterval;
+    /**
+     * @generated from field: string tier = 4;
+     */
+    tier: string;
+};
+/**
+ * Describes the message gateway.v3.ErrorDetail.BarLimit.
+ * Use `create(ErrorDetail_BarLimitSchema)` to create a new message.
+ */
+export declare const ErrorDetail_BarLimitSchema: GenMessage<ErrorDetail_BarLimit>;
+/**
+ * @generated from message gateway.v3.ErrorDetail.EntitlementDenial
+ */
+export type ErrorDetail_EntitlementDenial = Message<"gateway.v3.ErrorDetail.EntitlementDenial"> & {
+    /**
+     * @generated from field: string metric = 1;
+     */
+    metric: string;
+    /**
+     * @generated from field: AggregationInterval interval = 2;
+     */
+    interval: AggregationInterval;
+    /**
+     * @generated from field: string requiredTier = 3;
+     */
+    requiredTier: string;
+};
+/**
+ * Describes the message gateway.v3.ErrorDetail.EntitlementDenial.
+ * Use `create(ErrorDetail_EntitlementDenialSchema)` to create a new message.
+ */
+export declare const ErrorDetail_EntitlementDenialSchema: GenMessage<ErrorDetail_EntitlementDenial>;
+/**
+ * NotFound: the request's selector matched no instrument in the registry,
+ * so the empty stream is "no such instrument", not "valid but no data in
+ * the window". selector is a human-readable summary of the identity that
+ * was looked up (venue + symbol/coin), for the client to name what is
+ * missing.
+ *
+ * @generated from message gateway.v3.ErrorDetail.NotFound
+ */
+export type ErrorDetail_NotFound = Message<"gateway.v3.ErrorDetail.NotFound"> & {
+    /**
+     * @generated from field: string selector = 1;
+     */
+    selector: string;
+};
+/**
+ * Describes the message gateway.v3.ErrorDetail.NotFound.
+ * Use `create(ErrorDetail_NotFoundSchema)` to create a new message.
+ */
+export declare const ErrorDetail_NotFoundSchema: GenMessage<ErrorDetail_NotFound>;
+/**
+ * @generated from message gateway.v3.CryptoRef
+ */
+export type CryptoRef = Message<"gateway.v3.CryptoRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * @generated from field: string rawSymbol = 2;
+     */
+    rawSymbol: string;
+    /**
+     * the registry key includes category
+     *
+     * @generated from field: Category category = 3;
+     */
+    category: Category;
+};
+/**
+ * Describes the message gateway.v3.CryptoRef.
+ * Use `create(CryptoRefSchema)` to create a new message.
+ */
+export declare const CryptoRefSchema: GenMessage<CryptoRef>;
+/**
+ * @generated from message gateway.v3.OptionRef
+ */
+export type OptionRef = Message<"gateway.v3.OptionRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * A string underlying breaks the moment options on futures land (weiit
+     * round): the underlying is itself an instrument. coin keeps today's
+     * crypto options at field 2.
+     *
+     * @generated from oneof gateway.v3.OptionRef.underlying
+     */
+    underlying: {
+        /**
+         * @generated from field: string coin = 2;
+         */
+        value: string;
+        case: "coin";
+    } | {
+        /**
+         * @generated from field: gateway.v3.EquityRef equity = 7;
+         */
+        value: EquityRef;
+        case: "equity";
+    } | {
+        /**
+         * @generated from field: gateway.v3.FuturesRef futures = 8;
+         */
+        value: FuturesRef;
+        case: "futures";
+    } | {
+        /**
+         * @generated from field: gateway.v3.SpotRef index = 9;
+         */
+        value: SpotRef;
+        case: "index";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    /**
+     * @generated from field: int64 expiryUnixS = 3;
+     */
+    expiryUnixS: bigint;
+    /**
+     * @generated from field: double strike = 4;
+     */
+    strike: number;
+    /**
+     * @generated from field: OptionType optionType = 5;
+     */
+    optionType: OptionType;
+    /**
+     * @generated from field: optional bool inverse = 6;
+     */
+    inverse?: boolean;
+    /**
+     * The venue's contract symbol is the identity (V3-56 F1): a coin-settled and
+     * a USDC-settled Deribit contract, or an inverse and a linear OKX one, share
+     * coin/expiry/strike/side, and `inverse` is wrong on Deribit, so only the
+     * raw symbol tells a pair apart. expiry/strike/optionType describe the
+     * contract and are filled on output; a ref by parts alone need not resolve.
+     *
+     * @generated from field: string rawSymbol = 10;
+     */
+    rawSymbol: string;
+};
+/**
+ * Describes the message gateway.v3.OptionRef.
+ * Use `create(OptionRefSchema)` to create a new message.
+ */
+export declare const OptionRefSchema: GenMessage<OptionRef>;
+/**
+ * @generated from message gateway.v3.PredictionRef
+ */
+export type PredictionRef = Message<"gateway.v3.PredictionRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * Each venue keys by exactly one arm (stated per venue in the manifest):
+     * Polymarket by conditionId, Kalshi by ticker, HIP-4 (and any other venue
+     * handle, e.g. Binance's numeric marketId) by marketId. HIP-4 has no
+     * condition id and its native "outcome" number is the MARKET, which clashes
+     * with the class's "outcome" (the Yes/No side), so it rides marketId (V3-51).
+     *
+     * @generated from oneof gateway.v3.PredictionRef.id
+     */
+    id: {
+        /**
+         * @generated from field: string conditionId = 2;
+         */
+        value: string;
+        case: "conditionId";
+    } | {
+        /**
+         * @generated from field: string ticker = 4;
+         */
+        value: string;
+        case: "ticker";
+    } | {
+        /**
+         * @generated from field: string marketId = 5;
+         */
+        value: string;
+        case: "marketId";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    /**
+     * The outcome the series prices (required on points/books refs): an index
+     * into the market's outcomes list (Yes=0/No=1, Eagles=0/Bears=1), or the
+     * venue's own handle for it. An outcome the venue does not serve is refused
+     * by name (V3-51 P1).
+     *
+     * @generated from oneof gateway.v3.PredictionRef.outcome
+     */
+    outcome: {
+        /**
+         * @generated from field: int32 outcomeIndex = 6;
+         */
+        value: number;
+        case: "outcomeIndex";
+    } | {
+        /**
+         * @generated from field: string assetId = 3;
+         */
+        value: string;
+        case: "assetId";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message gateway.v3.PredictionRef.
+ * Use `create(PredictionRefSchema)` to create a new message.
+ */
+export declare const PredictionRefSchema: GenMessage<PredictionRef>;
+/**
+ * @generated from message gateway.v3.ContinuousRef
+ */
+export type ContinuousRef = Message<"gateway.v3.ContinuousRef"> & {
+    /**
+     * @generated from field: string root = 1;
+     */
+    root: string;
+    /**
+     * @generated from field: bool adjusted = 2;
+     */
+    adjusted: boolean;
+};
+/**
+ * Describes the message gateway.v3.ContinuousRef.
+ * Use `create(ContinuousRefSchema)` to create a new message.
+ */
+export declare const ContinuousRefSchema: GenMessage<ContinuousRef>;
+/**
+ * @generated from message gateway.v3.FuturesRef
+ */
+export type FuturesRef = Message<"gateway.v3.FuturesRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * @generated from oneof gateway.v3.FuturesRef.id
+     */
+    id: {
+        /**
+         * outright
+         *
+         * @generated from field: string contract = 2;
+         */
+        value: string;
+        case: "contract";
+    } | {
+        /**
+         * continuous alias
+         *
+         * @generated from field: gateway.v3.ContinuousRef continuous = 3;
+         */
+        value: ContinuousRef;
+        case: "continuous";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message gateway.v3.FuturesRef.
+ * Use `create(FuturesRefSchema)` to create a new message.
+ */
+export declare const FuturesRefSchema: GenMessage<FuturesRef>;
+/**
+ * COMMODITIES and INDICES arms share the spot shape. FX does NOT: a
+ * currency pair is not a symbol string (weiit round) - it uses FxRef.
+ *
+ * @generated from message gateway.v3.SpotRef
+ */
+export type SpotRef = Message<"gateway.v3.SpotRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * @generated from field: string symbol = 2;
+     */
+    symbol: string;
+};
+/**
+ * Describes the message gateway.v3.SpotRef.
+ * Use `create(SpotRefSchema)` to create a new message.
+ */
+export declare const SpotRefSchema: GenMessage<SpotRef>;
+/**
+ * @generated from message gateway.v3.FxRef
+ */
+export type FxRef = Message<"gateway.v3.FxRef"> & {
+    /**
+     * @generated from field: Exchange venue = 1;
+     */
+    venue: Exchange;
+    /**
+     * @generated from field: string base = 2;
+     */
+    base: string;
+    /**
+     * @generated from field: string quote = 3;
+     */
+    quote: string;
+    /**
+     * @generated from field: optional Tenor tenor = 4;
+     */
+    tenor?: Tenor;
+    /**
+     * Distinguishes deliverable spot from CFD-style broker quotes; FX CFD
+     * is a kind plus a broker venue, not a class.
+     *
+     * @generated from field: optional string kind = 5;
+     */
+    kind?: string;
+};
+/**
+ * Describes the message gateway.v3.FxRef.
+ * Use `create(FxRefSchema)` to create a new message.
+ */
+export declare const FxRefSchema: GenMessage<FxRef>;
+/**
+ * @generated from message gateway.v3.EquityRef
+ */
+export type EquityRef = Message<"gateway.v3.EquityRef"> & {
+    /**
+     * The conventional exchange ticker as a trader writes it: "CMG", "AAPL",
+     * "ARKB". The gateway maps it to each dataset's raw symbol ("CMG/USD" on the
+     * price series, bare "ARKB" on the ETF-flow series). Venue is POLYGON (enum
+     * 92; US_STOCKS is its alias), so it is implied.
+     *
+     * @generated from field: string ticker = 1;
+     */
+    ticker: string;
+    /**
+     * selects ETF-family series
+     *
+     * @generated from field: optional Issuer issuer = 2;
+     */
+    issuer?: Issuer;
+};
+/**
+ * Describes the message gateway.v3.EquityRef.
+ * Use `create(EquityRefSchema)` to create a new message.
+ */
+export declare const EquityRefSchema: GenMessage<EquityRef>;
+/**
+ * @generated from message gateway.v3.MacroSymbolId
+ */
+export type MacroSymbolId = Message<"gateway.v3.MacroSymbolId"> & {
+    /**
+     * @generated from field: Category category = 1;
+     */
+    category: Category;
+    /**
+     * @generated from field: string coin = 2;
+     */
+    coin: string;
+    /**
+     * @generated from field: string rawSymbol = 3;
+     */
+    rawSymbol: string;
+};
+/**
+ * Describes the message gateway.v3.MacroSymbolId.
+ * Use `create(MacroSymbolIdSchema)` to create a new message.
+ */
+export declare const MacroSymbolIdSchema: GenMessage<MacroSymbolId>;
+/**
+ * @generated from message gateway.v3.MacroRef
+ */
+export type MacroRef = Message<"gateway.v3.MacroRef"> & {
+    /**
+     * @generated from field: Exchange publisher = 1;
+     */
+    publisher: Exchange;
+    /**
+     * @generated from oneof gateway.v3.MacroRef.id
+     */
+    id: {
+        /**
+         * FRED
+         *
+         * @generated from field: string seriesId = 2;
+         */
+        value: string;
+        case: "seriesId";
+    } | {
+        /**
+         * OBSERVATION / CFTC_COT / MARGIN_DEBT
+         *
+         * @generated from field: gateway.v3.MacroSymbolId symbol = 3;
+         */
+        value: MacroSymbolId;
+        case: "symbol";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message gateway.v3.MacroRef.
+ * Use `create(MacroRefSchema)` to create a new message.
+ */
+export declare const MacroRefSchema: GenMessage<MacroRef>;
+/**
+ * InstrumentRef is the class-agnostic wrapper for the cross-class
+ * surfaces - a future events concern, a resolver, an instrument-vs-
+ * instrument spread (weiit round: a pair across classes has no shape in
+ * a single class arm). Data-method requests never take it: their class
+ * arm already picks exactly one class.
+ *
+ * @generated from message gateway.v3.InstrumentRef
+ */
+export type InstrumentRef = Message<"gateway.v3.InstrumentRef"> & {
+    /**
+     * @generated from oneof gateway.v3.InstrumentRef.ref
+     */
+    ref: {
+        /**
+         * @generated from field: gateway.v3.CryptoRef crypto = 1;
+         */
+        value: CryptoRef;
+        case: "crypto";
+    } | {
+        /**
+         * @generated from field: gateway.v3.OptionRef option = 2;
+         */
+        value: OptionRef;
+        case: "option";
+    } | {
+        /**
+         * @generated from field: gateway.v3.PredictionRef prediction = 3;
+         */
+        value: PredictionRef;
+        case: "prediction";
+    } | {
+        /**
+         * @generated from field: gateway.v3.FuturesRef futures = 4;
+         */
+        value: FuturesRef;
+        case: "futures";
+    } | {
+        /**
+         * @generated from field: gateway.v3.SpotRef spot = 5;
+         */
+        value: SpotRef;
+        case: "spot";
+    } | {
+        /**
+         * @generated from field: gateway.v3.EquityRef equity = 6;
+         */
+        value: EquityRef;
+        case: "equity";
+    } | {
+        /**
+         * @generated from field: gateway.v3.MacroRef macro = 7;
+         */
+        value: MacroRef;
+        case: "macro";
+    } | {
+        /**
+         * @generated from field: gateway.v3.FxRef fx = 8;
+         */
+        value: FxRef;
+        case: "fx";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message gateway.v3.InstrumentRef.
+ * Use `create(InstrumentRefSchema)` to create a new message.
+ */
+export declare const InstrumentRefSchema: GenMessage<InstrumentRef>;
+/**
+ * Domain is the routing vocabulary shared by the request arms and the
+ * cross-class surfaces (market search, symbol directory, entitlements, authz
+ * input). It is not the instrument's stored asset class (pb.AssetClass): a
+ * domain names which arm serves a metric, while the stored class classifies an
+ * instrument. Points/books/instruments requests carry the domain through their
+ * oneof arm instead of naming it here.
+ *
+ * @generated from enum gateway.v3.Domain
+ */
+export declare enum Domain {
+    /**
+     * @generated from enum value: DOMAIN_UNKNOWN = 0;
+     */
+    DOMAIN_UNKNOWN = 0,
+    /**
+     * @generated from enum value: CRYPTO = 1;
+     */
+    CRYPTO = 1,
+    /**
+     * @generated from enum value: OPTIONS = 2;
+     */
+    OPTIONS = 2,
+    /**
+     * @generated from enum value: PREDICTION = 3;
+     */
+    PREDICTION = 3,
+    /**
+     * @generated from enum value: EQUITIES = 4;
+     */
+    EQUITIES = 4,
+    /**
+     * @generated from enum value: FX = 5;
+     */
+    FX = 5,
+    /**
+     * @generated from enum value: COMMODITIES = 6;
+     */
+    COMMODITIES = 6,
+    /**
+     * @generated from enum value: FUTURES = 7;
+     */
+    FUTURES = 7,
+    /**
+     * @generated from enum value: INDICES = 8;
+     */
+    INDICES = 8,
+    /**
+     * @generated from enum value: MACRO = 9;
+     */
+    MACRO = 9
+}
+/**
+ * Describes the enum gateway.v3.Domain.
+ */
+export declare const DomainSchema: GenEnum<Domain>;
+//# sourceMappingURL=common_pb.d.ts.map