verimor-api-sdk/dist/api/inbox-api.d.ts

A NodeJS SDK for the Verimor API

import { BaseApi } from './base-api';
import { InboxMessage } from '../models/inbox-message';
import { ProxyConfig } from '../models/proxy-config';
/**
 * InboxApi class provides methods to interact with inbox-related endpoints.
 */
export declare class InboxApi extends BaseApi {
    /**
     * Creates an instance of InboxApi.
     * @param username - The API username.
     * @param password - The API password.
     * @param proxyConfig - Optional proxy configuration.
     */
    constructor(username: string, password: string, proxyConfig?: ProxyConfig);
    /**
     * Retrieves inbox messages.
     * @param fromTime - Start time for fetching messages (ISO 8601 format).
     * @param toTime - End time for fetching messages (ISO 8601 format).
     * @param greaterThan - Fetch messages with message_id greater than this value.
     * @returns Promise resolving to an array of InboxMessage.
     * @throws ErrorResponse if the API call fails.
     */
    getInboxMessages(fromTime?: string, toTime?: string, greaterThan?: number): Promise<InboxMessage[]>;
}