fixparser/types/enums/EnumType.d.ts

FIX.Latest / 5.0 SP2 Parser / AI Agent Trading

import type { ISpecEnums } from '../spec/SpecEnums.ts';
/**
 * Class representing a FIX enumeration type.
 * Stores and manages enumeration-specific information for FIX fields,
 * including version history and deprecation status.
 */
export declare class EnumType {
    /** The name of the enumeration */
    name: string | undefined;
    /** The unique identifier for the enumeration */
    id: string | undefined;
    /** The tag number associated with this enumeration */
    tag: number | undefined;
    /** The data type of the enumeration */
    type: string | undefined;
    /** The code set this enumeration belongs to */
    codeSet: string | undefined;
    /** The value of the enumeration */
    value: string | undefined;
    /** The sort order of the enumeration */
    sort?: number;
    /** The group this enumeration belongs to */
    group?: string;
    /** The version when this enumeration was added */
    added?: string;
    /** The EP version when this enumeration was added */
    addedEP?: string;
    /** The version when this enumeration was last updated */
    updated?: string;
    /** The EP version when this enumeration was last updated */
    updatedEP?: string;
    /** The version when this enumeration was deprecated */
    deprecated?: string;
    /** The EP version when this enumeration was deprecated */
    deprecatedEP?: string;
    /** A description of the enumeration */
    description?: string;
    /**
     * Sets the enumeration properties based on the provided enumeration specification.
     *
     * @param {ISpecEnums} enumType - The enumeration specification to set
     */
    setEnumeration(enumType: ISpecEnums): void;
}