@giveitsmaller/contracts 0.18.0 → 0.21.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 +69 -19
- package/availability/availability.json +99 -14
- package/dist/asyncapi/Failure.d.ts +1 -0
- package/dist/asyncapi/MultiOutputCompletion.d.ts +1 -0
- package/dist/asyncapi/PageIndexed.d.ts +1 -0
- package/dist/asyncapi/PositionIndexed.d.ts +1 -0
- package/dist/asyncapi/SingleOutputCompletion.d.ts +1 -0
- package/dist/asyncapi/Unindexed.d.ts +1 -0
- package/dist/openapi/models/AccountLimitEntry.d.ts +54 -0
- package/dist/openapi/models/AccountLimitEntry.js +51 -0
- package/dist/openapi/models/AccountLimits.d.ts +60 -0
- package/dist/openapi/models/AccountLimits.js +49 -0
- package/dist/openapi/models/AccountLimitsLimits.d.ts +40 -0
- package/dist/openapi/models/AccountLimitsLimits.js +50 -0
- package/dist/openapi/models/AccountLimitsSuccessEnvelope.d.ts +46 -0
- package/dist/openapi/models/AccountLimitsSuccessEnvelope.js +54 -0
- package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeRequest.js +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeResponse.js +1 -1
- package/dist/openapi/models/AuthErrorResponse.d.ts +1 -1
- package/dist/openapi/models/AuthErrorResponse.js +1 -1
- package/dist/openapi/models/AuthErrorType.d.ts +1 -1
- package/dist/openapi/models/AuthErrorType.js +1 -1
- package/dist/openapi/models/AuthRejectionEnvelope.d.ts +1 -1
- package/dist/openapi/models/AuthRejectionEnvelope.js +1 -1
- package/dist/openapi/models/AvailabilityValue.d.ts +1 -1
- package/dist/openapi/models/AvailabilityValue.js +1 -1
- package/dist/openapi/models/BalanceExhaustedResponse.d.ts +1 -1
- package/dist/openapi/models/BalanceExhaustedResponse.js +1 -1
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +1 -1
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +1 -1
- package/dist/openapi/models/CallbackEventType.d.ts +1 -1
- package/dist/openapi/models/CallbackEventType.js +1 -1
- package/dist/openapi/models/ChangePasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ChangePasswordRequest.js +1 -1
- package/dist/openapi/models/CompositionPlan.d.ts +1 -1
- package/dist/openapi/models/CompositionPlan.js +1 -1
- package/dist/openapi/models/CompositionPlanJob.d.ts +1 -1
- package/dist/openapi/models/CompositionPlanJob.js +1 -1
- package/dist/openapi/models/CompositionPlanOperation.d.ts +1 -1
- package/dist/openapi/models/CompositionPlanOperation.js +1 -1
- package/dist/openapi/models/ConfirmEmailChange200Response.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChange200Response.js +1 -1
- package/dist/openapi/models/ConfirmEmailChange200ResponseData.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChange200ResponseData.js +1 -1
- package/dist/openapi/models/ConfirmEmailChangeRequest.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChangeRequest.js +1 -1
- package/dist/openapi/models/ConnectionSource.d.ts +1 -1
- package/dist/openapi/models/ConnectionSource.js +1 -1
- package/dist/openapi/models/ContactRequest.d.ts +1 -1
- package/dist/openapi/models/ContactRequest.js +1 -1
- package/dist/openapi/models/ContactSubject.d.ts +1 -1
- package/dist/openapi/models/ContactSubject.js +1 -1
- package/dist/openapi/models/ContactValidationErrorResponse.d.ts +1 -1
- package/dist/openapi/models/ContactValidationErrorResponse.js +1 -1
- package/dist/openapi/models/CreateApiKey201Response.d.ts +1 -1
- package/dist/openapi/models/CreateApiKey201Response.js +1 -1
- package/dist/openapi/models/CreateApiKey201ResponseData.d.ts +1 -1
- package/dist/openapi/models/CreateApiKey201ResponseData.js +1 -1
- package/dist/openapi/models/CreateApiKeyRequest.d.ts +1 -1
- package/dist/openapi/models/CreateApiKeyRequest.js +1 -1
- package/dist/openapi/models/CreateExternalImport403Response.d.ts +1 -1
- package/dist/openapi/models/CreateExternalImport403Response.js +1 -1
- package/dist/openapi/models/CreateExternalImport422Response.d.ts +1 -1
- package/dist/openapi/models/CreateExternalImport422Response.js +1 -1
- package/dist/openapi/models/CreateWorkflow422Response.d.ts +1 -1
- package/dist/openapi/models/CreateWorkflow422Response.js +1 -1
- package/dist/openapi/models/CreditTransaction.d.ts +47 -1
- package/dist/openapi/models/CreditTransaction.js +11 -1
- package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +1 -1
- package/dist/openapi/models/CreditTransactionSourceBucket.js +1 -1
- package/dist/openapi/models/CreditsBalanceResponse.d.ts +1 -1
- package/dist/openapi/models/CreditsBalanceResponse.js +1 -1
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +1 -1
- package/dist/openapi/models/CreditsUsageResponse.d.ts +1 -1
- package/dist/openapi/models/CreditsUsageResponse.js +1 -1
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +1 -1
- package/dist/openapi/models/Delivery.d.ts +1 -1
- package/dist/openapi/models/Delivery.js +1 -1
- package/dist/openapi/models/DeliveryOutputRef.d.ts +1 -1
- package/dist/openapi/models/DeliveryOutputRef.js +1 -1
- package/dist/openapi/models/DeliveryPlan.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlan.js +1 -1
- package/dist/openapi/models/DeliveryPlanOutput.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlanOutput.js +1 -1
- package/dist/openapi/models/DeliveryPlanReason.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlanReason.js +1 -1
- package/dist/openapi/models/DeliverySelection.d.ts +1 -1
- package/dist/openapi/models/DeliverySelection.js +1 -1
- package/dist/openapi/models/EmptySuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/EmptySuccessEnvelope.js +1 -1
- package/dist/openapi/models/EndpointProjection.d.ts +1 -1
- package/dist/openapi/models/EndpointProjection.js +1 -1
- package/dist/openapi/models/ErrorEnvelope.d.ts +1 -1
- package/dist/openapi/models/ErrorEnvelope.js +1 -1
- package/dist/openapi/models/EstimateQuality.d.ts +1 -1
- package/dist/openapi/models/EstimateQuality.js +1 -1
- package/dist/openapi/models/EstimateRange.d.ts +1 -1
- package/dist/openapi/models/EstimateRange.js +1 -1
- package/dist/openapi/models/ExternalDestination.d.ts +1 -1
- package/dist/openapi/models/ExternalDestination.js +1 -1
- package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +1 -1
- package/dist/openapi/models/ExternalImportCreatedResponse.js +1 -1
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +1 -1
- package/dist/openapi/models/ExternalImportRequest.d.ts +1 -1
- package/dist/openapi/models/ExternalImportRequest.js +1 -1
- package/dist/openapi/models/ExternalImportToken.d.ts +1 -1
- package/dist/openapi/models/ExternalImportToken.js +1 -1
- package/dist/openapi/models/ExternalSource.d.ts +1 -1
- package/dist/openapi/models/ExternalSource.js +1 -1
- package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +1 -1
- package/dist/openapi/models/FeatureNotAvailableResponse.js +1 -1
- package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +1 -1
- package/dist/openapi/models/FeatureTierRestrictedResponse.js +1 -1
- package/dist/openapi/models/FeatureViolation.d.ts +1 -1
- package/dist/openapi/models/FeatureViolation.js +1 -1
- package/dist/openapi/models/ForgotPasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ForgotPasswordRequest.js +1 -1
- package/dist/openapi/models/ImageEncodeCapabilities.d.ts +1 -1
- package/dist/openapi/models/ImageEncodeCapabilities.js +1 -1
- package/dist/openapi/models/JobDefinition.d.ts +1 -1
- package/dist/openapi/models/JobDefinition.js +1 -1
- package/dist/openapi/models/JobDownload.d.ts +1 -1
- package/dist/openapi/models/JobDownload.js +1 -1
- package/dist/openapi/models/JobInputV2.d.ts +1 -1
- package/dist/openapi/models/JobInputV2.js +1 -1
- package/dist/openapi/models/JobMediaClass.d.ts +1 -1
- package/dist/openapi/models/JobMediaClass.js +1 -1
- package/dist/openapi/models/JobOutputSource.d.ts +1 -1
- package/dist/openapi/models/JobOutputSource.js +1 -1
- package/dist/openapi/models/JobResponse.d.ts +1 -1
- package/dist/openapi/models/JobResponse.js +1 -1
- package/dist/openapi/models/JobStatus.d.ts +1 -1
- package/dist/openapi/models/JobStatus.js +1 -1
- package/dist/openapi/models/JobType.d.ts +1 -1
- package/dist/openapi/models/JobType.js +1 -1
- package/dist/openapi/models/LivenessResponse.d.ts +1 -1
- package/dist/openapi/models/LivenessResponse.js +1 -1
- package/dist/openapi/models/LoginUser200Response.d.ts +1 -1
- package/dist/openapi/models/LoginUser200Response.js +1 -1
- package/dist/openapi/models/LoginUser200ResponseData.d.ts +1 -1
- package/dist/openapi/models/LoginUser200ResponseData.js +1 -1
- package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +1 -1
- package/dist/openapi/models/LoginUser200ResponseDataUser.js +1 -1
- package/dist/openapi/models/LoginUserRequest.d.ts +1 -1
- package/dist/openapi/models/LoginUserRequest.js +1 -1
- package/dist/openapi/models/MetadataResponse.d.ts +1 -1
- package/dist/openapi/models/MetadataResponse.js +1 -1
- package/dist/openapi/models/MetadataResponseDimensions.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseDimensions.js +1 -1
- package/dist/openapi/models/MetadataResponseExif.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseExif.js +1 -1
- package/dist/openapi/models/MetadataResponseExifGps.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseExifGps.js +1 -1
- package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MetadataSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MimeGroupSchema.d.ts +1 -1
- package/dist/openapi/models/MimeGroupSchema.js +1 -1
- package/dist/openapi/models/MultiInputSource.d.ts +1 -1
- package/dist/openapi/models/MultiInputSource.js +1 -1
- package/dist/openapi/models/MultipartCompleteRequest.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteRequest.js +1 -1
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +1 -1
- package/dist/openapi/models/MultipartCompleteResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteResponse.js +1 -1
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +1 -1
- package/dist/openapi/models/MultipartInitiateResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateResponse.js +1 -1
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartKeepaliveResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartKeepaliveResponse.js +1 -1
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartPartListing.d.ts +1 -1
- package/dist/openapi/models/MultipartPartListing.js +1 -1
- package/dist/openapi/models/MultipartPresignRequest.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignRequest.js +1 -1
- package/dist/openapi/models/MultipartPresignResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignResponse.js +1 -1
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartStatusResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartStatusResponse.js +1 -1
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.js +1 -1
- package/dist/openapi/models/OperationDefinition.d.ts +1 -1
- package/dist/openapi/models/OperationDefinition.js +1 -1
- package/dist/openapi/models/OperationDownload.d.ts +1 -1
- package/dist/openapi/models/OperationDownload.js +1 -1
- package/dist/openapi/models/OperationInputModel.d.ts +1 -1
- package/dist/openapi/models/OperationInputModel.js +1 -1
- package/dist/openapi/models/OperationResponse.d.ts +1 -1
- package/dist/openapi/models/OperationResponse.js +1 -1
- package/dist/openapi/models/OperationResult.d.ts +1 -1
- package/dist/openapi/models/OperationResult.js +1 -1
- package/dist/openapi/models/OperationResultMetadata.d.ts +1 -1
- package/dist/openapi/models/OperationResultMetadata.js +1 -1
- package/dist/openapi/models/OperationResultMetrics.d.ts +1 -1
- package/dist/openapi/models/OperationResultMetrics.js +1 -1
- package/dist/openapi/models/OperationSchemaDefinition.d.ts +1 -1
- package/dist/openapi/models/OperationSchemaDefinition.js +1 -1
- package/dist/openapi/models/OperationStatus.d.ts +1 -1
- package/dist/openapi/models/OperationStatus.js +1 -1
- package/dist/openapi/models/OperationType.d.ts +2 -2
- package/dist/openapi/models/OperationType.js +2 -2
- package/dist/openapi/models/OperationsSchemaResponse.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponse.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeatures.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeatures.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDelivery.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDelivery.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliveryMode.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliveryMode.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliverySelection.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliverySelection.js +1 -1
- package/dist/openapi/models/OptionSchema.d.ts +18 -6
- package/dist/openapi/models/OptionSchema.js +1 -1
- package/dist/openapi/models/PerRoleCardinalityEntry.d.ts +1 -1
- package/dist/openapi/models/PerRoleCardinalityEntry.js +1 -1
- package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +1 -1
- package/dist/openapi/models/PerValueAvailabilityEntry.js +1 -1
- package/dist/openapi/models/PresignedUrlPart.d.ts +1 -1
- package/dist/openapi/models/PresignedUrlPart.js +1 -1
- package/dist/openapi/models/ProbePendingResponse.d.ts +1 -1
- package/dist/openapi/models/ProbePendingResponse.js +1 -1
- package/dist/openapi/models/ProcessingClass.d.ts +1 -1
- package/dist/openapi/models/ProcessingClass.js +1 -1
- package/dist/openapi/models/ProcessingClassBandViolation.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassBandViolation.js +1 -1
- package/dist/openapi/models/ProcessingClassConstraints.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassConstraints.js +1 -1
- package/dist/openapi/models/ProcessingClassEntry.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassEntry.js +1 -1
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.js +1 -1
- package/dist/openapi/models/ProcessingClassHint.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassHint.js +1 -1
- package/dist/openapi/models/ProcessingClassReason.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassReason.js +1 -1
- package/dist/openapi/models/ProcessingClassRejectReason.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassRejectReason.js +1 -1
- package/dist/openapi/models/ProcessingPlan.d.ts +1 -1
- package/dist/openapi/models/ProcessingPlan.js +1 -1
- package/dist/openapi/models/ProcessingPlanJob.d.ts +1 -1
- package/dist/openapi/models/ProcessingPlanJob.js +1 -1
- package/dist/openapi/models/ReEncodeDecision.d.ts +1 -1
- package/dist/openapi/models/ReEncodeDecision.js +1 -1
- package/dist/openapi/models/ReadinessResponse.d.ts +1 -1
- package/dist/openapi/models/ReadinessResponse.js +1 -1
- package/dist/openapi/models/RegisterUser422Response.d.ts +1 -1
- package/dist/openapi/models/RegisterUser422Response.js +1 -1
- package/dist/openapi/models/RegisterUserRequest.d.ts +1 -1
- package/dist/openapi/models/RegisterUserRequest.js +1 -1
- package/dist/openapi/models/ResetPasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ResetPasswordRequest.js +1 -1
- package/dist/openapi/models/ResponseEnvelope.d.ts +1 -1
- package/dist/openapi/models/ResponseEnvelope.js +1 -1
- package/dist/openapi/models/RetryResponse.d.ts +1 -1
- package/dist/openapi/models/RetryResponse.js +1 -1
- package/dist/openapi/models/RetrySuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/RetrySuccessEnvelope.js +1 -1
- package/dist/openapi/models/SseCompletionBase.d.ts +1 -1
- package/dist/openapi/models/SseCompletionBase.js +1 -1
- package/dist/openapi/models/SseEventType.d.ts +1 -1
- package/dist/openapi/models/SseEventType.js +1 -1
- package/dist/openapi/models/SseJobCompletedData.d.ts +1 -1
- package/dist/openapi/models/SseJobCompletedData.js +1 -1
- package/dist/openapi/models/SseJobFailedData.d.ts +1 -1
- package/dist/openapi/models/SseJobFailedData.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletion.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletion.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.js +1 -1
- package/dist/openapi/models/SseMultiOutputResultEntry.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputResultEntry.js +1 -1
- package/dist/openapi/models/SseOperationCompletedData.d.ts +1 -1
- package/dist/openapi/models/SseOperationCompletedData.js +1 -1
- package/dist/openapi/models/SseOperationCompletionResult.d.ts +1 -1
- package/dist/openapi/models/SseOperationCompletionResult.js +1 -1
- package/dist/openapi/models/SseOperationFailedData.d.ts +1 -1
- package/dist/openapi/models/SseOperationFailedData.js +1 -1
- package/dist/openapi/models/SseOperationProgressData.d.ts +1 -1
- package/dist/openapi/models/SseOperationProgressData.js +1 -1
- package/dist/openapi/models/SseSingleOutputCompletion.d.ts +1 -1
- package/dist/openapi/models/SseSingleOutputCompletion.js +1 -1
- package/dist/openapi/models/SseWorkflowTerminalData.d.ts +1 -1
- package/dist/openapi/models/SseWorkflowTerminalData.js +1 -1
- package/dist/openapi/models/TierRestrictionKind.d.ts +1 -1
- package/dist/openapi/models/TierRestrictionKind.js +1 -1
- package/dist/openapi/models/TierRestrictionResponse.d.ts +1 -1
- package/dist/openapi/models/TierRestrictionResponse.js +1 -1
- package/dist/openapi/models/UpdateProfile200Response.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile200Response.js +1 -1
- package/dist/openapi/models/UpdateProfile200ResponseData.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile200ResponseData.js +1 -1
- package/dist/openapi/models/UpdateProfile422Response.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile422Response.js +1 -1
- package/dist/openapi/models/UpdateProfileRequest.d.ts +1 -1
- package/dist/openapi/models/UpdateProfileRequest.js +1 -1
- package/dist/openapi/models/UploadConstraintsApplied.d.ts +1 -1
- package/dist/openapi/models/UploadConstraintsApplied.js +1 -1
- package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +1 -1
- package/dist/openapi/models/UploadDurationExceedsTierResponse.js +1 -1
- package/dist/openapi/models/UploadFile403Response.d.ts +1 -1
- package/dist/openapi/models/UploadFile403Response.js +1 -1
- package/dist/openapi/models/UploadFile422Response.d.ts +1 -1
- package/dist/openapi/models/UploadFile422Response.js +1 -1
- package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +1 -1
- package/dist/openapi/models/UploadProbeMediaMetadata.js +1 -1
- package/dist/openapi/models/UploadProbeProcessingClass.d.ts +1 -1
- package/dist/openapi/models/UploadProbeProcessingClass.js +1 -1
- package/dist/openapi/models/UploadProbeResponse.d.ts +1 -1
- package/dist/openapi/models/UploadProbeResponse.js +1 -1
- package/dist/openapi/models/UploadProbeStatus.d.ts +1 -1
- package/dist/openapi/models/UploadProbeStatus.js +1 -1
- package/dist/openapi/models/UploadProbeSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/UploadProbeSuccessEnvelope.js +1 -1
- package/dist/openapi/models/UploadResponse.d.ts +1 -1
- package/dist/openapi/models/UploadResponse.js +1 -1
- package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +1 -1
- package/dist/openapi/models/UploadSizeExceedsTierResponse.js +1 -1
- package/dist/openapi/models/UploadSource.d.ts +1 -1
- package/dist/openapi/models/UploadSource.js +1 -1
- package/dist/openapi/models/UploadSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/UploadSuccessEnvelope.js +1 -1
- package/dist/openapi/models/UploadThresholds.d.ts +1 -1
- package/dist/openapi/models/UploadThresholds.js +1 -1
- package/dist/openapi/models/UserTier.d.ts +11 -4
- package/dist/openapi/models/UserTier.js +11 -4
- package/dist/openapi/models/ValidationErrorEnvelope.d.ts +1 -1
- package/dist/openapi/models/ValidationErrorEnvelope.js +1 -1
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +1 -1
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +1 -1
- package/dist/openapi/models/VerifyEmailRequest.d.ts +1 -1
- package/dist/openapi/models/VerifyEmailRequest.js +1 -1
- package/dist/openapi/models/WarningType.d.ts +1 -1
- package/dist/openapi/models/WarningType.js +1 -1
- package/dist/openapi/models/WebhookOperationContext.d.ts +1 -1
- package/dist/openapi/models/WebhookOperationContext.js +1 -1
- package/dist/openapi/models/WebhookPayload.d.ts +1 -1
- package/dist/openapi/models/WebhookPayload.js +1 -1
- package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelBillingEffect.js +1 -1
- package/dist/openapi/models/WorkflowCancelResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelResponse.js +1 -1
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowCreateRequest.d.ts +1 -1
- package/dist/openapi/models/WorkflowCreateRequest.js +1 -1
- package/dist/openapi/models/WorkflowCreateResponse.d.ts +20 -2
- package/dist/openapi/models/WorkflowCreateResponse.js +2 -1
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowDownloadResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowDownloadResponse.js +1 -1
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowEdge.d.ts +1 -1
- package/dist/openapi/models/WorkflowEdge.js +1 -1
- package/dist/openapi/models/WorkflowExpiredResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowExpiredResponse.js +1 -1
- package/dist/openapi/models/WorkflowListResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowListResponse.js +1 -1
- package/dist/openapi/models/WorkflowListSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowListSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +1 -1
- package/dist/openapi/models/WorkflowPauseRequiredAction.js +1 -1
- package/dist/openapi/models/WorkflowPausedDetail.d.ts +1 -1
- package/dist/openapi/models/WorkflowPausedDetail.js +1 -1
- package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +1 -1
- package/dist/openapi/models/WorkflowPausedDetailLinks.js +1 -1
- package/dist/openapi/models/WorkflowProcessing.d.ts +1 -1
- package/dist/openapi/models/WorkflowProcessing.js +1 -1
- package/dist/openapi/models/WorkflowResumeResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowResumeResponse.js +1 -1
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowSource.d.ts +1 -1
- package/dist/openapi/models/WorkflowSource.js +1 -1
- package/dist/openapi/models/WorkflowStatus.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatus.js +1 -1
- package/dist/openapi/models/WorkflowStatusResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatusResponse.js +1 -1
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowSummary.d.ts +1 -1
- package/dist/openapi/models/WorkflowSummary.js +1 -1
- package/dist/openapi/models/WorkflowSummaryJob.d.ts +1 -1
- package/dist/openapi/models/WorkflowSummaryJob.js +1 -1
- package/dist/openapi/models/WorkflowWarning.d.ts +1 -1
- package/dist/openapi/models/WorkflowWarning.js +1 -1
- package/dist/openapi/models/WorkflowWarningSeverity.d.ts +1 -1
- package/dist/openapi/models/WorkflowWarningSeverity.js +1 -1
- package/dist/openapi/models/index.d.ts +4 -0
- package/dist/openapi/models/index.js +4 -0
- package/dist/openapi/runtime.d.ts +1 -1
- package/dist/openapi/runtime.js +1 -1
- package/dist/operations/compress.d.ts +16 -0
- package/dist/operations/compress.js +16 -0
- package/dist/operations/compress.metadata.js +39 -2
- package/openapi/api.yaml +326 -15
- package/operations/schemas/compress.yaml +157 -32
- package/operations/schemas/convert.yaml +13 -2
- package/operations/schemas/split.yaml +10 -7
- package/package.json +1 -1
package/asyncapi/events.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
asyncapi: 3.0.0
|
|
2
2
|
info:
|
|
3
3
|
title: GISL Compression Events
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.20.0
|
|
5
5
|
description: |
|
|
6
6
|
Asynchronous event contracts for the GISL (Give It Smaller) compression service.
|
|
7
7
|
|
|
@@ -31,7 +31,9 @@ info:
|
|
|
31
31
|
`availability: beta` for its `audio` and `video` mime_groups
|
|
32
32
|
(workers live on staging — [`vKI0CFDu`](https://trello.com/c/vKI0CFDu);
|
|
33
33
|
video activates BOTH classes — `long_form` / `split-video-fargate`
|
|
34
|
-
|
|
34
|
+
deployed + wired on staging but NOT yet proven end-to-end per
|
|
35
|
+
[`rcwvUKhI`](https://trello.com/c/rcwvUKhI) — first customer-path soak
|
|
36
|
+
incomplete, 4GB+ speed-up unmeasured, fan-out flag-gated dark);
|
|
35
37
|
its `image_gif` and `document_pdf` mime_groups stay
|
|
36
38
|
`availability: planned`.
|
|
37
39
|
`audio_to_video` and `video_watermark` are `availability: beta`
|
|
@@ -218,7 +220,8 @@ channels:
|
|
|
218
220
|
ship per [`vKI0CFDu`](https://trello.com/c/vKI0CFDu);
|
|
219
221
|
long-form video splits route via `processing_class` to the
|
|
220
222
|
`split-video-fargate` worker — same OperationType, different
|
|
221
|
-
worker —
|
|
223
|
+
worker — now also `availability: beta` (worker deployed + wired
|
|
224
|
+
on staging, e2e-unproven, fan-out flag-gated dark))
|
|
222
225
|
- `operation_type = audio_watermark` -> `ops-audio-watermark`
|
|
223
226
|
queue (gated by `availability: planned` +
|
|
224
227
|
`required_tier: enterprise` per
|
|
@@ -1853,12 +1856,16 @@ operations:
|
|
|
1853
1856
|
The `operation-split` Lambda (lambdas pre-launch epic Wave A)
|
|
1854
1857
|
consumes split requests routed by `operation_type=split`. Its
|
|
1855
1858
|
`audio` + short-form `video` paths are live on staging (lambdas
|
|
1856
|
-
#161 / [`vKI0CFDu`](https://trello.com/c/vKI0CFDu));
|
|
1857
|
-
`
|
|
1858
|
-
|
|
1859
|
+
#161 / [`vKI0CFDu`](https://trello.com/c/vKI0CFDu)); video
|
|
1860
|
+
`long_form` (via `split-video-fargate`) is now also `beta` —
|
|
1861
|
+
deployed + wired on staging but e2e-unproven, fan-out flag-gated
|
|
1862
|
+
dark; the `image_gif` / `document_pdf` workers remain a cross-repo
|
|
1863
|
+
follow-up. Single-input —
|
|
1859
1864
|
`media_group` derives from the input MIME prefix per the
|
|
1860
1865
|
existing single-input rule. `availability: beta` for the `audio`
|
|
1861
|
-
and `video` (short-form
|
|
1866
|
+
and `video` mime_groups (short-form + long-form video both beta;
|
|
1867
|
+
only short-form video reaches this `ops-split` queue — long-form
|
|
1868
|
+
routes via `split-video-fargate`); the
|
|
1862
1869
|
`image_gif` and `document_pdf` mime_groups stay `availability:
|
|
1863
1870
|
planned`, and the API rejects their workflow-create with
|
|
1864
1871
|
`feature_not_available` (422) until those Lambdas ship.
|
|
@@ -3554,7 +3561,9 @@ components:
|
|
|
3554
3561
|
these three long-form classes are `availability: beta` (compress +
|
|
3555
3562
|
merge per CON-1; `split.video.long_form` per
|
|
3556
3563
|
[`rcwvUKhI`](https://trello.com/c/rcwvUKhI), worker
|
|
3557
|
-
`split-video-fargate`
|
|
3564
|
+
`split-video-fargate` deployed + wired on staging but NOT yet proven
|
|
3565
|
+
end-to-end — first customer-path soak incomplete, speed-up unmeasured,
|
|
3566
|
+
fan-out flag-gated dark). `audio_overlay` long-form
|
|
3558
3567
|
(reserve-name-only, no queue) is NOT yet produced and is therefore
|
|
3559
3568
|
absent from this enum; it gets added when its publisher ships.
|
|
3560
3569
|
|
|
@@ -3901,6 +3910,32 @@ components:
|
|
|
3901
3910
|
exclusive with `outputs[]`. Absent for multi-output operations and
|
|
3902
3911
|
on failure.
|
|
3903
3912
|
example: 2097152
|
|
3913
|
+
output_file_type:
|
|
3914
|
+
type: string
|
|
3915
|
+
maxLength: 100
|
|
3916
|
+
description: |
|
|
3917
|
+
OPTIONAL. MIME type of the produced artifact, as reported by the worker
|
|
3918
|
+
that wrote the bytes (single-output completion). Present on completion
|
|
3919
|
+
only; absent on failure. Informative alongside `output_key`, not mutually
|
|
3920
|
+
exclusive — single-output results MAY carry it.
|
|
3921
|
+
|
|
3922
|
+
Name follows the `events.yaml` MIME convention (`OperationRequest.file_type`
|
|
3923
|
+
is the input MIME; `output_file_type` is the output MIME). The OpenAPI/REST
|
|
3924
|
+
surface names the same concept `mime_type`.
|
|
3925
|
+
|
|
3926
|
+
**Purpose (future-proofing per ADR-0022).** The API consumes this MIME +
|
|
3927
|
+
its deterministic MIME→extension map (`DownloadFilenameComputer`) to derive
|
|
3928
|
+
the canonical download extension and the download `Content-Type` header
|
|
3929
|
+
SERVER-SIDE. It is NOT the download filename (the API already has that from
|
|
3930
|
+
the key). For today's traffic the API can infer the output MIME (compress is
|
|
3931
|
+
same-format; the compress+format facade canonicalizes to `convert` whose
|
|
3932
|
+
target is known), so this is **advisory/future-proofing** for a
|
|
3933
|
+
runtime-format-selection path (e.g. `compress output_format=auto|smallest`,
|
|
3934
|
+
currently `planned`/unbuilt) — landed additively now (cf. `watermark_id`) so
|
|
3935
|
+
that path needs no later contract bump. Wire-only: the API derives the
|
|
3936
|
+
ext/Content-Type server-side and does not echo this MIME onto the REST read
|
|
3937
|
+
surface (`OperationDownload`).
|
|
3938
|
+
example: "image/webp"
|
|
3904
3939
|
|
|
3905
3940
|
# Multi-output success fields (per ADR-0009 MultiOutputCompletion)
|
|
3906
3941
|
outputs:
|
|
@@ -3916,13 +3951,15 @@ components:
|
|
|
3916
3951
|
|
|
3917
3952
|
**`maxItems: 200`** is a worst-case transport-layer defence
|
|
3918
3953
|
against SQS/SNS's 256 KiB payload cap. Worst-case per-entry size
|
|
3919
|
-
is ~
|
|
3920
|
-
bytes JSON envelope per
|
|
3921
|
-
KB, leaving ~
|
|
3922
|
-
(`job_id`, `operation_id`,
|
|
3923
|
-
etc.).
|
|
3924
|
-
|
|
3925
|
-
|
|
3954
|
+
is ~1205 bytes (1024-char `output_key` at the S3 hard limit + the
|
|
3955
|
+
100-char-capped `output_file_type` + ~80 bytes JSON envelope per
|
|
3956
|
+
entry); 200 entries × 1205 bytes ≈ 241 KB, leaving ~15 KB headroom
|
|
3957
|
+
for the outer message envelope (`job_id`, `operation_id`,
|
|
3958
|
+
`metrics`, `total_output_size_bytes`, etc.). `output_file_type` is
|
|
3959
|
+
`maxLength: 100` precisely so it cannot blow this bound (real
|
|
3960
|
+
produced MIMEs are <80 chars). Typical Lambda-generated keys are
|
|
3961
|
+
~110 chars so the realistic per-message size stays well under the
|
|
3962
|
+
cap; this bound defends against the worst case, not the typical case.
|
|
3926
3963
|
|
|
3927
3964
|
Operations that could theoretically exceed 200 outputs from one
|
|
3928
3965
|
logical operation (e.g. convert PDF->image on a >200-page PDF)
|
|
@@ -4044,6 +4081,18 @@ components:
|
|
|
4044
4081
|
minimum: 0
|
|
4045
4082
|
description: Size of this individual output file in bytes.
|
|
4046
4083
|
example: 262144
|
|
4084
|
+
output_file_type:
|
|
4085
|
+
type: string
|
|
4086
|
+
maxLength: 100
|
|
4087
|
+
description: |
|
|
4088
|
+
OPTIONAL. MIME type of THIS individual output file, as reported by the
|
|
4089
|
+
worker (per-output, multi-output operations). Authoritative per-entry for
|
|
4090
|
+
multi-output (heterogeneous fan-out e.g. convert PDF→image — each entry MAY
|
|
4091
|
+
differ); the top-level `output_file_type` covers the single-output shape.
|
|
4092
|
+
Present on completion only. See ADR-0022 — the API derives the per-output
|
|
4093
|
+
download extension + Content-Type server-side from this MIME via its
|
|
4094
|
+
MIME→extension map. Future-proofing (additive now, cf. `target_id`).
|
|
4095
|
+
example: "image/png"
|
|
4047
4096
|
page_index:
|
|
4048
4097
|
type: integer
|
|
4049
4098
|
minimum: 1
|
|
@@ -4732,10 +4781,11 @@ components:
|
|
|
4732
4781
|
`processing_class`. `media_group` derives from the input
|
|
4733
4782
|
MIME prefix per the existing single-input rule (no
|
|
4734
4783
|
operation-specific conditional needed). `availability: beta`
|
|
4735
|
-
for the `audio` and `video`
|
|
4736
|
-
|
|
4737
|
-
|
|
4738
|
-
|
|
4784
|
+
for the `audio` and `video` mime_groups — video activates
|
|
4785
|
+
BOTH classes (`short_form` + `long_form` beta; long-form
|
|
4786
|
+
deployed + wired on staging but e2e-unproven, fan-out
|
|
4787
|
+
flag-gated dark). `image_gif` / `document_pdf` stay
|
|
4788
|
+
`planned`. Routes via `operation_type=split` to `ops-split`.
|
|
4739
4789
|
Per ADR-0004 + ADR-0014
|
|
4740
4790
|
([`vKI0CFDu`](https://trello.com/c/vKI0CFDu)).
|
|
4741
4791
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"capabilities_version":
|
|
2
|
+
"capabilities_version": 101,
|
|
3
3
|
"endpoints": {
|
|
4
4
|
"DELETE /api/auth/api-keys/{apiKeyId}": {
|
|
5
5
|
"auth": "required",
|
|
@@ -29,6 +29,13 @@
|
|
|
29
29
|
"operation_id": "getUploadMetadata",
|
|
30
30
|
"required_tier": null
|
|
31
31
|
},
|
|
32
|
+
"GET /api/v2/account/limits": {
|
|
33
|
+
"auth": "required",
|
|
34
|
+
"availability": "stable",
|
|
35
|
+
"identity_scoped": true,
|
|
36
|
+
"operation_id": "getAccountLimits",
|
|
37
|
+
"required_tier": null
|
|
38
|
+
},
|
|
32
39
|
"GET /api/v2/credits/balance": {
|
|
33
40
|
"auth": "required",
|
|
34
41
|
"availability": "stable",
|
|
@@ -867,7 +874,7 @@
|
|
|
867
874
|
"options": {
|
|
868
875
|
"bitrate": {
|
|
869
876
|
"default": 128,
|
|
870
|
-
"description": "Output bitrate in kbps. Applies to lossy
|
|
877
|
+
"description": "Output bitrate in kbps (CBR/ABR). Applies to lossy OUTPUTS. Only a caller-EXPLICIT bitrate against a lossless output is rejected as invalid_options (flac/wav have no bitrate target); the `default: 128` is never the basis for a rejection (ADR-0020 D1, carried into ADR-0023 \u2014 a default a caller did not set is the server's to resolve, and is dropped for a lossless target). The output is the input format unless `output_format` re-targets it: with `output_format: original` the lossy/lossless distinction follows the input MIME (mpeg/aac/ogg/mp4 = lossy \u2192 bitrate applies; flac/wav input \u2192 an explicit bitrate is rejected); with an explicit `output_format`, it follows that target (flac/wav target \u2192 an explicit bitrate is rejected). Not expressed as `depends_on` \u2014 the lossy-output condition is an output-value \u00d7 input-MIME cross-axis the option-to-option `depends_on` cannot model without dropping `original` and breaking same-format callers. The other knobs (channels/sample_rate/normalize) apply to all formats.\n",
|
|
871
878
|
"type": "enum",
|
|
872
879
|
"value_type": "integer",
|
|
873
880
|
"values": [
|
|
@@ -890,6 +897,19 @@
|
|
|
890
897
|
"description": "Apply loudness normalization (EBU R128 / -14 LUFS target)",
|
|
891
898
|
"type": "boolean"
|
|
892
899
|
},
|
|
900
|
+
"output_format": {
|
|
901
|
+
"default": "original",
|
|
902
|
+
"description": "Output audio format. original = keep input format (default, same-format compression). Non-`original` values re-target the container/codec via the API \"compress+format\" facade (one canonicalized convert pass); see FORMAT.md.",
|
|
903
|
+
"type": "enum",
|
|
904
|
+
"values": [
|
|
905
|
+
"original",
|
|
906
|
+
"mp3",
|
|
907
|
+
"aac",
|
|
908
|
+
"ogg",
|
|
909
|
+
"flac",
|
|
910
|
+
"wav"
|
|
911
|
+
]
|
|
912
|
+
},
|
|
893
913
|
"sample_rate": {
|
|
894
914
|
"description": "Audio sample rate in Hz",
|
|
895
915
|
"type": "enum",
|
|
@@ -1077,7 +1097,24 @@
|
|
|
1077
1097
|
},
|
|
1078
1098
|
"output_format": {
|
|
1079
1099
|
"default": "original",
|
|
1080
|
-
"description": "Output format. original = keep input format
|
|
1100
|
+
"description": "Output format. original = keep input format (default); auto = best for browser support (AVIF > WebP > JPEG via Accept hint); smallest = try all supported formats, return the smallest. Non-`original` values are served by the API \"compress+format\" facade (one combined convert-with-size-cap pass); see per_value_availability + FORMAT.md.",
|
|
1101
|
+
"per_value_availability": {
|
|
1102
|
+
"auto": {
|
|
1103
|
+
"availability": "planned"
|
|
1104
|
+
},
|
|
1105
|
+
"avif": {
|
|
1106
|
+
"availability": "planned"
|
|
1107
|
+
},
|
|
1108
|
+
"jpeg": {
|
|
1109
|
+
"availability": "planned"
|
|
1110
|
+
},
|
|
1111
|
+
"png": {
|
|
1112
|
+
"availability": "planned"
|
|
1113
|
+
},
|
|
1114
|
+
"smallest": {
|
|
1115
|
+
"availability": "planned"
|
|
1116
|
+
}
|
|
1117
|
+
},
|
|
1081
1118
|
"type": "enum",
|
|
1082
1119
|
"values": [
|
|
1083
1120
|
"original",
|
|
@@ -1119,8 +1156,14 @@
|
|
|
1119
1156
|
],
|
|
1120
1157
|
"options": {
|
|
1121
1158
|
"audio_bitrate": {
|
|
1122
|
-
"
|
|
1123
|
-
|
|
1159
|
+
"depends_on": {
|
|
1160
|
+
"audio_codec": [
|
|
1161
|
+
"aac",
|
|
1162
|
+
"opus",
|
|
1163
|
+
"vorbis"
|
|
1164
|
+
]
|
|
1165
|
+
},
|
|
1166
|
+
"description": "Audio track bitrate in kbps. Only valid with an explicit re-encode audio_codec (aac/opus/vorbis): an explicit audio_bitrate with audio_codec `copy`/omitted is rejected as `invalid_options` at workflow-create (the API enforces this `depends_on`); copy preserves the source bitrate. FE/SDK also prune it pre-submit. No default: a bitrate is only meaningful on an explicit re-encode (matches the worker, which applies none).\n",
|
|
1124
1167
|
"type": "enum",
|
|
1125
1168
|
"value_type": "integer",
|
|
1126
1169
|
"values": [
|
|
@@ -1134,7 +1177,7 @@
|
|
|
1134
1177
|
},
|
|
1135
1178
|
"audio_codec": {
|
|
1136
1179
|
"default": "copy",
|
|
1137
|
-
"description": "Audio codec. copy = passthrough (keep the source
|
|
1180
|
+
"description": "Audio codec. copy = passthrough (keep the source stream as-is; re-encode only on explicit request) \u2014 aac/opus/vorbis re-encode. Default is `copy` (ADR-0020 D7, carried into ADR-0023): on the same-container path (`output_format` original/absent) the source stream is already container-compatible, so copy is safe. When `output_format` RE-TARGETS the container, an absent/default audio_codec resolves to a container-valid codec via the facade (e.g. webm -> opus), NOT a blind copy of an incompatible stream \u2014 a DEFAULT is never rejected (the exact per-container resolution, incl. ogg vorbis-vs-opus, is an output_format stable-flip prerequisite, ADR-0023 D5). A caller-EXPLICIT codec the resolved container cannot carry (e.g. aac on a webm target) returns invalid_options. See FORMAT.md \"Container-conditional defaults\" + ADR-0023 (supersedes ADR-0020).\n",
|
|
1138
1181
|
"type": "enum",
|
|
1139
1182
|
"values": [
|
|
1140
1183
|
"aac",
|
|
@@ -1145,7 +1188,7 @@
|
|
|
1145
1188
|
},
|
|
1146
1189
|
"codec": {
|
|
1147
1190
|
"default": "h264",
|
|
1148
|
-
"description": "Video codec. h264 = widest compatibility, h265/av1 = better compression but slower. The default (h264) is the MP4/MOV standard and is CONTAINER-CONDITIONAL
|
|
1191
|
+
"description": "Video codec. h264 = widest compatibility, h265/av1 = better compression but slower. The default (h264) is the MP4/MOV standard and is CONTAINER-CONDITIONAL against the RESOLVED output container (the explicit `output_format` if set, else the input container): for a container that cannot carry it (e.g. WebM, which carries VP8/VP9/ AV1) the server resolves a container-valid codec (WebM -> vp9). A DEFAULT value is never rejected \u2014 including an explicit `output_format: webm` left at the default `h264` (resolves to vp9, NOT invalid_options); only a caller-EXPLICIT incompatible codec returns invalid_options. See FORMAT.md \"Container-conditional defaults\" + ADR-0023 (supersedes ADR-0020).\n",
|
|
1149
1192
|
"type": "enum",
|
|
1150
1193
|
"values": [
|
|
1151
1194
|
"h264",
|
|
@@ -1166,7 +1209,12 @@
|
|
|
1166
1209
|
},
|
|
1167
1210
|
"encoding_mode": {
|
|
1168
1211
|
"default": "crf",
|
|
1169
|
-
"description": "crf = constant quality (variable file size)
|
|
1212
|
+
"description": "crf = constant quality (variable file size). target_size = constrained file size \u2014 `planned`: the worker does not yet implement the two-pass encode (it rejects target_size); crf only today.",
|
|
1213
|
+
"per_value_availability": {
|
|
1214
|
+
"target_size": {
|
|
1215
|
+
"availability": "planned"
|
|
1216
|
+
}
|
|
1217
|
+
},
|
|
1170
1218
|
"type": "enum",
|
|
1171
1219
|
"values": [
|
|
1172
1220
|
"crf",
|
|
@@ -1175,7 +1223,7 @@
|
|
|
1175
1223
|
},
|
|
1176
1224
|
"faststart": {
|
|
1177
1225
|
"default": true,
|
|
1178
|
-
"description": "Move the MP4/MOV moov atom to start for progressive web playback. MP4/MOV only. CONTAINER-CONDITIONAL: the default (true) is silently inapplicable for a container with no moov atom (e.g. WebM) \u2014 that is NOT a rejection. Only a caller-EXPLICIT faststart:true on such a container returns invalid_options. See FORMAT.md \"Container-conditional defaults\" + ADR-0020.\n",
|
|
1226
|
+
"description": "Move the MP4/MOV moov atom to start for progressive web playback. MP4/MOV only. CONTAINER-CONDITIONAL against the RESOLVED output container (the explicit `output_format` if set, else the input): the default (true) is silently inapplicable for a container with no moov atom (e.g. WebM) \u2014 that is NOT a rejection. Only a caller-EXPLICIT faststart:true on such a container returns invalid_options. See FORMAT.md \"Container-conditional defaults\" + ADR-0023 (supersedes ADR-0020).\n",
|
|
1179
1227
|
"type": "boolean"
|
|
1180
1228
|
},
|
|
1181
1229
|
"fit": {
|
|
@@ -1206,6 +1254,28 @@
|
|
|
1206
1254
|
"min": 2,
|
|
1207
1255
|
"type": "integer"
|
|
1208
1256
|
},
|
|
1257
|
+
"output_format": {
|
|
1258
|
+
"default": "original",
|
|
1259
|
+
"description": "Output container. original = keep the input container (default, same-format compression). Non-`original` values re-target the container via the API \"compress+format\" facade (one canonicalized convert-with-size-cap pass); see per_value_availability + ADR-0023 + FORMAT.md. When set, the RESOLVED target container determines the valid codec/audio_codec/faststart sets \u2014 an absent/default codec resolves to a container-valid one (e.g. webm -> vp9) and is never rejected; only a caller-EXPLICIT incompatible value is invalid_options.",
|
|
1260
|
+
"per_value_availability": {
|
|
1261
|
+
"mp4": {
|
|
1262
|
+
"availability": "planned"
|
|
1263
|
+
},
|
|
1264
|
+
"ogg": {
|
|
1265
|
+
"availability": "planned"
|
|
1266
|
+
},
|
|
1267
|
+
"webm": {
|
|
1268
|
+
"availability": "planned"
|
|
1269
|
+
}
|
|
1270
|
+
},
|
|
1271
|
+
"type": "enum",
|
|
1272
|
+
"values": [
|
|
1273
|
+
"original",
|
|
1274
|
+
"mp4",
|
|
1275
|
+
"webm",
|
|
1276
|
+
"ogg"
|
|
1277
|
+
]
|
|
1278
|
+
},
|
|
1209
1279
|
"preset": {
|
|
1210
1280
|
"default": "medium",
|
|
1211
1281
|
"description": "Encoding speed vs compression ratio trade-off",
|
|
@@ -1223,10 +1293,11 @@
|
|
|
1223
1293
|
]
|
|
1224
1294
|
},
|
|
1225
1295
|
"target_size_bytes": {
|
|
1296
|
+
"availability": "planned",
|
|
1226
1297
|
"depends_on": {
|
|
1227
1298
|
"encoding_mode": "target_size"
|
|
1228
1299
|
},
|
|
1229
|
-
"description": "Target output file size in bytes (min 1MB).",
|
|
1300
|
+
"description": "Target output file size in bytes (min 1MB). `planned` \u2014 the worker does not yet implement the two-pass target-size encode.",
|
|
1230
1301
|
"min": 1048576,
|
|
1231
1302
|
"type": "integer"
|
|
1232
1303
|
},
|
|
@@ -1421,7 +1492,14 @@
|
|
|
1421
1492
|
],
|
|
1422
1493
|
"options": {
|
|
1423
1494
|
"codec": {
|
|
1424
|
-
"
|
|
1495
|
+
"depends_on": {
|
|
1496
|
+
"output_format": [
|
|
1497
|
+
"mp4",
|
|
1498
|
+
"webm",
|
|
1499
|
+
"ogg"
|
|
1500
|
+
]
|
|
1501
|
+
},
|
|
1502
|
+
"description": "Video codec for target format. Defaults to the format's standard codec (no literal default \u2014 the required output_format determines it). This is the container-conditional-default principle applied via an explicit container choice. See FORMAT.md \"Container-conditional defaults\" + ADR-0023 (supersedes ADR-0020). Not applicable to a `gif` output (no video codec): an explicit `codec` on a `gif` output is rejected as `invalid_options` at workflow-create (the API enforces this `depends_on`); FE/SDK prune it pre-submit.\n",
|
|
1425
1503
|
"type": "enum",
|
|
1426
1504
|
"values": [
|
|
1427
1505
|
"h264",
|
|
@@ -1443,7 +1521,14 @@
|
|
|
1443
1521
|
},
|
|
1444
1522
|
"quality": {
|
|
1445
1523
|
"default": 23,
|
|
1446
|
-
"
|
|
1524
|
+
"depends_on": {
|
|
1525
|
+
"output_format": [
|
|
1526
|
+
"mp4",
|
|
1527
|
+
"webm",
|
|
1528
|
+
"ogg"
|
|
1529
|
+
]
|
|
1530
|
+
},
|
|
1531
|
+
"description": "CRF value (0 = lossless, 51 = worst). Video outputs only \u2014 NOT applicable to a `gif` output (frame extraction has no CRF). An explicit `quality` on a `gif` output is rejected as `invalid_options` at workflow-create (the API enforces this `depends_on`); FE/SDK prune it pre-submit.\n",
|
|
1447
1532
|
"max": 51,
|
|
1448
1533
|
"min": 0,
|
|
1449
1534
|
"type": "integer"
|
|
@@ -2528,7 +2613,7 @@
|
|
|
2528
2613
|
"split": {
|
|
2529
2614
|
"availability": "beta",
|
|
2530
2615
|
"default": false,
|
|
2531
|
-
"description": "Fan one input file into N outputs across GIF, PDF, audio, and\nvideo MIME families. Single-input \u2014 one input file per job, fanned\ninto N outputs per the per-mime-group catalog. Mirrors the\n`merge` / `convert` catalog-split-by-mime-group pattern.\n\n**Three shared modes** (audio + video; the mode discriminator\ngates which option applies per the `depends_on` rules in this\nschema):\n- `interval`: split every N numeric-seconds.\n- `count`: split into N equal-duration pieces (integer 2..=200).\n- `cut_points`: explicit cut points in numeric-seconds (strictly\n increasing, no duplicates, each > 0 and < probed duration).\n\n**Plus an audio-only `silence` mode** (`beta`, gated by the\n`silence_mode_audio` feature): cut at detected silence gaps via\nthe worker's ffmpeg `silencedetect` filter. Video stays\nthree-mode.\n\n**GIF + PDF use range-based selection** instead of three modes:\n- GIF (`image_gif`): `frame_range` REQUIRED + `output_format`\n enum {png,webp,jpg}.\n- PDF (`document_pdf`): `page_range` OR `page_groups` (mutually\n exclusive per `depends_on`).\n\n**Wire format**: numeric seconds (floats allowed for sub-second\nprecision). NOT ISO 8601 duration strings. Matches FFmpeg /\nCloudinary / Shotstack / AWS MediaConvert conventions.\n\n**200-output hard cap** per ADR-0009 \u00a7D5\n(`OperationResult.outputs[].maxItems: 200`). Preflight rejects\nrequests exceeding this BEFORE work as `invalid_options` (422).\nCap math by mode:\n- `interval`: `ceil(probed_duration / interval) <= 200`\n- `count`: enforced by the option's `min: 2 max: 200` range\n- `cut_points`: `cut_points.len() + 1 <= 200`\n- `silence` (audio): resolved segment count (detected gaps + 1)\n `<= 200`; preflight rejects as `invalid_options` (422)\n- PDF: resolved page count after expansion `<= 200`\n (cross-ref [`WgCqnMRa`](https://trello.com/c/WgCqnMRa))\n- GIF: resolved frame count after expansion `<= 200`\n\n**Output naming**: 3-digit zero-padded \u2014 `output-001` ..\n`output-200`. Matches the convert PDF\u2192N precedent.\n\n**Output envelope binding** (per ADR-0014 + ADR-0009 \u00a7D2):\n- `image_gif`: `PositionIndexed` (frame stream-position 0-based\n ordinal)\n- `document_pdf`: `PageIndexed` (1-based gapless page index)\n- `audio`: `PositionIndexed` (cut stream-position ordinal)\n- `video`: `PositionIndexed` (cut stream-position ordinal)\n\n**`precision` flag** (audio + video only): `fast` (default) =\npacket-boundary approximate cuts; `exact` = re-encode-aligned\nprecise cuts. Mime_group scoping is the gate \u2014 precision does\nNOT apply to GIF or PDF (frame extraction is exact and PDF page\nselection is exact by definition).\n\n**Long-form video** routes to a separate `split-video-fargate`\nLambda (same `split` OperationType, different worker; routing\nvia `processing_class`). No schema-side discriminator beyond MIME\ndetection + `processing_class`.\n\n`availability: beta` for the `audio` and `video` mime_groups\n(workers live on staging \u2014 shape-stable + opt-in, MUST NOT 422).\nVideo activates **both classes**: `video.processing_class.short_form`\nAND `long_form` are `beta` \u2014 the `split-video-fargate` worker is
|
|
2616
|
+
"description": "Fan one input file into N outputs across GIF, PDF, audio, and\nvideo MIME families. Single-input \u2014 one input file per job, fanned\ninto N outputs per the per-mime-group catalog. Mirrors the\n`merge` / `convert` catalog-split-by-mime-group pattern.\n\n**Three shared modes** (audio + video; the mode discriminator\ngates which option applies per the `depends_on` rules in this\nschema):\n- `interval`: split every N numeric-seconds.\n- `count`: split into N equal-duration pieces (integer 2..=200).\n- `cut_points`: explicit cut points in numeric-seconds (strictly\n increasing, no duplicates, each > 0 and < probed duration).\n\n**Plus an audio-only `silence` mode** (`beta`, gated by the\n`silence_mode_audio` feature): cut at detected silence gaps via\nthe worker's ffmpeg `silencedetect` filter. Video stays\nthree-mode.\n\n**GIF + PDF use range-based selection** instead of three modes:\n- GIF (`image_gif`): `frame_range` REQUIRED + `output_format`\n enum {png,webp,jpg}.\n- PDF (`document_pdf`): `page_range` OR `page_groups` (mutually\n exclusive per `depends_on`).\n\n**Wire format**: numeric seconds (floats allowed for sub-second\nprecision). NOT ISO 8601 duration strings. Matches FFmpeg /\nCloudinary / Shotstack / AWS MediaConvert conventions.\n\n**200-output hard cap** per ADR-0009 \u00a7D5\n(`OperationResult.outputs[].maxItems: 200`). Preflight rejects\nrequests exceeding this BEFORE work as `invalid_options` (422).\nCap math by mode:\n- `interval`: `ceil(probed_duration / interval) <= 200`\n- `count`: enforced by the option's `min: 2 max: 200` range\n- `cut_points`: `cut_points.len() + 1 <= 200`\n- `silence` (audio): resolved segment count (detected gaps + 1)\n `<= 200`; preflight rejects as `invalid_options` (422)\n- PDF: resolved page count after expansion `<= 200`\n (cross-ref [`WgCqnMRa`](https://trello.com/c/WgCqnMRa))\n- GIF: resolved frame count after expansion `<= 200`\n\n**Output naming**: 3-digit zero-padded \u2014 `output-001` ..\n`output-200`. Matches the convert PDF\u2192N precedent.\n\n**Output envelope binding** (per ADR-0014 + ADR-0009 \u00a7D2):\n- `image_gif`: `PositionIndexed` (frame stream-position 0-based\n ordinal)\n- `document_pdf`: `PageIndexed` (1-based gapless page index)\n- `audio`: `PositionIndexed` (cut stream-position ordinal)\n- `video`: `PositionIndexed` (cut stream-position ordinal)\n\n**`precision` flag** (audio + video only): `fast` (default) =\npacket-boundary approximate cuts; `exact` = re-encode-aligned\nprecise cuts. Mime_group scoping is the gate \u2014 precision does\nNOT apply to GIF or PDF (frame extraction is exact and PDF page\nselection is exact by definition).\n\n**Long-form video** routes to a separate `split-video-fargate`\nLambda (same `split` OperationType, different worker; routing\nvia `processing_class`). No schema-side discriminator beyond MIME\ndetection + `processing_class`.\n\n`availability: beta` for the `audio` and `video` mime_groups\n(workers live on staging \u2014 shape-stable + opt-in, MUST NOT 422).\nVideo activates **both classes**: `video.processing_class.short_form`\nAND `long_form` are `beta` \u2014 the `split-video-fargate` worker is\ndeployed + wired on staging but NOT yet proven end-to-end\n([`rcwvUKhI`](https://trello.com/c/rcwvUKhI); the first customer-path\nsoak has not completed and the 4GB+ speed-up is unmeasured; the\nlong-form fan-out is flag-gated dark). The `image_gif` and\n`document_pdf` mime_groups stay `availability: planned` until their\ncross-repo Lambda workers ship ([`vKI0CFDu`](https://trello.com/c/vKI0CFDu)\n+ lambdas L1); dispatch returns `feature_not_available` (422) for the\nstill-planned groups/classes until then.\n\nPer ADR-0014.\n",
|
|
2532
2617
|
"features": {
|
|
2533
2618
|
"silence_mode_audio": {
|
|
2534
2619
|
"availability": "beta",
|
|
@@ -3316,7 +3401,7 @@
|
|
|
3316
3401
|
}
|
|
3317
3402
|
}
|
|
3318
3403
|
},
|
|
3319
|
-
"schema_version": "2.
|
|
3404
|
+
"schema_version": "2.78.0",
|
|
3320
3405
|
"source_commit": null,
|
|
3321
3406
|
"user_tier": null,
|
|
3322
3407
|
"workflow_features": {
|
|
@@ -14,6 +14,7 @@ interface Failure {
|
|
|
14
14
|
'output_bucket'?: string;
|
|
15
15
|
'output_key'?: string;
|
|
16
16
|
'output_size_bytes'?: number;
|
|
17
|
+
'output_file_type'?: string;
|
|
17
18
|
'outputs'?: (PageIndexed | PositionIndexed | Unindexed)[];
|
|
18
19
|
'total_output_size_bytes'?: number;
|
|
19
20
|
'metrics'?: OperationMetrics;
|
|
@@ -14,6 +14,7 @@ interface MultiOutputCompletion {
|
|
|
14
14
|
'output_bucket': string;
|
|
15
15
|
'output_key'?: string;
|
|
16
16
|
'output_size_bytes'?: number;
|
|
17
|
+
'output_file_type'?: string;
|
|
17
18
|
'outputs': (PageIndexed | PositionIndexed | Unindexed)[];
|
|
18
19
|
'total_output_size_bytes': number;
|
|
19
20
|
'metrics'?: OperationMetrics;
|
|
@@ -14,6 +14,7 @@ interface SingleOutputCompletion {
|
|
|
14
14
|
'output_bucket': string;
|
|
15
15
|
'output_key': string;
|
|
16
16
|
'output_size_bytes': number;
|
|
17
|
+
'output_file_type'?: string;
|
|
17
18
|
'outputs'?: (PageIndexed | PositionIndexed | Unindexed)[];
|
|
18
19
|
'total_output_size_bytes'?: number;
|
|
19
20
|
'metrics'?: OperationMetrics;
|
|
@@ -0,0 +1,54 @@
|
|
|
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 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. - **Currently committed locales:** `en-GB` only (per ticket [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier shape (`Accept-Language` + `Content-Language` + `Vary` headers + `locale` envelope field + `message_key` + `message_params`) is stable and exercised; the **catalog** of translated `message` strings is en-GB-only at runtime today. Additional locales (e.g. `pt-PT`) will be advertised by name when their catalogs ship — the request/response carrier shape does NOT change when a new locale lands. Treat unrequested locales as \"machine-code + `message_key` path is committed; localised `message` prose is not\" until this prose enumerates them by name. - **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 — which, until additional catalogs land, is every non-`en-GB` `Accept-Language`. - **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). `Vary` is emitted unconditionally so the header contract does not flip when a second locale ships. - **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.78.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
|
+
* One account limit: the effective value (override ?? tier default),
|
|
14
|
+
* the tier default, and whether a per-account override is active. The
|
|
15
|
+
* override mechanism / store is NOT exposed — only the resolved
|
|
16
|
+
* numbers plus the `overridden` flag.
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccountLimitEntry
|
|
20
|
+
*/
|
|
21
|
+
export interface AccountLimitEntry {
|
|
22
|
+
/**
|
|
23
|
+
* The cap in force for this account, in bytes
|
|
24
|
+
* (`override ?? tier_default`).
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof AccountLimitEntry
|
|
28
|
+
*/
|
|
29
|
+
effective: number;
|
|
30
|
+
/**
|
|
31
|
+
* The tier's default cap for this limit, in bytes (already public
|
|
32
|
+
* via the tier model).
|
|
33
|
+
*
|
|
34
|
+
* @type {number}
|
|
35
|
+
* @memberof AccountLimitEntry
|
|
36
|
+
*/
|
|
37
|
+
tierDefault: number;
|
|
38
|
+
/**
|
|
39
|
+
* True iff a per-account override is active (i.e. `effective`
|
|
40
|
+
* comes from an override rather than the tier default).
|
|
41
|
+
*
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof AccountLimitEntry
|
|
44
|
+
*/
|
|
45
|
+
overridden: boolean;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Check if a given object implements the AccountLimitEntry interface.
|
|
49
|
+
*/
|
|
50
|
+
export declare function instanceOfAccountLimitEntry(value: object): value is AccountLimitEntry;
|
|
51
|
+
export declare function AccountLimitEntryFromJSON(json: any): AccountLimitEntry;
|
|
52
|
+
export declare function AccountLimitEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountLimitEntry;
|
|
53
|
+
export declare function AccountLimitEntryToJSON(json: any): AccountLimitEntry;
|
|
54
|
+
export declare function AccountLimitEntryToJSONTyped(value?: AccountLimitEntry | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
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 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. - **Currently committed locales:** `en-GB` only (per ticket [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier shape (`Accept-Language` + `Content-Language` + `Vary` headers + `locale` envelope field + `message_key` + `message_params`) is stable and exercised; the **catalog** of translated `message` strings is en-GB-only at runtime today. Additional locales (e.g. `pt-PT`) will be advertised by name when their catalogs ship — the request/response carrier shape does NOT change when a new locale lands. Treat unrequested locales as \"machine-code + `message_key` path is committed; localised `message` prose is not\" until this prose enumerates them by name. - **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 — which, until additional catalogs land, is every non-`en-GB` `Accept-Language`. - **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). `Vary` is emitted unconditionally so the header contract does not flip when a second locale ships. - **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.78.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
|
+
* Check if a given object implements the AccountLimitEntry interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfAccountLimitEntry(value) {
|
|
18
|
+
if (!('effective' in value) || value['effective'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('tierDefault' in value) || value['tierDefault'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('overridden' in value) || value['overridden'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function AccountLimitEntryFromJSON(json) {
|
|
27
|
+
return AccountLimitEntryFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function AccountLimitEntryFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
'effective': json['effective'],
|
|
35
|
+
'tierDefault': json['tier_default'],
|
|
36
|
+
'overridden': json['overridden'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function AccountLimitEntryToJSON(json) {
|
|
40
|
+
return AccountLimitEntryToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
export function AccountLimitEntryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'effective': value['effective'],
|
|
48
|
+
'tier_default': value['tierDefault'],
|
|
49
|
+
'overridden': value['overridden'],
|
|
50
|
+
};
|
|
51
|
+
}
|