import { ApiResponse } from './apiResponse'; export interface LookupOptions { /** the caller’s phone number */ callerNumber: string; /** the caller’s caller ID */ callerId?: string; /** the callee (the phone number being called) */ calledNumber?: string; /** abandon the request and reject with an error after this amount of time */ timeoutMs?: number; } export interface LookupResult { /** true if the request completed successfully; false if an error occurred */ ok: boolean; /** * if the record was found, the spam risk level; undefined if the record was not found */ spamRisk?: number; /** the complete raw API response */ raw: ApiResponse; } /** Client for the YouMail Spam Caller (Big Data) API. */ export declare class YouMailClient { private readonly apiKey; private readonly apiSid; constructor(apiKey: string, apiSid: string); /** * Look up details about a phone number using the YouMail Spam Caller API. * @param options A LookupOptions object. For convenience, if you are only passing in * the callerNumber, you can pass that as a string instead of a LookupOptions object. */ lookup(options: LookupOptions | string): Promise; }