fixparser/types/messagetemplates/MessageTemplates.d.ts

FIX.Latest / 5.0 SP2 Parser / AI Agent Trading

import { Field } from '../fields/Field.ts';
import type { IFIXParser } from '../IFIXParser.ts';
import type { Message } from '../message/Message.ts';
/**
 * Creates a Heartbeat message for the FIX session.
 * Heartbeat messages are used to maintain the connection and indicate that the session is still active.
 * Optionally includes a TestReqID if provided.
 *
 * @param {IFIXParser} parser - The FIX parser instance
 * @param {Field} [testReqId] - Optional TestReqID field to include in the heartbeat
 * @returns {Message} A FIX Heartbeat message
 * @throws {Error} If the license is invalid
 */
export declare const heartBeat: (parser: IFIXParser, testReqId?: Field) => Message;
/**
 * Creates a Sequence Reset message for the FIX session.
 * Used to reset the sequence numbers between two parties in a FIX session.
 * Can be used to fill gaps in message sequences or to reset the sequence number.
 *
 * @param {IFIXParser} parser - The FIX parser instance
 * @param {number} seqNo - The current sequence number
 * @param {number} newSeqNo - The new sequence number to set
 * @param {'Y' | 'N'} [gapFillFlag=GapFillFlag.GapFillMessage] - Flag indicating if this is a gap fill message
 * @returns {Message} A FIX Sequence Reset message
 * @throws {Error} If the license is invalid
 */
export declare const sequenceReset: (parser: IFIXParser, seqNo: number, newSeqNo: number, gapFillFlag?: "Y" | "N") => Message;