@giveitsmaller/contracts 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/asyncapi/ErrorCode.d.ts +18 -0
- package/dist/asyncapi/ErrorCode.js +19 -0
- package/dist/asyncapi/MergeOutputType.d.ts +8 -0
- package/dist/asyncapi/MergeOutputType.js +9 -0
- package/{asyncapi/NotificationsOperationsQueue.ts → dist/asyncapi/NotificationsOperationsQueue.d.ts} +2 -2
- package/dist/asyncapi/NotificationsOperationsQueue.js +1 -0
- package/dist/asyncapi/OperationMetrics.d.ts +11 -0
- package/dist/asyncapi/OperationMetrics.js +1 -0
- package/dist/asyncapi/OperationProgress.d.ts +12 -0
- package/dist/asyncapi/OperationProgress.js +1 -0
- package/dist/asyncapi/OperationRequest.d.ts +21 -0
- package/dist/asyncapi/OperationRequest.js +1 -0
- package/dist/asyncapi/OperationResult.d.ts +20 -0
- package/dist/asyncapi/OperationResult.js +1 -0
- package/dist/asyncapi/OperationType.d.ts +9 -0
- package/dist/asyncapi/OperationType.js +10 -0
- package/dist/asyncapi/ProgressStatus.d.ts +7 -0
- package/dist/asyncapi/ProgressStatus.js +8 -0
- package/dist/asyncapi/ResultStatus.d.ts +5 -0
- package/dist/asyncapi/ResultStatus.js +6 -0
- package/dist/asyncapi/SourceEntry.d.ts +8 -0
- package/dist/asyncapi/SourceEntry.js +1 -0
- package/dist/asyncapi/index.d.ts +11 -0
- package/dist/asyncapi/index.js +5 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +4 -0
- package/dist/openapi/index.d.ts +2 -0
- package/dist/openapi/index.js +4 -0
- package/dist/openapi/models/CallbackEventType.d.ts +32 -0
- package/{openapi/models/CallbackEventType.ts → dist/openapi/models/CallbackEventType.js} +13 -23
- package/dist/openapi/models/ContactRequest.d.ts +60 -0
- package/{openapi/models/ContactRequest.ts → dist/openapi/models/ContactRequest.js} +14 -71
- package/dist/openapi/models/ContactSubject.d.ts +34 -0
- package/{openapi/models/ContactSubject.ts → dist/openapi/models/ContactSubject.js} +13 -23
- package/dist/openapi/models/ContactValidationErrorResponse.d.ts +35 -0
- package/{openapi/models/ContactValidationErrorResponse.ts → dist/openapi/models/ContactValidationErrorResponse.js} +9 -33
- package/dist/openapi/models/ErrorEnvelope.d.ts +45 -0
- package/{openapi/models/ErrorEnvelope.ts → dist/openapi/models/ErrorEnvelope.js} +12 -44
- package/{openapi/models/ExportConfig.ts → dist/openapi/models/ExportConfig.d.ts} +12 -57
- package/dist/openapi/models/ExportConfig.js +59 -0
- package/{openapi/models/JobDefinition.ts → dist/openapi/models/JobDefinition.d.ts} +9 -33
- package/dist/openapi/models/JobDefinition.js +31 -0
- package/dist/openapi/models/JobDownload.d.ts +45 -0
- package/dist/openapi/models/JobDownload.js +52 -0
- package/{openapi/models/JobInput.ts → dist/openapi/models/JobInput.d.ts} +13 -49
- package/dist/openapi/models/JobInput.js +47 -0
- package/dist/openapi/models/JobResponse.d.ts +58 -0
- package/dist/openapi/models/JobResponse.js +61 -0
- package/{openapi/models/JobSource.ts → dist/openapi/models/JobSource.d.ts} +9 -45
- package/dist/openapi/models/JobSource.js +45 -0
- package/dist/openapi/models/JobStatus.d.ts +34 -0
- package/{openapi/models/JobStatus.ts → dist/openapi/models/JobStatus.js} +13 -23
- package/dist/openapi/models/JobType.d.ts +32 -0
- package/{openapi/models/JobType.ts → dist/openapi/models/JobType.js} +13 -23
- package/dist/openapi/models/LivenessResponse.d.ts +32 -0
- package/{openapi/models/LivenessResponse.ts → dist/openapi/models/LivenessResponse.js} +9 -32
- package/dist/openapi/models/MetadataResponse.d.ts +139 -0
- package/dist/openapi/models/MetadataResponse.js +85 -0
- package/dist/openapi/models/MetadataResponseDimensions.d.ts +38 -0
- package/{openapi/models/MetadataResponseDimensions.ts → dist/openapi/models/MetadataResponseDimensions.js} +7 -37
- package/dist/openapi/models/MetadataResponseExif.d.ts +51 -0
- package/{openapi/models/MetadataResponseExif.ts → dist/openapi/models/MetadataResponseExif.js} +8 -57
- package/dist/openapi/models/MetadataResponseExifGps.d.ts +38 -0
- package/{openapi/models/MetadataResponseExifGps.ts → dist/openapi/models/MetadataResponseExifGps.js} +7 -37
- package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/MetadataSuccessEnvelope.ts → dist/openapi/models/MetadataSuccessEnvelope.js} +13 -52
- package/dist/openapi/models/MimeGroupSchema.d.ts +49 -0
- package/{openapi/models/MimeGroupSchema.ts → dist/openapi/models/MimeGroupSchema.js} +13 -53
- package/dist/openapi/models/MultipartCompleteRequest.d.ts +41 -0
- package/dist/openapi/models/MultipartCompleteRequest.js +48 -0
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +38 -0
- package/{openapi/models/MultipartCompleteRequestPartsInner.ts → dist/openapi/models/MultipartCompleteRequestPartsInner.js} +11 -39
- package/dist/openapi/models/MultipartInitiateResponse.d.ts +78 -0
- package/dist/openapi/models/MultipartInitiateResponse.js +68 -0
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/MultipartInitiateSuccessEnvelope.ts → dist/openapi/models/MultipartInitiateSuccessEnvelope.js} +13 -52
- package/{openapi/models/OperationDefinition.ts → dist/openapi/models/OperationDefinition.d.ts} +14 -57
- package/dist/openapi/models/OperationDefinition.js +46 -0
- package/dist/openapi/models/OperationDownload.d.ts +56 -0
- package/{openapi/models/OperationDownload.ts → dist/openapi/models/OperationDownload.js} +17 -60
- package/dist/openapi/models/OperationInputModel.d.ts +28 -0
- package/{openapi/models/OperationInputModel.ts → dist/openapi/models/OperationInputModel.js} +13 -23
- package/dist/openapi/models/OperationResponse.d.ts +59 -0
- package/dist/openapi/models/OperationResponse.js +58 -0
- package/dist/openapi/models/OperationResult.d.ts +52 -0
- package/{openapi/models/OperationResult.ts → dist/openapi/models/OperationResult.js} +12 -60
- package/dist/openapi/models/OperationResultMetrics.d.ts +38 -0
- package/{openapi/models/OperationResultMetrics.ts → dist/openapi/models/OperationResultMetrics.js} +7 -37
- package/dist/openapi/models/OperationSchemaDefinition.d.ts +96 -0
- package/dist/openapi/models/OperationSchemaDefinition.js +67 -0
- package/dist/openapi/models/OperationStatus.d.ts +34 -0
- package/{openapi/models/OperationStatus.ts → dist/openapi/models/OperationStatus.js} +13 -23
- package/dist/openapi/models/OperationType.d.ts +36 -0
- package/{openapi/models/OperationType.ts → dist/openapi/models/OperationType.js} +13 -23
- package/{openapi/models/OperationsSchemaResponse.ts → dist/openapi/models/OperationsSchemaResponse.d.ts} +13 -55
- package/dist/openapi/models/OperationsSchemaResponse.js +49 -0
- package/{openapi/models/OptionSchema.ts → dist/openapi/models/OptionSchema.d.ts} +24 -76
- package/dist/openapi/models/OptionSchema.js +76 -0
- package/dist/openapi/models/PresignedUrlPart.d.ts +46 -0
- package/{openapi/models/PresignedUrlPart.ts → dist/openapi/models/PresignedUrlPart.js} +13 -48
- package/dist/openapi/models/ReadinessResponse.d.ts +38 -0
- package/{openapi/models/ReadinessResponse.ts → dist/openapi/models/ReadinessResponse.js} +7 -37
- package/dist/openapi/models/ResponseEnvelope.d.ts +36 -0
- package/{openapi/models/ResponseEnvelope.ts → dist/openapi/models/ResponseEnvelope.js} +9 -36
- package/dist/openapi/models/RetryResponse.d.ts +51 -0
- package/{openapi/models/RetryResponse.ts → dist/openapi/models/RetryResponse.js} +14 -51
- package/dist/openapi/models/RetrySuccessEnvelope.d.ts +46 -0
- package/{openapi/models/RetrySuccessEnvelope.ts → dist/openapi/models/RetrySuccessEnvelope.js} +13 -52
- package/dist/openapi/models/SseEventType.d.ts +40 -0
- package/{openapi/models/SseEventType.ts → dist/openapi/models/SseEventType.js} +13 -23
- package/{openapi/models/SseJobCompletedData.ts → dist/openapi/models/SseJobCompletedData.d.ts} +12 -55
- package/dist/openapi/models/SseJobCompletedData.js +57 -0
- package/dist/openapi/models/SseJobFailedData.d.ts +51 -0
- package/{openapi/models/SseJobFailedData.ts → dist/openapi/models/SseJobFailedData.js} +14 -51
- package/dist/openapi/models/SseOperationCompletedData.d.ts +78 -0
- package/dist/openapi/models/SseOperationCompletedData.js +75 -0
- package/dist/openapi/models/SseOperationFailedData.d.ts +70 -0
- package/dist/openapi/models/SseOperationFailedData.js +70 -0
- package/dist/openapi/models/SseOperationProgressData.d.ts +51 -0
- package/{openapi/models/SseOperationProgressData.ts → dist/openapi/models/SseOperationProgressData.js} +16 -63
- package/dist/openapi/models/SseWorkflowTerminalData.d.ts +49 -0
- package/{openapi/models/SseWorkflowTerminalData.ts → dist/openapi/models/SseWorkflowTerminalData.js} +12 -46
- package/dist/openapi/models/UploadResponse.d.ts +50 -0
- package/{openapi/models/UploadResponse.ts → dist/openapi/models/UploadResponse.js} +15 -53
- package/dist/openapi/models/UploadSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/UploadSuccessEnvelope.ts → dist/openapi/models/UploadSuccessEnvelope.js} +13 -52
- package/dist/openapi/models/ValidationErrorEnvelope.d.ts +54 -0
- package/dist/openapi/models/ValidationErrorEnvelope.js +58 -0
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +50 -0
- package/{openapi/models/ValidationErrorEnvelopeDetailsInner.ts → dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js} +9 -50
- package/dist/openapi/models/WebhookOperationContext.d.ts +40 -0
- package/{openapi/models/WebhookOperationContext.ts → dist/openapi/models/WebhookOperationContext.js} +11 -41
- package/dist/openapi/models/WebhookPayload.d.ts +66 -0
- package/dist/openapi/models/WebhookPayload.js +60 -0
- package/dist/openapi/models/WorkflowCreateRequest.d.ts +76 -0
- package/dist/openapi/models/WorkflowCreateRequest.js +55 -0
- package/dist/openapi/models/WorkflowCreateResponse.d.ts +58 -0
- package/dist/openapi/models/WorkflowCreateResponse.js +54 -0
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/WorkflowCreateSuccessEnvelope.ts → dist/openapi/models/WorkflowCreateSuccessEnvelope.js} +13 -52
- package/dist/openapi/models/WorkflowDownloadResponse.d.ts +33 -0
- package/{openapi/models/WorkflowDownloadResponse.ts → dist/openapi/models/WorkflowDownloadResponse.js} +12 -42
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/WorkflowDownloadSuccessEnvelope.ts → dist/openapi/models/WorkflowDownloadSuccessEnvelope.js} +13 -52
- package/{openapi/models/WorkflowEdge.ts → dist/openapi/models/WorkflowEdge.d.ts} +8 -45
- package/dist/openapi/models/WorkflowEdge.js +47 -0
- package/dist/openapi/models/WorkflowStatus.d.ts +34 -0
- package/{openapi/models/WorkflowStatus.ts → dist/openapi/models/WorkflowStatus.js} +13 -23
- package/dist/openapi/models/WorkflowStatusResponse.d.ts +46 -0
- package/dist/openapi/models/WorkflowStatusResponse.js +53 -0
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +46 -0
- package/{openapi/models/WorkflowStatusSuccessEnvelope.ts → dist/openapi/models/WorkflowStatusSuccessEnvelope.js} +13 -52
- package/dist/openapi/models/index.d.ts +62 -0
- package/dist/openapi/models/index.js +64 -0
- package/dist/openapi/runtime.d.ts +184 -0
- package/{openapi/runtime.ts → dist/openapi/runtime.js} +107 -206
- package/dist/operations/archive.d.ts +12 -0
- package/dist/operations/archive.js +11 -0
- package/dist/operations/compress.d.ts +154 -0
- package/dist/operations/compress.js +112 -0
- package/dist/operations/convert.d.ts +58 -0
- package/dist/operations/convert.js +46 -0
- package/dist/operations/index.d.ts +5 -0
- package/dist/operations/index.js +6 -0
- package/dist/operations/merge.d.ts +79 -0
- package/dist/operations/merge.js +46 -0
- package/dist/operations/thumbnail.d.ts +55 -0
- package/dist/operations/thumbnail.js +42 -0
- package/package.json +29 -11
- package/asyncapi/ErrorCode.ts +0 -19
- package/asyncapi/MergeOutputType.ts +0 -9
- package/asyncapi/OperationMetrics.ts +0 -12
- package/asyncapi/OperationProgress.ts +0 -12
- package/asyncapi/OperationRequest.ts +0 -21
- package/asyncapi/OperationResult.ts +0 -20
- package/asyncapi/OperationType.ts +0 -10
- package/asyncapi/ProgressStatus.ts +0 -8
- package/asyncapi/README.md +0 -16
- package/asyncapi/ResultStatus.ts +0 -6
- package/asyncapi/SourceEntry.ts +0 -9
- package/asyncapi/index.ts +0 -11
- package/index.ts +0 -5
- package/openapi/.openapi-generator-ignore +0 -26
- package/openapi/README.md +0 -17
- package/openapi/index.ts +0 -4
- package/openapi/models/JobDownload.ts +0 -92
- package/openapi/models/JobResponse.ts +0 -119
- package/openapi/models/MetadataResponse.ts +0 -223
- package/openapi/models/MultipartCompleteRequest.ts +0 -85
- package/openapi/models/MultipartInitiateResponse.ts +0 -137
- package/openapi/models/OperationResponse.ts +0 -124
- package/openapi/models/OperationSchemaDefinition.ts +0 -163
- package/openapi/models/SseOperationCompletedData.ts +0 -143
- package/openapi/models/SseOperationFailedData.ts +0 -129
- package/openapi/models/ValidationErrorEnvelope.ts +0 -104
- package/openapi/models/WebhookPayload.ts +0 -132
- package/openapi/models/WorkflowCreateRequest.ts +0 -143
- package/openapi/models/WorkflowCreateResponse.ts +0 -114
- package/openapi/models/WorkflowStatusResponse.ts +0 -101
- package/openapi/models/index.ts +0 -64
- package/operations/README.md +0 -17
- package/operations/archive.ts +0 -16
- package/operations/compress.ts +0 -177
- package/operations/convert.ts +0 -69
- package/operations/index.ts +0 -7
- package/operations/merge.ts +0 -95
- package/operations/thumbnail.ts +0 -66
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GISL Compression API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Server-Sent Event types pushed on the /events endpoint:
|
|
14
|
+
* - operation.progress: Progress update for an operation
|
|
15
|
+
* - operation.completed: Operation finished successfully
|
|
16
|
+
* - operation.failed: Operation encountered an error
|
|
17
|
+
* - job.completed: All operations in a job completed
|
|
18
|
+
* - job.failed: Job failed
|
|
19
|
+
* - workflow.completed: All jobs completed successfully
|
|
20
|
+
* - workflow.failed: All jobs finished, at least one failed
|
|
21
|
+
* - workflow.partially_failed: Some succeeded, some failed
|
|
22
|
+
*
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const SseEventType: {
|
|
26
|
+
readonly operation_progress: "operation.progress";
|
|
27
|
+
readonly operation_completed: "operation.completed";
|
|
28
|
+
readonly operation_failed: "operation.failed";
|
|
29
|
+
readonly job_completed: "job.completed";
|
|
30
|
+
readonly job_failed: "job.failed";
|
|
31
|
+
readonly workflow_completed: "workflow.completed";
|
|
32
|
+
readonly workflow_failed: "workflow.failed";
|
|
33
|
+
readonly workflow_partially_failed: "workflow.partially_failed";
|
|
34
|
+
};
|
|
35
|
+
export type SseEventType = typeof SseEventType[keyof typeof SseEventType];
|
|
36
|
+
export declare function instanceOfSseEventType(value: any): boolean;
|
|
37
|
+
export declare function SseEventTypeFromJSON(json: any): SseEventType;
|
|
38
|
+
export declare function SseEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseEventType;
|
|
39
|
+
export declare function SseEventTypeToJSON(value?: SseEventType | null): any;
|
|
40
|
+
export declare function SseEventTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SseEventType;
|
|
@@ -2,17 +2,15 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* GISL Compression API
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
|
|
15
|
-
|
|
16
14
|
/**
|
|
17
15
|
* Server-Sent Event types pushed on the /events endpoint:
|
|
18
16
|
* - operation.progress: Progress update for an operation
|
|
@@ -23,7 +21,7 @@
|
|
|
23
21
|
* - workflow.completed: All jobs completed successfully
|
|
24
22
|
* - workflow.failed: All jobs finished, at least one failed
|
|
25
23
|
* - workflow.partially_failed: Some succeeded, some failed
|
|
26
|
-
*
|
|
24
|
+
*
|
|
27
25
|
* @export
|
|
28
26
|
*/
|
|
29
27
|
export const SseEventType = {
|
|
@@ -35,34 +33,26 @@ export const SseEventType = {
|
|
|
35
33
|
workflow_completed: 'workflow.completed',
|
|
36
34
|
workflow_failed: 'workflow.failed',
|
|
37
35
|
workflow_partially_failed: 'workflow.partially_failed'
|
|
38
|
-
}
|
|
39
|
-
export
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
export function instanceOfSseEventType(value: any): boolean {
|
|
36
|
+
};
|
|
37
|
+
export function instanceOfSseEventType(value) {
|
|
43
38
|
for (const key in SseEventType) {
|
|
44
39
|
if (Object.prototype.hasOwnProperty.call(SseEventType, key)) {
|
|
45
|
-
if (SseEventType[key
|
|
40
|
+
if (SseEventType[key] === value) {
|
|
46
41
|
return true;
|
|
47
42
|
}
|
|
48
43
|
}
|
|
49
44
|
}
|
|
50
45
|
return false;
|
|
51
46
|
}
|
|
52
|
-
|
|
53
|
-
export function SseEventTypeFromJSON(json: any): SseEventType {
|
|
47
|
+
export function SseEventTypeFromJSON(json) {
|
|
54
48
|
return SseEventTypeFromJSONTyped(json, false);
|
|
55
49
|
}
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
return json as SseEventType;
|
|
50
|
+
export function SseEventTypeFromJSONTyped(json, ignoreDiscriminator) {
|
|
51
|
+
return json;
|
|
59
52
|
}
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
return value as any;
|
|
53
|
+
export function SseEventTypeToJSON(value) {
|
|
54
|
+
return value;
|
|
63
55
|
}
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
return value as SseEventType;
|
|
56
|
+
export function SseEventTypeToJSONTyped(value, ignoreDiscriminator) {
|
|
57
|
+
return value;
|
|
67
58
|
}
|
|
68
|
-
|
package/{openapi/models/SseJobCompletedData.ts → dist/openapi/models/SseJobCompletedData.d.ts}
RENAMED
|
@@ -1,18 +1,14 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
1
|
/**
|
|
4
2
|
* GISL Compression API
|
|
5
|
-
* 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.
|
|
3
|
+
* 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.
|
|
6
4
|
*
|
|
7
5
|
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
6
|
+
*
|
|
9
7
|
*
|
|
10
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
9
|
* https://openapi-generator.tech
|
|
12
10
|
* Do not edit the class manually.
|
|
13
11
|
*/
|
|
14
|
-
|
|
15
|
-
import { mapValues } from '../runtime';
|
|
16
12
|
/**
|
|
17
13
|
* Payload for `job.completed` events
|
|
18
14
|
* @export
|
|
@@ -20,7 +16,7 @@ import { mapValues } from '../runtime';
|
|
|
20
16
|
*/
|
|
21
17
|
export interface SseJobCompletedData {
|
|
22
18
|
/**
|
|
23
|
-
*
|
|
19
|
+
*
|
|
24
20
|
* @type {string}
|
|
25
21
|
* @memberof SseJobCompletedData
|
|
26
22
|
*/
|
|
@@ -32,63 +28,24 @@ export interface SseJobCompletedData {
|
|
|
32
28
|
*/
|
|
33
29
|
jobId: string;
|
|
34
30
|
/**
|
|
35
|
-
*
|
|
31
|
+
*
|
|
36
32
|
* @type {string}
|
|
37
33
|
* @memberof SseJobCompletedData
|
|
38
34
|
*/
|
|
39
35
|
status: SseJobCompletedDataStatusEnum;
|
|
40
36
|
}
|
|
41
|
-
|
|
42
|
-
|
|
43
37
|
/**
|
|
44
38
|
* @export
|
|
45
39
|
*/
|
|
46
|
-
export const SseJobCompletedDataStatusEnum
|
|
47
|
-
completed:
|
|
48
|
-
}
|
|
40
|
+
export declare const SseJobCompletedDataStatusEnum: {
|
|
41
|
+
readonly completed: "completed";
|
|
42
|
+
};
|
|
49
43
|
export type SseJobCompletedDataStatusEnum = typeof SseJobCompletedDataStatusEnum[keyof typeof SseJobCompletedDataStatusEnum];
|
|
50
|
-
|
|
51
|
-
|
|
52
44
|
/**
|
|
53
45
|
* Check if a given object implements the SseJobCompletedData interface.
|
|
54
46
|
*/
|
|
55
|
-
export function instanceOfSseJobCompletedData(value: object): value is SseJobCompletedData
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export function SseJobCompletedDataFromJSON(json: any): SseJobCompletedData {
|
|
63
|
-
return SseJobCompletedDataFromJSONTyped(json, false);
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export function SseJobCompletedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobCompletedData {
|
|
67
|
-
if (json == null) {
|
|
68
|
-
return json;
|
|
69
|
-
}
|
|
70
|
-
return {
|
|
71
|
-
|
|
72
|
-
'jobRef': json['job_ref'],
|
|
73
|
-
'jobId': json['job_id'],
|
|
74
|
-
'status': json['status'],
|
|
75
|
-
};
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export function SseJobCompletedDataToJSON(json: any): SseJobCompletedData {
|
|
79
|
-
return SseJobCompletedDataToJSONTyped(json, false);
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
export function SseJobCompletedDataToJSONTyped(value?: SseJobCompletedData | null, ignoreDiscriminator: boolean = false): any {
|
|
83
|
-
if (value == null) {
|
|
84
|
-
return value;
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
return {
|
|
88
|
-
|
|
89
|
-
'job_ref': value['jobRef'],
|
|
90
|
-
'job_id': value['jobId'],
|
|
91
|
-
'status': value['status'],
|
|
92
|
-
};
|
|
93
|
-
}
|
|
94
|
-
|
|
47
|
+
export declare function instanceOfSseJobCompletedData(value: object): value is SseJobCompletedData;
|
|
48
|
+
export declare function SseJobCompletedDataFromJSON(json: any): SseJobCompletedData;
|
|
49
|
+
export declare function SseJobCompletedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobCompletedData;
|
|
50
|
+
export declare function SseJobCompletedDataToJSON(json: any): SseJobCompletedData;
|
|
51
|
+
export declare function SseJobCompletedDataToJSONTyped(value?: SseJobCompletedData | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* GISL Compression API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const SseJobCompletedDataStatusEnum = {
|
|
18
|
+
completed: 'completed'
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Check if a given object implements the SseJobCompletedData interface.
|
|
22
|
+
*/
|
|
23
|
+
export function instanceOfSseJobCompletedData(value) {
|
|
24
|
+
if (!('jobRef' in value) || value['jobRef'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('jobId' in value) || value['jobId'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
export function SseJobCompletedDataFromJSON(json) {
|
|
33
|
+
return SseJobCompletedDataFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
export function SseJobCompletedDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'jobRef': json['job_ref'],
|
|
41
|
+
'jobId': json['job_id'],
|
|
42
|
+
'status': json['status'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
export function SseJobCompletedDataToJSON(json) {
|
|
46
|
+
return SseJobCompletedDataToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
export function SseJobCompletedDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'job_ref': value['jobRef'],
|
|
54
|
+
'job_id': value['jobId'],
|
|
55
|
+
'status': value['status'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GISL Compression API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Payload for `job.failed` events
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SseJobFailedData
|
|
16
|
+
*/
|
|
17
|
+
export interface SseJobFailedData {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SseJobFailedData
|
|
22
|
+
*/
|
|
23
|
+
jobRef: string;
|
|
24
|
+
/**
|
|
25
|
+
* UUID v7 format identifier (time-ordered)
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SseJobFailedData
|
|
28
|
+
*/
|
|
29
|
+
jobId: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SseJobFailedData
|
|
34
|
+
*/
|
|
35
|
+
status: SseJobFailedDataStatusEnum;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const SseJobFailedDataStatusEnum: {
|
|
41
|
+
readonly failed: "failed";
|
|
42
|
+
};
|
|
43
|
+
export type SseJobFailedDataStatusEnum = typeof SseJobFailedDataStatusEnum[keyof typeof SseJobFailedDataStatusEnum];
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the SseJobFailedData interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfSseJobFailedData(value: object): value is SseJobFailedData;
|
|
48
|
+
export declare function SseJobFailedDataFromJSON(json: any): SseJobFailedData;
|
|
49
|
+
export declare function SseJobFailedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobFailedData;
|
|
50
|
+
export declare function SseJobFailedDataToJSON(json: any): SseJobFailedData;
|
|
51
|
+
export declare function SseJobFailedDataToJSONTyped(value?: SseJobFailedData | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -2,93 +2,56 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* GISL Compression API
|
|
5
|
-
* 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.
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 2.0.0
|
|
8
|
-
*
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
|
|
15
|
-
import { mapValues } from '../runtime';
|
|
16
|
-
/**
|
|
17
|
-
* Payload for `job.failed` events
|
|
18
|
-
* @export
|
|
19
|
-
* @interface SseJobFailedData
|
|
20
|
-
*/
|
|
21
|
-
export interface SseJobFailedData {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof SseJobFailedData
|
|
26
|
-
*/
|
|
27
|
-
jobRef: string;
|
|
28
|
-
/**
|
|
29
|
-
* UUID v7 format identifier (time-ordered)
|
|
30
|
-
* @type {string}
|
|
31
|
-
* @memberof SseJobFailedData
|
|
32
|
-
*/
|
|
33
|
-
jobId: string;
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @type {string}
|
|
37
|
-
* @memberof SseJobFailedData
|
|
38
|
-
*/
|
|
39
|
-
status: SseJobFailedDataStatusEnum;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
|
|
43
14
|
/**
|
|
44
15
|
* @export
|
|
45
16
|
*/
|
|
46
17
|
export const SseJobFailedDataStatusEnum = {
|
|
47
18
|
failed: 'failed'
|
|
48
|
-
}
|
|
49
|
-
export type SseJobFailedDataStatusEnum = typeof SseJobFailedDataStatusEnum[keyof typeof SseJobFailedDataStatusEnum];
|
|
50
|
-
|
|
51
|
-
|
|
19
|
+
};
|
|
52
20
|
/**
|
|
53
21
|
* Check if a given object implements the SseJobFailedData interface.
|
|
54
22
|
*/
|
|
55
|
-
export function instanceOfSseJobFailedData(value
|
|
56
|
-
if (!('jobRef' in value) || value['jobRef'] === undefined)
|
|
57
|
-
|
|
58
|
-
if (!('
|
|
23
|
+
export function instanceOfSseJobFailedData(value) {
|
|
24
|
+
if (!('jobRef' in value) || value['jobRef'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('jobId' in value) || value['jobId'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
29
|
+
return false;
|
|
59
30
|
return true;
|
|
60
31
|
}
|
|
61
|
-
|
|
62
|
-
export function SseJobFailedDataFromJSON(json: any): SseJobFailedData {
|
|
32
|
+
export function SseJobFailedDataFromJSON(json) {
|
|
63
33
|
return SseJobFailedDataFromJSONTyped(json, false);
|
|
64
34
|
}
|
|
65
|
-
|
|
66
|
-
export function SseJobFailedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseJobFailedData {
|
|
35
|
+
export function SseJobFailedDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
67
36
|
if (json == null) {
|
|
68
37
|
return json;
|
|
69
38
|
}
|
|
70
39
|
return {
|
|
71
|
-
|
|
72
40
|
'jobRef': json['job_ref'],
|
|
73
41
|
'jobId': json['job_id'],
|
|
74
42
|
'status': json['status'],
|
|
75
43
|
};
|
|
76
44
|
}
|
|
77
|
-
|
|
78
|
-
export function SseJobFailedDataToJSON(json: any): SseJobFailedData {
|
|
45
|
+
export function SseJobFailedDataToJSON(json) {
|
|
79
46
|
return SseJobFailedDataToJSONTyped(json, false);
|
|
80
47
|
}
|
|
81
|
-
|
|
82
|
-
export function SseJobFailedDataToJSONTyped(value?: SseJobFailedData | null, ignoreDiscriminator: boolean = false): any {
|
|
48
|
+
export function SseJobFailedDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
83
49
|
if (value == null) {
|
|
84
50
|
return value;
|
|
85
51
|
}
|
|
86
|
-
|
|
87
52
|
return {
|
|
88
|
-
|
|
89
53
|
'job_ref': value['jobRef'],
|
|
90
54
|
'job_id': value['jobId'],
|
|
91
55
|
'status': value['status'],
|
|
92
56
|
};
|
|
93
57
|
}
|
|
94
|
-
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GISL Compression API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { OperationResult } from './OperationResult.js';
|
|
13
|
+
import type { OperationType } from './OperationType.js';
|
|
14
|
+
/**
|
|
15
|
+
* Payload for `operation.completed` events
|
|
16
|
+
* @export
|
|
17
|
+
* @interface SseOperationCompletedData
|
|
18
|
+
*/
|
|
19
|
+
export interface SseOperationCompletedData {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof SseOperationCompletedData
|
|
24
|
+
*/
|
|
25
|
+
jobRef: string;
|
|
26
|
+
/**
|
|
27
|
+
* UUID v7 format identifier (time-ordered)
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof SseOperationCompletedData
|
|
30
|
+
*/
|
|
31
|
+
operationId: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {OperationType}
|
|
35
|
+
* @memberof SseOperationCompletedData
|
|
36
|
+
*/
|
|
37
|
+
type: OperationType;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof SseOperationCompletedData
|
|
42
|
+
*/
|
|
43
|
+
status: SseOperationCompletedDataStatusEnum;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof SseOperationCompletedData
|
|
48
|
+
*/
|
|
49
|
+
progress: SseOperationCompletedDataProgressEnum;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {OperationResult}
|
|
53
|
+
* @memberof SseOperationCompletedData
|
|
54
|
+
*/
|
|
55
|
+
result?: OperationResult;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const SseOperationCompletedDataStatusEnum: {
|
|
61
|
+
readonly completed: "completed";
|
|
62
|
+
};
|
|
63
|
+
export type SseOperationCompletedDataStatusEnum = typeof SseOperationCompletedDataStatusEnum[keyof typeof SseOperationCompletedDataStatusEnum];
|
|
64
|
+
/**
|
|
65
|
+
* @export
|
|
66
|
+
*/
|
|
67
|
+
export declare const SseOperationCompletedDataProgressEnum: {
|
|
68
|
+
readonly NUMBER_100: 100;
|
|
69
|
+
};
|
|
70
|
+
export type SseOperationCompletedDataProgressEnum = typeof SseOperationCompletedDataProgressEnum[keyof typeof SseOperationCompletedDataProgressEnum];
|
|
71
|
+
/**
|
|
72
|
+
* Check if a given object implements the SseOperationCompletedData interface.
|
|
73
|
+
*/
|
|
74
|
+
export declare function instanceOfSseOperationCompletedData(value: object): value is SseOperationCompletedData;
|
|
75
|
+
export declare function SseOperationCompletedDataFromJSON(json: any): SseOperationCompletedData;
|
|
76
|
+
export declare function SseOperationCompletedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationCompletedData;
|
|
77
|
+
export declare function SseOperationCompletedDataToJSON(json: any): SseOperationCompletedData;
|
|
78
|
+
export declare function SseOperationCompletedDataToJSONTyped(value?: SseOperationCompletedData | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* GISL Compression API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { OperationResultFromJSON, OperationResultToJSON, } from './OperationResult.js';
|
|
15
|
+
import { OperationTypeFromJSON, OperationTypeToJSON, } from './OperationType.js';
|
|
16
|
+
/**
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const SseOperationCompletedDataStatusEnum = {
|
|
20
|
+
completed: 'completed'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export const SseOperationCompletedDataProgressEnum = {
|
|
26
|
+
NUMBER_100: 100
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Check if a given object implements the SseOperationCompletedData interface.
|
|
30
|
+
*/
|
|
31
|
+
export function instanceOfSseOperationCompletedData(value) {
|
|
32
|
+
if (!('jobRef' in value) || value['jobRef'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('operationId' in value) || value['operationId'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('type' in value) || value['type'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('progress' in value) || value['progress'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
export function SseOperationCompletedDataFromJSON(json) {
|
|
45
|
+
return SseOperationCompletedDataFromJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
export function SseOperationCompletedDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
48
|
+
if (json == null) {
|
|
49
|
+
return json;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'jobRef': json['job_ref'],
|
|
53
|
+
'operationId': json['operation_id'],
|
|
54
|
+
'type': OperationTypeFromJSON(json['type']),
|
|
55
|
+
'status': json['status'],
|
|
56
|
+
'progress': json['progress'],
|
|
57
|
+
'result': json['result'] == null ? undefined : OperationResultFromJSON(json['result']),
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
export function SseOperationCompletedDataToJSON(json) {
|
|
61
|
+
return SseOperationCompletedDataToJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
export function SseOperationCompletedDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
return {
|
|
68
|
+
'job_ref': value['jobRef'],
|
|
69
|
+
'operation_id': value['operationId'],
|
|
70
|
+
'type': OperationTypeToJSON(value['type']),
|
|
71
|
+
'status': value['status'],
|
|
72
|
+
'progress': value['progress'],
|
|
73
|
+
'result': OperationResultToJSON(value['result']),
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GISL Compression API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { OperationType } from './OperationType.js';
|
|
13
|
+
/**
|
|
14
|
+
* Payload for `operation.failed` events
|
|
15
|
+
* @export
|
|
16
|
+
* @interface SseOperationFailedData
|
|
17
|
+
*/
|
|
18
|
+
export interface SseOperationFailedData {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof SseOperationFailedData
|
|
23
|
+
*/
|
|
24
|
+
jobRef: string;
|
|
25
|
+
/**
|
|
26
|
+
* UUID v7 format identifier (time-ordered)
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof SseOperationFailedData
|
|
29
|
+
*/
|
|
30
|
+
operationId: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {OperationType}
|
|
34
|
+
* @memberof SseOperationFailedData
|
|
35
|
+
*/
|
|
36
|
+
type: OperationType;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SseOperationFailedData
|
|
41
|
+
*/
|
|
42
|
+
status: SseOperationFailedDataStatusEnum;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof SseOperationFailedData
|
|
47
|
+
*/
|
|
48
|
+
errorCode: string;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof SseOperationFailedData
|
|
53
|
+
*/
|
|
54
|
+
errorMessage: string;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @export
|
|
58
|
+
*/
|
|
59
|
+
export declare const SseOperationFailedDataStatusEnum: {
|
|
60
|
+
readonly failed: "failed";
|
|
61
|
+
};
|
|
62
|
+
export type SseOperationFailedDataStatusEnum = typeof SseOperationFailedDataStatusEnum[keyof typeof SseOperationFailedDataStatusEnum];
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the SseOperationFailedData interface.
|
|
65
|
+
*/
|
|
66
|
+
export declare function instanceOfSseOperationFailedData(value: object): value is SseOperationFailedData;
|
|
67
|
+
export declare function SseOperationFailedDataFromJSON(json: any): SseOperationFailedData;
|
|
68
|
+
export declare function SseOperationFailedDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationFailedData;
|
|
69
|
+
export declare function SseOperationFailedDataToJSON(json: any): SseOperationFailedData;
|
|
70
|
+
export declare function SseOperationFailedDataToJSONTyped(value?: SseOperationFailedData | null, ignoreDiscriminator?: boolean): any;
|