sms77.io API

/**
 * sms77ioAPI - generated by OmniStream from sms77.io 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/sms77";

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

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

export class sms77ioAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: sms77ioAPIOptions = {}) {
    if (!token) throw new Error("sms77ioAPI: 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 sms77ioAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  analytics(params: { "start"?: string; "end"?: string; "label"?: string; "subaccounts"?: string; "group_by"?: string }): Promise<any> {
    return this._request("GET", "/analytics", { params });
  }

  balance(): Promise<any> {
    return this._request("GET", "/balance", {});
  }

  contactsGet(params: { "action": string; "json"?: number }): Promise<any> {
    return this._request("GET", "/contacts", { params });
  }

  contactsPOST(params: { "action": string; "json"?: number; "id"?: string; "nick"?: string; "empfaenger"?: string; "email"?: string }): Promise<any> {
    return this._request("POST", "/contacts", { params });
  }

  hooksGet(params: { "action": string }): Promise<any> {
    return this._request("GET", "/hooks", { params });
  }

  hooksPOST(params: { "action": string; "id"?: number; "target_url"?: string; "event_type"?: string; "request_method"?: string }): Promise<any> {
    return this._request("POST", "/hooks", { params });
  }

  lookup(params: { "type": string; "number": unknown[]; "json"?: string }): Promise<any> {
    return this._request("POST", "/lookup", { params });
  }

  lookupCnam(params: { "number": unknown[] }): Promise<any> {
    return this._request("POST", "/lookup/cnam", { params });
  }

  lookupFormat(params: { "number": unknown[] }): Promise<any> {
    return this._request("POST", "/lookup/format", { params });
  }

  lookupHlr(params: { "number": unknown[] }): Promise<any> {
    return this._request("POST", "/lookup/hlr", { params });
  }

  lookupMnp(params: { "number": unknown[]; "json"?: string }): Promise<any> {
    return this._request("POST", "/lookup/mnp", { params });
  }

  pricing(params: { "country"?: string; "format"?: string }): Promise<any> {
    return this._request("GET", "/pricing", { params });
  }

  sms(params: { "text": string; "to": string; "from"?: string; "foreign_id"?: string; "label"?: string; "udh"?: string; "delay"?: string; "debug"?: number; "no_reload"?: number; "unicode"?: number; "flash"?: number; "utf8"?: number; "details"?: number; "return_msg_id"?: number; "json"?: number; "performance_tracking"?: number }): Promise<any> {
    return this._request("POST", "/sms", { params });
  }

  status(params: { "msg_id": string }): Promise<any> {
    return this._request("GET", "/status", { params });
  }

  validateForVoice(params: { "number": string; "callback"?: string }): Promise<any> {
    return this._request("POST", "/validate_for_voice", { params });
  }

  voice(params: { "to": string; "text": string; "xml"?: number; "from"?: string }): Promise<any> {
    return this._request("POST", "/voice", { params });
  }
}

export default sms77ioAPI;