@giveitsmaller/contracts 0.1.0

package/openapi/models/SseEventType.ts

@@ -0,0 +1,68 @@
+/* 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.
+ */
+
+
+/**
+ * Server-Sent Event types pushed on the /events endpoint:
+ * - operation.progress: Progress update for an operation
+ * - operation.completed: Operation finished successfully
+ * - operation.failed: Operation encountered an error
+ * - job.completed: All operations in a job completed
+ * - job.failed: Job failed
+ * - workflow.completed: All jobs completed successfully
+ * - workflow.failed: All jobs finished, at least one failed
+ * - workflow.partially_failed: Some succeeded, some failed
+ * 
+ * @export
+ */
+export const SseEventType = {
+    operation_progress: 'operation.progress',
+    operation_completed: 'operation.completed',
+    operation_failed: 'operation.failed',
+    job_completed: 'job.completed',
+    job_failed: 'job.failed',
+    workflow_completed: 'workflow.completed',
+    workflow_failed: 'workflow.failed',
+    workflow_partially_failed: 'workflow.partially_failed'
+} as const;
+export type SseEventType = typeof SseEventType[keyof typeof SseEventType];
+
+
+export function instanceOfSseEventType(value: any): boolean {
+    for (const key in SseEventType) {
+        if (Object.prototype.hasOwnProperty.call(SseEventType, key)) {
+            if (SseEventType[key as keyof typeof SseEventType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SseEventTypeFromJSON(json: any): SseEventType {
+    return SseEventTypeFromJSONTyped(json, false);
+}
+
+export function SseEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseEventType {
+    return json as SseEventType;
+}
+
+export function SseEventTypeToJSON(value?: SseEventType | null): any {
+    return value as any;
+}
+
+export function SseEventTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SseEventType {
+    return value as SseEventType;
+}
+

package/openapi/models/SseJobCompletedData.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';
+/**
+ * Payload for `job.completed` events
+ * @export
+ * @interface SseJobCompletedData
+ */
+export interface SseJobCompletedData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SseJobCompletedData
+     */
+    jobRef: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof SseJobCompletedData
+     */
+    jobId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseJobCompletedData
+     */
+    status: SseJobCompletedDataStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const SseJobCompletedDataStatusEnum = {
+    completed: 'completed'
+} as const;
+export type SseJobCompletedDataStatusEnum = typeof SseJobCompletedDataStatusEnum[keyof typeof SseJobCompletedDataStatusEnum];
+
+
+/**
+ * Check if a given object implements the SseJobCompletedData interface.
+ */
+export function instanceOfSseJobCompletedData(value: object): value is SseJobCompletedData {
+    if (!('jobRef' in value) || value['jobRef'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function SseJobCompletedDataFromJSON(json: any): SseJobCompletedData {
+    return SseJobCompletedDataFromJSONTyped(json, false);
+}
+
+export function SseJobCompletedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobCompletedData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobRef': json['job_ref'],
+        'jobId': json['job_id'],
+        'status': json['status'],
+    };
+}
+
+export function SseJobCompletedDataToJSON(json: any): SseJobCompletedData {
+    return SseJobCompletedDataToJSONTyped(json, false);
+}
+
+export function SseJobCompletedDataToJSONTyped(value?: SseJobCompletedData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job_ref': value['jobRef'],
+        'job_id': value['jobId'],
+        'status': value['status'],
+    };
+}
+

package/openapi/models/SseJobFailedData.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';
+/**
+ * Payload for `job.failed` events
+ * @export
+ * @interface SseJobFailedData
+ */
+export interface SseJobFailedData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SseJobFailedData
+     */
+    jobRef: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof SseJobFailedData
+     */
+    jobId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseJobFailedData
+     */
+    status: SseJobFailedDataStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const SseJobFailedDataStatusEnum = {
+    failed: 'failed'
+} as const;
+export type SseJobFailedDataStatusEnum = typeof SseJobFailedDataStatusEnum[keyof typeof SseJobFailedDataStatusEnum];
+
+
+/**
+ * Check if a given object implements the SseJobFailedData interface.
+ */
+export function instanceOfSseJobFailedData(value: object): value is SseJobFailedData {
+    if (!('jobRef' in value) || value['jobRef'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function SseJobFailedDataFromJSON(json: any): SseJobFailedData {
+    return SseJobFailedDataFromJSONTyped(json, false);
+}
+
+export function SseJobFailedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobFailedData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobRef': json['job_ref'],
+        'jobId': json['job_id'],
+        'status': json['status'],
+    };
+}
+
+export function SseJobFailedDataToJSON(json: any): SseJobFailedData {
+    return SseJobFailedDataToJSONTyped(json, false);
+}
+
+export function SseJobFailedDataToJSONTyped(value?: SseJobFailedData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job_ref': value['jobRef'],
+        'job_id': value['jobId'],
+        'status': value['status'],
+    };
+}
+

package/openapi/models/SseOperationCompletedData.ts

@@ -0,0 +1,143 @@
+/* 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 { OperationResult } from './OperationResult';
+import {
+    OperationResultFromJSON,
+    OperationResultFromJSONTyped,
+    OperationResultToJSON,
+    OperationResultToJSONTyped,
+} from './OperationResult';
+import type { OperationType } from './OperationType';
+import {
+    OperationTypeFromJSON,
+    OperationTypeFromJSONTyped,
+    OperationTypeToJSON,
+    OperationTypeToJSONTyped,
+} from './OperationType';
+
+/**
+ * Payload for `operation.completed` events
+ * @export
+ * @interface SseOperationCompletedData
+ */
+export interface SseOperationCompletedData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationCompletedData
+     */
+    jobRef: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof SseOperationCompletedData
+     */
+    operationId: string;
+    /**
+     * 
+     * @type {OperationType}
+     * @memberof SseOperationCompletedData
+     */
+    type: OperationType;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationCompletedData
+     */
+    status: SseOperationCompletedDataStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof SseOperationCompletedData
+     */
+    progress: SseOperationCompletedDataProgressEnum;
+    /**
+     * 
+     * @type {OperationResult}
+     * @memberof SseOperationCompletedData
+     */
+    result?: OperationResult;
+}
+
+
+/**
+ * @export
+ */
+export const SseOperationCompletedDataStatusEnum = {
+    completed: 'completed'
+} as const;
+export type SseOperationCompletedDataStatusEnum = typeof SseOperationCompletedDataStatusEnum[keyof typeof SseOperationCompletedDataStatusEnum];
+
+/**
+ * @export
+ */
+export const SseOperationCompletedDataProgressEnum = {
+    NUMBER_100: 100
+} as const;
+export type SseOperationCompletedDataProgressEnum = typeof SseOperationCompletedDataProgressEnum[keyof typeof SseOperationCompletedDataProgressEnum];
+
+
+/**
+ * Check if a given object implements the SseOperationCompletedData interface.
+ */
+export function instanceOfSseOperationCompletedData(value: object): value is SseOperationCompletedData {
+    if (!('jobRef' in value) || value['jobRef'] === undefined) return false;
+    if (!('operationId' in value) || value['operationId'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    return true;
+}
+
+export function SseOperationCompletedDataFromJSON(json: any): SseOperationCompletedData {
+    return SseOperationCompletedDataFromJSONTyped(json, false);
+}
+
+export function SseOperationCompletedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationCompletedData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobRef': json['job_ref'],
+        'operationId': json['operation_id'],
+        'type': OperationTypeFromJSON(json['type']),
+        'status': json['status'],
+        'progress': json['progress'],
+        'result': json['result'] == null ? undefined : OperationResultFromJSON(json['result']),
+    };
+}
+
+export function SseOperationCompletedDataToJSON(json: any): SseOperationCompletedData {
+    return SseOperationCompletedDataToJSONTyped(json, false);
+}
+
+export function SseOperationCompletedDataToJSONTyped(value?: SseOperationCompletedData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job_ref': value['jobRef'],
+        'operation_id': value['operationId'],
+        'type': OperationTypeToJSON(value['type']),
+        'status': value['status'],
+        'progress': value['progress'],
+        'result': OperationResultToJSON(value['result']),
+    };
+}
+

package/openapi/models/SseOperationFailedData.ts

@@ -0,0 +1,129 @@
+/* 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 { OperationType } from './OperationType';
+import {
+    OperationTypeFromJSON,
+    OperationTypeFromJSONTyped,
+    OperationTypeToJSON,
+    OperationTypeToJSONTyped,
+} from './OperationType';
+
+/**
+ * Payload for `operation.failed` events
+ * @export
+ * @interface SseOperationFailedData
+ */
+export interface SseOperationFailedData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationFailedData
+     */
+    jobRef: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof SseOperationFailedData
+     */
+    operationId: string;
+    /**
+     * 
+     * @type {OperationType}
+     * @memberof SseOperationFailedData
+     */
+    type: OperationType;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationFailedData
+     */
+    status: SseOperationFailedDataStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationFailedData
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationFailedData
+     */
+    errorMessage: string;
+}
+
+
+/**
+ * @export
+ */
+export const SseOperationFailedDataStatusEnum = {
+    failed: 'failed'
+} as const;
+export type SseOperationFailedDataStatusEnum = typeof SseOperationFailedDataStatusEnum[keyof typeof SseOperationFailedDataStatusEnum];
+
+
+/**
+ * Check if a given object implements the SseOperationFailedData interface.
+ */
+export function instanceOfSseOperationFailedData(value: object): value is SseOperationFailedData {
+    if (!('jobRef' in value) || value['jobRef'] === undefined) return false;
+    if (!('operationId' in value) || value['operationId'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('errorMessage' in value) || value['errorMessage'] === undefined) return false;
+    return true;
+}
+
+export function SseOperationFailedDataFromJSON(json: any): SseOperationFailedData {
+    return SseOperationFailedDataFromJSONTyped(json, false);
+}
+
+export function SseOperationFailedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationFailedData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobRef': json['job_ref'],
+        'operationId': json['operation_id'],
+        'type': OperationTypeFromJSON(json['type']),
+        'status': json['status'],
+        'errorCode': json['error_code'],
+        'errorMessage': json['error_message'],
+    };
+}
+
+export function SseOperationFailedDataToJSON(json: any): SseOperationFailedData {
+    return SseOperationFailedDataToJSONTyped(json, false);
+}
+
+export function SseOperationFailedDataToJSONTyped(value?: SseOperationFailedData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job_ref': value['jobRef'],
+        'operation_id': value['operationId'],
+        'type': OperationTypeToJSON(value['type']),
+        'status': value['status'],
+        'error_code': value['errorCode'],
+        'error_message': value['errorMessage'],
+    };
+}
+

package/openapi/models/SseOperationProgressData.ts

@@ -0,0 +1,103 @@
+/* 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 { OperationType } from './OperationType';
+import {
+    OperationTypeFromJSON,
+    OperationTypeFromJSONTyped,
+    OperationTypeToJSON,
+    OperationTypeToJSONTyped,
+} from './OperationType';
+
+/**
+ * Payload for `operation.progress` events
+ * @export
+ * @interface SseOperationProgressData
+ */
+export interface SseOperationProgressData {
+    /**
+     * 
+     * @type {string}
+     * @memberof SseOperationProgressData
+     */
+    jobRef: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof SseOperationProgressData
+     */
+    operationId: string;
+    /**
+     * 
+     * @type {OperationType}
+     * @memberof SseOperationProgressData
+     */
+    type: OperationType;
+    /**
+     * 
+     * @type {number}
+     * @memberof SseOperationProgressData
+     */
+    progress: number;
+}
+
+
+
+/**
+ * Check if a given object implements the SseOperationProgressData interface.
+ */
+export function instanceOfSseOperationProgressData(value: object): value is SseOperationProgressData {
+    if (!('jobRef' in value) || value['jobRef'] === undefined) return false;
+    if (!('operationId' in value) || value['operationId'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    return true;
+}
+
+export function SseOperationProgressDataFromJSON(json: any): SseOperationProgressData {
+    return SseOperationProgressDataFromJSONTyped(json, false);
+}
+
+export function SseOperationProgressDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationProgressData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobRef': json['job_ref'],
+        'operationId': json['operation_id'],
+        'type': OperationTypeFromJSON(json['type']),
+        'progress': json['progress'],
+    };
+}
+
+export function SseOperationProgressDataToJSON(json: any): SseOperationProgressData {
+    return SseOperationProgressDataToJSONTyped(json, false);
+}
+
+export function SseOperationProgressDataToJSONTyped(value?: SseOperationProgressData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'job_ref': value['jobRef'],
+        'operation_id': value['operationId'],
+        'type': OperationTypeToJSON(value['type']),
+        'progress': value['progress'],
+    };
+}
+