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

A NodeJS SDK for the Verimor API

import { BaseApi } from './base-api';
import { MessageStatusResponse } from '../models/message-status-response';
import { ProxyConfig } from '../models/proxy-config';
/**
 * MessageApi class provides methods to interact with message-related endpoints.
 */
export declare class MessageApi extends BaseApi {
    /**
     * Creates an instance of MessageApi.
     * @param username - The API username.
     * @param password - The API password.
     * @param proxyConfig - Optional proxy configuration.
     */
    constructor(username: string, password: string, proxyConfig?: ProxyConfig);
    /**
     * Retrieves the status of messages.
     * @param params - Parameters for fetching message status.
     * @returns Promise resolving to an array of MessageStatusResponse.
     * @throws ErrorResponse if the API call fails.
     */
    getMessageStatus(params: {
        id?: number;
        custom_id?: string;
        dest?: string[];
        greater_than?: number;
    }): Promise<MessageStatusResponse[]>;
}