@giveitsmaller/contracts 0.2.0 → 0.2.3

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

@@ -21,7 +21,7 @@ export interface MultipartCompleteRequest {
      * @type {string}
      * @memberof MultipartCompleteRequest
      */
-    fileId: string;
+    uploadId: string;
     /**
      * ETags for parts 2 through total_parts, collected from S3 PUT responses.
      * Part 1 ETag is already known from the initiate step.

package/dist/openapi/models/MultipartCompleteRequest.js

@@ -16,7 +16,7 @@ import { MultipartCompleteRequestPartsInnerFromJSON, MultipartCompleteRequestPar
  * Check if a given object implements the MultipartCompleteRequest interface.
  */
 export function instanceOfMultipartCompleteRequest(value) {
-    if (!('fileId' in value) || value['fileId'] === undefined)
+    if (!('uploadId' in value) || value['uploadId'] === undefined)
         return false;
     if (!('parts' in value) || value['parts'] === undefined)
         return false;
@@ -30,7 +30,7 @@ export function MultipartCompleteRequestFromJSONTyped(json, ignoreDiscriminator)
         return json;
     }
     return {
-        'fileId': json['file_id'],
+        'uploadId': json['upload_id'],
         'parts': (json['parts'].map(MultipartCompleteRequestPartsInnerFromJSON)),
     };
 }
@@ -42,7 +42,7 @@ export function MultipartCompleteRequestToJSONTyped(value, ignoreDiscriminator =
         return value;
     }
     return {
-        'file_id': value['fileId'],
+        'upload_id': value['uploadId'],
         'parts': (value['parts'].map(MultipartCompleteRequestPartsInnerToJSON)),
     };
 }

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

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * Result of finalising a multipart upload. Intentionally narrower than
+ * `UploadResponse` (single-upload shape) — the server returns only the
+ * finalised `upload_id` and a completion status. Clients who need file
+ * metadata (original name, MIME type, size) can use the values captured
+ * during initiate, or call `GET /api/uploads/{id}/metadata`.
+ *
+ * @export
+ * @interface MultipartCompleteResponse
+ */
+export interface MultipartCompleteResponse {
+    /**
+     * UUID v7 format identifier (time-ordered)
+     * @type {string}
+     * @memberof MultipartCompleteResponse
+     */
+    uploadId: string;
+    /**
+     * Terminal status of the multipart upload session.
+     * @type {string}
+     * @memberof MultipartCompleteResponse
+     */
+    status: MultipartCompleteResponseStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const MultipartCompleteResponseStatusEnum: {
+    readonly completed: "completed";
+};
+export type MultipartCompleteResponseStatusEnum = typeof MultipartCompleteResponseStatusEnum[keyof typeof MultipartCompleteResponseStatusEnum];
+/**
+ * Check if a given object implements the MultipartCompleteResponse interface.
+ */
+export declare function instanceOfMultipartCompleteResponse(value: object): value is MultipartCompleteResponse;
+export declare function MultipartCompleteResponseFromJSON(json: any): MultipartCompleteResponse;
+export declare function MultipartCompleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MultipartCompleteResponse;
+export declare function MultipartCompleteResponseToJSON(json: any): MultipartCompleteResponse;
+export declare function MultipartCompleteResponseToJSONTyped(value?: MultipartCompleteResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/MultipartCompleteResponse.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const MultipartCompleteResponseStatusEnum = {
+    completed: 'completed'
+};
+/**
+ * Check if a given object implements the MultipartCompleteResponse interface.
+ */
+export function instanceOfMultipartCompleteResponse(value) {
+    if (!('uploadId' in value) || value['uploadId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function MultipartCompleteResponseFromJSON(json) {
+    return MultipartCompleteResponseFromJSONTyped(json, false);
+}
+export function MultipartCompleteResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'uploadId': json['upload_id'],
+        'status': json['status'],
+    };
+}
+export function MultipartCompleteResponseToJSON(json) {
+    return MultipartCompleteResponseToJSONTyped(json, false);
+}
+export function MultipartCompleteResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'upload_id': value['uploadId'],
+        'status': value['status'],
+    };
+}

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

@@ -0,0 +1,46 @@
+/**
+ * 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 type { MultipartCompleteResponse } from './MultipartCompleteResponse.js';
+/**
+ *
+ * @export
+ * @interface MultipartCompleteSuccessEnvelope
+ */
+export interface MultipartCompleteSuccessEnvelope {
+    /**
+     *
+     * @type {boolean}
+     * @memberof MultipartCompleteSuccessEnvelope
+     */
+    success: MultipartCompleteSuccessEnvelopeSuccessEnum;
+    /**
+     *
+     * @type {MultipartCompleteResponse}
+     * @memberof MultipartCompleteSuccessEnvelope
+     */
+    data: MultipartCompleteResponse;
+}
+/**
+ * @export
+ */
+export declare const MultipartCompleteSuccessEnvelopeSuccessEnum: {
+    readonly true: true;
+};
+export type MultipartCompleteSuccessEnvelopeSuccessEnum = typeof MultipartCompleteSuccessEnvelopeSuccessEnum[keyof typeof MultipartCompleteSuccessEnvelopeSuccessEnum];
+/**
+ * Check if a given object implements the MultipartCompleteSuccessEnvelope interface.
+ */
+export declare function instanceOfMultipartCompleteSuccessEnvelope(value: object): value is MultipartCompleteSuccessEnvelope;
+export declare function MultipartCompleteSuccessEnvelopeFromJSON(json: any): MultipartCompleteSuccessEnvelope;
+export declare function MultipartCompleteSuccessEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MultipartCompleteSuccessEnvelope;
+export declare function MultipartCompleteSuccessEnvelopeToJSON(json: any): MultipartCompleteSuccessEnvelope;
+export declare function MultipartCompleteSuccessEnvelopeToJSONTyped(value?: MultipartCompleteSuccessEnvelope | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js

@@ -0,0 +1,54 @@
+/* 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 { MultipartCompleteResponseFromJSON, MultipartCompleteResponseToJSON, } from './MultipartCompleteResponse.js';
+/**
+ * @export
+ */
+export const MultipartCompleteSuccessEnvelopeSuccessEnum = {
+    true: true
+};
+/**
+ * Check if a given object implements the MultipartCompleteSuccessEnvelope interface.
+ */
+export function instanceOfMultipartCompleteSuccessEnvelope(value) {
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function MultipartCompleteSuccessEnvelopeFromJSON(json) {
+    return MultipartCompleteSuccessEnvelopeFromJSONTyped(json, false);
+}
+export function MultipartCompleteSuccessEnvelopeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'success': json['success'],
+        'data': MultipartCompleteResponseFromJSON(json['data']),
+    };
+}
+export function MultipartCompleteSuccessEnvelopeToJSON(json) {
+    return MultipartCompleteSuccessEnvelopeToJSONTyped(json, false);
+}
+export function MultipartCompleteSuccessEnvelopeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'success': value['success'],
+        'data': MultipartCompleteResponseToJSON(value['data']),
+    };
+}

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

@@ -21,7 +21,7 @@ export interface MultipartInitiateResponse {
      * @type {string}
      * @memberof MultipartInitiateResponse
      */
-    fileId: string;
+    uploadId: string;
     /**
      * MIME type detected from the first chunk
      * @type {string}

package/dist/openapi/models/MultipartInitiateResponse.js

@@ -16,7 +16,7 @@ import { PresignedUrlPartFromJSON, PresignedUrlPartToJSON, } from './PresignedUr
  * Check if a given object implements the MultipartInitiateResponse interface.
  */
 export function instanceOfMultipartInitiateResponse(value) {
-    if (!('fileId' in value) || value['fileId'] === undefined)
+    if (!('uploadId' in value) || value['uploadId'] === undefined)
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
         return false;
@@ -40,7 +40,7 @@ export function MultipartInitiateResponseFromJSONTyped(json, ignoreDiscriminator
         return json;
     }
     return {
-        'fileId': json['file_id'],
+        'uploadId': json['upload_id'],
         'mimeType': json['mime_type'],
         'firstChunkEtag': json['first_chunk_etag'],
         'firstChunkSizeBytes': json['first_chunk_size_bytes'],
@@ -57,7 +57,7 @@ export function MultipartInitiateResponseToJSONTyped(value, ignoreDiscriminator
         return value;
     }
     return {
-        'file_id': value['fileId'],
+        'upload_id': value['uploadId'],
         'mime_type': value['mimeType'],
         'first_chunk_etag': value['firstChunkEtag'],
         'first_chunk_size_bytes': value['firstChunkSizeBytes'],

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

@@ -20,6 +20,8 @@ export * from './MetadataSuccessEnvelope.js';
 export * from './MimeGroupSchema.js';
 export * from './MultipartCompleteRequest.js';
 export * from './MultipartCompleteRequestPartsInner.js';
+export * from './MultipartCompleteResponse.js';
+export * from './MultipartCompleteSuccessEnvelope.js';
 export * from './MultipartInitiateResponse.js';
 export * from './MultipartInitiateSuccessEnvelope.js';
 export * from './OperationDefinition.js';

package/dist/openapi/models/index.js

@@ -22,6 +22,8 @@ export * from './MetadataSuccessEnvelope.js';
 export * from './MimeGroupSchema.js';
 export * from './MultipartCompleteRequest.js';
 export * from './MultipartCompleteRequestPartsInner.js';
+export * from './MultipartCompleteResponse.js';
+export * from './MultipartCompleteSuccessEnvelope.js';
 export * from './MultipartInitiateResponse.js';
 export * from './MultipartInitiateSuccessEnvelope.js';
 export * from './OperationDefinition.js';