@giveitsmaller/contracts 0.1.0

package/openapi/models/ExportConfig.ts

@@ -0,0 +1,108 @@
+/* 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 configuration. When set, all operation outputs are copied to the
+ * customer's destination in addition to GISL's own S3 storage.
+ * Currently supports AWS S3 via cross-account AssumeRole.
+ * 
+ * @export
+ * @interface ExportConfig
+ */
+export interface ExportConfig {
+    /**
+     * Destination service
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    service: ExportConfigServiceEnum;
+    /**
+     * Destination bucket name
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    bucket: string;
+    /**
+     * Key prefix for exported files
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    keyPrefix?: string;
+    /**
+     * IAM role ARN in the customer's AWS account. GISL's Lambda assumes this
+     * role to write to the customer's bucket. The customer must configure a
+     * trust policy allowing GISL's execution role to assume it.
+     * 
+     * @type {string}
+     * @memberof ExportConfig
+     */
+    roleArn: string;
+}
+
+
+/**
+ * @export
+ */
+export const ExportConfigServiceEnum = {
+    s3: 's3'
+} as const;
+export type ExportConfigServiceEnum = typeof ExportConfigServiceEnum[keyof typeof ExportConfigServiceEnum];
+
+
+/**
+ * Check if a given object implements the ExportConfig interface.
+ */
+export function instanceOfExportConfig(value: object): value is ExportConfig {
+    if (!('service' in value) || value['service'] === undefined) return false;
+    if (!('bucket' in value) || value['bucket'] === undefined) return false;
+    if (!('roleArn' in value) || value['roleArn'] === undefined) return false;
+    return true;
+}
+
+export function ExportConfigFromJSON(json: any): ExportConfig {
+    return ExportConfigFromJSONTyped(json, false);
+}
+
+export function ExportConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'service': json['service'],
+        'bucket': json['bucket'],
+        'keyPrefix': json['key_prefix'] == null ? undefined : json['key_prefix'],
+        'roleArn': json['role_arn'],
+    };
+}
+
+export function ExportConfigToJSON(json: any): ExportConfig {
+    return ExportConfigToJSONTyped(json, false);
+}
+
+export function ExportConfigToJSONTyped(value?: ExportConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'service': value['service'],
+        'bucket': value['bucket'],
+        'key_prefix': value['keyPrefix'],
+        'role_arn': value['roleArn'],
+    };
+}
+

package/openapi/models/JobDefinition.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.
+ */
+
+/**
+ * @type JobDefinition
+ * A job within a workflow. Each job must have exactly one source:
+ * - `file_id`: Direct reference to an uploaded file
+ * - `source`: Reference another job's output (single-input downstream)
+ * - `inputs`: Reference multiple job outputs (multi-input: merge/archive)
+ * 
+ * Future versions will add `url` and `import` source types for external
+ * file references (V2).
+ * 
+ * For single-input jobs with `file_id`, `operations` defaults to
+ * `[{ "type": "compress" }]` if omitted. Multi-input jobs must specify
+ * operations explicitly.
+ * 
+ * @export
+ */
+export type JobDefinition = any;
+
+export function JobDefinitionFromJSON(json: any): JobDefinition {
+    return JobDefinitionFromJSONTyped(json, false);
+}
+
+export function JobDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobDefinition {
+    if (json == null) {
+        return json;
+    }
+
+    return {} as any;
+}
+
+export function JobDefinitionToJSON(json: any): any {
+    return JobDefinitionToJSONTyped(json, false);
+}
+
+export function JobDefinitionToJSONTyped(value?: JobDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {};
+}
+

package/openapi/models/JobDownload.ts

@@ -0,0 +1,92 @@
+/* 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 { OperationDownload } from './OperationDownload';
+import {
+    OperationDownloadFromJSON,
+    OperationDownloadFromJSONTyped,
+    OperationDownloadToJSON,
+    OperationDownloadToJSONTyped,
+} from './OperationDownload';
+
+/**
+ * 
+ * @export
+ * @interface JobDownload
+ */
+export interface JobDownload {
+    /**
+     * Job reference label
+     * @type {string}
+     * @memberof JobDownload
+     */
+    ref: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof JobDownload
+     */
+    jobId: string;
+    /**
+     * 
+     * @type {Array<OperationDownload>}
+     * @memberof JobDownload
+     */
+    files: Array<OperationDownload>;
+}
+
+/**
+ * Check if a given object implements the JobDownload interface.
+ */
+export function instanceOfJobDownload(value: object): value is JobDownload {
+    if (!('ref' in value) || value['ref'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    if (!('files' in value) || value['files'] === undefined) return false;
+    return true;
+}
+
+export function JobDownloadFromJSON(json: any): JobDownload {
+    return JobDownloadFromJSONTyped(json, false);
+}
+
+export function JobDownloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobDownload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ref': json['ref'],
+        'jobId': json['job_id'],
+        'files': ((json['files'] as Array<any>).map(OperationDownloadFromJSON)),
+    };
+}
+
+export function JobDownloadToJSON(json: any): JobDownload {
+    return JobDownloadToJSONTyped(json, false);
+}
+
+export function JobDownloadToJSONTyped(value?: JobDownload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ref': value['ref'],
+        'job_id': value['jobId'],
+        'files': ((value['files'] as Array<any>).map(OperationDownloadToJSON)),
+    };
+}
+

package/openapi/models/JobInput.ts

@@ -0,0 +1,89 @@
+/* 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';
+/**
+ * Single input reference for multi-input operations. Each references a
+ * specific job and optionally a specific operation output from that job.
+ * 
+ * @export
+ * @interface JobInput
+ */
+export interface JobInput {
+    /**
+     * Reference label of the upstream job
+     * @type {string}
+     * @memberof JobInput
+     */
+    ref: string;
+    /**
+     * Specific operation output to use. If omitted, uses the last
+     * operation's output.
+     * 
+     * @type {string}
+     * @memberof JobInput
+     */
+    operation?: string;
+    /**
+     * Per-input option overrides. For merge operations, individual inputs
+     * can override global transition settings for the join point preceding
+     * this input. Keys are option names, values are the override values.
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof JobInput
+     */
+    perInputOptions?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the JobInput interface.
+ */
+export function instanceOfJobInput(value: object): value is JobInput {
+    if (!('ref' in value) || value['ref'] === undefined) return false;
+    return true;
+}
+
+export function JobInputFromJSON(json: any): JobInput {
+    return JobInputFromJSONTyped(json, false);
+}
+
+export function JobInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ref': json['ref'],
+        'operation': json['operation'] == null ? undefined : json['operation'],
+        'perInputOptions': json['per_input_options'] == null ? undefined : json['per_input_options'],
+    };
+}
+
+export function JobInputToJSON(json: any): JobInput {
+    return JobInputToJSONTyped(json, false);
+}
+
+export function JobInputToJSONTyped(value?: JobInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ref': value['ref'],
+        'operation': value['operation'],
+        'per_input_options': value['perInputOptions'],
+    };
+}
+

package/openapi/models/JobResponse.ts

@@ -0,0 +1,119 @@
+/* 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 { JobStatus } from './JobStatus';
+import {
+    JobStatusFromJSON,
+    JobStatusFromJSONTyped,
+    JobStatusToJSON,
+    JobStatusToJSONTyped,
+} from './JobStatus';
+import type { OperationResponse } from './OperationResponse';
+import {
+    OperationResponseFromJSON,
+    OperationResponseFromJSONTyped,
+    OperationResponseToJSON,
+    OperationResponseToJSONTyped,
+} from './OperationResponse';
+
+/**
+ * Job status within a workflow response
+ * @export
+ * @interface JobResponse
+ */
+export interface JobResponse {
+    /**
+     * Job reference label
+     * @type {string}
+     * @memberof JobResponse
+     */
+    ref: string;
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof JobResponse
+     */
+    jobId: string;
+    /**
+     * 
+     * @type {JobStatus}
+     * @memberof JobResponse
+     */
+    status: JobStatus;
+    /**
+     * List of upstream job refs this job depends on
+     * @type {Array<string>}
+     * @memberof JobResponse
+     */
+    dependsOn: Array<string>;
+    /**
+     * 
+     * @type {Array<OperationResponse>}
+     * @memberof JobResponse
+     */
+    operations: Array<OperationResponse>;
+}
+
+
+
+/**
+ * Check if a given object implements the JobResponse interface.
+ */
+export function instanceOfJobResponse(value: object): value is JobResponse {
+    if (!('ref' in value) || value['ref'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('dependsOn' in value) || value['dependsOn'] === undefined) return false;
+    if (!('operations' in value) || value['operations'] === undefined) return false;
+    return true;
+}
+
+export function JobResponseFromJSON(json: any): JobResponse {
+    return JobResponseFromJSONTyped(json, false);
+}
+
+export function JobResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ref': json['ref'],
+        'jobId': json['job_id'],
+        'status': JobStatusFromJSON(json['status']),
+        'dependsOn': json['depends_on'],
+        'operations': ((json['operations'] as Array<any>).map(OperationResponseFromJSON)),
+    };
+}
+
+export function JobResponseToJSON(json: any): JobResponse {
+    return JobResponseToJSONTyped(json, false);
+}
+
+export function JobResponseToJSONTyped(value?: JobResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ref': value['ref'],
+        'job_id': value['jobId'],
+        'status': JobStatusToJSON(value['status']),
+        'depends_on': value['dependsOn'],
+        'operations': ((value['operations'] as Array<any>).map(OperationResponseToJSON)),
+    };
+}
+

package/openapi/models/JobSource.ts

@@ -0,0 +1,79 @@
+/* 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';
+/**
+ * Reference to another job's output for single-input downstream jobs.
+ * The input is the referenced job's output, resolved via the incoming
+ * workflow edge.
+ * 
+ * @export
+ * @interface JobSource
+ */
+export interface JobSource {
+    /**
+     * Reference label of the upstream job
+     * @type {string}
+     * @memberof JobSource
+     */
+    ref: string;
+    /**
+     * Specific operation output to use from the upstream job.
+     * If omitted, uses the last operation's output.
+     * 
+     * @type {string}
+     * @memberof JobSource
+     */
+    operation?: string;
+}
+
+/**
+ * Check if a given object implements the JobSource interface.
+ */
+export function instanceOfJobSource(value: object): value is JobSource {
+    if (!('ref' in value) || value['ref'] === undefined) return false;
+    return true;
+}
+
+export function JobSourceFromJSON(json: any): JobSource {
+    return JobSourceFromJSONTyped(json, false);
+}
+
+export function JobSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobSource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ref': json['ref'],
+        'operation': json['operation'] == null ? undefined : json['operation'],
+    };
+}
+
+export function JobSourceToJSON(json: any): JobSource {
+    return JobSourceToJSONTyped(json, false);
+}
+
+export function JobSourceToJSONTyped(value?: JobSource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ref': value['ref'],
+        'operation': value['operation'],
+    };
+}
+

package/openapi/models/JobStatus.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.
+ */
+
+
+/**
+ * Job lifecycle status:
+ * - pending: Created, waiting to be scheduled
+ * - waiting: Blocked by upstream job dependencies (workflow_edges)
+ * - in_progress: At least one operation is running
+ * - completed: All operations completed successfully
+ * - failed: Job failed (at least one operation failed)
+ * 
+ * @export
+ */
+export const JobStatus = {
+    pending: 'pending',
+    waiting: 'waiting',
+    in_progress: 'in_progress',
+    completed: 'completed',
+    failed: 'failed'
+} as const;
+export type JobStatus = typeof JobStatus[keyof typeof JobStatus];
+
+
+export function instanceOfJobStatus(value: any): boolean {
+    for (const key in JobStatus) {
+        if (Object.prototype.hasOwnProperty.call(JobStatus, key)) {
+            if (JobStatus[key as keyof typeof JobStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobStatusFromJSON(json: any): JobStatus {
+    return JobStatusFromJSONTyped(json, false);
+}
+
+export function JobStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobStatus {
+    return json as JobStatus;
+}
+
+export function JobStatusToJSON(value?: JobStatus | null): any {
+    return value as any;
+}
+
+export function JobStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): JobStatus {
+    return value as JobStatus;
+}
+

package/openapi/models/JobType.ts

@@ -0,0 +1,60 @@
+/* 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.
+ */
+
+
+/**
+ * Media type category derived from MIME type. Used for SNS routing:
+ * - image/* -> image
+ * - video/* -> video
+ * - audio/* -> audio
+ * - document types -> document (PDF, DOCX, XLSX, PPTX, ODT, ODS, ODP, EPUB)
+ * 
+ * @export
+ */
+export const JobType = {
+    image: 'image',
+    video: 'video',
+    audio: 'audio',
+    document: 'document'
+} as const;
+export type JobType = typeof JobType[keyof typeof JobType];
+
+
+export function instanceOfJobType(value: any): boolean {
+    for (const key in JobType) {
+        if (Object.prototype.hasOwnProperty.call(JobType, key)) {
+            if (JobType[key as keyof typeof JobType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobTypeFromJSON(json: any): JobType {
+    return JobTypeFromJSONTyped(json, false);
+}
+
+export function JobTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobType {
+    return json as JobType;
+}
+
+export function JobTypeToJSON(value?: JobType | null): any {
+    return value as any;
+}
+
+export function JobTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): JobType {
+    return value as JobType;
+}
+