cloudflare/src/resources/stream/captions/language/language.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 '../../../../resource';
import * as Core from '../../../../core';
import * as CaptionsAPI from '../captions';
import * as VttAPI from './vtt';
import { Vtt, VttGetParams, VttGetResponse } from './vtt';

export class Language extends APIResource {
  vtt: VttAPI.Vtt = new VttAPI.Vtt(this._client);

  /**
   * Generate captions or subtitles for provided language via AI.
   *
   * @example
   * ```ts
   * const caption =
   *   await client.stream.captions.language.create(
   *     'ea95132c15732412d22c1476fa83f27a',
   *     'tr',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  create(
    identifier: string,
    language: string,
    params: LanguageCreateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<CaptionsAPI.Caption> {
    const { account_id } = params;
    return (
      this._client.post(
        `/accounts/${account_id}/stream/${identifier}/captions/${language}/generate`,
        options,
      ) as Core.APIPromise<{ result: CaptionsAPI.Caption }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Uploads the caption or subtitle file to the endpoint for a specific BCP47
   * language. One caption or subtitle file per language is allowed.
   *
   * @example
   * ```ts
   * const caption =
   *   await client.stream.captions.language.update(
   *     'ea95132c15732412d22c1476fa83f27a',
   *     'tr',
   *     {
   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *       file: '@/Users/kyle/Desktop/tr.vtt',
   *     },
   *   );
   * ```
   */
  update(
    identifier: string,
    language: string,
    params: LanguageUpdateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<CaptionsAPI.Caption> {
    const { account_id, ...body } = params;
    return (
      this._client.put(
        `/accounts/${account_id}/stream/${identifier}/captions/${language}`,
        Core.multipartFormRequestOptions({ body, ...options }),
      ) as Core.APIPromise<{ result: CaptionsAPI.Caption }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Removes the captions or subtitles from a video.
   *
   * @example
   * ```ts
   * const language =
   *   await client.stream.captions.language.delete(
   *     'ea95132c15732412d22c1476fa83f27a',
   *     'tr',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  delete(
    identifier: string,
    language: string,
    params: LanguageDeleteParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<LanguageDeleteResponse> {
    const { account_id } = params;
    return (
      this._client.delete(
        `/accounts/${account_id}/stream/${identifier}/captions/${language}`,
        options,
      ) as Core.APIPromise<{ result: LanguageDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Lists the captions or subtitles for provided language.
   *
   * @example
   * ```ts
   * const caption = await client.stream.captions.language.get(
   *   'ea95132c15732412d22c1476fa83f27a',
   *   'tr',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * );
   * ```
   */
  get(
    identifier: string,
    language: string,
    params: LanguageGetParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<CaptionsAPI.Caption> {
    const { account_id } = params;
    return (
      this._client.get(
        `/accounts/${account_id}/stream/${identifier}/captions/${language}`,
        options,
      ) as Core.APIPromise<{ result: CaptionsAPI.Caption }>
    )._thenUnwrap((obj) => obj.result);
  }
}

export type LanguageDeleteResponse = string;

export interface LanguageCreateParams {
  /**
   * Identifier.
   */
  account_id: string;
}

export interface LanguageUpdateParams {
  /**
   * Path param: Identifier.
   */
  account_id: string;

  /**
   * Body param: The WebVTT file containing the caption or subtitle content.
   */
  file: string;
}

export interface LanguageDeleteParams {
  /**
   * Identifier.
   */
  account_id: string;
}

export interface LanguageGetParams {
  /**
   * Identifier.
   */
  account_id: string;
}

Language.Vtt = Vtt;

export declare namespace Language {
  export {
    type LanguageDeleteResponse as LanguageDeleteResponse,
    type LanguageCreateParams as LanguageCreateParams,
    type LanguageUpdateParams as LanguageUpdateParams,
    type LanguageDeleteParams as LanguageDeleteParams,
    type LanguageGetParams as LanguageGetParams,
  };

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