@transcodely/sdk 0.3.1 → 0.3.2

package/dist/index.d.cts

@@ -3961,7 +3961,11 @@ declare enum HDRMode {
      */
     HDR_MODE_PASSTHROUGH = 1,
     /**
-     * Convert HDR to SDR via tone mapping.
+     * Convert HDR to SDR via tone mapping. Requires an HDR input: whether the
+     * input carries HDR color signaling is only knowable once it has been
+     * probed, so a tone-map job on an SDR source is accepted at create and then
+     * fails at probe time with error code `input_not_hdr`, before any encode
+     * starts.
      *
      * @generated from enum value: HDR_MODE_TONEMAP = 2;
      */
@@ -4492,12 +4496,12 @@ declare class SubtitleTrack extends Message<SubtitleTrack> {
     /**
      * Generate an AI chapters track from the transcript this track produces.
      *
-     * Only meaningful together with the (upcoming) `generate` subtitle operation:
-     * when enabled, an AI pass over the generated transcript produces a chapters
+     * Only meaningful together with the `generate` subtitle operation: when
+     * enabled, an AI pass over the generated transcript produces a chapters
      * track delivered as WebVTT plus JSON. Free — no pricing impact. The
      * transcript text is processed via the Anthropic API (an external
-     * subprocessor). Until the `generate` operation ships, setting this is
-     * rejected at job creation.
+     * subprocessor). Caption generation is available; the auto-chapters pass is
+     * not yet, so setting this is still rejected at job creation.
      *
      * @generated from field: optional bool generate_chapters = 12;
      */
@@ -4550,9 +4554,9 @@ declare class ChapterPoint extends Message<ChapterPoint> {
  * responses). It is produced by the opt-in auto-chapters pass over generated
  * captions (SubtitleTrack.generate_chapters).
  *
- * Not yet populated: the auto-chapters feature is rolling out together with
- * generated captions. Fields are documented here so consumers can code against
- * the shape ahead of the rollout.
+ * Not yet populated: the auto-chapters pass has not shipped yet. Fields are
+ * documented here so consumers can code against the shape ahead of the
+ * rollout.
  *
  * @generated from message transcodely.v1.ChapterResult
  */
@@ -4673,6 +4677,30 @@ declare class SubtitleResult extends Message<SubtitleResult> {
      * @generated from field: string transcript_url = 10;
      */
     transcriptUrl: string;
+    /**
+     * Ready-to-fetch HTTPS URL for the caption file, signed and time-limited.
+     *
+     * Points at the same object as url, but as a CDN URL a browser or player can
+     * load — url is a raw storage URI ("s3://…") that no client can fetch.
+     * Present only for jobs writing to Transcodely-managed storage (an
+     * output_origin with provider "transcodely"); jobs writing to your own bucket
+     * get nothing here and should sign url with their own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+     * 6 hours by default — so re-read the job for a fresh one rather than
+     * storing it.
+     *
+     * @generated from field: optional string signed_url = 11;
+     */
+    signedUrl?: string;
+    /**
+     * Ready-to-fetch HTTPS URL for the segment transcript, signed and
+     * time-limited. Same rules and lifetime as signed_url; set only for generate
+     * tracks, which are the only ones carrying a transcript.
+     *
+     * @generated from field: optional string transcript_signed_url = 12;
+     */
+    transcriptSignedUrl?: string;
     constructor(data?: PartialMessage<SubtitleResult>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.SubtitleResult";
@@ -4739,41 +4767,59 @@ declare enum EncryptionScheme {
  * Bring Your Own Key configuration.
  * Client provides their own encryption keys.
  *
+ * Write-only apart from key_id. Every read — CreateJob, GetJob, ListJobs, the
+ * Watch snapshots and the webhook payloads — returns key_id and nothing else;
+ * the content key, the PSSH boxes and the FairPlay IV/URI are never echoed
+ * back. Because key is a non-optional scalar it still appears on the wire as
+ * the empty string; that means "never returned", not "empty key". A job read
+ * back from the API therefore cannot be resubmitted verbatim — repopulate key
+ * from your own records first.
+ *
+ * Outputs created before the key id got its own storage column (2026-07-30)
+ * carry no key id and return no byok block at all. There is no backfill:
+ * recovering their id would mean opening the encrypted config envelope.
+ *
  * @generated from message transcodely.v1.BYOKConfig
  */
 declare class BYOKConfig extends Message<BYOKConfig> {
     /**
      * Key identifier (32 hex characters).
      *
+     * The one BYOK field returned on reads. It names which key encrypted an
+     * output — the way an API key's prefix and last-4 name the key — so the
+     * key in use can be confirmed without keeping separate records.
+     *
      * @generated from field: string key_id = 1;
      */
     keyId: string;
     /**
      * Content encryption key (32 hex characters).
      *
+     * Write-only: encrypted at rest and never returned on any read.
+     *
      * @generated from field: string key = 2;
      */
     key: string;
     /**
-     * Widevine PSSH box (base64-encoded, optional).
+     * Widevine PSSH box (base64-encoded, optional). Write-only.
      *
      * @generated from field: optional string pssh_widevine = 3;
      */
     psshWidevine?: string;
     /**
-     * PlayReady PSSH XML (optional).
+     * PlayReady PSSH XML (optional). Write-only.
      *
      * @generated from field: optional string pssh_playready = 4;
      */
     psshPlayready?: string;
     /**
-     * FairPlay initialization vector (32 hex characters).
+     * FairPlay initialization vector (32 hex characters). Write-only.
      *
      * @generated from field: optional string fairplay_iv = 5;
      */
     fairplayIv?: string;
     /**
-     * FairPlay key server URI (skd:// scheme).
+     * FairPlay key server URI (skd:// scheme). Write-only.
      *
      * @generated from field: optional string fairplay_uri = 6;
      */
@@ -4803,6 +4849,9 @@ declare class KeyServerConfig extends Message<KeyServerConfig> {
     /**
      * Authentication token for the key server.
      *
+     * Write-only: encrypted at rest and never returned on any read. The other
+     * two fields of this message are echoed back normally.
+     *
      * @generated from field: optional string auth_token = 2;
      */
     authToken?: string;
@@ -4843,6 +4892,9 @@ declare class DRMConfig extends Message<DRMConfig> {
     /**
      * BYOK configuration (mutually exclusive with key_server).
      *
+     * On reads this is a partial reveal: present with only key_id populated,
+     * or absent entirely for outputs predating the key id column.
+     *
      * @generated from field: optional transcodely.v1.BYOKConfig byok = 3;
      */
     byok?: BYOKConfig;
@@ -6781,6 +6833,24 @@ declare class ThumbnailResult extends Message<ThumbnailResult> {
      * @generated from field: int32 index = 7;
      */
     index: number;
+    /**
+     * Ready-to-fetch HTTPS URL for this thumbnail file, signed and time-limited.
+     *
+     * Points at the same object as url, but as a CDN URL a browser can load —
+     * url is a raw storage URI ("s3://…") that no client can fetch. Present only
+     * for jobs writing to Transcodely-managed storage (an output_origin with
+     * provider "transcodely"); jobs writing to your own bucket get nothing here
+     * and should sign url with their own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+     * 6 hours by default — so re-read the job for a fresh one rather than storing
+     * it. The sprite mode's WebVTT sidecar (format "vtt") is signed so that the
+     * sprite image its cues reference relatively inherits the same
+     * authorization.
+     *
+     * @generated from field: optional string signed_url = 8;
+     */
+    signedUrl?: string;
     constructor(data?: PartialMessage<ThumbnailResult>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.ThumbnailResult";
@@ -7641,7 +7711,14 @@ declare class JobOutput extends Message<JobOutput> {
      */
     errorCode?: string;
     /**
-     * Error message if failed.
+     * Human-readable summary of why this output failed, in one or two sentences.
+     *
+     * Derived from error_code, not from the transcoder: this field never carries
+     * raw tool output, command lines, stack traces, or file paths. Where a short
+     * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+     *
+     * Match on error_code, not on this text. The wording is documentation, not
+     * API surface, and may be reworded in any release.
      *
      * @generated from field: optional string error_message = 13;
      */
@@ -7720,6 +7797,28 @@ declare class JobOutput extends Message<JobOutput> {
      * @generated from field: repeated transcodely.v1.OutputVariantResult variant_results = 25;
      */
     variantResults: OutputVariantResult[];
+    /**
+     * Ready-to-fetch HTTPS URL for this output, signed and time-limited.
+     *
+     * Points at the same object as output_url — the media file for a progressive
+     * output, the master playlist or MPD for HLS/DASH — but as a CDN URL a
+     * browser or player can load, where output_url is a raw storage URI
+     * ("s3://…") that no client can fetch.
+     *
+     * Present only when the job writes to Transcodely-managed storage (an
+     * output_origin with provider "transcodely") and the output has completed.
+     * Jobs writing to your own bucket get nothing here: we hold no delivery
+     * domain for it, so read output_url and sign it with your own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List. The URL expires
+     * — 6 hours by default — so treat it as a fetch handle, not a durable link:
+     * re-read the job for a fresh one rather than storing it. For HLS and DASH it
+     * is signed so that variant playlists and segments referenced by the manifest
+     * inherit the same authorization.
+     *
+     * @generated from field: optional string signed_url = 26;
+     */
+    signedUrl?: string;
     constructor(data?: PartialMessage<JobOutput>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.JobOutput";
@@ -8014,7 +8113,9 @@ declare class Job extends Message<Job> {
      */
     inputMetadata?: InputMetadata;
     /**
-     * Output renditions.
+     * Output renditions, in the same order as the create request's `outputs`.
+     * The order is stable across every read of the job, so indexing into this
+     * array to find the rendition you asked for is safe.
      *
      * @generated from field: repeated transcodely.v1.JobOutput outputs = 7;
      */
@@ -8052,7 +8153,15 @@ declare class Job extends Message<Job> {
      */
     errorCode?: string;
     /**
-     * Error message if status is FAILED.
+     * Human-readable summary of why the job failed, in one or two sentences.
+     *
+     * Derived from error_code, not from the transcoder: this field never carries
+     * raw tool output, command lines, stack traces, or file paths. Where a short
+     * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+     * The same text reaches you on the job.failed webhook payload.
+     *
+     * Match on error_code, not on this text. The wording is documentation, not
+     * API surface, and may be reworded in any release.
      *
      * @generated from field: optional string error_message = 11;
      */
@@ -8223,8 +8332,8 @@ declare class Job extends Message<Job> {
     inputVideoId: string;
     /**
      * Auto-generated chapter tracks, one per output whose generated caption track
-     * had chapters enabled (SubtitleTrack.generate_chapters). Not yet populated:
-     * the auto-chapters feature is rolling out together with generated captions.
+     * had chapters enabled (SubtitleTrack.generate_chapters). Populated once the
+     * auto-chapters pass ships; empty until then.
      *
      * @generated from field: repeated transcodely.v1.ChapterResult chapter_results = 35;
      */
@@ -13208,7 +13317,7 @@ declare class Transcodely {
 }
 
 /** SDK version. Bumped by release-please from package.json on each tag. */
-declare const SDK_VERSION = "0.3.1";
+declare const SDK_VERSION = "0.3.2";
 /**
  * API version this SDK release is pinned to. Sent on every request as
  * `Transcodely-Version`. Customers can override per-client via the

package/dist/index.d.ts

@@ -3961,7 +3961,11 @@ declare enum HDRMode {
      */
     HDR_MODE_PASSTHROUGH = 1,
     /**
-     * Convert HDR to SDR via tone mapping.
+     * Convert HDR to SDR via tone mapping. Requires an HDR input: whether the
+     * input carries HDR color signaling is only knowable once it has been
+     * probed, so a tone-map job on an SDR source is accepted at create and then
+     * fails at probe time with error code `input_not_hdr`, before any encode
+     * starts.
      *
      * @generated from enum value: HDR_MODE_TONEMAP = 2;
      */
@@ -4492,12 +4496,12 @@ declare class SubtitleTrack extends Message<SubtitleTrack> {
     /**
      * Generate an AI chapters track from the transcript this track produces.
      *
-     * Only meaningful together with the (upcoming) `generate` subtitle operation:
-     * when enabled, an AI pass over the generated transcript produces a chapters
+     * Only meaningful together with the `generate` subtitle operation: when
+     * enabled, an AI pass over the generated transcript produces a chapters
      * track delivered as WebVTT plus JSON. Free — no pricing impact. The
      * transcript text is processed via the Anthropic API (an external
-     * subprocessor). Until the `generate` operation ships, setting this is
-     * rejected at job creation.
+     * subprocessor). Caption generation is available; the auto-chapters pass is
+     * not yet, so setting this is still rejected at job creation.
      *
      * @generated from field: optional bool generate_chapters = 12;
      */
@@ -4550,9 +4554,9 @@ declare class ChapterPoint extends Message<ChapterPoint> {
  * responses). It is produced by the opt-in auto-chapters pass over generated
  * captions (SubtitleTrack.generate_chapters).
  *
- * Not yet populated: the auto-chapters feature is rolling out together with
- * generated captions. Fields are documented here so consumers can code against
- * the shape ahead of the rollout.
+ * Not yet populated: the auto-chapters pass has not shipped yet. Fields are
+ * documented here so consumers can code against the shape ahead of the
+ * rollout.
  *
  * @generated from message transcodely.v1.ChapterResult
  */
@@ -4673,6 +4677,30 @@ declare class SubtitleResult extends Message<SubtitleResult> {
      * @generated from field: string transcript_url = 10;
      */
     transcriptUrl: string;
+    /**
+     * Ready-to-fetch HTTPS URL for the caption file, signed and time-limited.
+     *
+     * Points at the same object as url, but as a CDN URL a browser or player can
+     * load — url is a raw storage URI ("s3://…") that no client can fetch.
+     * Present only for jobs writing to Transcodely-managed storage (an
+     * output_origin with provider "transcodely"); jobs writing to your own bucket
+     * get nothing here and should sign url with their own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+     * 6 hours by default — so re-read the job for a fresh one rather than
+     * storing it.
+     *
+     * @generated from field: optional string signed_url = 11;
+     */
+    signedUrl?: string;
+    /**
+     * Ready-to-fetch HTTPS URL for the segment transcript, signed and
+     * time-limited. Same rules and lifetime as signed_url; set only for generate
+     * tracks, which are the only ones carrying a transcript.
+     *
+     * @generated from field: optional string transcript_signed_url = 12;
+     */
+    transcriptSignedUrl?: string;
     constructor(data?: PartialMessage<SubtitleResult>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.SubtitleResult";
@@ -4739,41 +4767,59 @@ declare enum EncryptionScheme {
  * Bring Your Own Key configuration.
  * Client provides their own encryption keys.
  *
+ * Write-only apart from key_id. Every read — CreateJob, GetJob, ListJobs, the
+ * Watch snapshots and the webhook payloads — returns key_id and nothing else;
+ * the content key, the PSSH boxes and the FairPlay IV/URI are never echoed
+ * back. Because key is a non-optional scalar it still appears on the wire as
+ * the empty string; that means "never returned", not "empty key". A job read
+ * back from the API therefore cannot be resubmitted verbatim — repopulate key
+ * from your own records first.
+ *
+ * Outputs created before the key id got its own storage column (2026-07-30)
+ * carry no key id and return no byok block at all. There is no backfill:
+ * recovering their id would mean opening the encrypted config envelope.
+ *
  * @generated from message transcodely.v1.BYOKConfig
  */
 declare class BYOKConfig extends Message<BYOKConfig> {
     /**
      * Key identifier (32 hex characters).
      *
+     * The one BYOK field returned on reads. It names which key encrypted an
+     * output — the way an API key's prefix and last-4 name the key — so the
+     * key in use can be confirmed without keeping separate records.
+     *
      * @generated from field: string key_id = 1;
      */
     keyId: string;
     /**
      * Content encryption key (32 hex characters).
      *
+     * Write-only: encrypted at rest and never returned on any read.
+     *
      * @generated from field: string key = 2;
      */
     key: string;
     /**
-     * Widevine PSSH box (base64-encoded, optional).
+     * Widevine PSSH box (base64-encoded, optional). Write-only.
      *
      * @generated from field: optional string pssh_widevine = 3;
      */
     psshWidevine?: string;
     /**
-     * PlayReady PSSH XML (optional).
+     * PlayReady PSSH XML (optional). Write-only.
      *
      * @generated from field: optional string pssh_playready = 4;
      */
     psshPlayready?: string;
     /**
-     * FairPlay initialization vector (32 hex characters).
+     * FairPlay initialization vector (32 hex characters). Write-only.
      *
      * @generated from field: optional string fairplay_iv = 5;
      */
     fairplayIv?: string;
     /**
-     * FairPlay key server URI (skd:// scheme).
+     * FairPlay key server URI (skd:// scheme). Write-only.
      *
      * @generated from field: optional string fairplay_uri = 6;
      */
@@ -4803,6 +4849,9 @@ declare class KeyServerConfig extends Message<KeyServerConfig> {
     /**
      * Authentication token for the key server.
      *
+     * Write-only: encrypted at rest and never returned on any read. The other
+     * two fields of this message are echoed back normally.
+     *
      * @generated from field: optional string auth_token = 2;
      */
     authToken?: string;
@@ -4843,6 +4892,9 @@ declare class DRMConfig extends Message<DRMConfig> {
     /**
      * BYOK configuration (mutually exclusive with key_server).
      *
+     * On reads this is a partial reveal: present with only key_id populated,
+     * or absent entirely for outputs predating the key id column.
+     *
      * @generated from field: optional transcodely.v1.BYOKConfig byok = 3;
      */
     byok?: BYOKConfig;
@@ -6781,6 +6833,24 @@ declare class ThumbnailResult extends Message<ThumbnailResult> {
      * @generated from field: int32 index = 7;
      */
     index: number;
+    /**
+     * Ready-to-fetch HTTPS URL for this thumbnail file, signed and time-limited.
+     *
+     * Points at the same object as url, but as a CDN URL a browser can load —
+     * url is a raw storage URI ("s3://…") that no client can fetch. Present only
+     * for jobs writing to Transcodely-managed storage (an output_origin with
+     * provider "transcodely"); jobs writing to your own bucket get nothing here
+     * and should sign url with their own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List, and expires —
+     * 6 hours by default — so re-read the job for a fresh one rather than storing
+     * it. The sprite mode's WebVTT sidecar (format "vtt") is signed so that the
+     * sprite image its cues reference relatively inherits the same
+     * authorization.
+     *
+     * @generated from field: optional string signed_url = 8;
+     */
+    signedUrl?: string;
     constructor(data?: PartialMessage<ThumbnailResult>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.ThumbnailResult";
@@ -7641,7 +7711,14 @@ declare class JobOutput extends Message<JobOutput> {
      */
     errorCode?: string;
     /**
-     * Error message if failed.
+     * Human-readable summary of why this output failed, in one or two sentences.
+     *
+     * Derived from error_code, not from the transcoder: this field never carries
+     * raw tool output, command lines, stack traces, or file paths. Where a short
+     * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+     *
+     * Match on error_code, not on this text. The wording is documentation, not
+     * API surface, and may be reworded in any release.
      *
      * @generated from field: optional string error_message = 13;
      */
@@ -7720,6 +7797,28 @@ declare class JobOutput extends Message<JobOutput> {
      * @generated from field: repeated transcodely.v1.OutputVariantResult variant_results = 25;
      */
     variantResults: OutputVariantResult[];
+    /**
+     * Ready-to-fetch HTTPS URL for this output, signed and time-limited.
+     *
+     * Points at the same object as output_url — the media file for a progressive
+     * output, the master playlist or MPD for HLS/DASH — but as a CDN URL a
+     * browser or player can load, where output_url is a raw storage URI
+     * ("s3://…") that no client can fetch.
+     *
+     * Present only when the job writes to Transcodely-managed storage (an
+     * output_origin with provider "transcodely") and the output has completed.
+     * Jobs writing to your own bucket get nothing here: we hold no delivery
+     * domain for it, so read output_url and sign it with your own credentials.
+     *
+     * Emitted on single-job reads (Get, Watch) and never on List. The URL expires
+     * — 6 hours by default — so treat it as a fetch handle, not a durable link:
+     * re-read the job for a fresh one rather than storing it. For HLS and DASH it
+     * is signed so that variant playlists and segments referenced by the manifest
+     * inherit the same authorization.
+     *
+     * @generated from field: optional string signed_url = 26;
+     */
+    signedUrl?: string;
     constructor(data?: PartialMessage<JobOutput>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "transcodely.v1.JobOutput";
@@ -8014,7 +8113,9 @@ declare class Job extends Message<Job> {
      */
     inputMetadata?: InputMetadata;
     /**
-     * Output renditions.
+     * Output renditions, in the same order as the create request's `outputs`.
+     * The order is stable across every read of the job, so indexing into this
+     * array to find the rendition you asked for is safe.
      *
      * @generated from field: repeated transcodely.v1.JobOutput outputs = 7;
      */
@@ -8052,7 +8153,15 @@ declare class Job extends Message<Job> {
      */
     errorCode?: string;
     /**
-     * Error message if status is FAILED.
+     * Human-readable summary of why the job failed, in one or two sentences.
+     *
+     * Derived from error_code, not from the transcoder: this field never carries
+     * raw tool output, command lines, stack traces, or file paths. Where a short
+     * safe detail is available it is appended in parentheses, e.g. "(HTTP 404)".
+     * The same text reaches you on the job.failed webhook payload.
+     *
+     * Match on error_code, not on this text. The wording is documentation, not
+     * API surface, and may be reworded in any release.
      *
      * @generated from field: optional string error_message = 11;
      */
@@ -8223,8 +8332,8 @@ declare class Job extends Message<Job> {
     inputVideoId: string;
     /**
      * Auto-generated chapter tracks, one per output whose generated caption track
-     * had chapters enabled (SubtitleTrack.generate_chapters). Not yet populated:
-     * the auto-chapters feature is rolling out together with generated captions.
+     * had chapters enabled (SubtitleTrack.generate_chapters). Populated once the
+     * auto-chapters pass ships; empty until then.
      *
      * @generated from field: repeated transcodely.v1.ChapterResult chapter_results = 35;
      */
@@ -13208,7 +13317,7 @@ declare class Transcodely {
 }
 
 /** SDK version. Bumped by release-please from package.json on each tag. */
-declare const SDK_VERSION = "0.3.1";
+declare const SDK_VERSION = "0.3.2";
 /**
  * API version this SDK release is pinned to. Sent on every request as
  * `Transcodely-Version`. Customers can override per-client via the