@giveitsmaller/contracts 0.2.0 → 0.3.0

package/dist/openapi/models/ExternalSource.js

@@ -0,0 +1,47 @@
+/* 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.7.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ConnectionSourceFromJSONTyped, ConnectionSourceToJSON, } from './ConnectionSource.js';
+import { ExternalImportTokenFromJSONTyped, ExternalImportTokenToJSON, } from './ExternalImportToken.js';
+export function ExternalSourceFromJSON(json) {
+    return ExternalSourceFromJSONTyped(json, false);
+}
+export function ExternalSourceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    switch (json['type']) {
+        case 'connection':
+            return Object.assign({}, ConnectionSourceFromJSONTyped(json, true), { type: 'connection' });
+        case 'external_import':
+            return Object.assign({}, ExternalImportTokenFromJSONTyped(json, true), { type: 'external_import' });
+        default:
+            return json;
+    }
+}
+export function ExternalSourceToJSON(json) {
+    return ExternalSourceToJSONTyped(json, false);
+}
+export function ExternalSourceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    switch (value['type']) {
+        case 'connection':
+            return Object.assign({}, ConnectionSourceToJSON(value), { type: 'connection' });
+        case 'external_import':
+            return Object.assign({}, ExternalImportTokenToJSON(value), { type: 'external_import' });
+        default:
+            return value;
+    }
+}

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

@@ -0,0 +1,140 @@
+/**
+ * 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
+ *
+ *
+ * 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 { FeatureViolation } from './FeatureViolation.js';
+/**
+ * 422 response body when a workflow references one or more features
+ * whose availability is not `stable` (i.e. `planned`,
+ * `experimental`, or `beta` not enabled for this caller).
+ *
+ * Per ADR-0001 §1.3 Tension 1 rule, the server MUST honour tagged
+ * availability and MUST NOT silently reject spec-valid features
+ * with a generic schema error. This envelope is the structured
+ * rejection.
+ *
+ * The 422 response is delivered alongside `ValidationErrorEnvelope`
+ * via `oneOf + discriminator` on `error_type` — see the 422
+ * response on `POST /api/workflows`.
+ *
+ * @export
+ * @interface FeatureNotAvailableResponse
+ */
+export interface FeatureNotAvailableResponse {
+    /**
+     *
+     * @type {FeatureNotAvailableResponseSuccessEnum}
+     * @memberof FeatureNotAvailableResponse
+     */
+    success: FeatureNotAvailableResponseSuccessEnum;
+    /**
+     * 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.
+     *
+     * @type {string}
+     * @memberof FeatureNotAvailableResponse
+     */
+    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 FeatureNotAvailableResponse
+     */
+    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 FeatureNotAvailableResponse
+     */
+    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 FeatureNotAvailableResponse
+     */
+    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 FeatureNotAvailableResponse
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+    /**
+     * Discriminator for the 422 oneOf. Always `feature_not_available`.
+     * @type {FeatureNotAvailableResponseErrorTypeEnum}
+     * @memberof FeatureNotAvailableResponse
+     */
+    errorType: FeatureNotAvailableResponseErrorTypeEnum;
+    /**
+     * One entry per unavailable feature referenced by the
+     * request. Per ADR-0001 §F6 batched-violations rule,
+     * multiple violations in a single request are ALL returned
+     * here (fail-all, not fail-fast).
+     *
+     * @type {Array<FeatureViolation>}
+     * @memberof FeatureNotAvailableResponse
+     */
+    violations: Array<FeatureViolation>;
+}
+/**
+ * @export
+ */
+export declare const FeatureNotAvailableResponseSuccessEnum: {
+    readonly false: false;
+};
+export type FeatureNotAvailableResponseSuccessEnum = typeof FeatureNotAvailableResponseSuccessEnum[keyof typeof FeatureNotAvailableResponseSuccessEnum];
+/**
+ * @export
+ */
+export declare const FeatureNotAvailableResponseErrorTypeEnum: {
+    readonly feature_not_available: "feature_not_available";
+};
+export type FeatureNotAvailableResponseErrorTypeEnum = typeof FeatureNotAvailableResponseErrorTypeEnum[keyof typeof FeatureNotAvailableResponseErrorTypeEnum];
+/**
+ * Check if a given object implements the FeatureNotAvailableResponse interface.
+ */
+export declare function instanceOfFeatureNotAvailableResponse(value: object): value is FeatureNotAvailableResponse;
+export declare function FeatureNotAvailableResponseFromJSON(json: any): FeatureNotAvailableResponse;
+export declare function FeatureNotAvailableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureNotAvailableResponse;
+export declare function FeatureNotAvailableResponseToJSON(json: any): FeatureNotAvailableResponse;
+export declare function FeatureNotAvailableResponseToJSONTyped(value?: FeatureNotAvailableResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/FeatureNotAvailableResponse.js

@@ -0,0 +1,76 @@
+/* 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.7.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeatureViolationFromJSON, FeatureViolationToJSON, } from './FeatureViolation.js';
+/**
+ * @export
+ */
+export const FeatureNotAvailableResponseSuccessEnum = {
+    false: false
+};
+/**
+ * @export
+ */
+export const FeatureNotAvailableResponseErrorTypeEnum = {
+    feature_not_available: 'feature_not_available'
+};
+/**
+ * Check if a given object implements the FeatureNotAvailableResponse interface.
+ */
+export function instanceOfFeatureNotAvailableResponse(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 (!('violations' in value) || value['violations'] === undefined)
+        return false;
+    return true;
+}
+export function FeatureNotAvailableResponseFromJSON(json) {
+    return FeatureNotAvailableResponseFromJSONTyped(json, false);
+}
+export function FeatureNotAvailableResponseFromJSONTyped(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'],
+        'violations': (json['violations'].map(FeatureViolationFromJSON)),
+    };
+}
+export function FeatureNotAvailableResponseToJSON(json) {
+    return FeatureNotAvailableResponseToJSONTyped(json, false);
+}
+export function FeatureNotAvailableResponseToJSONTyped(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'],
+        'violations': (value['violations'].map(FeatureViolationToJSON)),
+    };
+}

package/dist/openapi/models/FeatureTierRestrictedResponse.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.7.1
+ *
+ *
+ * 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 { FeatureViolation } from './FeatureViolation.js';
+/**
+ * 403 response body when a workflow references one or more features
+ * gated by a higher subscription tier than the caller has.
+ *
+ * Distinct from `TierRestrictionResponse` (also 403): this envelope
+ * is per-feature granularity (operation / mime_group / option /
+ * per_value); `TierRestrictionResponse` is request-level (file size
+ * or MIME). The two envelopes are discriminated by `error_type` at
+ * the response `oneOf` level.
+ *
+ * @export
+ * @interface FeatureTierRestrictedResponse
+ */
+export interface FeatureTierRestrictedResponse {
+    /**
+     *
+     * @type {FeatureTierRestrictedResponseSuccessEnum}
+     * @memberof FeatureTierRestrictedResponse
+     */
+    success: FeatureTierRestrictedResponseSuccessEnum;
+    /**
+     * 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.
+     *
+     * @type {string}
+     * @memberof FeatureTierRestrictedResponse
+     */
+    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 FeatureTierRestrictedResponse
+     */
+    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 FeatureTierRestrictedResponse
+     */
+    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 FeatureTierRestrictedResponse
+     */
+    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 FeatureTierRestrictedResponse
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+    /**
+     * Discriminator for the 403 oneOf. Always `feature_tier_restricted`.
+     * @type {FeatureTierRestrictedResponseErrorTypeEnum}
+     * @memberof FeatureTierRestrictedResponse
+     */
+    errorType: FeatureTierRestrictedResponseErrorTypeEnum;
+    /**
+     * One entry per tier-gated feature. Each `FeatureViolation`
+     * MUST set `required_tier` to the tier that would satisfy
+     * the request.
+     *
+     * @type {Array<FeatureViolation>}
+     * @memberof FeatureTierRestrictedResponse
+     */
+    violations: Array<FeatureViolation>;
+}
+/**
+ * @export
+ */
+export declare const FeatureTierRestrictedResponseSuccessEnum: {
+    readonly false: false;
+};
+export type FeatureTierRestrictedResponseSuccessEnum = typeof FeatureTierRestrictedResponseSuccessEnum[keyof typeof FeatureTierRestrictedResponseSuccessEnum];
+/**
+ * @export
+ */
+export declare const FeatureTierRestrictedResponseErrorTypeEnum: {
+    readonly feature_tier_restricted: "feature_tier_restricted";
+};
+export type FeatureTierRestrictedResponseErrorTypeEnum = typeof FeatureTierRestrictedResponseErrorTypeEnum[keyof typeof FeatureTierRestrictedResponseErrorTypeEnum];
+/**
+ * Check if a given object implements the FeatureTierRestrictedResponse interface.
+ */
+export declare function instanceOfFeatureTierRestrictedResponse(value: object): value is FeatureTierRestrictedResponse;
+export declare function FeatureTierRestrictedResponseFromJSON(json: any): FeatureTierRestrictedResponse;
+export declare function FeatureTierRestrictedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureTierRestrictedResponse;
+export declare function FeatureTierRestrictedResponseToJSON(json: any): FeatureTierRestrictedResponse;
+export declare function FeatureTierRestrictedResponseToJSONTyped(value?: FeatureTierRestrictedResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/FeatureTierRestrictedResponse.js

@@ -0,0 +1,76 @@
+/* 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.7.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FeatureViolationFromJSON, FeatureViolationToJSON, } from './FeatureViolation.js';
+/**
+ * @export
+ */
+export const FeatureTierRestrictedResponseSuccessEnum = {
+    false: false
+};
+/**
+ * @export
+ */
+export const FeatureTierRestrictedResponseErrorTypeEnum = {
+    feature_tier_restricted: 'feature_tier_restricted'
+};
+/**
+ * Check if a given object implements the FeatureTierRestrictedResponse interface.
+ */
+export function instanceOfFeatureTierRestrictedResponse(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 (!('violations' in value) || value['violations'] === undefined)
+        return false;
+    return true;
+}
+export function FeatureTierRestrictedResponseFromJSON(json) {
+    return FeatureTierRestrictedResponseFromJSONTyped(json, false);
+}
+export function FeatureTierRestrictedResponseFromJSONTyped(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'],
+        'violations': (json['violations'].map(FeatureViolationFromJSON)),
+    };
+}
+export function FeatureTierRestrictedResponseToJSON(json) {
+    return FeatureTierRestrictedResponseToJSONTyped(json, false);
+}
+export function FeatureTierRestrictedResponseToJSONTyped(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'],
+        'violations': (value['violations'].map(FeatureViolationToJSON)),
+    };
+}

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

@@ -0,0 +1,108 @@
+/**
+ * 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
+ *
+ *
+ * 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 { AvailabilityValue } from './AvailabilityValue.js';
+/**
+ * Single feature violation. One or more of these are returned in
+ * `FeatureNotAvailableResponse.violations[]` (422) and
+ * `FeatureTierRestrictedResponse.violations[]` (403).
+ *
+ * `feature` is a dotted-path identifier of the unavailable schema
+ * entry (e.g. `operation.image_watermark`,
+ * `operation.compress.option.codec.av1`,
+ * `operation.merge.mime_group.image.option.transition.dissolve`).
+ * Granularity matches the schema entry that was rejected
+ * (operation / mime_group / option / per_value).
+ *
+ * @export
+ * @interface FeatureViolation
+ */
+export interface FeatureViolation {
+    /**
+     * Dotted-path identifier of the rejected schema entry.
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    feature: string;
+    /**
+     *
+     * @type {AvailabilityValue}
+     * @memberof FeatureViolation
+     */
+    availability: AvailabilityValue;
+    /**
+     * Optional ISO-8601 date or quarter (`2026-Q3`) when the feature
+     * is expected to ship. Only meaningful for
+     * `availability: planned`. May be omitted when no ETA is
+     * committed.
+     *
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    eta?: string;
+    /**
+     *
+     * @type {UserTier}
+     * @memberof FeatureViolation
+     */
+    requiredTier?: UserTier | null;
+    /**
+     * Optional link to feature documentation.
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    documentationUrl?: string;
+    /**
+     * Canonical lookup key per ticket
+     * [I26](https://trello.com/c/rcnqwgI4). See
+     * `ErrorEnvelope.message_key`.
+     *
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    messageKey?: string;
+    /**
+     * Human-readable, optionally localised explanation. See
+     * `ErrorEnvelope.message`. Never parse for control flow.
+     *
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    message?: string;
+    /**
+     * BCP 47 locale tag. See `ErrorEnvelope.locale`.
+     * @type {string}
+     * @memberof FeatureViolation
+     */
+    locale?: string;
+    /**
+     * Optional interpolation values for the localised
+     * `message` (e.g.
+     * `{ "feature": "audio_overlay", "eta": "2026-Q3" }`).
+     * See `ErrorEnvelope.message_params`. Excludes cost
+     * numbers.
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof FeatureViolation
+     */
+    messageParams?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the FeatureViolation interface.
+ */
+export declare function instanceOfFeatureViolation(value: object): value is FeatureViolation;
+export declare function FeatureViolationFromJSON(json: any): FeatureViolation;
+export declare function FeatureViolationFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureViolation;
+export declare function FeatureViolationToJSON(json: any): FeatureViolation;
+export declare function FeatureViolationToJSONTyped(value?: FeatureViolation | null, ignoreDiscriminator?: boolean): any;