cloudflare/src/resources/stream/captions/language/vtt.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../core/resource';
import { APIPromise } from '../../../../core/api-promise';
import { buildHeaders } from '../../../../internal/headers';
import { RequestOptions } from '../../../../internal/request-options';
import { path } from '../../../../internal/utils/path';

export class BaseVtt extends APIResource {
  static override readonly _key: readonly ['stream', 'captions', 'language', 'vtt'] = Object.freeze([
    'stream',
    'captions',
    'language',
    'vtt',
  ] as const);

  /**
   * Return WebVTT captions for a provided language.
   *
   * @example
   * ```ts
   * const vtt = await client.stream.captions.language.vtt.get(
   *   'tr',
   *   {
   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *     identifier: 'ea95132c15732412d22c1476fa83f27a',
   *   },
   * );
   * ```
   */
  get(language: string, params: VttGetParams, options?: RequestOptions): APIPromise<string> {
    const { account_id, identifier } = params;
    return this._client.get(path`/accounts/${account_id}/stream/${identifier}/captions/${language}/vtt`, {
      ...options,
      headers: buildHeaders([{ Accept: 'text/vtt' }, options?.headers]),
    });
  }
}
export class Vtt extends BaseVtt {}

export type VttGetResponse = string;

export interface VttGetParams {
  /**
   * Identifier.
   */
  account_id: string;

  /**
   * A Cloudflare-generated unique identifier for a media item.
   */
  identifier: string;
}

export declare namespace Vtt {
  export { type VttGetResponse as VttGetResponse, type VttGetParams as VttGetParams };
}