@giveitsmaller/contracts 0.3.0 → 0.5.0

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

@@ -0,0 +1,171 @@
+/**
+ * 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.15.3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 422 response on `POST /api/workflows` when the probe-pending
+ * gate (API `av1J0rEF`, shipped behind a default-OFF feature flag)
+ * is enabled and a job references an upload whose server-side
+ * probe has not yet completed at workflow-create time. Rather than
+ * silently routing the job as `short_form` (which hard-fails long
+ * video clips), the server rejects with this envelope so the
+ * client can recover deterministically.
+ *
+ * **Recovery contract.** Poll `POST /api/uploads/{id}/probe` for
+ * the pending upload until its `probe_status` is terminal
+ * (`ok` → re-`POST /api/workflows` the same request; `corrupt` /
+ * `unsupported_codec` → surface the probe error, do not retry).
+ * The `Retry-After` response header (when present) carries the
+ * suggested delay in seconds before the next poll/retry.
+ *
+ * Delivered alongside `ValidationErrorEnvelope`,
+ * `FeatureNotAvailableResponse`, and
+ * `ProcessingClassExceedsBandResponse` via the naked `oneOf` on
+ * the 422 response — duck-typed on required-field shape: this
+ * branch is the only one carrying `error_type: probe_pending`
+ * and it has neither `details` (ValidationErrorEnvelope) nor
+ * `violations` (the other two typed envelopes), so it matches
+ * exactly one branch.
+ *
+ * @export
+ * @interface ProbePendingResponse
+ */
+export interface ProbePendingResponse {
+    /**
+     *
+     * @type {ProbePendingResponseSuccessEnum}
+     * @memberof ProbePendingResponse
+     */
+    success: ProbePendingResponseSuccessEnum;
+    /**
+     * 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 ProbePendingResponse
+     */
+    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 ProbePendingResponse
+     */
+    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 ProbePendingResponse
+     */
+    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 ProbePendingResponse
+     */
+    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 ProbePendingResponse
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+    /**
+     * Discriminator for the 422 oneOf. Always `probe_pending`.
+     * @type {ProbePendingResponseErrorTypeEnum}
+     * @memberof ProbePendingResponse
+     */
+    errorType: ProbePendingResponseErrorTypeEnum;
+    /**
+     * Workflow-local identifier of the job whose upload-probe
+     * has not landed — `JobDefinition.id` if the caller
+     * supplied one, else the auto-generated `job_N` token.
+     * Mirrors `ProcessingClassBandViolation.job_ref`; NOT
+     * `format: uuid` because workflow-create rejects fire
+     * before server-side UUIDs are assigned.
+     *
+     * @type {string}
+     * @memberof ProbePendingResponse
+     */
+    jobRef: string;
+}
+/**
+ * @export
+ */
+export declare const ProbePendingResponseSuccessEnum: {
+    readonly false: false;
+};
+export type ProbePendingResponseSuccessEnum = typeof ProbePendingResponseSuccessEnum[keyof typeof ProbePendingResponseSuccessEnum];
+/**
+ * @export
+ */
+export declare const ProbePendingResponseErrorTypeEnum: {
+    readonly probe_pending: "probe_pending";
+};
+export type ProbePendingResponseErrorTypeEnum = typeof ProbePendingResponseErrorTypeEnum[keyof typeof ProbePendingResponseErrorTypeEnum];
+/**
+ * Check if a given object implements the ProbePendingResponse interface.
+ */
+export declare function instanceOfProbePendingResponse(value: object): value is ProbePendingResponse;
+export declare function ProbePendingResponseFromJSON(json: any): ProbePendingResponse;
+export declare function ProbePendingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProbePendingResponse;
+export declare function ProbePendingResponseToJSON(json: any): ProbePendingResponse;
+export declare function ProbePendingResponseToJSONTyped(value?: ProbePendingResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/ProbePendingResponse.js

@@ -0,0 +1,75 @@
+/* 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.15.3
+ *
+ *
+ * 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 ProbePendingResponseSuccessEnum = {
+    false: false
+};
+/**
+ * @export
+ */
+export const ProbePendingResponseErrorTypeEnum = {
+    probe_pending: 'probe_pending'
+};
+/**
+ * Check if a given object implements the ProbePendingResponse interface.
+ */
+export function instanceOfProbePendingResponse(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;
+    if (!('jobRef' in value) || value['jobRef'] === undefined)
+        return false;
+    return true;
+}
+export function ProbePendingResponseFromJSON(json) {
+    return ProbePendingResponseFromJSONTyped(json, false);
+}
+export function ProbePendingResponseFromJSONTyped(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': json['error_type'],
+        'jobRef': json['job_ref'],
+    };
+}
+export function ProbePendingResponseToJSON(json) {
+    return ProbePendingResponseToJSONTyped(json, false);
+}
+export function ProbePendingResponseToJSONTyped(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': value['errorType'],
+        'job_ref': value['jobRef'],
+    };
+}

package/dist/openapi/models/ProcessingClass.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/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.7.1
+ * The version of the OpenAPI document: 2.15.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/ProcessingClass.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/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.7.1
+ * The version of the OpenAPI document: 2.15.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -0,0 +1,149 @@
+/**
+ * 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.15.3
+ *
+ *
+ * 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 { UserTier } from './UserTier.js';
+import type { ProcessingClass } from './ProcessingClass.js';
+import type { OperationType } from './OperationType.js';
+import type { ProcessingClassRejectReason } from './ProcessingClassRejectReason.js';
+/**
+ * One band-ceiling overflow on a workflow-create reject. Carries
+ * the I26 localisation quad on the violation (mirrors
+ * `FeatureViolation`); envelope-level localisation rides via
+ * `allOf [ErrorEnvelope]` on `ProcessingClassExceedsBandResponse`.
+ *
+ * `job_ref`, `actual`, `ceiling`, `operation`, and
+ * `processing_class` are REQUIRED — the server always knows them
+ * at reject time and consumers rely on them to (a) correlate
+ * fail-all violations back to the offending job in multi-job
+ * workflows and (b) render "X exceeded by Y" without re-deriving
+ * caps from the per-tier overlay.
+ *
+ * @export
+ * @interface ProcessingClassBandViolation
+ */
+export interface ProcessingClassBandViolation {
+    /**
+     *
+     * @type {ProcessingClassRejectReason}
+     * @memberof ProcessingClassBandViolation
+     */
+    reason: ProcessingClassRejectReason;
+    /**
+     * Workflow-local job identifier — `JobDefinition.id` if the
+     * caller supplied one, otherwise the auto-generated `job_N`
+     * positional token assigned by the server during request
+     * validation (e.g. `job_0`, `job_1`). Workflow-create rejects
+     * fire BEFORE persisted server UUIDs are assigned; `job_ref`
+     * is the request-local handle that survives across reject
+     * and (later) success paths. Per `JobDefinition.id` pattern
+     * + auto-generation rules.
+     *
+     * @type {string}
+     * @memberof ProcessingClassBandViolation
+     */
+    jobRef: string;
+    /**
+     * 0-based ordinal into `JobDefinition.inputs[]` identifying
+     * the specific input that violated the per-input ceiling.
+     * Set ONLY on `input_*_exceeds_long_form` reasons for
+     * multi-input operations; omitted on single-input
+     * operations (no positional ambiguity) and on
+     * `combined_*_exceeds_long_form` reasons (whole-job
+     * violation across all inputs).
+     *
+     * @type {number}
+     * @memberof ProcessingClassBandViolation
+     */
+    inputIndex?: number;
+    /**
+     * Operation type that triggered the band-ceiling reject.
+     * @type {OperationType}
+     * @memberof ProcessingClassBandViolation
+     */
+    operation: OperationType;
+    /**
+     * The class whose ceiling was exceeded — typically `long_form`
+     * or `long_form_re_encode`.
+     *
+     * @type {ProcessingClass}
+     * @memberof ProcessingClassBandViolation
+     */
+    processingClass: ProcessingClass;
+    /**
+     * Observed value. Bytes for `*_size_exceeds_long_form`
+     * reasons; whole seconds for `*_duration_exceeds_long_form`
+     * reasons.
+     *
+     * @type {number}
+     * @memberof ProcessingClassBandViolation
+     */
+    actual: number;
+    /**
+     * Effective per-tier ceiling for this caller (same units as
+     * `actual`). The binding cap after `per_tier_constraints`
+     * overlay; lets consumers render "X exceeded by Y" without
+     * re-deriving caps from the per-tier overlay.
+     *
+     * @type {number}
+     * @memberof ProcessingClassBandViolation
+     */
+    ceiling: number;
+    /**
+     *
+     * @type {UserTier}
+     * @memberof ProcessingClassBandViolation
+     */
+    requiredTier?: UserTier | null;
+    /**
+     * Optional link to processing-class documentation.
+     * @type {string}
+     * @memberof ProcessingClassBandViolation
+     */
+    documentationUrl?: string;
+    /**
+     * Per I26. See `ErrorEnvelope.message_key`.
+     * @type {string}
+     * @memberof ProcessingClassBandViolation
+     */
+    messageKey?: string;
+    /**
+     * Per I26. Human-readable, localised per `Accept-Language`.
+     * Never parse for control flow.
+     *
+     * @type {string}
+     * @memberof ProcessingClassBandViolation
+     */
+    message?: string;
+    /**
+     * BCP 47 locale tag. See `ErrorEnvelope.locale`.
+     * @type {string}
+     * @memberof ProcessingClassBandViolation
+     */
+    locale?: string;
+    /**
+     * Per I26. Optional interpolation values for the localised
+     * `message`. Excludes cost numbers.
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ProcessingClassBandViolation
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the ProcessingClassBandViolation interface.
+ */
+export declare function instanceOfProcessingClassBandViolation(value: object): value is ProcessingClassBandViolation;
+export declare function ProcessingClassBandViolationFromJSON(json: any): ProcessingClassBandViolation;
+export declare function ProcessingClassBandViolationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProcessingClassBandViolation;
+export declare function ProcessingClassBandViolationToJSON(json: any): ProcessingClassBandViolation;
+export declare function ProcessingClassBandViolationToJSONTyped(value?: ProcessingClassBandViolation | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/ProcessingClassBandViolation.js

@@ -0,0 +1,81 @@
+/* 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.15.3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserTierFromJSON, UserTierToJSON, } from './UserTier.js';
+import { ProcessingClassFromJSON, ProcessingClassToJSON, } from './ProcessingClass.js';
+import { OperationTypeFromJSON, OperationTypeToJSON, } from './OperationType.js';
+import { ProcessingClassRejectReasonFromJSON, ProcessingClassRejectReasonToJSON, } from './ProcessingClassRejectReason.js';
+/**
+ * Check if a given object implements the ProcessingClassBandViolation interface.
+ */
+export function instanceOfProcessingClassBandViolation(value) {
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    if (!('jobRef' in value) || value['jobRef'] === undefined)
+        return false;
+    if (!('operation' in value) || value['operation'] === undefined)
+        return false;
+    if (!('processingClass' in value) || value['processingClass'] === undefined)
+        return false;
+    if (!('actual' in value) || value['actual'] === undefined)
+        return false;
+    if (!('ceiling' in value) || value['ceiling'] === undefined)
+        return false;
+    return true;
+}
+export function ProcessingClassBandViolationFromJSON(json) {
+    return ProcessingClassBandViolationFromJSONTyped(json, false);
+}
+export function ProcessingClassBandViolationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reason': ProcessingClassRejectReasonFromJSON(json['reason']),
+        'jobRef': json['job_ref'],
+        'inputIndex': json['input_index'] == null ? undefined : json['input_index'],
+        'operation': OperationTypeFromJSON(json['operation']),
+        'processingClass': ProcessingClassFromJSON(json['processing_class']),
+        'actual': json['actual'],
+        'ceiling': json['ceiling'],
+        'requiredTier': json['required_tier'] == null ? undefined : UserTierFromJSON(json['required_tier']),
+        'documentationUrl': json['documentation_url'] == null ? undefined : json['documentation_url'],
+        'messageKey': json['message_key'] == null ? undefined : json['message_key'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'locale': json['locale'] == null ? undefined : json['locale'],
+        'messageParams': json['message_params'] == null ? undefined : json['message_params'],
+    };
+}
+export function ProcessingClassBandViolationToJSON(json) {
+    return ProcessingClassBandViolationToJSONTyped(json, false);
+}
+export function ProcessingClassBandViolationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reason': ProcessingClassRejectReasonToJSON(value['reason']),
+        'job_ref': value['jobRef'],
+        'input_index': value['inputIndex'],
+        'operation': OperationTypeToJSON(value['operation']),
+        'processing_class': ProcessingClassToJSON(value['processingClass']),
+        'actual': value['actual'],
+        'ceiling': value['ceiling'],
+        'required_tier': UserTierToJSON(value['requiredTier']),
+        'documentation_url': value['documentationUrl'],
+        'message_key': value['messageKey'],
+        'message': value['message'],
+        'locale': value['locale'],
+        'message_params': value['messageParams'],
+    };
+}