ART19 Content API Documentation

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

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

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

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

  /** Get ClassificationInclusion records */
  getclassificationInclusions(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "classification_id"?: string; "classification_type"?: string; "classified_id"?: string; "classified_type"?: string; "q"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/classification_inclusions", { params });
  }

  /** Get a specific classification inclusion */
  getclassificationInclusionsId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/classification_inclusions/{id}", { params });
  }

  /** Get a list of classifications */
  getclassifications(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "type"?: string; "q"?: string; "is_country"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/classifications", { params });
  }

  /** Get a specific classification */
  getclassificationsId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/classifications/{id}", { params });
  }

  /** Get a list of credits */
  getcredits(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "creditable_id"?: string; "creditable_type"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/credits", { params });
  }

  /** Get a specific credit */
  getcreditsId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/credits/{id}", { params });
  }

  /** Get a list of episodes */
  getepisodes(params: { "page[number]": number; "page[size]": number; "ids[]"?: unknown[]; "included_in_inventory_calendar"?: string; "month"?: string; "published"?: boolean; "q"?: string; "released_after"?: string; "released_before"?: string; "rss"?: boolean; "season_id"?: string; "series_id"?: string; "sort"?: unknown[]; "year"?: string }): Promise<any> {
    return this._request("GET", "/episodes", { params });
  }

  /** Get a specific episode */
  getepisodesId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/episodes/{id}", { params });
  }

  /** Get the episode released right after the specified one */
  getepisodesIdNextSibling(params: { "id": string; "rss"?: boolean }): Promise<any> {
    return this._request("GET", "/episodes/{id}/next_sibling", { params });
  }

  /** Get the episode released right before the specified one */
  getepisodesIdPreviousSibling(params: { "id": string; "rss"?: boolean }): Promise<any> {
    return this._request("GET", "/episodes/{id}/previous_sibling", { params });
  }

  /** Get a list of images */
  getimages(params: { "ids[]": unknown[] }): Promise<any> {
    return this._request("GET", "/images", { params });
  }

  /** Get a specific image */
  getimagesId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/images/{id}", { params });
  }

  /** Get a list of media assets */
  getmediaAssets(params: { "ids[]": unknown[] }): Promise<any> {
    return this._request("GET", "/media_assets", { params });
  }

  /** Get a specific media asset */
  getmediaAssetsId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/media_assets/{id}", { params });
  }

  /** Get a list of networks */
  getnetworks(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "q"?: string; "ad_rep_account_id"?: string; "ad_deal_status"?: unknown[]; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/networks", { params });
  }

  /** Get a specific network */
  getnetworksId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/networks/{id}", { params });
  }

  /** Get a list of people */
  getpeople(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "q"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/people", { params });
  }

  /** Get a specific person */
  getpeopleId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/people/{id}", { params });
  }

  /** Get a list of seasons */
  getseasons(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "series_id"?: string; "q"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/seasons", { params });
  }

  /** Get a specific season */
  getseasonsId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/seasons/{id}", { params });
  }

  /** Get a list of series */
  getseries(params: { "ids[]"?: unknown[]; "page[number]"?: number; "page[size]"?: number; "ad_rep_account_id"?: string; "network_id"?: string; "q"?: string; "sort"?: unknown[] }): Promise<any> {
    return this._request("GET", "/series", { params });
  }

  /** Get a specific series */
  getseriesId(params: { "id": string }): Promise<any> {
    return this._request("GET", "/series/{id}", { params });
  }
}

export default ART19ContentAPIDocumentation;