TV API

/**
 * TVAPI - generated by OmniStream from TV 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/pressassociation";

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

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

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

  /** Asset Collection */
  listAssets(params: { "updatedAfter"?: string; "limit"?: number; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/asset", { params });
  }

  /** Asset Detail */
  getAsset(params: { "assetId": string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/asset/{assetId}", { params });
  }

  /** Asset Contributors */
  getAssetContributors(params: { "assetId": string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/asset/{assetId}/contributor", { params });
  }

  /** Catalogue Collection */
  listCatalogues(): Promise<any> {
    return this._request("GET", "/catalogue", {});
  }

  /** Catalogue Detail */
  getCatalogue(params: { "catalogueId": string }): Promise<any> {
    return this._request("GET", "/catalogue/{catalogueId}", { params });
  }

  /** Catalogue Asset Collection */
  getCatalogueAsset(params: { "catalogueId": string; "title"?: string; "start"?: string; "end"?: string; "updatedAfter"?: string; "limit"?: number; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/catalogue/{catalogueId}/asset", { params });
  }

  /** Catalogue Asset Detail */
  getCatalogueAssetDetail(params: { "catalogueId": string; "assetId": string }): Promise<any> {
    return this._request("GET", "/catalogue/{catalogueId}/asset/{assetId}", { params });
  }

  /** Channel Collection */
  listChannels(params: { "platformId"?: string; "regionId"?: string; "aliases"?: boolean; "date"?: string; "scheduleStart"?: string; "scheduleEnd"?: string; "scheduleUpdatedSince"?: string }): Promise<any> {
    return this._request("GET", "/channel", { params });
  }

  /** Channel Detail */
  getChannel(params: { "channelId": string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/channel/{channelId}", { params });
  }

  /** Contributor Collection */
  listContributor(params: { "updatedAfter"?: string; "limit"?: number; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/contributor", { params });
  }

  /** Contributor Detail */
  getContributor(params: { "contributorId": string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/contributor/{contributorId}", { params });
  }

  /** Feature Collection */
  listFeatures(params: { "type"?: string; "date"?: string; "start"?: string; "end"?: string }): Promise<any> {
    return this._request("GET", "/feature", { params });
  }

  /** Feature Type Collection */
  listFeatureTypes(): Promise<any> {
    return this._request("GET", "/feature-type", {});
  }

  /** Feature Detail */
  getFeature(params: { "featureId": string }): Promise<any> {
    return this._request("GET", "/feature/{featureId}", { params });
  }

  /** Platform Collection */
  listPlatforms(params: { "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/platform", { params });
  }

  /** Platform Detail */
  getPlatform(params: { "platformId": string }): Promise<any> {
    return this._request("GET", "/platform/{platformId}", { params });
  }

  /** Platform Region Collection */
  listPlatformRegions(params: { "platformId": string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/platform/{platformId}/region", { params });
  }

  /** Schedule Collection */
  listSchedule(params: { "channelId": string; "start": string; "end"?: string; "aliases"?: boolean }): Promise<any> {
    return this._request("GET", "/schedule", { params });
  }
}

export default TVAPI;