@giveitsmaller/contracts 0.1.0

package/openapi/models/OperationInputModel.ts

@@ -0,0 +1,56 @@
+/* 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.
+ */
+
+
+/**
+ * Whether the operation accepts a single file or multiple files:
+ * - single: One input file (compress, thumbnail, watermark, convert)
+ * - multi: Multiple input files (merge, archive)
+ * 
+ * @export
+ */
+export const OperationInputModel = {
+    single: 'single',
+    multi: 'multi'
+} as const;
+export type OperationInputModel = typeof OperationInputModel[keyof typeof OperationInputModel];
+
+
+export function instanceOfOperationInputModel(value: any): boolean {
+    for (const key in OperationInputModel) {
+        if (Object.prototype.hasOwnProperty.call(OperationInputModel, key)) {
+            if (OperationInputModel[key as keyof typeof OperationInputModel] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function OperationInputModelFromJSON(json: any): OperationInputModel {
+    return OperationInputModelFromJSONTyped(json, false);
+}
+
+export function OperationInputModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationInputModel {
+    return json as OperationInputModel;
+}
+
+export function OperationInputModelToJSON(value?: OperationInputModel | null): any {
+    return value as any;
+}
+
+export function OperationInputModelToJSONTyped(value: any, ignoreDiscriminator: boolean): OperationInputModel {
+    return value as OperationInputModel;
+}
+

package/openapi/models/OperationResponse.ts

@@ -0,0 +1,124 @@
+/* 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 { OperationStatus } from './OperationStatus';
+import {
+    OperationStatusFromJSON,
+    OperationStatusFromJSONTyped,
+    OperationStatusToJSON,
+    OperationStatusToJSONTyped,
+} from './OperationStatus';
+import type { OperationResult } from './OperationResult';
+import {
+    OperationResultFromJSON,
+    OperationResultFromJSONTyped,
+    OperationResultToJSON,
+    OperationResultToJSONTyped,
+} from './OperationResult';
+import type { OperationType } from './OperationType';
+import {
+    OperationTypeFromJSON,
+    OperationTypeFromJSONTyped,
+    OperationTypeToJSON,
+    OperationTypeToJSONTyped,
+} from './OperationType';
+
+/**
+ * Operation status within a job response
+ * @export
+ * @interface OperationResponse
+ */
+export interface OperationResponse {
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof OperationResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {OperationType}
+     * @memberof OperationResponse
+     */
+    type: OperationType;
+    /**
+     * 
+     * @type {OperationStatus}
+     * @memberof OperationResponse
+     */
+    status: OperationStatus;
+    /**
+     * Progress percentage (0-100). Present when in_progress or completed.
+     * @type {number}
+     * @memberof OperationResponse
+     */
+    progress?: number;
+    /**
+     * 
+     * @type {OperationResult}
+     * @memberof OperationResponse
+     */
+    result?: OperationResult;
+}
+
+
+
+/**
+ * Check if a given object implements the OperationResponse interface.
+ */
+export function instanceOfOperationResponse(value: object): value is OperationResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function OperationResponseFromJSON(json: any): OperationResponse {
+    return OperationResponseFromJSONTyped(json, false);
+}
+
+export function OperationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': OperationTypeFromJSON(json['type']),
+        'status': OperationStatusFromJSON(json['status']),
+        'progress': json['progress'] == null ? undefined : json['progress'],
+        'result': json['result'] == null ? undefined : OperationResultFromJSON(json['result']),
+    };
+}
+
+export function OperationResponseToJSON(json: any): OperationResponse {
+    return OperationResponseToJSONTyped(json, false);
+}
+
+export function OperationResponseToJSONTyped(value?: OperationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': OperationTypeToJSON(value['type']),
+        'status': OperationStatusToJSON(value['status']),
+        'progress': value['progress'],
+        'result': OperationResultToJSON(value['result']),
+    };
+}
+

package/openapi/models/OperationResult.ts

@@ -0,0 +1,100 @@
+/* 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 { OperationResultMetrics } from './OperationResultMetrics';
+import {
+    OperationResultMetricsFromJSON,
+    OperationResultMetricsFromJSONTyped,
+    OperationResultMetricsToJSON,
+    OperationResultMetricsToJSONTyped,
+} from './OperationResultMetrics';
+
+/**
+ * Result of a completed operation. Present only when operation status is `completed`.
+ * 
+ * @export
+ * @interface OperationResult
+ */
+export interface OperationResult {
+    /**
+     * Pre-signed download URL for the operation output
+     * @type {string}
+     * @memberof OperationResult
+     */
+    downloadUrl: string;
+    /**
+     * Output file size in bytes
+     * @type {number}
+     * @memberof OperationResult
+     */
+    sizeBytes: number;
+    /**
+     * Key in the customer's export destination (if export configured)
+     * @type {string}
+     * @memberof OperationResult
+     */
+    exportKey?: string;
+    /**
+     * 
+     * @type {OperationResultMetrics}
+     * @memberof OperationResult
+     */
+    metrics?: OperationResultMetrics;
+}
+
+/**
+ * Check if a given object implements the OperationResult interface.
+ */
+export function instanceOfOperationResult(value: object): value is OperationResult {
+    if (!('downloadUrl' in value) || value['downloadUrl'] === undefined) return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined) return false;
+    return true;
+}
+
+export function OperationResultFromJSON(json: any): OperationResult {
+    return OperationResultFromJSONTyped(json, false);
+}
+
+export function OperationResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'downloadUrl': json['download_url'],
+        'sizeBytes': json['size_bytes'],
+        'exportKey': json['export_key'] == null ? undefined : json['export_key'],
+        'metrics': json['metrics'] == null ? undefined : OperationResultMetricsFromJSON(json['metrics']),
+    };
+}
+
+export function OperationResultToJSON(json: any): OperationResult {
+    return OperationResultToJSONTyped(json, false);
+}
+
+export function OperationResultToJSONTyped(value?: OperationResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'download_url': value['downloadUrl'],
+        'size_bytes': value['sizeBytes'],
+        'export_key': value['exportKey'],
+        'metrics': OperationResultMetricsToJSON(value['metrics']),
+    };
+}
+

package/openapi/models/OperationResultMetrics.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';
+/**
+ * Operation-specific performance metrics
+ * @export
+ * @interface OperationResultMetrics
+ */
+export interface OperationResultMetrics {
+    /**
+     * Ratio of output size to input size (e.g. 0.45 = 55% reduction)
+     * @type {number}
+     * @memberof OperationResultMetrics
+     */
+    compressionRatio?: number;
+    /**
+     * Processing time in milliseconds
+     * @type {number}
+     * @memberof OperationResultMetrics
+     */
+    durationMs?: number;
+}
+
+/**
+ * Check if a given object implements the OperationResultMetrics interface.
+ */
+export function instanceOfOperationResultMetrics(value: object): value is OperationResultMetrics {
+    return true;
+}
+
+export function OperationResultMetricsFromJSON(json: any): OperationResultMetrics {
+    return OperationResultMetricsFromJSONTyped(json, false);
+}
+
+export function OperationResultMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationResultMetrics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'compressionRatio': json['compression_ratio'] == null ? undefined : json['compression_ratio'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+    };
+}
+
+export function OperationResultMetricsToJSON(json: any): OperationResultMetrics {
+    return OperationResultMetricsToJSONTyped(json, false);
+}
+
+export function OperationResultMetricsToJSONTyped(value?: OperationResultMetrics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'compression_ratio': value['compressionRatio'],
+        'duration_ms': value['durationMs'],
+    };
+}
+

package/openapi/models/OperationSchemaDefinition.ts

@@ -0,0 +1,163 @@
+/* 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 { MimeGroupSchema } from './MimeGroupSchema';
+import {
+    MimeGroupSchemaFromJSON,
+    MimeGroupSchemaFromJSONTyped,
+    MimeGroupSchemaToJSON,
+    MimeGroupSchemaToJSONTyped,
+} from './MimeGroupSchema';
+import type { OperationInputModel } from './OperationInputModel';
+import {
+    OperationInputModelFromJSON,
+    OperationInputModelFromJSONTyped,
+    OperationInputModelToJSON,
+    OperationInputModelToJSONTyped,
+} from './OperationInputModel';
+import type { OptionSchema } from './OptionSchema';
+import {
+    OptionSchemaFromJSON,
+    OptionSchemaFromJSONTyped,
+    OptionSchemaToJSON,
+    OptionSchemaToJSONTyped,
+} from './OptionSchema';
+
+/**
+ * Schema for a single operation type
+ * @export
+ * @interface OperationSchemaDefinition
+ */
+export interface OperationSchemaDefinition {
+    /**
+     * Human-readable description of what the operation does
+     * @type {string}
+     * @memberof OperationSchemaDefinition
+     */
+    description: string;
+    /**
+     * Whether this is the default operation when none specified
+     * @type {boolean}
+     * @memberof OperationSchemaDefinition
+     */
+    _default?: boolean;
+    /**
+     * 
+     * @type {OperationInputModel}
+     * @memberof OperationSchemaDefinition
+     */
+    inputModel: OperationInputModel;
+    /**
+     * Minimum number of inputs (multi-input operations only)
+     * @type {number}
+     * @memberof OperationSchemaDefinition
+     */
+    minInputs?: number;
+    /**
+     * Maximum number of inputs (multi-input operations only)
+     * @type {number}
+     * @memberof OperationSchemaDefinition
+     */
+    maxInputs?: number;
+    /**
+     * Whether mixed MIME types are allowed (archive only)
+     * @type {boolean}
+     * @memberof OperationSchemaDefinition
+     */
+    acceptsMixedTypes?: boolean;
+    /**
+     * MIME-type-specific option schemas. When present, options are grouped
+     * by MIME category (image, video, audio, document). Each group lists
+     * the supported MIME types and group-specific options.
+     * 
+     * @type {{ [key: string]: MimeGroupSchema; }}
+     * @memberof OperationSchemaDefinition
+     */
+    mimeGroups?: { [key: string]: MimeGroupSchema; };
+    /**
+     * Global options applicable regardless of MIME type, keyed by option name.
+     * For operations with mime_groups, these are the common options.
+     * 
+     * @type {{ [key: string]: OptionSchema; }}
+     * @memberof OperationSchemaDefinition
+     */
+    options: { [key: string]: OptionSchema; };
+    /**
+     * Options that can be overridden per-input for multi-input operations,
+     * keyed by option name. For merge: per-join-point transition overrides.
+     * 
+     * @type {{ [key: string]: OptionSchema; }}
+     * @memberof OperationSchemaDefinition
+     */
+    perInputOptions?: { [key: string]: OptionSchema; };
+}
+
+
+
+/**
+ * Check if a given object implements the OperationSchemaDefinition interface.
+ */
+export function instanceOfOperationSchemaDefinition(value: object): value is OperationSchemaDefinition {
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('inputModel' in value) || value['inputModel'] === undefined) return false;
+    if (!('options' in value) || value['options'] === undefined) return false;
+    return true;
+}
+
+export function OperationSchemaDefinitionFromJSON(json: any): OperationSchemaDefinition {
+    return OperationSchemaDefinitionFromJSONTyped(json, false);
+}
+
+export function OperationSchemaDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationSchemaDefinition {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'],
+        '_default': json['default'] == null ? undefined : json['default'],
+        'inputModel': OperationInputModelFromJSON(json['input_model']),
+        'minInputs': json['min_inputs'] == null ? undefined : json['min_inputs'],
+        'maxInputs': json['max_inputs'] == null ? undefined : json['max_inputs'],
+        'acceptsMixedTypes': json['accepts_mixed_types'] == null ? undefined : json['accepts_mixed_types'],
+        'mimeGroups': json['mime_groups'] == null ? undefined : (mapValues(json['mime_groups'], MimeGroupSchemaFromJSON)),
+        'options': (mapValues(json['options'], OptionSchemaFromJSON)),
+        'perInputOptions': json['per_input_options'] == null ? undefined : (mapValues(json['per_input_options'], OptionSchemaFromJSON)),
+    };
+}
+
+export function OperationSchemaDefinitionToJSON(json: any): OperationSchemaDefinition {
+    return OperationSchemaDefinitionToJSONTyped(json, false);
+}
+
+export function OperationSchemaDefinitionToJSONTyped(value?: OperationSchemaDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'default': value['_default'],
+        'input_model': OperationInputModelToJSON(value['inputModel']),
+        'min_inputs': value['minInputs'],
+        'max_inputs': value['maxInputs'],
+        'accepts_mixed_types': value['acceptsMixedTypes'],
+        'mime_groups': value['mimeGroups'] == null ? undefined : (mapValues(value['mimeGroups'], MimeGroupSchemaToJSON)),
+        'options': (mapValues(value['options'], OptionSchemaToJSON)),
+        'per_input_options': value['perInputOptions'] == null ? undefined : (mapValues(value['perInputOptions'], OptionSchemaToJSON)),
+    };
+}
+

package/openapi/models/OperationStatus.ts

@@ -0,0 +1,62 @@
+/* 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.
+ */
+
+
+/**
+ * Operation lifecycle status:
+ * - pending: Created, waiting to start
+ * - in_progress: Currently processing
+ * - completed: Finished successfully
+ * - failed: Encountered an error
+ * - retried: Failed and replaced by a new retry operation
+ * 
+ * @export
+ */
+export const OperationStatus = {
+    pending: 'pending',
+    in_progress: 'in_progress',
+    completed: 'completed',
+    failed: 'failed',
+    retried: 'retried'
+} as const;
+export type OperationStatus = typeof OperationStatus[keyof typeof OperationStatus];
+
+
+export function instanceOfOperationStatus(value: any): boolean {
+    for (const key in OperationStatus) {
+        if (Object.prototype.hasOwnProperty.call(OperationStatus, key)) {
+            if (OperationStatus[key as keyof typeof OperationStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function OperationStatusFromJSON(json: any): OperationStatus {
+    return OperationStatusFromJSONTyped(json, false);
+}
+
+export function OperationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationStatus {
+    return json as OperationStatus;
+}
+
+export function OperationStatusToJSON(value?: OperationStatus | null): any {
+    return value as any;
+}
+
+export function OperationStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): OperationStatus {
+    return value as OperationStatus;
+}
+

package/openapi/models/OperationType.ts

@@ -0,0 +1,64 @@
+/* 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.
+ */
+
+
+/**
+ * Available operation types:
+ * - compress: Reduce file size (images, audio, video, documents)
+ * - thumbnail: Generate preview image (images, video, documents)
+ * - watermark: Apply branding/protection (images, video, audio, documents)
+ * - merge: Concatenate/combine multiple files into one (images, video, audio, documents/PDF). Multi-input.
+ * - archive: Bundle files into ZIP/tar.gz (all types). Multi-input.
+ * - convert: Change file format (all types)
+ * 
+ * @export
+ */
+export const OperationType = {
+    compress: 'compress',
+    thumbnail: 'thumbnail',
+    watermark: 'watermark',
+    merge: 'merge',
+    archive: 'archive',
+    convert: 'convert'
+} as const;
+export type OperationType = typeof OperationType[keyof typeof OperationType];
+
+
+export function instanceOfOperationType(value: any): boolean {
+    for (const key in OperationType) {
+        if (Object.prototype.hasOwnProperty.call(OperationType, key)) {
+            if (OperationType[key as keyof typeof OperationType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function OperationTypeFromJSON(json: any): OperationType {
+    return OperationTypeFromJSONTyped(json, false);
+}
+
+export function OperationTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationType {
+    return json as OperationType;
+}
+
+export function OperationTypeToJSON(value?: OperationType | null): any {
+    return value as any;
+}
+
+export function OperationTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): OperationType {
+    return value as OperationType;
+}
+