@giveitsmaller/contracts 0.2.3 → 0.3.0

package/dist/asyncapi/AnonymousSchema_13.d.ts

@@ -0,0 +1,6 @@
+declare enum AnonymousSchema_13 {
+    BASE = "base",
+    OVERLAY = "overlay",
+    TRANSITION_MASK = "transition_mask"
+}
+export default AnonymousSchema_13;

package/dist/asyncapi/AnonymousSchema_13.js

@@ -0,0 +1,7 @@
+var AnonymousSchema_13;
+(function (AnonymousSchema_13) {
+    AnonymousSchema_13["BASE"] = "base";
+    AnonymousSchema_13["OVERLAY"] = "overlay";
+    AnonymousSchema_13["TRANSITION_MASK"] = "transition_mask";
+})(AnonymousSchema_13 || (AnonymousSchema_13 = {}));
+export default AnonymousSchema_13;

package/dist/asyncapi/AnonymousSchema_152.d.ts

@@ -0,0 +1,5 @@
+declare enum AnonymousSchema_152 {
+    STREAM_COPY = "stream_copy",
+    RE_ENCODE = "re_encode"
+}
+export default AnonymousSchema_152;

package/dist/asyncapi/AnonymousSchema_152.js

@@ -0,0 +1,6 @@
+var AnonymousSchema_152;
+(function (AnonymousSchema_152) {
+    AnonymousSchema_152["STREAM_COPY"] = "stream_copy";
+    AnonymousSchema_152["RE_ENCODE"] = "re_encode";
+})(AnonymousSchema_152 || (AnonymousSchema_152 = {}));
+export default AnonymousSchema_152;

package/dist/asyncapi/Failure.d.ts

@@ -0,0 +1,25 @@
+import OperationType from './OperationType.js';
+import ResultStatus from './ResultStatus.js';
+import PageIndexed from './PageIndexed.js';
+import PositionIndexed from './PositionIndexed.js';
+import Unindexed from './Unindexed.js';
+import OperationMetrics from './OperationMetrics.js';
+import ErrorCode from './ErrorCode.js';
+interface Failure {
+    'job_id': string;
+    'operation_id': string;
+    'operation_type': OperationType;
+    'status': ResultStatus.COMPLETED;
+    'output_bucket'?: string;
+    'output_key'?: string;
+    'output_size_bytes'?: number;
+    'outputs'?: (PageIndexed | PositionIndexed | Unindexed)[];
+    'total_output_size_bytes'?: number;
+    'metrics'?: OperationMetrics;
+    'error_code': ErrorCode;
+    'error_message': string;
+    'is_retryable': boolean;
+    'last_progress'?: number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default Failure;

package/dist/asyncapi/Failure.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/JobInputRole.d.ts

@@ -0,0 +1,6 @@
+declare enum JobInputRole {
+    BASE = "base",
+    OVERLAY = "overlay",
+    TRANSITION_MASK = "transition_mask"
+}
+export default JobInputRole;

package/dist/asyncapi/JobInputRole.js

@@ -0,0 +1,7 @@
+var JobInputRole;
+(function (JobInputRole) {
+    JobInputRole["BASE"] = "base";
+    JobInputRole["OVERLAY"] = "overlay";
+    JobInputRole["TRANSITION_MASK"] = "transition_mask";
+})(JobInputRole || (JobInputRole = {}));
+export default JobInputRole;

package/dist/asyncapi/MergeOutputType.d.ts

@@ -1,8 +1,6 @@
 declare enum MergeOutputType {
-    RESERVED_IMAGE = "image",
     GIF = "gif",
     VIDEO = "video",
-    AUDIO = "audio",
-    RESERVED_DOCUMENT = "document"
+    AUDIO = "audio"
 }
 export default MergeOutputType;

package/dist/asyncapi/MergeOutputType.js

@@ -1,9 +1,7 @@
 var MergeOutputType;
 (function (MergeOutputType) {
-    MergeOutputType["RESERVED_IMAGE"] = "image";
     MergeOutputType["GIF"] = "gif";
     MergeOutputType["VIDEO"] = "video";
     MergeOutputType["AUDIO"] = "audio";
-    MergeOutputType["RESERVED_DOCUMENT"] = "document";
 })(MergeOutputType || (MergeOutputType = {}));
 export default MergeOutputType;

package/dist/asyncapi/MultiOutputCompletion.d.ts

@@ -0,0 +1,25 @@
+import OperationType from './OperationType.js';
+import ResultStatus from './ResultStatus.js';
+import PageIndexed from './PageIndexed.js';
+import PositionIndexed from './PositionIndexed.js';
+import Unindexed from './Unindexed.js';
+import OperationMetrics from './OperationMetrics.js';
+import ErrorCode from './ErrorCode.js';
+interface MultiOutputCompletion {
+    'job_id': string;
+    'operation_id': string;
+    'operation_type': OperationType;
+    'status': ResultStatus.COMPLETED;
+    'output_bucket': string;
+    'output_key'?: string;
+    'output_size_bytes'?: number;
+    'outputs': (PageIndexed | PositionIndexed | Unindexed)[];
+    'total_output_size_bytes': number;
+    'metrics'?: OperationMetrics;
+    'error_code'?: ErrorCode;
+    'error_message'?: string;
+    'is_retryable'?: boolean;
+    'last_progress'?: number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default MultiOutputCompletion;

package/dist/asyncapi/MultiOutputCompletion.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/NotificationsOperationsQueue.d.ts

@@ -1,4 +1,6 @@
 import OperationProgress from './OperationProgress.js';
-import OperationResult from './OperationResult.js';
-type NotificationsOperationsQueue = OperationProgress | OperationResult;
+import SingleOutputCompletion from './SingleOutputCompletion.js';
+import MultiOutputCompletion from './MultiOutputCompletion.js';
+import Failure from './Failure.js';
+type NotificationsOperationsQueue = OperationProgress | SingleOutputCompletion | MultiOutputCompletion | Failure;
 export default NotificationsOperationsQueue;

package/dist/asyncapi/OperationMetrics.d.ts

@@ -1,3 +1,4 @@
+import ReEncodeDecision from './ReEncodeDecision.js';
 interface OperationMetrics {
     'original_size_bytes'?: number;
     'output_size_bytes'?: number;
@@ -6,6 +7,8 @@ interface OperationMetrics {
     'input_count'?: number;
     'file_count'?: number;
     'total_input_size_bytes'?: number;
+    're_encode_decision'?: ReEncodeDecision;
+    're_encode_reason'?: string;
     'additionalProperties'?: Record<string, any>;
 }
 export default OperationMetrics;

package/dist/asyncapi/OperationProgress.d.ts

@@ -7,6 +7,8 @@ interface OperationProgress {
     'status': ProgressStatus;
     'progress': number;
     'stage'?: string;
+    'phase_input_index'?: number;
+    'phase_total_inputs'?: number;
     'additionalProperties'?: Record<string, any>;
 }
 export default OperationProgress;

package/dist/asyncapi/OperationResult.d.ts

@@ -1,20 +1,5 @@
-import OperationType from './OperationType.js';
-import ResultStatus from './ResultStatus.js';
-import OperationMetrics from './OperationMetrics.js';
-import ErrorCode from './ErrorCode.js';
-interface OperationResult {
-    'job_id': string;
-    'operation_id': string;
-    'operation_type': OperationType;
-    'status': ResultStatus;
-    'output_bucket'?: string;
-    'output_key'?: string;
-    'output_size_bytes'?: number;
-    'metrics'?: OperationMetrics;
-    'error_code'?: ErrorCode;
-    'error_message'?: string;
-    'is_retryable'?: boolean;
-    'last_progress'?: number;
-    'additionalProperties'?: Record<string, any>;
-}
+import SingleOutputCompletion from './SingleOutputCompletion.js';
+import MultiOutputCompletion from './MultiOutputCompletion.js';
+import Failure from './Failure.js';
+type OperationResult = SingleOutputCompletion | MultiOutputCompletion | Failure;
 export default OperationResult;

package/dist/asyncapi/OperationType.d.ts

@@ -1,13 +1,13 @@
 declare enum OperationType {
     COMPRESS = "compress",
     THUMBNAIL = "thumbnail",
-    THUMBNAIL_IMAGE = "thumbnail_image",
-    THUMBNAIL_VIDEO = "thumbnail_video",
-    THUMBNAIL_DOCUMENT = "thumbnail_document",
-    THUMBNAIL_OFFICE = "thumbnail_office",
-    WATERMARK = "watermark",
+    IMAGE_WATERMARK = "image_watermark",
+    TEXT_WATERMARK = "text_watermark",
     CONVERT = "convert",
     MERGE = "merge",
-    ARCHIVE = "archive"
+    ARCHIVE = "archive",
+    CUSTOM_LUMA = "custom_luma",
+    AUDIO_OVERLAY = "audio_overlay",
+    AUDIO_WATERMARK = "audio_watermark"
 }
 export default OperationType;

package/dist/asyncapi/OperationType.js

@@ -2,13 +2,13 @@ var OperationType;
 (function (OperationType) {
     OperationType["COMPRESS"] = "compress";
     OperationType["THUMBNAIL"] = "thumbnail";
-    OperationType["THUMBNAIL_IMAGE"] = "thumbnail_image";
-    OperationType["THUMBNAIL_VIDEO"] = "thumbnail_video";
-    OperationType["THUMBNAIL_DOCUMENT"] = "thumbnail_document";
-    OperationType["THUMBNAIL_OFFICE"] = "thumbnail_office";
-    OperationType["WATERMARK"] = "watermark";
+    OperationType["IMAGE_WATERMARK"] = "image_watermark";
+    OperationType["TEXT_WATERMARK"] = "text_watermark";
     OperationType["CONVERT"] = "convert";
     OperationType["MERGE"] = "merge";
     OperationType["ARCHIVE"] = "archive";
+    OperationType["CUSTOM_LUMA"] = "custom_luma";
+    OperationType["AUDIO_OVERLAY"] = "audio_overlay";
+    OperationType["AUDIO_WATERMARK"] = "audio_watermark";
 })(OperationType || (OperationType = {}));
 export default OperationType;

package/dist/asyncapi/PageIndexed.d.ts

@@ -0,0 +1,8 @@
+interface PageIndexed {
+    'output_key': string;
+    'output_size_bytes': number;
+    'page_index': number;
+    'position'?: number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default PageIndexed;

package/dist/asyncapi/PageIndexed.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/PositionIndexed.d.ts

@@ -0,0 +1,8 @@
+interface PositionIndexed {
+    'output_key': string;
+    'output_size_bytes': number;
+    'page_index'?: number;
+    'position': number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default PositionIndexed;

package/dist/asyncapi/PositionIndexed.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/ProgressStatus.d.ts

@@ -1,7 +1,10 @@
 declare enum ProgressStatus {
     STARTED = "started",
     DOWNLOADING = "downloading",
+    PROBING = "probing",
+    DECODING = "decoding",
     PROCESSING = "processing",
+    ENCODING = "encoding",
     UPLOADING = "uploading"
 }
 export default ProgressStatus;

package/dist/asyncapi/ProgressStatus.js

@@ -2,7 +2,10 @@ var ProgressStatus;
 (function (ProgressStatus) {
     ProgressStatus["STARTED"] = "started";
     ProgressStatus["DOWNLOADING"] = "downloading";
+    ProgressStatus["PROBING"] = "probing";
+    ProgressStatus["DECODING"] = "decoding";
     ProgressStatus["PROCESSING"] = "processing";
+    ProgressStatus["ENCODING"] = "encoding";
     ProgressStatus["UPLOADING"] = "uploading";
 })(ProgressStatus || (ProgressStatus = {}));
 export default ProgressStatus;

package/dist/asyncapi/ReEncodeDecision.d.ts

@@ -0,0 +1,5 @@
+declare enum ReEncodeDecision {
+    STREAM_COPY = "stream_copy",
+    RE_ENCODE = "re_encode"
+}
+export default ReEncodeDecision;

package/dist/asyncapi/ReEncodeDecision.js

@@ -0,0 +1,6 @@
+var ReEncodeDecision;
+(function (ReEncodeDecision) {
+    ReEncodeDecision["STREAM_COPY"] = "stream_copy";
+    ReEncodeDecision["RE_ENCODE"] = "re_encode";
+})(ReEncodeDecision || (ReEncodeDecision = {}));
+export default ReEncodeDecision;

package/dist/asyncapi/SingleOutputCompletion.d.ts

@@ -0,0 +1,25 @@
+import OperationType from './OperationType.js';
+import ResultStatus from './ResultStatus.js';
+import PageIndexed from './PageIndexed.js';
+import PositionIndexed from './PositionIndexed.js';
+import Unindexed from './Unindexed.js';
+import OperationMetrics from './OperationMetrics.js';
+import ErrorCode from './ErrorCode.js';
+interface SingleOutputCompletion {
+    'job_id': string;
+    'operation_id': string;
+    'operation_type': OperationType;
+    'status': ResultStatus.COMPLETED;
+    'output_bucket': string;
+    'output_key': string;
+    'output_size_bytes': number;
+    'outputs'?: (PageIndexed | PositionIndexed | Unindexed)[];
+    'total_output_size_bytes'?: number;
+    'metrics'?: OperationMetrics;
+    'error_code'?: ErrorCode;
+    'error_message'?: string;
+    'is_retryable'?: boolean;
+    'last_progress'?: number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default SingleOutputCompletion;

package/dist/asyncapi/SingleOutputCompletion.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/SourceEntry.d.ts

@@ -1,8 +1,9 @@
+import JobInputRole from './JobInputRole.js';
 interface SourceEntry {
     'bucket': string;
     'key': string;
+    'role'?: JobInputRole;
     'transition'?: string;
-    'page_range'?: string;
     'additionalProperties'?: Record<string, any>;
 }
 export default SourceEntry;

package/dist/asyncapi/Unindexed.d.ts

@@ -0,0 +1,8 @@
+interface Unindexed {
+    'output_key': string;
+    'output_size_bytes': number;
+    'page_index'?: number;
+    'position'?: number;
+    'additionalProperties'?: Record<string, any>;
+}
+export default Unindexed;

package/dist/asyncapi/Unindexed.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/UploadProbeCompletion.d.ts

@@ -0,0 +1,16 @@
+import UploadProbeStatus from './UploadProbeStatus.js';
+import UploadProbeProcessingClass from './UploadProbeProcessingClass.js';
+import UploadProbeMediaMetadata from './UploadProbeMediaMetadata.js';
+interface UploadProbeCompletion {
+    'file_id': string;
+    'idempotency_key': string;
+    'probe_status'?: UploadProbeStatus;
+    'processing_class_pre_assignment'?: UploadProbeProcessingClass;
+    'media_metadata'?: UploadProbeMediaMetadata;
+    'error_code'?: string;
+    'error_message'?: string;
+    'probed_at': string;
+    'probe_version': string;
+    'additionalProperties'?: Record<string, any>;
+}
+export default UploadProbeCompletion;

package/dist/asyncapi/UploadProbeCompletion.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/UploadProbeMediaMetadata.d.ts

@@ -0,0 +1,18 @@
+interface UploadProbeMediaMetadata {
+    'duration_seconds'?: number;
+    'width'?: number;
+    'height'?: number;
+    'codec'?: string;
+    'audio_codec'?: string;
+    'container'?: string;
+    'fps'?: number;
+    'bitrate_bps'?: number;
+    'audio_layout'?: string;
+    'channels'?: number;
+    'sample_rate_hz'?: number;
+    'page_count'?: number;
+    'dpi'?: number;
+    'probed_at': string;
+    'additionalProperties'?: Record<string, any>;
+}
+export default UploadProbeMediaMetadata;

package/dist/asyncapi/UploadProbeMediaMetadata.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/UploadProbeProcessingClass.d.ts

@@ -0,0 +1,6 @@
+declare enum UploadProbeProcessingClass {
+    SHORT_FORM = "short_form",
+    LONG_FORM = "long_form",
+    BLOCKED = "blocked"
+}
+export default UploadProbeProcessingClass;

package/dist/asyncapi/UploadProbeProcessingClass.js

@@ -0,0 +1,7 @@
+var UploadProbeProcessingClass;
+(function (UploadProbeProcessingClass) {
+    UploadProbeProcessingClass["SHORT_FORM"] = "short_form";
+    UploadProbeProcessingClass["LONG_FORM"] = "long_form";
+    UploadProbeProcessingClass["BLOCKED"] = "blocked";
+})(UploadProbeProcessingClass || (UploadProbeProcessingClass = {}));
+export default UploadProbeProcessingClass;

package/dist/asyncapi/UploadProbeRequest.d.ts

@@ -0,0 +1,10 @@
+interface UploadProbeRequest {
+    'file_id': string;
+    'source_bucket': string;
+    'source_key': string;
+    'file_type': string;
+    'idempotency_key': string;
+    'requested_at'?: string;
+    'additionalProperties'?: Record<string, any>;
+}
+export default UploadProbeRequest;

package/dist/asyncapi/UploadProbeRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/asyncapi/UploadProbeStatus.d.ts

@@ -0,0 +1,7 @@
+declare enum UploadProbeStatus {
+    OK = "ok",
+    CORRUPT = "corrupt",
+    UNSUPPORTED_CODEC = "unsupported_codec",
+    MISSING_METADATA = "missing_metadata"
+}
+export default UploadProbeStatus;

package/dist/asyncapi/UploadProbeStatus.js

@@ -0,0 +1,8 @@
+var UploadProbeStatus;
+(function (UploadProbeStatus) {
+    UploadProbeStatus["OK"] = "ok";
+    UploadProbeStatus["CORRUPT"] = "corrupt";
+    UploadProbeStatus["UNSUPPORTED_CODEC"] = "unsupported_codec";
+    UploadProbeStatus["MISSING_METADATA"] = "missing_metadata";
+})(UploadProbeStatus || (UploadProbeStatus = {}));
+export default UploadProbeStatus;

package/dist/asyncapi/index.d.ts

@@ -1,11 +1,24 @@
 export { default as ErrorCode } from './ErrorCode.js';
+export { default as Failure } from './Failure.js';
+export { default as JobInputRole } from './JobInputRole.js';
 export { default as MergeOutputType } from './MergeOutputType.js';
+export { default as MultiOutputCompletion } from './MultiOutputCompletion.js';
 export { default as NotificationsOperationsQueue } from './NotificationsOperationsQueue.js';
 export { default as OperationMetrics } from './OperationMetrics.js';
 export { default as OperationProgress } from './OperationProgress.js';
 export { default as OperationRequest } from './OperationRequest.js';
 export { default as OperationResult } from './OperationResult.js';
 export { default as OperationType } from './OperationType.js';
+export { default as PageIndexed } from './PageIndexed.js';
+export { default as PositionIndexed } from './PositionIndexed.js';
 export { default as ProgressStatus } from './ProgressStatus.js';
+export { default as ReEncodeDecision } from './ReEncodeDecision.js';
 export { default as ResultStatus } from './ResultStatus.js';
+export { default as SingleOutputCompletion } from './SingleOutputCompletion.js';
 export { default as SourceEntry } from './SourceEntry.js';
+export { default as Unindexed } from './Unindexed.js';
+export { default as UploadProbeCompletion } from './UploadProbeCompletion.js';
+export { default as UploadProbeMediaMetadata } from './UploadProbeMediaMetadata.js';
+export { default as UploadProbeProcessingClass } from './UploadProbeProcessingClass.js';
+export { default as UploadProbeRequest } from './UploadProbeRequest.js';
+export { default as UploadProbeStatus } from './UploadProbeStatus.js';

package/dist/asyncapi/index.js

@@ -1,5 +1,9 @@
 export { default as ErrorCode } from './ErrorCode.js';
+export { default as JobInputRole } from './JobInputRole.js';
 export { default as MergeOutputType } from './MergeOutputType.js';
 export { default as OperationType } from './OperationType.js';
 export { default as ProgressStatus } from './ProgressStatus.js';
+export { default as ReEncodeDecision } from './ReEncodeDecision.js';
 export { default as ResultStatus } from './ResultStatus.js';
+export { default as UploadProbeProcessingClass } from './UploadProbeProcessingClass.js';
+export { default as UploadProbeStatus } from './UploadProbeStatus.js';

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

@@ -0,0 +1,64 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for `POST /api/audio-watermark/decode`. Per
+ * ticket [I20](https://trello.com/c/omiCq7Vn). The asset to
+ * decode is identified by an upload `file_id` (from the standard
+ * upload flow); the decoder fetches the asset from S3 and
+ * extracts the watermark.
+ *
+ * Same scope-limit applies as documented on the endpoint:
+ * own-watermarks-only. The runtime cross-references the
+ * decoded `watermark_id` against the caller's audit log of
+ * previously-issued watermarks; mismatches return 404 (rather
+ * than leaking that *some* watermark was detected).
+ *
+ * @export
+ * @interface AudioWatermarkDecodeRequest
+ */
+export interface AudioWatermarkDecodeRequest {
+    /**
+     * UUID-v7 file ID of the uploaded asset to decode. Must
+     * reference an upload owned by the caller.
+     *
+     * @type {string}
+     * @memberof AudioWatermarkDecodeRequest
+     */
+    fileId: string;
+    /**
+     * Hint to the decoder about which method was used at embed
+     * time. `auto` (default) tries each method in order until
+     * a watermark is detected. Specifying the method directly
+     * shortens decode latency when the caller already knows.
+     *
+     * @type {AudioWatermarkDecodeRequestMethodHintEnum}
+     * @memberof AudioWatermarkDecodeRequest
+     */
+    methodHint?: AudioWatermarkDecodeRequestMethodHintEnum;
+}
+/**
+ * @export
+ */
+export declare const AudioWatermarkDecodeRequestMethodHintEnum: {
+    readonly auto: "auto";
+    readonly psychoacoustic: "psychoacoustic";
+    readonly neural: "neural";
+};
+export type AudioWatermarkDecodeRequestMethodHintEnum = typeof AudioWatermarkDecodeRequestMethodHintEnum[keyof typeof AudioWatermarkDecodeRequestMethodHintEnum];
+/**
+ * Check if a given object implements the AudioWatermarkDecodeRequest interface.
+ */
+export declare function instanceOfAudioWatermarkDecodeRequest(value: object): value is AudioWatermarkDecodeRequest;
+export declare function AudioWatermarkDecodeRequestFromJSON(json: any): AudioWatermarkDecodeRequest;
+export declare function AudioWatermarkDecodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AudioWatermarkDecodeRequest;
+export declare function AudioWatermarkDecodeRequestToJSON(json: any): AudioWatermarkDecodeRequest;
+export declare function AudioWatermarkDecodeRequestToJSONTyped(value?: AudioWatermarkDecodeRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/AudioWatermarkDecodeRequest.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AudioWatermarkDecodeRequestMethodHintEnum = {
+    auto: 'auto',
+    psychoacoustic: 'psychoacoustic',
+    neural: 'neural'
+};
+/**
+ * Check if a given object implements the AudioWatermarkDecodeRequest interface.
+ */
+export function instanceOfAudioWatermarkDecodeRequest(value) {
+    if (!('fileId' in value) || value['fileId'] === undefined)
+        return false;
+    return true;
+}
+export function AudioWatermarkDecodeRequestFromJSON(json) {
+    return AudioWatermarkDecodeRequestFromJSONTyped(json, false);
+}
+export function AudioWatermarkDecodeRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['file_id'],
+        'methodHint': json['method_hint'] == null ? undefined : json['method_hint'],
+    };
+}
+export function AudioWatermarkDecodeRequestToJSON(json) {
+    return AudioWatermarkDecodeRequestToJSONTyped(json, false);
+}
+export function AudioWatermarkDecodeRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file_id': value['fileId'],
+        'method_hint': value['methodHint'],
+    };
+}