@giveitsmaller/contracts 0.2.0 → 0.3.0
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/asyncapi/events.yaml +3617 -0
- package/availability/availability.json +2403 -0
- package/dist/asyncapi/AnonymousSchema_13.d.ts +6 -0
- package/dist/asyncapi/AnonymousSchema_13.js +7 -0
- package/dist/asyncapi/AnonymousSchema_152.d.ts +5 -0
- package/dist/asyncapi/AnonymousSchema_152.js +6 -0
- package/dist/asyncapi/Failure.d.ts +25 -0
- package/dist/asyncapi/Failure.js +1 -0
- package/dist/asyncapi/JobInputRole.d.ts +6 -0
- package/dist/asyncapi/JobInputRole.js +7 -0
- package/dist/asyncapi/MergeOutputType.d.ts +1 -3
- package/dist/asyncapi/MergeOutputType.js +0 -2
- package/dist/asyncapi/MultiOutputCompletion.d.ts +25 -0
- package/dist/asyncapi/MultiOutputCompletion.js +1 -0
- package/dist/asyncapi/NotificationsOperationsQueue.d.ts +4 -2
- package/dist/asyncapi/OperationMetrics.d.ts +3 -0
- package/dist/asyncapi/OperationProgress.d.ts +2 -0
- package/dist/asyncapi/OperationResult.d.ts +4 -19
- package/dist/asyncapi/OperationType.d.ts +6 -6
- package/dist/asyncapi/OperationType.js +5 -5
- package/dist/asyncapi/PageIndexed.d.ts +8 -0
- package/dist/asyncapi/PageIndexed.js +1 -0
- package/dist/asyncapi/PositionIndexed.d.ts +8 -0
- package/dist/asyncapi/PositionIndexed.js +1 -0
- package/dist/asyncapi/ProgressStatus.d.ts +3 -0
- package/dist/asyncapi/ProgressStatus.js +3 -0
- package/dist/asyncapi/ReEncodeDecision.d.ts +5 -0
- package/dist/asyncapi/ReEncodeDecision.js +6 -0
- package/dist/asyncapi/SingleOutputCompletion.d.ts +25 -0
- package/dist/asyncapi/SingleOutputCompletion.js +1 -0
- package/dist/asyncapi/SourceEntry.d.ts +2 -1
- package/dist/asyncapi/Unindexed.d.ts +8 -0
- package/dist/asyncapi/Unindexed.js +1 -0
- package/dist/asyncapi/UploadProbeCompletion.d.ts +16 -0
- package/dist/asyncapi/UploadProbeCompletion.js +1 -0
- package/dist/asyncapi/UploadProbeMediaMetadata.d.ts +18 -0
- package/dist/asyncapi/UploadProbeMediaMetadata.js +1 -0
- package/dist/asyncapi/UploadProbeProcessingClass.d.ts +6 -0
- package/dist/asyncapi/UploadProbeProcessingClass.js +7 -0
- package/dist/asyncapi/UploadProbeRequest.d.ts +10 -0
- package/dist/asyncapi/UploadProbeRequest.js +1 -0
- package/dist/asyncapi/UploadProbeStatus.d.ts +7 -0
- package/dist/asyncapi/UploadProbeStatus.js +8 -0
- package/dist/asyncapi/index.d.ts +13 -0
- package/dist/asyncapi/index.js +4 -0
- package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +64 -0
- package/dist/openapi/models/AudioWatermarkDecodeRequest.js +53 -0
- package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +80 -0
- package/dist/openapi/models/AudioWatermarkDecodeResponse.js +64 -0
- package/dist/openapi/models/AuthErrorResponse.d.ts +116 -0
- package/dist/openapi/models/AuthErrorResponse.js +66 -0
- package/dist/openapi/models/AuthErrorType.d.ts +73 -0
- package/dist/openapi/models/AuthErrorType.js +91 -0
- package/dist/openapi/models/AvailabilityValue.d.ts +43 -0
- package/dist/openapi/models/AvailabilityValue.js +61 -0
- package/dist/openapi/models/BalanceExhaustedResponse.d.ts +157 -0
- package/dist/openapi/models/BalanceExhaustedResponse.js +86 -0
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +38 -0
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +43 -0
- package/dist/openapi/models/CallbackEventType.d.ts +2 -2
- package/dist/openapi/models/CallbackEventType.js +2 -2
- package/dist/openapi/models/ConnectionSource.d.ts +64 -0
- package/dist/openapi/models/ConnectionSource.js +57 -0
- package/dist/openapi/models/ContactRequest.d.ts +2 -2
- package/dist/openapi/models/ContactRequest.js +2 -2
- package/dist/openapi/models/ContactSubject.d.ts +2 -2
- package/dist/openapi/models/ContactSubject.js +2 -2
- package/dist/openapi/models/ContactValidationErrorResponse.d.ts +2 -2
- package/dist/openapi/models/ContactValidationErrorResponse.js +2 -2
- package/dist/openapi/models/CreateExternalImport403Response.d.ts +24 -0
- package/dist/openapi/models/CreateExternalImport403Response.js +58 -0
- package/dist/openapi/models/CreateWorkflow422Response.d.ts +23 -0
- package/dist/openapi/models/CreateWorkflow422Response.js +51 -0
- package/dist/openapi/models/CreditTransaction.d.ts +186 -0
- package/dist/openapi/models/CreditTransaction.js +100 -0
- package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +46 -0
- package/dist/openapi/models/CreditTransactionSourceBucket.js +64 -0
- package/dist/openapi/models/CreditsBalanceResponse.d.ts +84 -0
- package/dist/openapi/models/CreditsBalanceResponse.js +68 -0
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +54 -0
- package/dist/openapi/models/CreditsUsageResponse.d.ts +51 -0
- package/dist/openapi/models/CreditsUsageResponse.js +56 -0
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +54 -0
- package/dist/openapi/models/Delivery.d.ts +98 -0
- package/dist/openapi/models/Delivery.js +65 -0
- package/dist/openapi/models/DeliveryOutputRef.d.ts +44 -0
- package/dist/openapi/models/DeliveryOutputRef.js +45 -0
- package/dist/openapi/models/DeliveryPlan.d.ts +77 -0
- package/dist/openapi/models/DeliveryPlan.js +72 -0
- package/dist/openapi/models/DeliveryPlanOutput.d.ts +53 -0
- package/dist/openapi/models/DeliveryPlanOutput.js +52 -0
- package/dist/openapi/models/DeliveryPlanReason.d.ts +35 -0
- package/dist/openapi/models/DeliveryPlanReason.js +53 -0
- package/dist/openapi/models/DeliverySelection.d.ts +62 -0
- package/dist/openapi/models/DeliverySelection.js +54 -0
- package/dist/openapi/models/ErrorEnvelope.d.ts +83 -5
- package/dist/openapi/models/ErrorEnvelope.js +10 -2
- package/dist/openapi/models/EstimateQuality.d.ts +34 -0
- package/dist/openapi/models/EstimateQuality.js +52 -0
- package/dist/openapi/models/EstimateRange.d.ts +48 -0
- package/dist/openapi/models/EstimateRange.js +51 -0
- package/dist/openapi/models/ExternalDestination.d.ts +41 -0
- package/dist/openapi/models/ExternalDestination.js +47 -0
- package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +49 -0
- package/dist/openapi/models/ExternalImportCreatedResponse.js +51 -0
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +54 -0
- package/dist/openapi/models/ExternalImportRequest.d.ts +92 -0
- package/dist/openapi/models/ExternalImportRequest.js +61 -0
- package/dist/openapi/models/ExternalImportToken.d.ts +51 -0
- package/dist/openapi/models/ExternalImportToken.js +53 -0
- package/dist/openapi/models/ExternalSource.d.ts +31 -0
- package/dist/openapi/models/ExternalSource.js +47 -0
- package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +140 -0
- package/dist/openapi/models/FeatureNotAvailableResponse.js +76 -0
- package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +135 -0
- package/dist/openapi/models/FeatureTierRestrictedResponse.js +76 -0
- package/dist/openapi/models/FeatureViolation.d.ts +108 -0
- package/dist/openapi/models/FeatureViolation.js +63 -0
- package/dist/openapi/models/JobDefinition.d.ts +125 -14
- package/dist/openapi/models/JobDefinition.js +25 -4
- package/dist/openapi/models/JobDownload.d.ts +2 -2
- package/dist/openapi/models/JobDownload.js +2 -2
- package/dist/openapi/models/JobInputV2.d.ts +89 -0
- package/dist/openapi/models/JobInputV2.js +56 -0
- package/dist/openapi/models/JobOutputSource.d.ts +57 -0
- package/dist/openapi/models/JobOutputSource.js +55 -0
- package/dist/openapi/models/JobResponse.d.ts +2 -2
- package/dist/openapi/models/JobResponse.js +2 -2
- package/dist/openapi/models/JobStatus.d.ts +17 -8
- package/dist/openapi/models/JobStatus.js +17 -8
- package/dist/openapi/models/JobType.d.ts +2 -2
- package/dist/openapi/models/JobType.js +2 -2
- package/dist/openapi/models/LivenessResponse.d.ts +2 -2
- package/dist/openapi/models/LivenessResponse.js +2 -2
- package/dist/openapi/models/LoginUser200Response.d.ts +46 -0
- package/dist/openapi/models/LoginUser200Response.js +54 -0
- package/dist/openapi/models/LoginUser200ResponseData.d.ts +33 -0
- package/dist/openapi/models/LoginUser200ResponseData.js +44 -0
- package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +50 -0
- package/dist/openapi/models/LoginUser200ResponseDataUser.js +51 -0
- package/dist/openapi/models/LoginUserRequest.d.ts +38 -0
- package/dist/openapi/models/LoginUserRequest.js +47 -0
- package/dist/openapi/models/LogoutUser200Response.d.ts +50 -0
- package/dist/openapi/models/LogoutUser200Response.js +53 -0
- package/dist/openapi/models/MetadataResponse.d.ts +13 -2
- package/dist/openapi/models/MetadataResponse.js +6 -2
- package/dist/openapi/models/MetadataResponseDimensions.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseDimensions.js +2 -2
- package/dist/openapi/models/MetadataResponseExif.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseExif.js +3 -3
- package/dist/openapi/models/MetadataResponseExifGps.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseExifGps.js +2 -2
- package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/MetadataSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MimeGroupSchema.d.ts +46 -2
- package/dist/openapi/models/MimeGroupSchema.js +11 -2
- package/dist/openapi/models/MultipartCompleteRequest.d.ts +4 -4
- package/dist/openapi/models/MultipartCompleteRequest.js +5 -5
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +2 -2
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +2 -2
- package/dist/openapi/models/MultipartCompleteResponse.d.ts +53 -0
- package/dist/openapi/models/MultipartCompleteResponse.js +53 -0
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +54 -0
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +56 -0
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +45 -0
- package/dist/openapi/models/MultipartInitiateResponse.d.ts +20 -4
- package/dist/openapi/models/MultipartInitiateResponse.js +10 -5
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +2 -2
- package/dist/openapi/models/OperationDefinition.d.ts +2 -2
- package/dist/openapi/models/OperationDefinition.js +2 -2
- package/dist/openapi/models/OperationDownload.d.ts +2 -2
- package/dist/openapi/models/OperationDownload.js +2 -2
- package/dist/openapi/models/OperationInputModel.d.ts +4 -4
- package/dist/openapi/models/OperationInputModel.js +4 -4
- package/dist/openapi/models/OperationResponse.d.ts +2 -2
- package/dist/openapi/models/OperationResponse.js +2 -2
- package/dist/openapi/models/OperationResult.d.ts +2 -2
- package/dist/openapi/models/OperationResult.js +2 -2
- package/dist/openapi/models/OperationResultMetrics.d.ts +2 -2
- package/dist/openapi/models/OperationResultMetrics.js +2 -2
- package/dist/openapi/models/OperationSchemaDefinition.d.ts +52 -5
- package/dist/openapi/models/OperationSchemaDefinition.js +10 -6
- package/dist/openapi/models/OperationStatus.d.ts +2 -2
- package/dist/openapi/models/OperationStatus.js +2 -2
- package/dist/openapi/models/OperationType.d.ts +17 -5
- package/dist/openapi/models/OperationType.js +18 -6
- package/dist/openapi/models/OperationsSchemaResponse.d.ts +70 -10
- package/dist/openapi/models/OperationsSchemaResponse.js +17 -2
- package/dist/openapi/models/OptionSchema.d.ts +42 -4
- package/dist/openapi/models/OptionSchema.js +12 -2
- package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +80 -0
- package/dist/openapi/models/PerValueAvailabilityEntry.js +53 -0
- package/dist/openapi/models/PresignedUrlPart.d.ts +2 -2
- package/dist/openapi/models/PresignedUrlPart.js +3 -3
- package/dist/openapi/models/ProcessingClass.d.ts +35 -0
- package/dist/openapi/models/ProcessingClass.js +53 -0
- package/dist/openapi/models/ProcessingClassHint.d.ts +36 -0
- package/dist/openapi/models/ProcessingClassHint.js +54 -0
- package/dist/openapi/models/ProcessingClassReason.d.ts +46 -0
- package/dist/openapi/models/ProcessingClassReason.js +64 -0
- package/dist/openapi/models/ProcessingPlan.d.ts +70 -0
- package/dist/openapi/models/ProcessingPlan.js +49 -0
- package/dist/openapi/models/ProcessingPlanJob.d.ts +81 -0
- package/dist/openapi/models/ProcessingPlanJob.js +71 -0
- package/dist/openapi/models/ReadinessResponse.d.ts +2 -2
- package/dist/openapi/models/ReadinessResponse.js +2 -2
- package/dist/openapi/models/ResponseEnvelope.d.ts +2 -2
- package/dist/openapi/models/ResponseEnvelope.js +2 -2
- package/dist/openapi/models/RetryResponse.d.ts +5 -5
- package/dist/openapi/models/RetryResponse.js +2 -2
- package/dist/openapi/models/RetrySuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/RetrySuccessEnvelope.js +2 -2
- package/dist/openapi/models/SseEventType.d.ts +2 -2
- package/dist/openapi/models/SseEventType.js +2 -2
- package/dist/openapi/models/SseJobCompletedData.d.ts +3 -3
- package/dist/openapi/models/SseJobCompletedData.js +2 -2
- package/dist/openapi/models/SseJobFailedData.d.ts +3 -3
- package/dist/openapi/models/SseJobFailedData.js +2 -2
- package/dist/openapi/models/SseOperationCompletedData.d.ts +4 -4
- package/dist/openapi/models/SseOperationCompletedData.js +2 -2
- package/dist/openapi/models/SseOperationFailedData.d.ts +3 -3
- package/dist/openapi/models/SseOperationFailedData.js +2 -2
- package/dist/openapi/models/SseOperationProgressData.d.ts +61 -3
- package/dist/openapi/models/SseOperationProgressData.js +22 -2
- package/dist/openapi/models/SseWorkflowTerminalData.d.ts +26 -4
- package/dist/openapi/models/SseWorkflowTerminalData.js +4 -2
- package/dist/openapi/models/TierRestrictionKind.d.ts +33 -0
- package/dist/openapi/models/TierRestrictionKind.js +51 -0
- package/dist/openapi/models/TierRestrictionResponse.d.ts +154 -0
- package/dist/openapi/models/TierRestrictionResponse.js +83 -0
- package/dist/openapi/models/UploadConstraintsApplied.d.ts +70 -0
- package/dist/openapi/models/UploadConstraintsApplied.js +57 -0
- package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +136 -0
- package/dist/openapi/models/UploadDurationExceedsTierResponse.js +82 -0
- package/dist/openapi/models/UploadFile403Response.d.ts +27 -0
- package/dist/openapi/models/UploadFile403Response.js +47 -0
- package/dist/openapi/models/UploadFile422Response.d.ts +27 -0
- package/dist/openapi/models/UploadFile422Response.js +47 -0
- package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +172 -0
- package/dist/openapi/models/UploadProbeMediaMetadata.js +69 -0
- package/dist/openapi/models/UploadProbeProcessingClass.d.ts +33 -0
- package/dist/openapi/models/UploadProbeProcessingClass.js +51 -0
- package/dist/openapi/models/UploadProbeResponse.d.ts +58 -0
- package/dist/openapi/models/UploadProbeResponse.js +58 -0
- package/dist/openapi/models/UploadProbeStatus.d.ts +41 -0
- package/dist/openapi/models/UploadProbeStatus.js +59 -0
- package/dist/openapi/models/UploadResponse.d.ts +17 -3
- package/dist/openapi/models/UploadResponse.js +7 -2
- package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +136 -0
- package/dist/openapi/models/UploadSizeExceedsTierResponse.js +82 -0
- package/dist/openapi/models/UploadSource.d.ts +48 -0
- package/dist/openapi/models/UploadSource.js +53 -0
- package/dist/openapi/models/UploadSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/UploadSuccessEnvelope.js +2 -2
- package/dist/openapi/models/UploadThresholds.d.ts +119 -0
- package/dist/openapi/models/UploadThresholds.js +79 -0
- package/dist/openapi/models/UserTier.d.ts +41 -0
- package/dist/openapi/models/UserTier.js +59 -0
- package/dist/openapi/models/ValidationErrorEnvelope.d.ts +51 -4
- package/dist/openapi/models/ValidationErrorEnvelope.js +10 -2
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +37 -4
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +6 -2
- package/dist/openapi/models/WarningType.d.ts +48 -0
- package/dist/openapi/models/WarningType.js +66 -0
- package/dist/openapi/models/WebhookOperationContext.d.ts +3 -3
- package/dist/openapi/models/WebhookOperationContext.js +2 -2
- package/dist/openapi/models/WebhookPayload.d.ts +2 -2
- package/dist/openapi/models/WebhookPayload.js +3 -3
- package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +36 -0
- package/dist/openapi/models/WorkflowCancelBillingEffect.js +54 -0
- package/dist/openapi/models/WorkflowCancelResponse.d.ts +66 -0
- package/dist/openapi/models/WorkflowCancelResponse.js +62 -0
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +54 -0
- package/dist/openapi/models/WorkflowCreateRequest.d.ts +39 -5
- package/dist/openapi/models/WorkflowCreateRequest.js +11 -5
- package/dist/openapi/models/WorkflowCreateResponse.d.ts +63 -2
- package/dist/openapi/models/WorkflowCreateResponse.js +21 -2
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowDownloadResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowDownloadResponse.js +2 -2
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowEdge.d.ts +2 -2
- package/dist/openapi/models/WorkflowEdge.js +2 -2
- package/dist/openapi/models/WorkflowExpiredResponse.d.ts +126 -0
- package/dist/openapi/models/WorkflowExpiredResponse.js +75 -0
- package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +30 -0
- package/dist/openapi/models/WorkflowPauseRequiredAction.js +48 -0
- package/dist/openapi/models/WorkflowPausedDetail.d.ts +99 -0
- package/dist/openapi/models/WorkflowPausedDetail.js +65 -0
- package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +47 -0
- package/dist/openapi/models/WorkflowPausedDetailLinks.js +45 -0
- package/dist/openapi/models/WorkflowProcessing.d.ts +36 -0
- package/dist/openapi/models/WorkflowProcessing.js +42 -0
- package/dist/openapi/models/WorkflowResumeResponse.d.ts +55 -0
- package/dist/openapi/models/WorkflowResumeResponse.js +57 -0
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +54 -0
- package/dist/openapi/models/WorkflowSource.d.ts +40 -0
- package/dist/openapi/models/WorkflowSource.js +57 -0
- package/dist/openapi/models/WorkflowStatus.d.ts +31 -8
- package/dist/openapi/models/WorkflowStatus.js +32 -9
- package/dist/openapi/models/WorkflowStatusResponse.d.ts +34 -2
- package/dist/openapi/models/WorkflowStatusResponse.js +13 -2
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +3 -3
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowWarning.d.ts +119 -0
- package/dist/openapi/models/WorkflowWarning.js +63 -0
- package/dist/openapi/models/WorkflowWarningSeverity.d.ts +29 -0
- package/dist/openapi/models/WorkflowWarningSeverity.js +47 -0
- package/dist/openapi/models/index.d.ts +77 -3
- package/dist/openapi/models/index.js +77 -3
- package/dist/openapi/runtime.d.ts +2 -2
- package/dist/openapi/runtime.js +17 -2
- package/dist/operations/archive.metadata.d.ts +2 -0
- package/dist/operations/archive.metadata.js +13 -0
- package/dist/operations/audio_overlay.d.ts +48 -0
- package/dist/operations/audio_overlay.js +19 -0
- package/dist/operations/audio_overlay.metadata.d.ts +2 -0
- package/dist/operations/audio_overlay.metadata.js +167 -0
- package/dist/operations/audio_watermark.d.ts +42 -0
- package/dist/operations/audio_watermark.js +37 -0
- package/dist/operations/audio_watermark.metadata.d.ts +2 -0
- package/dist/operations/audio_watermark.metadata.js +94 -0
- package/dist/operations/compress.metadata.d.ts +2 -0
- package/dist/operations/compress.metadata.js +205 -0
- package/dist/operations/convert.metadata.d.ts +2 -0
- package/dist/operations/convert.metadata.js +85 -0
- package/dist/operations/custom_luma.d.ts +7 -0
- package/dist/operations/custom_luma.js +2 -0
- package/dist/operations/custom_luma.metadata.d.ts +2 -0
- package/dist/operations/custom_luma.metadata.js +49 -0
- package/dist/operations/image_watermark.d.ts +54 -0
- package/dist/operations/image_watermark.js +37 -0
- package/dist/operations/image_watermark.metadata.d.ts +2 -0
- package/dist/operations/image_watermark.metadata.js +97 -0
- package/dist/operations/index.d.ts +16 -1
- package/dist/operations/index.js +16 -1
- package/dist/operations/merge.d.ts +111 -31
- package/dist/operations/merge.js +106 -20
- package/dist/operations/merge.metadata.d.ts +2 -0
- package/dist/operations/merge.metadata.js +385 -0
- package/dist/operations/metadata-types.d.ts +47 -0
- package/dist/operations/metadata-types.js +2 -0
- package/dist/operations/text_watermark.d.ts +31 -0
- package/dist/operations/text_watermark.js +22 -0
- package/dist/operations/text_watermark.metadata.d.ts +2 -0
- package/dist/operations/text_watermark.metadata.js +46 -0
- package/dist/operations/thumbnail.metadata.d.ts +2 -0
- package/dist/operations/thumbnail.metadata.js +88 -0
- package/openapi/api.yaml +7154 -0
- package/operations/schemas/archive.yaml +22 -0
- package/operations/schemas/audio_overlay.yaml +397 -0
- package/operations/schemas/audio_watermark.yaml +184 -0
- package/operations/schemas/compress.yaml +297 -0
- package/operations/schemas/convert.yaml +119 -0
- package/operations/schemas/custom_luma.yaml +109 -0
- package/operations/schemas/image_watermark.yaml +280 -0
- package/operations/schemas/merge.yaml +440 -0
- package/operations/schemas/text_watermark.yaml +147 -0
- package/operations/schemas/thumbnail.yaml +135 -0
- package/package.json +20 -3
|
@@ -0,0 +1,29 @@
|
|
|
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, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - 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 (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.7.1
|
|
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
|
+
* Severity of a workflow advisory warning. V2.0 ships with a
|
|
14
|
+
* single value `advisory` — non-blocking; the workflow
|
|
15
|
+
* proceeds regardless. Future severities reserved for cases
|
|
16
|
+
* where a warning escalates to blocking-but-overrideable (no
|
|
17
|
+
* such cases in V2.0).
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const WorkflowWarningSeverity: {
|
|
22
|
+
readonly advisory: "advisory";
|
|
23
|
+
};
|
|
24
|
+
export type WorkflowWarningSeverity = typeof WorkflowWarningSeverity[keyof typeof WorkflowWarningSeverity];
|
|
25
|
+
export declare function instanceOfWorkflowWarningSeverity(value: any): boolean;
|
|
26
|
+
export declare function WorkflowWarningSeverityFromJSON(json: any): WorkflowWarningSeverity;
|
|
27
|
+
export declare function WorkflowWarningSeverityFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowWarningSeverity;
|
|
28
|
+
export declare function WorkflowWarningSeverityToJSON(value?: WorkflowWarningSeverity | null): any;
|
|
29
|
+
export declare function WorkflowWarningSeverityToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowWarningSeverity;
|
|
@@ -0,0 +1,47 @@
|
|
|
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, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - 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 (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.7.1
|
|
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
|
+
* Severity of a workflow advisory warning. V2.0 ships with a
|
|
16
|
+
* single value `advisory` — non-blocking; the workflow
|
|
17
|
+
* proceeds regardless. Future severities reserved for cases
|
|
18
|
+
* where a warning escalates to blocking-but-overrideable (no
|
|
19
|
+
* such cases in V2.0).
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export const WorkflowWarningSeverity = {
|
|
24
|
+
advisory: 'advisory'
|
|
25
|
+
};
|
|
26
|
+
export function instanceOfWorkflowWarningSeverity(value) {
|
|
27
|
+
for (const key in WorkflowWarningSeverity) {
|
|
28
|
+
if (Object.prototype.hasOwnProperty.call(WorkflowWarningSeverity, key)) {
|
|
29
|
+
if (WorkflowWarningSeverity[key] === value) {
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
return false;
|
|
35
|
+
}
|
|
36
|
+
export function WorkflowWarningSeverityFromJSON(json) {
|
|
37
|
+
return WorkflowWarningSeverityFromJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function WorkflowWarningSeverityFromJSONTyped(json, ignoreDiscriminator) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
export function WorkflowWarningSeverityToJSON(value) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
export function WorkflowWarningSeverityToJSONTyped(value, ignoreDiscriminator) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
@@ -1,17 +1,54 @@
|
|
|
1
|
+
export * from './AudioWatermarkDecodeRequest.js';
|
|
2
|
+
export * from './AudioWatermarkDecodeResponse.js';
|
|
3
|
+
export * from './AuthErrorResponse.js';
|
|
4
|
+
export * from './AuthErrorType.js';
|
|
5
|
+
export * from './AvailabilityValue.js';
|
|
6
|
+
export * from './BalanceExhaustedResponse.js';
|
|
7
|
+
export * from './BalanceExhaustedResponseAllOfLinks.js';
|
|
1
8
|
export * from './CallbackEventType.js';
|
|
9
|
+
export * from './ConnectionSource.js';
|
|
2
10
|
export * from './ContactRequest.js';
|
|
3
11
|
export * from './ContactSubject.js';
|
|
4
12
|
export * from './ContactValidationErrorResponse.js';
|
|
13
|
+
export * from './CreateExternalImport403Response.js';
|
|
14
|
+
export * from './CreateWorkflow422Response.js';
|
|
15
|
+
export * from './CreditTransaction.js';
|
|
16
|
+
export * from './CreditTransactionSourceBucket.js';
|
|
17
|
+
export * from './CreditsBalanceResponse.js';
|
|
18
|
+
export * from './CreditsBalanceSuccessEnvelope.js';
|
|
19
|
+
export * from './CreditsUsageResponse.js';
|
|
20
|
+
export * from './CreditsUsageSuccessEnvelope.js';
|
|
21
|
+
export * from './Delivery.js';
|
|
22
|
+
export * from './DeliveryOutputRef.js';
|
|
23
|
+
export * from './DeliveryPlan.js';
|
|
24
|
+
export * from './DeliveryPlanOutput.js';
|
|
25
|
+
export * from './DeliveryPlanReason.js';
|
|
26
|
+
export * from './DeliverySelection.js';
|
|
5
27
|
export * from './ErrorEnvelope.js';
|
|
6
|
-
export * from './
|
|
28
|
+
export * from './EstimateQuality.js';
|
|
29
|
+
export * from './EstimateRange.js';
|
|
30
|
+
export * from './ExternalDestination.js';
|
|
31
|
+
export * from './ExternalImportCreatedResponse.js';
|
|
32
|
+
export * from './ExternalImportCreatedSuccessEnvelope.js';
|
|
33
|
+
export * from './ExternalImportRequest.js';
|
|
34
|
+
export * from './ExternalImportToken.js';
|
|
35
|
+
export * from './ExternalSource.js';
|
|
36
|
+
export * from './FeatureNotAvailableResponse.js';
|
|
37
|
+
export * from './FeatureTierRestrictedResponse.js';
|
|
38
|
+
export * from './FeatureViolation.js';
|
|
7
39
|
export * from './JobDefinition.js';
|
|
8
40
|
export * from './JobDownload.js';
|
|
9
|
-
export * from './
|
|
41
|
+
export * from './JobInputV2.js';
|
|
42
|
+
export * from './JobOutputSource.js';
|
|
10
43
|
export * from './JobResponse.js';
|
|
11
|
-
export * from './JobSource.js';
|
|
12
44
|
export * from './JobStatus.js';
|
|
13
45
|
export * from './JobType.js';
|
|
14
46
|
export * from './LivenessResponse.js';
|
|
47
|
+
export * from './LoginUser200Response.js';
|
|
48
|
+
export * from './LoginUser200ResponseData.js';
|
|
49
|
+
export * from './LoginUser200ResponseDataUser.js';
|
|
50
|
+
export * from './LoginUserRequest.js';
|
|
51
|
+
export * from './LogoutUser200Response.js';
|
|
15
52
|
export * from './MetadataResponse.js';
|
|
16
53
|
export * from './MetadataResponseDimensions.js';
|
|
17
54
|
export * from './MetadataResponseExif.js';
|
|
@@ -20,6 +57,9 @@ export * from './MetadataSuccessEnvelope.js';
|
|
|
20
57
|
export * from './MimeGroupSchema.js';
|
|
21
58
|
export * from './MultipartCompleteRequest.js';
|
|
22
59
|
export * from './MultipartCompleteRequestPartsInner.js';
|
|
60
|
+
export * from './MultipartCompleteResponse.js';
|
|
61
|
+
export * from './MultipartCompleteSuccessEnvelope.js';
|
|
62
|
+
export * from './MultipartInitiateRequestMetadataHint.js';
|
|
23
63
|
export * from './MultipartInitiateResponse.js';
|
|
24
64
|
export * from './MultipartInitiateSuccessEnvelope.js';
|
|
25
65
|
export * from './OperationDefinition.js';
|
|
@@ -33,7 +73,13 @@ export * from './OperationStatus.js';
|
|
|
33
73
|
export * from './OperationType.js';
|
|
34
74
|
export * from './OperationsSchemaResponse.js';
|
|
35
75
|
export * from './OptionSchema.js';
|
|
76
|
+
export * from './PerValueAvailabilityEntry.js';
|
|
36
77
|
export * from './PresignedUrlPart.js';
|
|
78
|
+
export * from './ProcessingClass.js';
|
|
79
|
+
export * from './ProcessingClassHint.js';
|
|
80
|
+
export * from './ProcessingClassReason.js';
|
|
81
|
+
export * from './ProcessingPlan.js';
|
|
82
|
+
export * from './ProcessingPlanJob.js';
|
|
37
83
|
export * from './ReadinessResponse.js';
|
|
38
84
|
export * from './ResponseEnvelope.js';
|
|
39
85
|
export * from './RetryResponse.js';
|
|
@@ -45,18 +91,46 @@ export * from './SseOperationCompletedData.js';
|
|
|
45
91
|
export * from './SseOperationFailedData.js';
|
|
46
92
|
export * from './SseOperationProgressData.js';
|
|
47
93
|
export * from './SseWorkflowTerminalData.js';
|
|
94
|
+
export * from './TierRestrictionKind.js';
|
|
95
|
+
export * from './TierRestrictionResponse.js';
|
|
96
|
+
export * from './UploadConstraintsApplied.js';
|
|
97
|
+
export * from './UploadDurationExceedsTierResponse.js';
|
|
98
|
+
export * from './UploadFile403Response.js';
|
|
99
|
+
export * from './UploadFile422Response.js';
|
|
100
|
+
export * from './UploadProbeMediaMetadata.js';
|
|
101
|
+
export * from './UploadProbeProcessingClass.js';
|
|
102
|
+
export * from './UploadProbeResponse.js';
|
|
103
|
+
export * from './UploadProbeStatus.js';
|
|
48
104
|
export * from './UploadResponse.js';
|
|
105
|
+
export * from './UploadSizeExceedsTierResponse.js';
|
|
106
|
+
export * from './UploadSource.js';
|
|
49
107
|
export * from './UploadSuccessEnvelope.js';
|
|
108
|
+
export * from './UploadThresholds.js';
|
|
109
|
+
export * from './UserTier.js';
|
|
50
110
|
export * from './ValidationErrorEnvelope.js';
|
|
51
111
|
export * from './ValidationErrorEnvelopeDetailsInner.js';
|
|
112
|
+
export * from './WarningType.js';
|
|
52
113
|
export * from './WebhookOperationContext.js';
|
|
53
114
|
export * from './WebhookPayload.js';
|
|
115
|
+
export * from './WorkflowCancelBillingEffect.js';
|
|
116
|
+
export * from './WorkflowCancelResponse.js';
|
|
117
|
+
export * from './WorkflowCancelSuccessEnvelope.js';
|
|
54
118
|
export * from './WorkflowCreateRequest.js';
|
|
55
119
|
export * from './WorkflowCreateResponse.js';
|
|
56
120
|
export * from './WorkflowCreateSuccessEnvelope.js';
|
|
57
121
|
export * from './WorkflowDownloadResponse.js';
|
|
58
122
|
export * from './WorkflowDownloadSuccessEnvelope.js';
|
|
59
123
|
export * from './WorkflowEdge.js';
|
|
124
|
+
export * from './WorkflowExpiredResponse.js';
|
|
125
|
+
export * from './WorkflowPauseRequiredAction.js';
|
|
126
|
+
export * from './WorkflowPausedDetail.js';
|
|
127
|
+
export * from './WorkflowPausedDetailLinks.js';
|
|
128
|
+
export * from './WorkflowProcessing.js';
|
|
129
|
+
export * from './WorkflowResumeResponse.js';
|
|
130
|
+
export * from './WorkflowResumeSuccessEnvelope.js';
|
|
131
|
+
export * from './WorkflowSource.js';
|
|
60
132
|
export * from './WorkflowStatus.js';
|
|
61
133
|
export * from './WorkflowStatusResponse.js';
|
|
62
134
|
export * from './WorkflowStatusSuccessEnvelope.js';
|
|
135
|
+
export * from './WorkflowWarning.js';
|
|
136
|
+
export * from './WorkflowWarningSeverity.js';
|
|
@@ -1,19 +1,56 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
|
+
export * from './AudioWatermarkDecodeRequest.js';
|
|
4
|
+
export * from './AudioWatermarkDecodeResponse.js';
|
|
5
|
+
export * from './AuthErrorResponse.js';
|
|
6
|
+
export * from './AuthErrorType.js';
|
|
7
|
+
export * from './AvailabilityValue.js';
|
|
8
|
+
export * from './BalanceExhaustedResponse.js';
|
|
9
|
+
export * from './BalanceExhaustedResponseAllOfLinks.js';
|
|
3
10
|
export * from './CallbackEventType.js';
|
|
11
|
+
export * from './ConnectionSource.js';
|
|
4
12
|
export * from './ContactRequest.js';
|
|
5
13
|
export * from './ContactSubject.js';
|
|
6
14
|
export * from './ContactValidationErrorResponse.js';
|
|
15
|
+
export * from './CreateExternalImport403Response.js';
|
|
16
|
+
export * from './CreateWorkflow422Response.js';
|
|
17
|
+
export * from './CreditTransaction.js';
|
|
18
|
+
export * from './CreditTransactionSourceBucket.js';
|
|
19
|
+
export * from './CreditsBalanceResponse.js';
|
|
20
|
+
export * from './CreditsBalanceSuccessEnvelope.js';
|
|
21
|
+
export * from './CreditsUsageResponse.js';
|
|
22
|
+
export * from './CreditsUsageSuccessEnvelope.js';
|
|
23
|
+
export * from './Delivery.js';
|
|
24
|
+
export * from './DeliveryOutputRef.js';
|
|
25
|
+
export * from './DeliveryPlan.js';
|
|
26
|
+
export * from './DeliveryPlanOutput.js';
|
|
27
|
+
export * from './DeliveryPlanReason.js';
|
|
28
|
+
export * from './DeliverySelection.js';
|
|
7
29
|
export * from './ErrorEnvelope.js';
|
|
8
|
-
export * from './
|
|
30
|
+
export * from './EstimateQuality.js';
|
|
31
|
+
export * from './EstimateRange.js';
|
|
32
|
+
export * from './ExternalDestination.js';
|
|
33
|
+
export * from './ExternalImportCreatedResponse.js';
|
|
34
|
+
export * from './ExternalImportCreatedSuccessEnvelope.js';
|
|
35
|
+
export * from './ExternalImportRequest.js';
|
|
36
|
+
export * from './ExternalImportToken.js';
|
|
37
|
+
export * from './ExternalSource.js';
|
|
38
|
+
export * from './FeatureNotAvailableResponse.js';
|
|
39
|
+
export * from './FeatureTierRestrictedResponse.js';
|
|
40
|
+
export * from './FeatureViolation.js';
|
|
9
41
|
export * from './JobDefinition.js';
|
|
10
42
|
export * from './JobDownload.js';
|
|
11
|
-
export * from './
|
|
43
|
+
export * from './JobInputV2.js';
|
|
44
|
+
export * from './JobOutputSource.js';
|
|
12
45
|
export * from './JobResponse.js';
|
|
13
|
-
export * from './JobSource.js';
|
|
14
46
|
export * from './JobStatus.js';
|
|
15
47
|
export * from './JobType.js';
|
|
16
48
|
export * from './LivenessResponse.js';
|
|
49
|
+
export * from './LoginUser200Response.js';
|
|
50
|
+
export * from './LoginUser200ResponseData.js';
|
|
51
|
+
export * from './LoginUser200ResponseDataUser.js';
|
|
52
|
+
export * from './LoginUserRequest.js';
|
|
53
|
+
export * from './LogoutUser200Response.js';
|
|
17
54
|
export * from './MetadataResponse.js';
|
|
18
55
|
export * from './MetadataResponseDimensions.js';
|
|
19
56
|
export * from './MetadataResponseExif.js';
|
|
@@ -22,6 +59,9 @@ export * from './MetadataSuccessEnvelope.js';
|
|
|
22
59
|
export * from './MimeGroupSchema.js';
|
|
23
60
|
export * from './MultipartCompleteRequest.js';
|
|
24
61
|
export * from './MultipartCompleteRequestPartsInner.js';
|
|
62
|
+
export * from './MultipartCompleteResponse.js';
|
|
63
|
+
export * from './MultipartCompleteSuccessEnvelope.js';
|
|
64
|
+
export * from './MultipartInitiateRequestMetadataHint.js';
|
|
25
65
|
export * from './MultipartInitiateResponse.js';
|
|
26
66
|
export * from './MultipartInitiateSuccessEnvelope.js';
|
|
27
67
|
export * from './OperationDefinition.js';
|
|
@@ -35,7 +75,13 @@ export * from './OperationStatus.js';
|
|
|
35
75
|
export * from './OperationType.js';
|
|
36
76
|
export * from './OperationsSchemaResponse.js';
|
|
37
77
|
export * from './OptionSchema.js';
|
|
78
|
+
export * from './PerValueAvailabilityEntry.js';
|
|
38
79
|
export * from './PresignedUrlPart.js';
|
|
80
|
+
export * from './ProcessingClass.js';
|
|
81
|
+
export * from './ProcessingClassHint.js';
|
|
82
|
+
export * from './ProcessingClassReason.js';
|
|
83
|
+
export * from './ProcessingPlan.js';
|
|
84
|
+
export * from './ProcessingPlanJob.js';
|
|
39
85
|
export * from './ReadinessResponse.js';
|
|
40
86
|
export * from './ResponseEnvelope.js';
|
|
41
87
|
export * from './RetryResponse.js';
|
|
@@ -47,18 +93,46 @@ export * from './SseOperationCompletedData.js';
|
|
|
47
93
|
export * from './SseOperationFailedData.js';
|
|
48
94
|
export * from './SseOperationProgressData.js';
|
|
49
95
|
export * from './SseWorkflowTerminalData.js';
|
|
96
|
+
export * from './TierRestrictionKind.js';
|
|
97
|
+
export * from './TierRestrictionResponse.js';
|
|
98
|
+
export * from './UploadConstraintsApplied.js';
|
|
99
|
+
export * from './UploadDurationExceedsTierResponse.js';
|
|
100
|
+
export * from './UploadFile403Response.js';
|
|
101
|
+
export * from './UploadFile422Response.js';
|
|
102
|
+
export * from './UploadProbeMediaMetadata.js';
|
|
103
|
+
export * from './UploadProbeProcessingClass.js';
|
|
104
|
+
export * from './UploadProbeResponse.js';
|
|
105
|
+
export * from './UploadProbeStatus.js';
|
|
50
106
|
export * from './UploadResponse.js';
|
|
107
|
+
export * from './UploadSizeExceedsTierResponse.js';
|
|
108
|
+
export * from './UploadSource.js';
|
|
51
109
|
export * from './UploadSuccessEnvelope.js';
|
|
110
|
+
export * from './UploadThresholds.js';
|
|
111
|
+
export * from './UserTier.js';
|
|
52
112
|
export * from './ValidationErrorEnvelope.js';
|
|
53
113
|
export * from './ValidationErrorEnvelopeDetailsInner.js';
|
|
114
|
+
export * from './WarningType.js';
|
|
54
115
|
export * from './WebhookOperationContext.js';
|
|
55
116
|
export * from './WebhookPayload.js';
|
|
117
|
+
export * from './WorkflowCancelBillingEffect.js';
|
|
118
|
+
export * from './WorkflowCancelResponse.js';
|
|
119
|
+
export * from './WorkflowCancelSuccessEnvelope.js';
|
|
56
120
|
export * from './WorkflowCreateRequest.js';
|
|
57
121
|
export * from './WorkflowCreateResponse.js';
|
|
58
122
|
export * from './WorkflowCreateSuccessEnvelope.js';
|
|
59
123
|
export * from './WorkflowDownloadResponse.js';
|
|
60
124
|
export * from './WorkflowDownloadSuccessEnvelope.js';
|
|
61
125
|
export * from './WorkflowEdge.js';
|
|
126
|
+
export * from './WorkflowExpiredResponse.js';
|
|
127
|
+
export * from './WorkflowPauseRequiredAction.js';
|
|
128
|
+
export * from './WorkflowPausedDetail.js';
|
|
129
|
+
export * from './WorkflowPausedDetailLinks.js';
|
|
130
|
+
export * from './WorkflowProcessing.js';
|
|
131
|
+
export * from './WorkflowResumeResponse.js';
|
|
132
|
+
export * from './WorkflowResumeSuccessEnvelope.js';
|
|
133
|
+
export * from './WorkflowSource.js';
|
|
62
134
|
export * from './WorkflowStatus.js';
|
|
63
135
|
export * from './WorkflowStatusResponse.js';
|
|
64
136
|
export * from './WorkflowStatusSuccessEnvelope.js';
|
|
137
|
+
export * from './WorkflowWarning.js';
|
|
138
|
+
export * from './WorkflowWarningSeverity.js';
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
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,
|
|
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, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - 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 (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.7.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/openapi/runtime.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
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,
|
|
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, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - 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 (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.
|
|
7
|
+
* The version of the OpenAPI document: 2.7.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -223,6 +223,11 @@ export class ResponseError extends Error {
|
|
|
223
223
|
constructor(response, msg) {
|
|
224
224
|
super(msg);
|
|
225
225
|
this.response = response;
|
|
226
|
+
// restore prototype chain
|
|
227
|
+
const actualProto = new.target.prototype;
|
|
228
|
+
if (Object.setPrototypeOf) {
|
|
229
|
+
Object.setPrototypeOf(this, actualProto);
|
|
230
|
+
}
|
|
226
231
|
}
|
|
227
232
|
}
|
|
228
233
|
export class FetchError extends Error {
|
|
@@ -231,6 +236,11 @@ export class FetchError extends Error {
|
|
|
231
236
|
constructor(cause, msg) {
|
|
232
237
|
super(msg);
|
|
233
238
|
this.cause = cause;
|
|
239
|
+
// restore prototype chain
|
|
240
|
+
const actualProto = new.target.prototype;
|
|
241
|
+
if (Object.setPrototypeOf) {
|
|
242
|
+
Object.setPrototypeOf(this, actualProto);
|
|
243
|
+
}
|
|
234
244
|
}
|
|
235
245
|
}
|
|
236
246
|
export class RequiredError extends Error {
|
|
@@ -239,6 +249,11 @@ export class RequiredError extends Error {
|
|
|
239
249
|
constructor(field, msg) {
|
|
240
250
|
super(msg);
|
|
241
251
|
this.field = field;
|
|
252
|
+
// restore prototype chain
|
|
253
|
+
const actualProto = new.target.prototype;
|
|
254
|
+
if (Object.setPrototypeOf) {
|
|
255
|
+
Object.setPrototypeOf(this, actualProto);
|
|
256
|
+
}
|
|
242
257
|
}
|
|
243
258
|
}
|
|
244
259
|
export const COLLECTION_FORMATS = {
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// Auto-generated from archive.yaml -- do not edit
|
|
2
|
+
export const archiveMetadata = {
|
|
3
|
+
features: {},
|
|
4
|
+
mime_groups: {},
|
|
5
|
+
direct_options: {
|
|
6
|
+
format: {
|
|
7
|
+
per_value_availability: {},
|
|
8
|
+
},
|
|
9
|
+
folder_structure: {
|
|
10
|
+
per_value_availability: {},
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
};
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
export declare enum AudioOverlayAudioMode {
|
|
2
|
+
Mix = "mix",
|
|
3
|
+
Duck = "duck",
|
|
4
|
+
Replace = "replace"
|
|
5
|
+
}
|
|
6
|
+
export interface AudioOverlayAudioOptions {
|
|
7
|
+
start_at?: number;
|
|
8
|
+
duration?: number;
|
|
9
|
+
overlay_gain_db?: number;
|
|
10
|
+
mode?: AudioOverlayAudioMode;
|
|
11
|
+
duck_threshold?: number;
|
|
12
|
+
duck_ratio?: number;
|
|
13
|
+
duck_attack_ms?: number;
|
|
14
|
+
duck_release_ms?: number;
|
|
15
|
+
fade_in_ms?: number;
|
|
16
|
+
fade_out_ms?: number;
|
|
17
|
+
loop?: boolean;
|
|
18
|
+
loop_interval?: number;
|
|
19
|
+
silence_threshold_db?: number;
|
|
20
|
+
min_silence_ms?: number;
|
|
21
|
+
}
|
|
22
|
+
export declare enum AudioOverlayVideoMode {
|
|
23
|
+
Mix = "mix",
|
|
24
|
+
Duck = "duck",
|
|
25
|
+
Replace = "replace"
|
|
26
|
+
}
|
|
27
|
+
export declare enum AudioOverlayVideoNoAudioTrackBehaviour {
|
|
28
|
+
Reject = "reject",
|
|
29
|
+
CreateSilent = "create_silent",
|
|
30
|
+
Replace = "replace"
|
|
31
|
+
}
|
|
32
|
+
export interface AudioOverlayVideoOptions {
|
|
33
|
+
start_at?: number;
|
|
34
|
+
duration?: number;
|
|
35
|
+
overlay_gain_db?: number;
|
|
36
|
+
mode?: AudioOverlayVideoMode;
|
|
37
|
+
duck_threshold?: number;
|
|
38
|
+
duck_ratio?: number;
|
|
39
|
+
duck_attack_ms?: number;
|
|
40
|
+
duck_release_ms?: number;
|
|
41
|
+
fade_in_ms?: number;
|
|
42
|
+
fade_out_ms?: number;
|
|
43
|
+
loop?: boolean;
|
|
44
|
+
loop_interval?: number;
|
|
45
|
+
no_audio_track_behaviour?: AudioOverlayVideoNoAudioTrackBehaviour;
|
|
46
|
+
silence_threshold_db?: number;
|
|
47
|
+
min_silence_ms?: number;
|
|
48
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// Auto-generated from audio_overlay.yaml -- do not edit
|
|
2
|
+
export var AudioOverlayAudioMode;
|
|
3
|
+
(function (AudioOverlayAudioMode) {
|
|
4
|
+
AudioOverlayAudioMode["Mix"] = "mix";
|
|
5
|
+
AudioOverlayAudioMode["Duck"] = "duck";
|
|
6
|
+
AudioOverlayAudioMode["Replace"] = "replace";
|
|
7
|
+
})(AudioOverlayAudioMode || (AudioOverlayAudioMode = {}));
|
|
8
|
+
export var AudioOverlayVideoMode;
|
|
9
|
+
(function (AudioOverlayVideoMode) {
|
|
10
|
+
AudioOverlayVideoMode["Mix"] = "mix";
|
|
11
|
+
AudioOverlayVideoMode["Duck"] = "duck";
|
|
12
|
+
AudioOverlayVideoMode["Replace"] = "replace";
|
|
13
|
+
})(AudioOverlayVideoMode || (AudioOverlayVideoMode = {}));
|
|
14
|
+
export var AudioOverlayVideoNoAudioTrackBehaviour;
|
|
15
|
+
(function (AudioOverlayVideoNoAudioTrackBehaviour) {
|
|
16
|
+
AudioOverlayVideoNoAudioTrackBehaviour["Reject"] = "reject";
|
|
17
|
+
AudioOverlayVideoNoAudioTrackBehaviour["CreateSilent"] = "create_silent";
|
|
18
|
+
AudioOverlayVideoNoAudioTrackBehaviour["Replace"] = "replace";
|
|
19
|
+
})(AudioOverlayVideoNoAudioTrackBehaviour || (AudioOverlayVideoNoAudioTrackBehaviour = {}));
|