ReadMe API

/**
 * ReadMeAPI - generated by OmniStream from ReadMe 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/readme";

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

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

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

  /** Get metadata about the current project */
  getProject(): Promise<any> {
    return this._request("GET", "/", {});
  }

  /** Get API specification metadata */
  getAPISpecification(params: { "x-readme-version": string; "perPage"?: number; "page"?: number }): Promise<any> {
    return this._request("GET", "/api-specification", { params });
  }

  /** Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/automatically-sync-api-specification-with-github */
  uploadAPISpecification(params: { "x-readme-version": string }): Promise<any> {
    return this._request("POST", "/api-specification", { params });
  }

  /** Update an API specification in ReadMe */
  updateAPISpecification(params: { "id": string }): Promise<any> {
    return this._request("PUT", "/api-specification/{id}", { params });
  }

  /** Delete an API specification in ReadMe */
  deleteAPISpecification(params: { "id": string }): Promise<any> {
    return this._request("DELETE", "/api-specification/{id}", { params });
  }

  /** Get category */
  getCategory(params: { "slug": string; "x-readme-version": string }): Promise<any> {
    return this._request("GET", "/categories/{slug}", { params });
  }

  /** Get docs for category */
  getCategoryDocs(params: { "slug": string; "x-readme-version": string }): Promise<any> {
    return this._request("GET", "/categories/{slug}/docs", { params });
  }

  /** Get changelogs */
  getChangelogs(params: { "perPage"?: number; "page"?: number }): Promise<any> {
    return this._request("GET", "/changelogs", { params });
  }

  /** Create changelog */
  createChangelog(body: unknown): Promise<any> {
    return this._request("POST", "/changelogs", { body });
  }

  /** Get changelog */
  getChangelog(params: { "slug": string }): Promise<any> {
    return this._request("GET", "/changelogs/{slug}", { params });
  }

  /** Update changelog */
  updateChangelog(body: unknown, params: { "slug": string }): Promise<any> {
    return this._request("PUT", "/changelogs/{slug}", { body, params });
  }

  /** Delete changelog */
  deleteChangelog(params: { "slug": string }): Promise<any> {
    return this._request("DELETE", "/changelogs/{slug}", { params });
  }

  /** Get custom pages */
  getCustomPages(params: { "perPage"?: number; "page"?: number }): Promise<any> {
    return this._request("GET", "/custompages", { params });
  }

  /** Create custom page */
  createCustomPage(body: unknown): Promise<any> {
    return this._request("POST", "/custompages", { body });
  }

  /** Get custom page */
  getCustomPage(params: { "slug": string }): Promise<any> {
    return this._request("GET", "/custompages/{slug}", { params });
  }

  /** Update custom page */
  updateCustomPage(body: unknown, params: { "slug": string }): Promise<any> {
    return this._request("PUT", "/custompages/{slug}", { body, params });
  }

  /** Delete custom page */
  deleteCustomPage(params: { "slug": string }): Promise<any> {
    return this._request("DELETE", "/custompages/{slug}", { params });
  }

  /** Create doc */
  createDoc(body: unknown, params: { "x-readme-version": string }): Promise<any> {
    return this._request("POST", "/docs", { body, params });
  }

  /** Search docs */
  searchDocs(params: { "search": string; "x-readme-version": string }): Promise<any> {
    return this._request("POST", "/docs/search", { params });
  }

  /** Get doc */
  getDoc(params: { "slug": string; "x-readme-version": string }): Promise<any> {
    return this._request("GET", "/docs/{slug}", { params });
  }

  /** Update doc */
  updateDoc(body: unknown, params: { "slug": string; "x-readme-version": string }): Promise<any> {
    return this._request("PUT", "/docs/{slug}", { body, params });
  }

  /** Delete doc */
  deleteDoc(params: { "slug": string; "x-readme-version": string }): Promise<any> {
    return this._request("DELETE", "/docs/{slug}", { params });
  }

  /** Get errors */
  getErrors(): Promise<any> {
    return this._request("GET", "/errors", {});
  }

  /** Get versions */
  getVersions(): Promise<any> {
    return this._request("GET", "/version", {});
  }

  /** Create version */
  createVersion(body: unknown): Promise<any> {
    return this._request("POST", "/version", { body });
  }

  /** Get version */
  getVersion(params: { "versionId": string }): Promise<any> {
    return this._request("GET", "/version/{versionId}", { params });
  }

  /** Update version */
  updateVersion(body: unknown, params: { "versionId": string }): Promise<any> {
    return this._request("PUT", "/version/{versionId}", { body, params });
  }

  /** Delete version */
  deleteVersion(params: { "versionId": string }): Promise<any> {
    return this._request("DELETE", "/version/{versionId}", { params });
  }
}

export default ReadMeAPI;