@giveitsmaller/contracts 0.1.0

package/openapi/models/OperationsSchemaResponse.ts

@@ -0,0 +1,90 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { OperationSchemaDefinition } from './OperationSchemaDefinition';
+import {
+    OperationSchemaDefinitionFromJSON,
+    OperationSchemaDefinitionFromJSONTyped,
+    OperationSchemaDefinitionToJSON,
+    OperationSchemaDefinitionToJSONTyped,
+} from './OperationSchemaDefinition';
+
+/**
+ * Operations meta-schema. Describes all available operation types, their options,
+ * constraints, defaults, and MIME type applicability. Returned raw (no envelope)
+ * for CDN cacheability.
+ * 
+ * Each operation defines options with types, constraints, and conditional
+ * dependencies (via `depends_on`). Clients use this to build dynamic forms
+ * and validate options before submission.
+ * 
+ * @export
+ * @interface OperationsSchemaResponse
+ */
+export interface OperationsSchemaResponse {
+    /**
+     * Schema version for cache-busting
+     * @type {string}
+     * @memberof OperationsSchemaResponse
+     */
+    schemaVersion: string;
+    /**
+     * Map of operation type to its schema definition
+     * @type {{ [key: string]: OperationSchemaDefinition; }}
+     * @memberof OperationsSchemaResponse
+     */
+    operations: { [key: string]: OperationSchemaDefinition; };
+}
+
+/**
+ * Check if a given object implements the OperationsSchemaResponse interface.
+ */
+export function instanceOfOperationsSchemaResponse(value: object): value is OperationsSchemaResponse {
+    if (!('schemaVersion' in value) || value['schemaVersion'] === undefined) return false;
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    return true;
+}
+
+export function OperationsSchemaResponseFromJSON(json: any): OperationsSchemaResponse {
+    return OperationsSchemaResponseFromJSONTyped(json, false);
+}
+
+export function OperationsSchemaResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationsSchemaResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'schemaVersion': json['schema_version'],
+        'operations': (mapValues(json['operations'], OperationSchemaDefinitionFromJSON)),
+    };
+}
+
+export function OperationsSchemaResponseToJSON(json: any): OperationsSchemaResponse {
+    return OperationsSchemaResponseToJSONTyped(json, false);
+}
+
+export function OperationsSchemaResponseToJSONTyped(value?: OperationsSchemaResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'schema_version': value['schemaVersion'],
+        'operations': (mapValues(value['operations'], OperationSchemaDefinitionToJSON)),
+    };
+}
+

package/openapi/models/OptionSchema.ts

@@ -0,0 +1,160 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Schema for a single operation option
+ * @export
+ * @interface OptionSchema
+ */
+export interface OptionSchema {
+    /**
+     * Option value type
+     * @type {string}
+     * @memberof OptionSchema
+     */
+    type: OptionSchemaTypeEnum;
+    /**
+     * Human-readable description
+     * @type {string}
+     * @memberof OptionSchema
+     */
+    description?: string;
+    /**
+     * Whether the option is required
+     * @type {boolean}
+     * @memberof OptionSchema
+     */
+    required?: boolean;
+    /**
+     * 
+     * @type {any}
+     * @memberof OptionSchema
+     */
+    _default?: any | null;
+    /**
+     * Allowed values (for enum type)
+     * @type {Array<any>}
+     * @memberof OptionSchema
+     */
+    values?: Array<any>;
+    /**
+     * Actual type of enum values when not strings (e.g. "integer" for numeric bitrate enums).
+     * Consumers should parse/display values as this type rather than as strings.
+     * 
+     * @type {string}
+     * @memberof OptionSchema
+     */
+    valueType?: OptionSchemaValueTypeEnum;
+    /**
+     * Minimum value (for integer/float types)
+     * @type {number}
+     * @memberof OptionSchema
+     */
+    min?: number;
+    /**
+     * Maximum value (for integer/float types)
+     * @type {number}
+     * @memberof OptionSchema
+     */
+    max?: number;
+    /**
+     * Conditional dependency. This option is only applicable when the condition is met.
+     * Simple: `{ "mode": "lossy" }` — option applies when mode equals lossy.
+     * Multi-value: `{ "output_format": ["jpeg", "webp"] }` — option applies when output_format is any listed value.
+     * Set condition: `{ "width": "set", "height": "set", "logic": "or" }` — option applies when width or height is provided.
+     * The "set" sentinel means the option has any value. "logic" can be "and" (default) or "or".
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof OptionSchema
+     */
+    dependsOn?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const OptionSchemaTypeEnum = {
+    integer: 'integer',
+    float: 'float',
+    boolean: 'boolean',
+    enum: 'enum',
+    string: 'string'
+} as const;
+export type OptionSchemaTypeEnum = typeof OptionSchemaTypeEnum[keyof typeof OptionSchemaTypeEnum];
+
+/**
+ * @export
+ */
+export const OptionSchemaValueTypeEnum = {
+    integer: 'integer',
+    float: 'float'
+} as const;
+export type OptionSchemaValueTypeEnum = typeof OptionSchemaValueTypeEnum[keyof typeof OptionSchemaValueTypeEnum];
+
+
+/**
+ * Check if a given object implements the OptionSchema interface.
+ */
+export function instanceOfOptionSchema(value: object): value is OptionSchema {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function OptionSchemaFromJSON(json: any): OptionSchema {
+    return OptionSchemaFromJSONTyped(json, false);
+}
+
+export function OptionSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): OptionSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'required': json['required'] == null ? undefined : json['required'],
+        '_default': json['default'] == null ? undefined : json['default'],
+        'values': json['values'] == null ? undefined : json['values'],
+        'valueType': json['value_type'] == null ? undefined : json['value_type'],
+        'min': json['min'] == null ? undefined : json['min'],
+        'max': json['max'] == null ? undefined : json['max'],
+        'dependsOn': json['depends_on'] == null ? undefined : json['depends_on'],
+    };
+}
+
+export function OptionSchemaToJSON(json: any): OptionSchema {
+    return OptionSchemaToJSONTyped(json, false);
+}
+
+export function OptionSchemaToJSONTyped(value?: OptionSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'description': value['description'],
+        'required': value['required'],
+        'default': value['_default'],
+        'values': value['values'],
+        'value_type': value['valueType'],
+        'min': value['min'],
+        'max': value['max'],
+        'depends_on': value['dependsOn'],
+    };
+}
+

package/openapi/models/PresignedUrlPart.ts

@@ -0,0 +1,86 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PresignedUrlPart
+ */
+export interface PresignedUrlPart {
+    /**
+     * S3 multipart part number (starts at 2, API handled part 1)
+     * @type {number}
+     * @memberof PresignedUrlPart
+     */
+    partNumber: number;
+    /**
+     * Pre-signed S3 PUT URL. Send PUT with raw binary chunk as body.
+     * @type {string}
+     * @memberof PresignedUrlPart
+     */
+    url: string;
+    /**
+     * ISO 8601 expiry timestamp. TTL is dynamic: estimated_upload_duration * 2,
+     * clamped between 900s and 3600s.
+     * 
+     * @type {Date}
+     * @memberof PresignedUrlPart
+     */
+    expiresAt: Date;
+}
+
+/**
+ * Check if a given object implements the PresignedUrlPart interface.
+ */
+export function instanceOfPresignedUrlPart(value: object): value is PresignedUrlPart {
+    if (!('partNumber' in value) || value['partNumber'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    return true;
+}
+
+export function PresignedUrlPartFromJSON(json: any): PresignedUrlPart {
+    return PresignedUrlPartFromJSONTyped(json, false);
+}
+
+export function PresignedUrlPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): PresignedUrlPart {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'partNumber': json['part_number'],
+        'url': json['url'],
+        'expiresAt': (new Date(json['expires_at'])),
+    };
+}
+
+export function PresignedUrlPartToJSON(json: any): PresignedUrlPart {
+    return PresignedUrlPartToJSONTyped(json, false);
+}
+
+export function PresignedUrlPartToJSONTyped(value?: PresignedUrlPart | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'part_number': value['partNumber'],
+        'url': value['url'],
+        'expires_at': ((value['expiresAt']).toISOString()),
+    };
+}
+

package/openapi/models/ReadinessResponse.ts

@@ -0,0 +1,73 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReadinessResponse
+ */
+export interface ReadinessResponse {
+    /**
+     * Database connection is healthy
+     * @type {boolean}
+     * @memberof ReadinessResponse
+     */
+    database?: boolean;
+    /**
+     * Cache connection is healthy
+     * @type {boolean}
+     * @memberof ReadinessResponse
+     */
+    cache?: boolean;
+}
+
+/**
+ * Check if a given object implements the ReadinessResponse interface.
+ */
+export function instanceOfReadinessResponse(value: object): value is ReadinessResponse {
+    return true;
+}
+
+export function ReadinessResponseFromJSON(json: any): ReadinessResponse {
+    return ReadinessResponseFromJSONTyped(json, false);
+}
+
+export function ReadinessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReadinessResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'database': json['database'] == null ? undefined : json['database'],
+        'cache': json['cache'] == null ? undefined : json['cache'],
+    };
+}
+
+export function ReadinessResponseToJSON(json: any): ReadinessResponse {
+    return ReadinessResponseToJSONTyped(json, false);
+}
+
+export function ReadinessResponseToJSONTyped(value?: ReadinessResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'database': value['database'],
+        'cache': value['cache'],
+    };
+}
+

package/openapi/models/ResponseEnvelope.ts

@@ -0,0 +1,70 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Standard response wrapper. All API responses (except GET /api/operations/schema,
+ * health probes, and POST /api/contact) use this envelope.
+ * Success: `{ success: true, data: {...} }`.
+ * Error: `{ success: false, error: "...", details: [...] }`.
+ * 
+ * @export
+ * @interface ResponseEnvelope
+ */
+export interface ResponseEnvelope {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ResponseEnvelope
+     */
+    success: boolean;
+}
+
+/**
+ * Check if a given object implements the ResponseEnvelope interface.
+ */
+export function instanceOfResponseEnvelope(value: object): value is ResponseEnvelope {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    return true;
+}
+
+export function ResponseEnvelopeFromJSON(json: any): ResponseEnvelope {
+    return ResponseEnvelopeFromJSONTyped(json, false);
+}
+
+export function ResponseEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+    };
+}
+
+export function ResponseEnvelopeToJSON(json: any): ResponseEnvelope {
+    return ResponseEnvelopeToJSONTyped(json, false);
+}
+
+export function ResponseEnvelopeToJSONTyped(value?: ResponseEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+    };
+}
+

package/openapi/models/RetryResponse.ts

@@ -0,0 +1,94 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface RetryResponse
+ */
+export interface RetryResponse {
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof RetryResponse
+     */
+    operationId: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof RetryResponse
+     */
+    originalOperationId: string;
+    /**
+     * Always "pending" for a new retry
+     * @type {string}
+     * @memberof RetryResponse
+     */
+    status: RetryResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const RetryResponseStatusEnum = {
+    pending: 'pending'
+} as const;
+export type RetryResponseStatusEnum = typeof RetryResponseStatusEnum[keyof typeof RetryResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the RetryResponse interface.
+ */
+export function instanceOfRetryResponse(value: object): value is RetryResponse {
+    if (!('operationId' in value) || value['operationId'] === undefined) return false;
+    if (!('originalOperationId' in value) || value['originalOperationId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function RetryResponseFromJSON(json: any): RetryResponse {
+    return RetryResponseFromJSONTyped(json, false);
+}
+
+export function RetryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetryResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'operationId': json['operation_id'],
+        'originalOperationId': json['original_operation_id'],
+        'status': json['status'],
+    };
+}
+
+export function RetryResponseToJSON(json: any): RetryResponse {
+    return RetryResponseToJSONTyped(json, false);
+}
+
+export function RetryResponseToJSONTyped(value?: RetryResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'operation_id': value['operationId'],
+        'original_operation_id': value['originalOperationId'],
+        'status': value['status'],
+    };
+}
+

package/openapi/models/RetrySuccessEnvelope.ts

@@ -0,0 +1,93 @@
+/* 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, watermark, merge, archive, convert) - 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 (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { RetryResponse } from './RetryResponse';
+import {
+    RetryResponseFromJSON,
+    RetryResponseFromJSONTyped,
+    RetryResponseToJSON,
+    RetryResponseToJSONTyped,
+} from './RetryResponse';
+
+/**
+ * 
+ * @export
+ * @interface RetrySuccessEnvelope
+ */
+export interface RetrySuccessEnvelope {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RetrySuccessEnvelope
+     */
+    success: RetrySuccessEnvelopeSuccessEnum;
+    /**
+     * 
+     * @type {RetryResponse}
+     * @memberof RetrySuccessEnvelope
+     */
+    data: RetryResponse;
+}
+
+
+/**
+ * @export
+ */
+export const RetrySuccessEnvelopeSuccessEnum = {
+    true: true
+} as const;
+export type RetrySuccessEnvelopeSuccessEnum = typeof RetrySuccessEnvelopeSuccessEnum[keyof typeof RetrySuccessEnvelopeSuccessEnum];
+
+
+/**
+ * Check if a given object implements the RetrySuccessEnvelope interface.
+ */
+export function instanceOfRetrySuccessEnvelope(value: object): value is RetrySuccessEnvelope {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function RetrySuccessEnvelopeFromJSON(json: any): RetrySuccessEnvelope {
+    return RetrySuccessEnvelopeFromJSONTyped(json, false);
+}
+
+export function RetrySuccessEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetrySuccessEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'data': RetryResponseFromJSON(json['data']),
+    };
+}
+
+export function RetrySuccessEnvelopeToJSON(json: any): RetrySuccessEnvelope {
+    return RetrySuccessEnvelopeToJSONTyped(json, false);
+}
+
+export function RetrySuccessEnvelopeToJSONTyped(value?: RetrySuccessEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'data': RetryResponseToJSON(value['data']),
+    };
+}
+