@giveitsmaller/contracts 0.54.0 → 0.57.0

package/dist/openapi/models/WorkflowWarningSeverity.js

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

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

@@ -51,6 +51,7 @@ export * from './CreateApiKeyRequest.js';
 export * from './CreateBillingCheckoutSession422Response.js';
 export * from './CreateExternalImport403Response.js';
 export * from './CreateExternalImport422Response.js';
+export * from './CreateWorkflow401Response.js';
 export * from './CreateWorkflow422Response.js';
 export * from './CreditTransaction.js';
 export * from './CreditTransactionSourceBucket.js';
@@ -65,6 +66,7 @@ export * from './DeliveryPlanOutput.js';
 export * from './DeliveryPlanReason.js';
 export * from './DeliverySelection.js';
 export * from './DownloadBundle.js';
+export * from './EmailNotify.js';
 export * from './EmptySuccessEnvelope.js';
 export * from './EndpointProjection.js';
 export * from './ErrorEnvelope.js';
@@ -79,7 +81,6 @@ export * from './ExternalSource.js';
 export * from './FeatureNotAvailableResponse.js';
 export * from './FeatureTierRestrictedResponse.js';
 export * from './FeatureViolation.js';
-export * from './ForgotPasswordRequest.js';
 export * from './ImageEncodeCapabilities.js';
 export * from './JobDefinition.js';
 export * from './JobDownload.js';
@@ -93,6 +94,7 @@ export * from './LivenessResponse.js';
 export * from './LoginUser200Response.js';
 export * from './LoginUser200ResponseData.js';
 export * from './LoginUser200ResponseDataUser.js';
+export * from './LoginUser401Response.js';
 export * from './LoginUserRequest.js';
 export * from './LongFormConcurrencyLimitResponse.js';
 export * from './LongFormConcurrencyLimitResponseAllOfLinks.js';
@@ -118,6 +120,7 @@ export * from './MultipartPresignResponse.js';
 export * from './MultipartPresignSuccessEnvelope.js';
 export * from './MultipartStatusResponse.js';
 export * from './MultipartStatusSuccessEnvelope.js';
+export * from './NotifyConfig.js';
 export * from './OperationCapability.js';
 export * from './OperationDefinition.js';
 export * from './OperationDownload.js';
@@ -155,6 +158,7 @@ export * from './ReEncodeDecision.js';
 export * from './ReadinessResponse.js';
 export * from './RegisterUser422Response.js';
 export * from './RegisterUserRequest.js';
+export * from './ResendVerificationEmailRequest.js';
 export * from './ResetPasswordRequest.js';
 export * from './ResponseEnvelope.js';
 export * from './RetryResponse.js';

package/dist/openapi/models/index.js

@@ -53,6 +53,7 @@ export * from './CreateApiKeyRequest.js';
 export * from './CreateBillingCheckoutSession422Response.js';
 export * from './CreateExternalImport403Response.js';
 export * from './CreateExternalImport422Response.js';
+export * from './CreateWorkflow401Response.js';
 export * from './CreateWorkflow422Response.js';
 export * from './CreditTransaction.js';
 export * from './CreditTransactionSourceBucket.js';
@@ -67,6 +68,7 @@ export * from './DeliveryPlanOutput.js';
 export * from './DeliveryPlanReason.js';
 export * from './DeliverySelection.js';
 export * from './DownloadBundle.js';
+export * from './EmailNotify.js';
 export * from './EmptySuccessEnvelope.js';
 export * from './EndpointProjection.js';
 export * from './ErrorEnvelope.js';
@@ -81,7 +83,6 @@ export * from './ExternalSource.js';
 export * from './FeatureNotAvailableResponse.js';
 export * from './FeatureTierRestrictedResponse.js';
 export * from './FeatureViolation.js';
-export * from './ForgotPasswordRequest.js';
 export * from './ImageEncodeCapabilities.js';
 export * from './JobDefinition.js';
 export * from './JobDownload.js';
@@ -95,6 +96,7 @@ export * from './LivenessResponse.js';
 export * from './LoginUser200Response.js';
 export * from './LoginUser200ResponseData.js';
 export * from './LoginUser200ResponseDataUser.js';
+export * from './LoginUser401Response.js';
 export * from './LoginUserRequest.js';
 export * from './LongFormConcurrencyLimitResponse.js';
 export * from './LongFormConcurrencyLimitResponseAllOfLinks.js';
@@ -120,6 +122,7 @@ export * from './MultipartPresignResponse.js';
 export * from './MultipartPresignSuccessEnvelope.js';
 export * from './MultipartStatusResponse.js';
 export * from './MultipartStatusSuccessEnvelope.js';
+export * from './NotifyConfig.js';
 export * from './OperationCapability.js';
 export * from './OperationDefinition.js';
 export * from './OperationDownload.js';
@@ -157,6 +160,7 @@ export * from './ReEncodeDecision.js';
 export * from './ReadinessResponse.js';
 export * from './RegisterUser422Response.js';
 export * from './RegisterUserRequest.js';
+export * from './ResendVerificationEmailRequest.js';
 export * from './ResetPasswordRequest.js';
 export * from './ResponseEnvelope.js';
 export * from './RetryResponse.js';

package/dist/openapi/runtime.d.ts

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

package/dist/openapi/runtime.js

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

package/dist/operations/compress.d.ts

@@ -313,27 +313,7 @@ export interface CompressVideoOptions {
     audio_bitrate?: CompressVideoAudioBitrate;
     trim_start?: number;
     trim_end?: number;
-}
-export declare enum CompressDocumentPdfProfile {
-    Screen = "screen",
-    Ebook = "ebook",
-    Printer = "printer",
-    Prepress = "prepress"
-}
-export declare enum CompressDocumentPdfColorspace {
-    Unchanged = "unchanged",
-    Rgb = "rgb",
-    Cmyk = "cmyk",
-    Grayscale = "grayscale"
-}
-export interface CompressDocumentPdfOptions {
-    quality?: number;
-    profile?: CompressDocumentPdfProfile;
-    grayscale?: boolean;
-    image_dpi?: number;
-    colorspace?: CompressDocumentPdfColorspace;
-    pages?: string;
-    flatten_forms?: boolean;
+    speed?: number;
 }
 export interface CompressDocumentOfficeOptions {
     quality?: number;

package/dist/operations/compress.js

@@ -259,17 +259,3 @@ export var CompressVideoAudioBitrate;
     CompressVideoAudioBitrate[CompressVideoAudioBitrate["_256"] = 256] = "_256";
     CompressVideoAudioBitrate[CompressVideoAudioBitrate["_320"] = 320] = "_320";
 })(CompressVideoAudioBitrate || (CompressVideoAudioBitrate = {}));
-export var CompressDocumentPdfProfile;
-(function (CompressDocumentPdfProfile) {
-    CompressDocumentPdfProfile["Screen"] = "screen";
-    CompressDocumentPdfProfile["Ebook"] = "ebook";
-    CompressDocumentPdfProfile["Printer"] = "printer";
-    CompressDocumentPdfProfile["Prepress"] = "prepress";
-})(CompressDocumentPdfProfile || (CompressDocumentPdfProfile = {}));
-export var CompressDocumentPdfColorspace;
-(function (CompressDocumentPdfColorspace) {
-    CompressDocumentPdfColorspace["Unchanged"] = "unchanged";
-    CompressDocumentPdfColorspace["Rgb"] = "rgb";
-    CompressDocumentPdfColorspace["Cmyk"] = "cmyk";
-    CompressDocumentPdfColorspace["Grayscale"] = "grayscale";
-})(CompressDocumentPdfColorspace || (CompressDocumentPdfColorspace = {}));

package/dist/operations/compress.metadata.js

@@ -324,7 +324,7 @@ export const compressMetadata = {
                     },
                 },
                 long_form: {
-                    availability: 'beta',
+                    availability: 'stable',
                     required_tier: 'pro',
                     constraints: {
                         max_input_duration: 'PT12H',
@@ -390,34 +390,7 @@ export const compressMetadata = {
                 trim_end: {
                     per_value_availability: {},
                 },
-            },
-            per_input_options: {},
-        },
-        document_pdf: {
-            processing_class: {},
-            per_mime_availability: {},
-            options: {
-                quality: {
-                    per_value_availability: {},
-                },
-                profile: {
-                    per_value_availability: {},
-                },
-                grayscale: {
-                    per_value_availability: {},
-                },
-                image_dpi: {
-                    per_value_availability: {},
-                },
-                colorspace: {
-                    availability: 'planned',
-                    per_value_availability: {},
-                },
-                pages: {
-                    availability: 'planned',
-                    per_value_availability: {},
-                },
-                flatten_forms: {
+                speed: {
                     availability: 'planned',
                     per_value_availability: {},
                 },

package/dist/operations/merge.metadata.js

@@ -125,7 +125,7 @@ export const mergeMetadata = {
                     },
                 },
                 long_form_re_encode: {
-                    availability: 'beta',
+                    availability: 'stable',
                     required_tier: 'pro',
                     constraints: {
                         max_total_duration: 'PT24H',