@giveitsmaller/contracts 0.21.0 → 0.23.0

package/dist/openapi/models/WorkflowSummaryJob.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarning.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarning.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarningSeverity.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/WorkflowWarningSeverity.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/runtime.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/runtime.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.78.0
+ * The version of the OpenAPI document: 2.83.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/operations/archive.metadata.js

@@ -7,7 +7,11 @@ export const archiveMetadata = {
             per_value_availability: {},
         },
         folder_structure: {
-            per_value_availability: {},
+            per_value_availability: {
+                by_job: {
+                    availability: 'planned',
+                },
+            },
         },
     },
 };

package/dist/operations/compress.d.ts

@@ -1,18 +1,59 @@
-export declare enum CompressImageMode {
-    Lossy = "lossy",
-    Lossless = "lossless",
-    Auto = "auto"
+export declare enum CompressImageJpegMetadata {
+    All = "all"
 }
-export declare enum CompressImageMetadata {
-    All = "all",
-    None = "none",
-    Copyright = "copyright",
-    Sensitive = "sensitive"
+export declare enum CompressImageJpegOutputFormat {
+    Original = "original",
+    Auto = "auto",
+    Smallest = "smallest",
+    Jpeg = "jpeg",
+    Png = "png",
+    Webp = "webp",
+    Avif = "avif"
+}
+export interface CompressImageJpegOptions {
+    quality?: number;
+    metadata?: CompressImageJpegMetadata;
+    progressive?: boolean;
+    output_format?: CompressImageJpegOutputFormat;
+}
+export declare enum CompressImagePngMetadata {
+    All = "all"
 }
-export declare enum CompressImageIccProfile {
-    Preserve = "preserve",
-    Strip = "strip",
-    Srgb = "srgb"
+export declare enum CompressImagePngOutputFormat {
+    Original = "original",
+    Auto = "auto",
+    Smallest = "smallest",
+    Jpeg = "jpeg",
+    Png = "png",
+    Webp = "webp",
+    Avif = "avif"
+}
+export interface CompressImagePngOptions {
+    quality?: number;
+    metadata?: CompressImagePngMetadata;
+    optimization_level?: number;
+    output_format?: CompressImagePngOutputFormat;
+}
+export declare enum CompressImageAvifMetadata {
+    All = "all"
+}
+export declare enum CompressImageAvifOutputFormat {
+    Original = "original",
+    Auto = "auto",
+    Smallest = "smallest",
+    Jpeg = "jpeg",
+    Png = "png",
+    Webp = "webp",
+    Avif = "avif"
+}
+export interface CompressImageAvifOptions {
+    quality?: number;
+    metadata?: CompressImageAvifMetadata;
+    avif_speed?: number;
+    output_format?: CompressImageAvifOutputFormat;
+}
+export declare enum CompressImageMetadata {
+    All = "all"
 }
 export declare enum CompressImageOutputFormat {
     Original = "original",
@@ -24,11 +65,8 @@ export declare enum CompressImageOutputFormat {
     Avif = "avif"
 }
 export interface CompressImageOptions {
-    mode?: CompressImageMode;
     quality?: number;
     metadata?: CompressImageMetadata;
-    icc_profile?: CompressImageIccProfile;
-    progressive?: boolean;
     output_format?: CompressImageOutputFormat;
 }
 export declare enum CompressAudioOutputFormat {
@@ -138,23 +176,27 @@ export declare enum CompressDocumentPdfColorspace {
     Grayscale = "grayscale"
 }
 export interface CompressDocumentPdfOptions {
+    quality?: number;
     profile?: CompressDocumentPdfProfile;
     colorspace?: CompressDocumentPdfColorspace;
     pages?: string;
     flatten_forms?: boolean;
 }
 export interface CompressDocumentOfficeOptions {
+    quality?: number;
     image_quality?: number;
     strip_macros?: boolean;
     strip_hidden_data?: boolean;
     strip_unused_fonts?: boolean;
 }
 export interface CompressDocumentOdfOptions {
+    quality?: number;
     image_quality?: number;
     strip_metadata?: boolean;
     strip_unused_styles?: boolean;
 }
 export interface CompressDocumentEpubOptions {
+    quality?: number;
     image_quality?: number;
     font_subsetting?: boolean;
     strip_unused_css?: boolean;

package/dist/operations/compress.js

@@ -1,23 +1,50 @@
 // Auto-generated from compress.yaml -- do not edit
-export var CompressImageMode;
-(function (CompressImageMode) {
-    CompressImageMode["Lossy"] = "lossy";
-    CompressImageMode["Lossless"] = "lossless";
-    CompressImageMode["Auto"] = "auto";
-})(CompressImageMode || (CompressImageMode = {}));
+export var CompressImageJpegMetadata;
+(function (CompressImageJpegMetadata) {
+    CompressImageJpegMetadata["All"] = "all";
+})(CompressImageJpegMetadata || (CompressImageJpegMetadata = {}));
+export var CompressImageJpegOutputFormat;
+(function (CompressImageJpegOutputFormat) {
+    CompressImageJpegOutputFormat["Original"] = "original";
+    CompressImageJpegOutputFormat["Auto"] = "auto";
+    CompressImageJpegOutputFormat["Smallest"] = "smallest";
+    CompressImageJpegOutputFormat["Jpeg"] = "jpeg";
+    CompressImageJpegOutputFormat["Png"] = "png";
+    CompressImageJpegOutputFormat["Webp"] = "webp";
+    CompressImageJpegOutputFormat["Avif"] = "avif";
+})(CompressImageJpegOutputFormat || (CompressImageJpegOutputFormat = {}));
+export var CompressImagePngMetadata;
+(function (CompressImagePngMetadata) {
+    CompressImagePngMetadata["All"] = "all";
+})(CompressImagePngMetadata || (CompressImagePngMetadata = {}));
+export var CompressImagePngOutputFormat;
+(function (CompressImagePngOutputFormat) {
+    CompressImagePngOutputFormat["Original"] = "original";
+    CompressImagePngOutputFormat["Auto"] = "auto";
+    CompressImagePngOutputFormat["Smallest"] = "smallest";
+    CompressImagePngOutputFormat["Jpeg"] = "jpeg";
+    CompressImagePngOutputFormat["Png"] = "png";
+    CompressImagePngOutputFormat["Webp"] = "webp";
+    CompressImagePngOutputFormat["Avif"] = "avif";
+})(CompressImagePngOutputFormat || (CompressImagePngOutputFormat = {}));
+export var CompressImageAvifMetadata;
+(function (CompressImageAvifMetadata) {
+    CompressImageAvifMetadata["All"] = "all";
+})(CompressImageAvifMetadata || (CompressImageAvifMetadata = {}));
+export var CompressImageAvifOutputFormat;
+(function (CompressImageAvifOutputFormat) {
+    CompressImageAvifOutputFormat["Original"] = "original";
+    CompressImageAvifOutputFormat["Auto"] = "auto";
+    CompressImageAvifOutputFormat["Smallest"] = "smallest";
+    CompressImageAvifOutputFormat["Jpeg"] = "jpeg";
+    CompressImageAvifOutputFormat["Png"] = "png";
+    CompressImageAvifOutputFormat["Webp"] = "webp";
+    CompressImageAvifOutputFormat["Avif"] = "avif";
+})(CompressImageAvifOutputFormat || (CompressImageAvifOutputFormat = {}));
 export var CompressImageMetadata;
 (function (CompressImageMetadata) {
     CompressImageMetadata["All"] = "all";
-    CompressImageMetadata["None"] = "none";
-    CompressImageMetadata["Copyright"] = "copyright";
-    CompressImageMetadata["Sensitive"] = "sensitive";
 })(CompressImageMetadata || (CompressImageMetadata = {}));
-export var CompressImageIccProfile;
-(function (CompressImageIccProfile) {
-    CompressImageIccProfile["Preserve"] = "preserve";
-    CompressImageIccProfile["Strip"] = "strip";
-    CompressImageIccProfile["Srgb"] = "srgb";
-})(CompressImageIccProfile || (CompressImageIccProfile = {}));
 export var CompressImageOutputFormat;
 (function (CompressImageOutputFormat) {
     CompressImageOutputFormat["Original"] = "original";

package/dist/operations/compress.metadata.js

@@ -2,27 +2,120 @@
 export const compressMetadata = {
     features: {},
     mime_groups: {
-        image: {
+        image_jpeg: {
             processing_class: {},
-            per_mime_availability: {
-                'image/avif': {
-                    availability: 'beta',
+            per_mime_availability: {},
+            options: {
+                quality: {
+                    per_value_availability: {},
+                },
+                metadata: {
+                    per_value_availability: {},
+                },
+                progressive: {
+                    per_value_availability: {},
+                },
+                output_format: {
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                        jpeg: {
+                            availability: 'planned',
+                        },
+                        png: {
+                            availability: 'planned',
+                        },
+                        avif: {
+                            availability: 'planned',
+                        },
+                    },
                 },
             },
+            per_input_options: {},
+        },
+        image_png: {
+            processing_class: {},
+            per_mime_availability: {},
             options: {
-                mode: {
+                quality: {
+                    per_value_availability: {},
+                },
+                metadata: {
                     per_value_availability: {},
                 },
+                optimization_level: {
+                    per_value_availability: {},
+                },
+                output_format: {
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                        jpeg: {
+                            availability: 'planned',
+                        },
+                        png: {
+                            availability: 'planned',
+                        },
+                        avif: {
+                            availability: 'planned',
+                        },
+                    },
+                },
+            },
+            per_input_options: {},
+        },
+        image_avif: {
+            availability: 'beta',
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
                 quality: {
                     per_value_availability: {},
                 },
                 metadata: {
                     per_value_availability: {},
                 },
-                icc_profile: {
+                avif_speed: {
                     per_value_availability: {},
                 },
-                progressive: {
+                output_format: {
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                        jpeg: {
+                            availability: 'planned',
+                        },
+                        png: {
+                            availability: 'planned',
+                        },
+                        avif: {
+                            availability: 'planned',
+                        },
+                    },
+                },
+            },
+            per_input_options: {},
+        },
+        image: {
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
+                quality: {
+                    per_value_availability: {},
+                },
+                metadata: {
                     per_value_availability: {},
                 },
                 output_format: {
@@ -168,16 +261,23 @@ export const compressMetadata = {
             processing_class: {},
             per_mime_availability: {},
             options: {
+                quality: {
+                    per_value_availability: {},
+                },
                 profile: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 colorspace: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 pages: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 flatten_forms: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
             },
@@ -187,16 +287,23 @@ export const compressMetadata = {
             processing_class: {},
             per_mime_availability: {},
             options: {
+                quality: {
+                    per_value_availability: {},
+                },
                 image_quality: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_macros: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_hidden_data: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_unused_fonts: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
             },
@@ -206,13 +313,19 @@ export const compressMetadata = {
             processing_class: {},
             per_mime_availability: {},
             options: {
+                quality: {
+                    per_value_availability: {},
+                },
                 image_quality: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_metadata: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_unused_styles: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
             },
@@ -222,13 +335,19 @@ export const compressMetadata = {
             processing_class: {},
             per_mime_availability: {},
             options: {
+                quality: {
+                    per_value_availability: {},
+                },
                 image_quality: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 font_subsetting: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 strip_unused_css: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
             },

package/dist/operations/convert.d.ts

@@ -17,21 +17,15 @@ export declare enum ConvertVideoOutputFormat {
     Ogg = "ogg",
     Gif = "gif"
 }
-export declare enum ConvertVideoCodec {
-    H264 = "h264",
-    H265 = "h265",
-    Vp9 = "vp9",
-    Av1 = "av1"
-}
 export interface ConvertVideoOptions {
     output_format: ConvertVideoOutputFormat;
-    codec?: ConvertVideoCodec;
-    quality?: number;
+    crf?: number;
 }
 export declare enum ConvertAudioOutputFormat {
     Mp3 = "mp3",
     Aac = "aac",
     Ogg = "ogg",
+    Opus = "opus",
     Flac = "flac",
     Wav = "wav"
 }

package/dist/operations/convert.js

@@ -15,18 +15,12 @@ export var ConvertVideoOutputFormat;
     ConvertVideoOutputFormat["Ogg"] = "ogg";
     ConvertVideoOutputFormat["Gif"] = "gif";
 })(ConvertVideoOutputFormat || (ConvertVideoOutputFormat = {}));
-export var ConvertVideoCodec;
-(function (ConvertVideoCodec) {
-    ConvertVideoCodec["H264"] = "h264";
-    ConvertVideoCodec["H265"] = "h265";
-    ConvertVideoCodec["Vp9"] = "vp9";
-    ConvertVideoCodec["Av1"] = "av1";
-})(ConvertVideoCodec || (ConvertVideoCodec = {}));
 export var ConvertAudioOutputFormat;
 (function (ConvertAudioOutputFormat) {
     ConvertAudioOutputFormat["Mp3"] = "mp3";
     ConvertAudioOutputFormat["Aac"] = "aac";
     ConvertAudioOutputFormat["Ogg"] = "ogg";
+    ConvertAudioOutputFormat["Opus"] = "opus";
     ConvertAudioOutputFormat["Flac"] = "flac";
     ConvertAudioOutputFormat["Wav"] = "wav";
 })(ConvertAudioOutputFormat || (ConvertAudioOutputFormat = {}));

package/dist/operations/convert.metadata.js

@@ -50,10 +50,7 @@ export const convertMetadata = {
                 output_format: {
                     per_value_availability: {},
                 },
-                codec: {
-                    per_value_availability: {},
-                },
-                quality: {
+                crf: {
                     per_value_availability: {},
                 },
             },

package/dist/operations/thumbnail.d.ts

@@ -13,6 +13,7 @@ export interface ThumbnailImageOptions {
     height: number;
     fit?: ThumbnailImageFit;
     format?: ThumbnailImageFormat;
+    quality?: number;
 }
 export declare enum ThumbnailVideoFit {
     Max = "max",
@@ -30,6 +31,7 @@ export interface ThumbnailVideoOptions {
     height: number;
     fit?: ThumbnailVideoFit;
     format?: ThumbnailVideoFormat;
+    quality?: number;
 }
 export declare enum ThumbnailDocumentSource {
     Page = "page",
@@ -52,4 +54,5 @@ export interface ThumbnailDocumentOptions {
     height: number;
     fit?: ThumbnailDocumentFit;
     format?: ThumbnailDocumentFormat;
+    quality?: number;
 }

package/dist/operations/thumbnail.metadata.js

@@ -25,6 +25,9 @@ export const thumbnailMetadata = {
                 format: {
                     per_value_availability: {},
                 },
+                quality: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },
@@ -63,6 +66,9 @@ export const thumbnailMetadata = {
                 format: {
                     per_value_availability: {},
                 },
+                quality: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },
@@ -88,6 +94,9 @@ export const thumbnailMetadata = {
                 format: {
                     per_value_availability: {},
                 },
+                quality: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },