Neutrino API

/**
 * NeutrinoAPI - generated by OmniStream from Neutrino API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/neutrinoapi";

export class NeutrinoAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `NeutrinoAPI error ${status}`);
    this.name = "NeutrinoAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface NeutrinoAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class NeutrinoAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: NeutrinoAPIOptions = {}) {
    if (!token) throw new Error("NeutrinoAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new NeutrinoAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Bad Word Filter */
  badWordFilter(): Promise<any> {
    return this._request("POST", "/bad-word-filter", {  });
  }

  /** BIN List Download */
  bINListDownload(params: { "include-iso3"?: boolean; "include-8digit"?: boolean }): Promise<any> {
    return this._request("GET", "/bin-list-download", { params });
  }

  /** BIN Lookup */
  bINLookup(params: { "bin-number": string; "customer-ip"?: string }): Promise<any> {
    return this._request("GET", "/bin-lookup", { params });
  }

  /** Browser Bot */
  browserBot(): Promise<any> {
    return this._request("POST", "/browser-bot", {  });
  }

  /** Convert */
  convert(params: { "from-value": string; "from-type": string; "to-type": string }): Promise<any> {
    return this._request("GET", "/convert", { params });
  }

  /** Email Validate */
  emailValidate(params: { "email": string; "fix-typos"?: boolean }): Promise<any> {
    return this._request("GET", "/email-validate", { params });
  }

  /** Email Verify */
  emailVerify(params: { "email": string; "fix-typos"?: boolean }): Promise<any> {
    return this._request("GET", "/email-verify", { params });
  }

  /** Geocode Address */
  geocodeAddress(params: { "address"?: string; "house-number"?: string; "street"?: string; "city"?: string; "county"?: string; "state"?: string; "postal-code"?: string; "country-code"?: string; "language-code"?: string; "fuzzy-search"?: boolean }): Promise<any> {
    return this._request("GET", "/geocode-address", { params });
  }

  /** Geocode Reverse */
  geocodeReverse(params: { "latitude": string; "longitude": string; "language-code"?: string; "zoom"?: string }): Promise<any> {
    return this._request("GET", "/geocode-reverse", { params });
  }

  /** HLR Lookup */
  hLRLookup(params: { "number": string; "country-code"?: string }): Promise<any> {
    return this._request("GET", "/hlr-lookup", { params });
  }

  /** Host Reputation */
  hostReputation(params: { "host": string; "list-rating"?: number; "zones"?: string }): Promise<any> {
    return this._request("GET", "/host-reputation", { params });
  }

  /** HTML Clean */
  hTMLClean(): Promise<any> {
    return this._request("POST", "/html-clean", {  });
  }

  /** HTML Render */
  hTMLRender(): Promise<any> {
    return this._request("POST", "/html-render", {  });
  }

  /** Image Resize */
  imageResize(): Promise<any> {
    return this._request("POST", "/image-resize", {  });
  }

  /** Image Watermark */
  imageWatermark(): Promise<any> {
    return this._request("POST", "/image-watermark", {  });
  }

  /** IP Blocklist */
  iPBlocklist(params: { "ip": string; "vpn-lookup"?: boolean }): Promise<any> {
    return this._request("GET", "/ip-blocklist", { params });
  }

  /** IP Blocklist Download */
  iPBlocklistDownload(params: { "format"?: string; "include-vpn"?: boolean; "cidr"?: boolean; "ip6"?: boolean }): Promise<any> {
    return this._request("GET", "/ip-blocklist-download", { params });
  }

  /** IP Info */
  iPInfo(params: { "ip": string; "reverse-lookup"?: boolean }): Promise<any> {
    return this._request("GET", "/ip-info", { params });
  }

  /** IP Probe */
  iPProbe(params: { "ip": string }): Promise<any> {
    return this._request("GET", "/ip-probe", { params });
  }

  /** Phone Playback */
  phonePlayback(): Promise<any> {
    return this._request("POST", "/phone-playback", {  });
  }

  /** Phone Validate */
  phoneValidate(params: { "number": string; "country-code"?: string; "ip"?: string }): Promise<any> {
    return this._request("GET", "/phone-validate", { params });
  }

  /** Phone Verify */
  phoneVerify(): Promise<any> {
    return this._request("POST", "/phone-verify", {  });
  }

  /** QR Code */
  qRCode(): Promise<any> {
    return this._request("POST", "/qr-code", {  });
  }

  /** SMS Verify */
  sMSVerify(): Promise<any> {
    return this._request("POST", "/sms-verify", {  });
  }

  /** UA Lookup */
  uALookup(params: { "ua": string; "ua-version"?: string; "ua-platform"?: string; "ua-platform-version"?: string; "ua-mobile"?: string; "device-model"?: string; "device-brand"?: string }): Promise<any> {
    return this._request("GET", "/ua-lookup", { params });
  }

  /** URL Info */
  uRLInfo(params: { "url": string; "fetch-content"?: boolean; "ignore-certificate-errors"?: boolean; "timeout"?: number; "retry"?: number }): Promise<any> {
    return this._request("GET", "/url-info", { params });
  }

  /** Verify Security Code */
  verifySecurityCode(params: { "security-code": string; "limit-by"?: string }): Promise<any> {
    return this._request("GET", "/verify-security-code", { params });
  }
}

export default NeutrinoAPI;