@giveitsmaller/contracts 0.2.3 → 0.4.0

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

@@ -0,0 +1,80 @@
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 200 response from `POST /api/audio-watermark/decode`. Per
+ * ticket [I20](https://trello.com/c/omiCq7Vn).
+ *
+ * @export
+ * @interface AudioWatermarkDecodeResponse
+ */
+export interface AudioWatermarkDecodeResponse {
+    /**
+     * The `watermark_id` of the detected watermark — either the
+     * UUID-v7 the server generated at embed time (when the
+     * caller did not supply a `payload`), or the
+     * server-assigned ID for caller-supplied payloads.
+     *
+     * @type {string}
+     * @memberof AudioWatermarkDecodeResponse
+     */
+    watermarkId: string;
+    /**
+     * Caller-supplied payload that was embedded at
+     * watermark-creation time, when present. Absent when the
+     * embed call did not specify a `payload` (server-generated
+     * `watermark_id` only). Max 256 characters.
+     *
+     * @type {string}
+     * @memberof AudioWatermarkDecodeResponse
+     */
+    payload?: string;
+    /**
+     * Decoder confidence in the extracted watermark. Values
+     * below 0.6 indicate a noisy / partial detection; the
+     * caller should treat such results as advisory.
+     *
+     * @type {number}
+     * @memberof AudioWatermarkDecodeResponse
+     */
+    confidence: number;
+    /**
+     * Method that successfully extracted the watermark. (The
+     * `auto` value is request-side only; the response always
+     * reports the concrete method used.)
+     *
+     * @type {AudioWatermarkDecodeResponseMethodEnum}
+     * @memberof AudioWatermarkDecodeResponse
+     */
+    method: AudioWatermarkDecodeResponseMethodEnum;
+    /**
+     * ISO-8601 timestamp at which the decode call ran.
+     * @type {Date}
+     * @memberof AudioWatermarkDecodeResponse
+     */
+    detectedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const AudioWatermarkDecodeResponseMethodEnum: {
+    readonly psychoacoustic: "psychoacoustic";
+    readonly neural: "neural";
+};
+export type AudioWatermarkDecodeResponseMethodEnum = typeof AudioWatermarkDecodeResponseMethodEnum[keyof typeof AudioWatermarkDecodeResponseMethodEnum];
+/**
+ * Check if a given object implements the AudioWatermarkDecodeResponse interface.
+ */
+export declare function instanceOfAudioWatermarkDecodeResponse(value: object): value is AudioWatermarkDecodeResponse;
+export declare function AudioWatermarkDecodeResponseFromJSON(json: any): AudioWatermarkDecodeResponse;
+export declare function AudioWatermarkDecodeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AudioWatermarkDecodeResponse;
+export declare function AudioWatermarkDecodeResponseToJSON(json: any): AudioWatermarkDecodeResponse;
+export declare function AudioWatermarkDecodeResponseToJSONTyped(value?: AudioWatermarkDecodeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/AudioWatermarkDecodeResponse.js

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const AudioWatermarkDecodeResponseMethodEnum = {
+    psychoacoustic: 'psychoacoustic',
+    neural: 'neural'
+};
+/**
+ * Check if a given object implements the AudioWatermarkDecodeResponse interface.
+ */
+export function instanceOfAudioWatermarkDecodeResponse(value) {
+    if (!('watermarkId' in value) || value['watermarkId'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    if (!('detectedAt' in value) || value['detectedAt'] === undefined)
+        return false;
+    return true;
+}
+export function AudioWatermarkDecodeResponseFromJSON(json) {
+    return AudioWatermarkDecodeResponseFromJSONTyped(json, false);
+}
+export function AudioWatermarkDecodeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'watermarkId': json['watermark_id'],
+        'payload': json['payload'] == null ? undefined : json['payload'],
+        'confidence': json['confidence'],
+        'method': json['method'],
+        'detectedAt': (new Date(json['detected_at'])),
+    };
+}
+export function AudioWatermarkDecodeResponseToJSON(json) {
+    return AudioWatermarkDecodeResponseToJSONTyped(json, false);
+}
+export function AudioWatermarkDecodeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'watermark_id': value['watermarkId'],
+        'payload': value['payload'],
+        'confidence': value['confidence'],
+        'method': value['method'],
+        'detected_at': value['detectedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,135 @@
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AuthErrorType } from './AuthErrorType.js';
+/**
+ * Error response for auth HTTP failures. Extends `ErrorEnvelope` via
+ * `allOf` with an `error_type` discriminator. This is the first
+ * `allOf`-based envelope extension in this spec — subsequent auth-related
+ * error envelopes should follow the same pattern rather than redefining
+ * a parallel flat shape.
+ *
+ * @export
+ * @interface AuthErrorResponse
+ */
+export interface AuthErrorResponse {
+    /**
+     *
+     * @type {AuthErrorResponseSuccessEnum}
+     * @memberof AuthErrorResponse
+     */
+    success: AuthErrorResponseSuccessEnum;
+    /**
+     * Stable, machine-readable error code (e.g.
+     * `INVALID_OPTIONS`, `BALANCE_EXHAUSTED`,
+     * `REQUIRES_REENCODE`). Canonical English; never localised.
+     * SDKs duck-type on this field for typed error-branch
+     * helpers.
+     *
+     * Multipart-session resume codes (per ticket
+     * [`HxUmVr3Y`](https://trello.com/c/HxUmVr3Y), V2.10.0):
+     * - `MULTIPART_SESSION_NOT_FOUND` (404) — upload_id does
+     *   not match an in-flight session (expired / never
+     *   existed / wrong account namespace). Fired by /status,
+     *   /presign, /keepalive.
+     * - `MULTIPART_SESSION_OWNERSHIP` (403) — authenticated
+     *   caller is not the session owner. Fired by /status,
+     *   /presign, /keepalive, /complete (when manifest.userId
+     *   is non-null and differs).
+     * - `MULTIPART_SESSION_AUTH_REQUIRED` (403) — session was
+     *   anonymously initiated; the three resume endpoints
+     *   require authentication. The `8LABloaz` follow-up will
+     *   flip `/initiate` to also require auth.
+     * - `FILE_TOO_LARGE_FOR_MULTIPART` (422) — assembled object
+     *   would exceed the S3 multipart capacity cap. Pre-S3
+     *   server-side capacity gate; distinct from tier-quota
+     *   rejections (`upload_size_exceeds_tier`).
+     *
+     * @type {string}
+     * @memberof AuthErrorResponse
+     */
+    error: string;
+    /**
+     * Human-readable error message, localised per the
+     * request's `Accept-Language` header (fallback locale
+     * `en-GB`). The response carries `Content-Language:
+     * <locale>` + `Vary: Accept-Language` headers. **Never
+     * parse this field for control flow** — it changes per
+     * locale.
+     *
+     * @type {string}
+     * @memberof AuthErrorResponse
+     */
+    message?: string;
+    /**
+     * Stable canonical lookup key for the message (e.g.
+     * `error.balance_exhausted.add_credits`,
+     * `error.upload_size_exceeds_tier`). Never localised. SDK +
+     * frontend translation layers gate on this for client-side
+     * i18n catalogs (per ticket X19, cross-repo SDK companion
+     * work). Stable across server message-prose updates.
+     *
+     * @type {string}
+     * @memberof AuthErrorResponse
+     */
+    messageKey?: string;
+    /**
+     * BCP 47 locale tag echoing the resolved `Content-Language`
+     * response header value (e.g. `en-GB`, `pt-BR`, `ja-JP`).
+     * Lets the SDK confirm which locale the server selected
+     * when the request used q-value negotiation across multiple
+     * `Accept-Language` values.
+     *
+     * @type {string}
+     * @memberof AuthErrorResponse
+     */
+    locale?: string;
+    /**
+     * Optional interpolation values for the localised
+     * `message`. Keys are stable parameter names referenced by
+     * the translation table (e.g.
+     * `{ "filename": "photo.heic", "max_size_mb": 100 }`).
+     * **Excludes cost / monetary numbers** per plan v5 §F11
+     * round-13 narrowing — pricing-related localisation reads
+     * numeric state from `GET /api/v2/credits/balance`, not
+     * from this field. Values are JSON-native scalars
+     * (`string` / `integer` / `number` / `boolean` / `null`)
+     * — no nested objects, to keep translation-table
+     * integration simple.
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof AuthErrorResponse
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {AuthErrorType}
+     * @memberof AuthErrorResponse
+     */
+    errorType: AuthErrorType;
+}
+/**
+ * @export
+ */
+export declare const AuthErrorResponseSuccessEnum: {
+    readonly false: false;
+};
+export type AuthErrorResponseSuccessEnum = typeof AuthErrorResponseSuccessEnum[keyof typeof AuthErrorResponseSuccessEnum];
+/**
+ * Check if a given object implements the AuthErrorResponse interface.
+ */
+export declare function instanceOfAuthErrorResponse(value: object): value is AuthErrorResponse;
+export declare function AuthErrorResponseFromJSON(json: any): AuthErrorResponse;
+export declare function AuthErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthErrorResponse;
+export declare function AuthErrorResponseToJSON(json: any): AuthErrorResponse;
+export declare function AuthErrorResponseToJSONTyped(value?: AuthErrorResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/AuthErrorResponse.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AuthErrorTypeFromJSON, AuthErrorTypeToJSON, } from './AuthErrorType.js';
+/**
+ * @export
+ */
+export const AuthErrorResponseSuccessEnum = {
+    false: false
+};
+/**
+ * Check if a given object implements the AuthErrorResponse interface.
+ */
+export function instanceOfAuthErrorResponse(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    if (!('errorType' in value) || value['errorType'] === undefined)
+        return false;
+    return true;
+}
+export function AuthErrorResponseFromJSON(json) {
+    return AuthErrorResponseFromJSONTyped(json, false);
+}
+export function AuthErrorResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'error': json['error'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'messageKey': json['message_key'] == null ? undefined : json['message_key'],
+        'locale': json['locale'] == null ? undefined : json['locale'],
+        'messageParams': json['message_params'] == null ? undefined : json['message_params'],
+        'errorType': AuthErrorTypeFromJSON(json['error_type']),
+    };
+}
+export function AuthErrorResponseToJSON(json) {
+    return AuthErrorResponseToJSONTyped(json, false);
+}
+export function AuthErrorResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'error': value['error'],
+        'message': value['message'],
+        'message_key': value['messageKey'],
+        'locale': value['locale'],
+        'message_params': value['messageParams'],
+        'error_type': AuthErrorTypeToJSON(value['errorType']),
+    };
+}

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

@@ -0,0 +1,73 @@
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Machine-readable discriminator for auth HTTP errors (401/403). Distinct
+ * from rate-limit 429 responses, which carry no `error_type` and use the
+ * plain `ErrorEnvelope` with a `Retry-After` header.
+ *
+ * Values are emitted by three auth mechanisms on the server:
+ *
+ * - **Login** (`POST /api/auth/login`) — password-based authentication.
+ * - **`ApiEntryPoint`** — challenge emitted on any protected route
+ *   when no authenticated principal is present.
+ * - **`ApiKeyAuthenticator`** — validates `Authorization: Bearer <key>`
+ *   headers on the `api` firewall.
+ *
+ * Per-value attribution:
+ *
+ * - `invalid_credentials` (Login): wrong password, OR correct password on
+ *   an unverified account. The two cases are intentionally collapsed to
+ *   avoid leaking account existence on the machine-readable channel;
+ *   this keeps the login path consistent with the backend's registration
+ *   and password-reset flows, both of which are also anti-enumeration
+ *   (no existence leak on duplicate email or unknown account).
+ * - `account_locked` (Login OR `ApiKeyAuthenticator`): account is in a
+ *   persisted locked state (e.g. set after repeated failures on the
+ *   server side). Can occur on both mechanisms when the underlying
+ *   account is locked, regardless of credential validity.
+ * - `account_disabled` (Login OR `ApiKeyAuthenticator`): account has been
+ *   disabled by an administrator.
+ * - `account_deleted` (Login OR `ApiKeyAuthenticator`): account has been
+ *   deleted.
+ * - `account_deletion_expired` (Login OR `ApiKeyAuthenticator`): grace
+ *   period expired after a user-initiated deletion request.
+ * - `authentication_required` (`ApiEntryPoint`): unauthenticated
+ *   request reached an endpoint that requires authentication.
+ *   Emitted as a 401 challenge; no credentials were presented or
+ *   the session is absent/expired. (Endpoint-level auth requirements
+ *   are not declared in this spec yet — tracked as a separate
+ *   housekeeping item to wire `security` requirements per route.)
+ * - `api_key_invalid` (`ApiKeyAuthenticator`): API key not found, or the
+ *   key resolves to a user that does not exist. The two cases are
+ *   intentionally collapsed for anti-enumeration (same reasoning as
+ *   `invalid_credentials`).
+ * - `api_key_revoked` (`ApiKeyAuthenticator`): API key was found but is
+ *   no longer active (`isActive() === false`).
+ *
+ * @export
+ */
+export declare const AuthErrorType: {
+    readonly invalid_credentials: "invalid_credentials";
+    readonly account_locked: "account_locked";
+    readonly account_disabled: "account_disabled";
+    readonly account_deleted: "account_deleted";
+    readonly account_deletion_expired: "account_deletion_expired";
+    readonly authentication_required: "authentication_required";
+    readonly api_key_invalid: "api_key_invalid";
+    readonly api_key_revoked: "api_key_revoked";
+};
+export type AuthErrorType = typeof AuthErrorType[keyof typeof AuthErrorType];
+export declare function instanceOfAuthErrorType(value: any): boolean;
+export declare function AuthErrorTypeFromJSON(json: any): AuthErrorType;
+export declare function AuthErrorTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthErrorType;
+export declare function AuthErrorTypeToJSON(value?: AuthErrorType | null): any;
+export declare function AuthErrorTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): AuthErrorType;

package/dist/openapi/models/AuthErrorType.js

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Machine-readable discriminator for auth HTTP errors (401/403). Distinct
+ * from rate-limit 429 responses, which carry no `error_type` and use the
+ * plain `ErrorEnvelope` with a `Retry-After` header.
+ *
+ * Values are emitted by three auth mechanisms on the server:
+ *
+ * - **Login** (`POST /api/auth/login`) — password-based authentication.
+ * - **`ApiEntryPoint`** — challenge emitted on any protected route
+ *   when no authenticated principal is present.
+ * - **`ApiKeyAuthenticator`** — validates `Authorization: Bearer <key>`
+ *   headers on the `api` firewall.
+ *
+ * Per-value attribution:
+ *
+ * - `invalid_credentials` (Login): wrong password, OR correct password on
+ *   an unverified account. The two cases are intentionally collapsed to
+ *   avoid leaking account existence on the machine-readable channel;
+ *   this keeps the login path consistent with the backend's registration
+ *   and password-reset flows, both of which are also anti-enumeration
+ *   (no existence leak on duplicate email or unknown account).
+ * - `account_locked` (Login OR `ApiKeyAuthenticator`): account is in a
+ *   persisted locked state (e.g. set after repeated failures on the
+ *   server side). Can occur on both mechanisms when the underlying
+ *   account is locked, regardless of credential validity.
+ * - `account_disabled` (Login OR `ApiKeyAuthenticator`): account has been
+ *   disabled by an administrator.
+ * - `account_deleted` (Login OR `ApiKeyAuthenticator`): account has been
+ *   deleted.
+ * - `account_deletion_expired` (Login OR `ApiKeyAuthenticator`): grace
+ *   period expired after a user-initiated deletion request.
+ * - `authentication_required` (`ApiEntryPoint`): unauthenticated
+ *   request reached an endpoint that requires authentication.
+ *   Emitted as a 401 challenge; no credentials were presented or
+ *   the session is absent/expired. (Endpoint-level auth requirements
+ *   are not declared in this spec yet — tracked as a separate
+ *   housekeeping item to wire `security` requirements per route.)
+ * - `api_key_invalid` (`ApiKeyAuthenticator`): API key not found, or the
+ *   key resolves to a user that does not exist. The two cases are
+ *   intentionally collapsed for anti-enumeration (same reasoning as
+ *   `invalid_credentials`).
+ * - `api_key_revoked` (`ApiKeyAuthenticator`): API key was found but is
+ *   no longer active (`isActive() === false`).
+ *
+ * @export
+ */
+export const AuthErrorType = {
+    invalid_credentials: 'invalid_credentials',
+    account_locked: 'account_locked',
+    account_disabled: 'account_disabled',
+    account_deleted: 'account_deleted',
+    account_deletion_expired: 'account_deletion_expired',
+    authentication_required: 'authentication_required',
+    api_key_invalid: 'api_key_invalid',
+    api_key_revoked: 'api_key_revoked'
+};
+export function instanceOfAuthErrorType(value) {
+    for (const key in AuthErrorType) {
+        if (Object.prototype.hasOwnProperty.call(AuthErrorType, key)) {
+            if (AuthErrorType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function AuthErrorTypeFromJSON(json) {
+    return AuthErrorTypeFromJSONTyped(json, false);
+}
+export function AuthErrorTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function AuthErrorTypeToJSON(value) {
+    return value;
+}
+export function AuthErrorTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,43 @@
+/**
+ * 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/Last-Modified 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.  - **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. - **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). - **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.12.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Availability level for an operation, mime_group, option, or
+ * per-enum-value entry per ADR-0001 §1.3. Used as the value of
+ * decorative `x-availability` extensions in this spec, and as the
+ * typed schema referenced by the runtime capability endpoint
+ * (`GET /api/operations/schema`, ticket I3) and the sidecar
+ * `availability.json` (ticket I3b).
+ *
+ * Per ADR-0001 §1.4: when `availability` is absent on a schema
+ * entry, the implicit value is `stable` for SDK / client / external
+ * consumers. `stable_pending_audit` is internal CI / audit
+ * accounting only and never surfaces to consumers.
+ *
+ * See `schemas/FORMAT.md` §Availability Taxonomy and
+ * `docs/decisions/0001-contract-first-availability.md` for the full
+ * rules, vocabulary rationale, and parser obligations.
+ *
+ * @export
+ */
+export declare const AvailabilityValue: {
+    readonly stable: "stable";
+    readonly beta: "beta";
+    readonly experimental: "experimental";
+    readonly planned: "planned";
+    readonly deprecated: "deprecated";
+};
+export type AvailabilityValue = typeof AvailabilityValue[keyof typeof AvailabilityValue];
+export declare function instanceOfAvailabilityValue(value: any): boolean;
+export declare function AvailabilityValueFromJSON(json: any): AvailabilityValue;
+export declare function AvailabilityValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): AvailabilityValue;
+export declare function AvailabilityValueToJSON(value?: AvailabilityValue | null): any;
+export declare function AvailabilityValueToJSONTyped(value: any, ignoreDiscriminator: boolean): AvailabilityValue;