Medium API

/**
 * MediumAPI - generated by OmniStream from Medium 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/medium";

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

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

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

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

  /** Get Article Info */
  getarticleArticleId(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}", { params });
  }

  /** Get Article's Content */
  getarticleArticleIdContent(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}/content", { params });
  }

  /** Get Article Fans */
  getarticleArticleIdFans(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}/fans", { params });
  }

  /** Get Article's Markdown */
  getarticleArticleIdMarkdown(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}/markdown", { params });
  }

  /** Get Related Articles */
  getarticleArticleIdRelated(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}/related", { params });
  }

  /** Get Article Responses */
  getarticleArticleIdResponses(params: { "article_id": string }): Promise<any> {
    return this._request("GET", "/article/{article_id}/responses", { params });
  }

  /** Get Latest Posts */
  getlatestpostsTopicSlug(params: { "topic_slug": string }): Promise<any> {
    return this._request("GET", "/latestposts/{topic_slug}", { params });
  }

  /** Get List Info */
  getlistListId(params: { "list_id": string }): Promise<any> {
    return this._request("GET", "/list/{list_id}", { params });
  }

  /** Get List Articles */
  getlistListIdArticles(params: { "list_id": string }): Promise<any> {
    return this._request("GET", "/list/{list_id}/articles", { params });
  }

  /** Get List Responses */
  getlistListIdResponses(params: { "list_id": string }): Promise<any> {
    return this._request("GET", "/list/{list_id}/responses", { params });
  }

  /** Get Publication ID */
  getpublicationIdForPublicationSlug(params: { "publication_slug": string }): Promise<any> {
    return this._request("GET", "/publication/id_for/{publication_slug}", { params });
  }

  /** Get Publication Info */
  getpublicationPublicationId(params: { "publication_id": string }): Promise<any> {
    return this._request("GET", "/publication/{publication_id}", { params });
  }

  /** Get Publication Articles */
  getpublicationPublicationIdArticles(params: { "publication_id": string; "from"?: string }): Promise<any> {
    return this._request("GET", "/publication/{publication_id}/articles", { params });
  }

  /** Get Publication Newsletter */
  getpublicationPublicationIdNewsletter(params: { "publication_id": string }): Promise<any> {
    return this._request("GET", "/publication/{publication_id}/newsletter", { params });
  }

  /** Get Related Tags */
  getrelatedTagsTag(params: { "tag": string }): Promise<any> {
    return this._request("GET", "/related_tags/{tag}", { params });
  }

  /** Search Articles */
  getsearchArticlesQueryQuery(params: { "query": string }): Promise<any> {
    return this._request("GET", "/search/articles?query={query}", { params });
  }

  /** Search Lists */
  getsearchListsQueryQuery(params: { "query": string }): Promise<any> {
    return this._request("GET", "/search/lists?query={query}", { params });
  }

  /** Search Publications */
  getsearchPublicationsQueryQuery(params: { "query": string }): Promise<any> {
    return this._request("GET", "/search/publications?query={query}", { params });
  }

  /** Search Tags */
  getsearchTagsQueryQuery(params: { "query": string }): Promise<any> {
    return this._request("GET", "/search/tags?query={query}", { params });
  }

  /** Search Users */
  getsearchUsersQueryQuery(params: { "query": string }): Promise<any> {
    return this._request("GET", "/search/users?query={query}", { params });
  }

  /** Get Top Writers */
  gettopWriterTopicSlug(params: { "topic_slug": string; "count"?: number }): Promise<any> {
    return this._request("GET", "/top_writer/{topic_slug}", { params });
  }

  /** Get Topfeeds */
  gettopfeedsTagMode(params: { "tag": string; "mode": string; "after"?: number; "count"?: number }): Promise<any> {
    return this._request("GET", "/topfeeds/{tag}/{mode}", { params });
  }

  /** Get User ID */
  getuserIdForUsername(params: { "username": string }): Promise<any> {
    return this._request("GET", "/user/id_for/{username}", { params });
  }

  /** Get User Info */
  getuserUserId(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}", { params });
  }

  /** Get User's Articles */
  getuserUserIdArticles(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}/articles", { params });
  }

  /** Get User Followers */
  getuserUserIdFollowers(params: { "user_id": string; "count"?: number }): Promise<any> {
    return this._request("GET", "/user/{user_id}/followers", { params });
  }

  /** Get User Following */
  getuserUserIdFollowing(params: { "user_id": string; "count"?: number }): Promise<any> {
    return this._request("GET", "/user/{user_id}/following", { params });
  }

  /** Get User's Interests */
  getuserUserIdInterests(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}/interests", { params });
  }

  /** Get User's Lists */
  getuserUserIdLists(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}/lists", { params });
  }

  /** Get User's Publications */
  getuserUserIdPublications(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}/publications", { params });
  }

  /** Get User's Top Articles */
  getuserUserIdTopArticles(params: { "user_id": string }): Promise<any> {
    return this._request("GET", "/user/{user_id}/top_articles", { params });
  }
}

export default MediumAPI;