@giveitsmaller/contracts 0.2.3 → 0.4.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.
Files changed (397) hide show
  1. package/asyncapi/events.yaml +1777 -172
  2. package/availability/availability.json +2449 -0
  3. package/dist/asyncapi/Failure.d.ts +25 -0
  4. package/dist/asyncapi/Failure.js +1 -0
  5. package/dist/asyncapi/JobInputRole.d.ts +6 -0
  6. package/dist/asyncapi/JobInputRole.js +7 -0
  7. package/dist/asyncapi/MergeOutputType.d.ts +1 -3
  8. package/dist/asyncapi/MergeOutputType.js +0 -2
  9. package/dist/asyncapi/MultiOutputCompletion.d.ts +25 -0
  10. package/dist/asyncapi/MultiOutputCompletion.js +1 -0
  11. package/dist/asyncapi/NotificationsOperationsQueue.d.ts +4 -2
  12. package/dist/asyncapi/OperationMetrics.d.ts +3 -0
  13. package/dist/asyncapi/OperationProgress.d.ts +2 -0
  14. package/dist/asyncapi/OperationResult.d.ts +4 -19
  15. package/dist/asyncapi/OperationType.d.ts +6 -6
  16. package/dist/asyncapi/OperationType.js +5 -5
  17. package/dist/asyncapi/PageIndexed.d.ts +8 -0
  18. package/dist/asyncapi/PageIndexed.js +1 -0
  19. package/dist/asyncapi/PositionIndexed.d.ts +8 -0
  20. package/dist/asyncapi/PositionIndexed.js +1 -0
  21. package/dist/asyncapi/ProgressStatus.d.ts +3 -0
  22. package/dist/asyncapi/ProgressStatus.js +3 -0
  23. package/dist/asyncapi/ReEncodeDecision.d.ts +5 -0
  24. package/dist/asyncapi/ReEncodeDecision.js +6 -0
  25. package/dist/asyncapi/SingleOutputCompletion.d.ts +25 -0
  26. package/dist/asyncapi/SingleOutputCompletion.js +1 -0
  27. package/dist/asyncapi/SourceEntry.d.ts +2 -1
  28. package/dist/asyncapi/Unindexed.d.ts +8 -0
  29. package/dist/asyncapi/Unindexed.js +1 -0
  30. package/dist/asyncapi/UploadProbeCompletion.d.ts +16 -0
  31. package/dist/asyncapi/UploadProbeCompletion.js +1 -0
  32. package/dist/asyncapi/UploadProbeMediaMetadata.d.ts +18 -0
  33. package/dist/asyncapi/UploadProbeMediaMetadata.js +1 -0
  34. package/dist/asyncapi/UploadProbeProcessingClass.d.ts +6 -0
  35. package/dist/asyncapi/UploadProbeProcessingClass.js +7 -0
  36. package/dist/asyncapi/UploadProbeRequest.d.ts +10 -0
  37. package/dist/asyncapi/UploadProbeRequest.js +1 -0
  38. package/dist/asyncapi/UploadProbeStatus.d.ts +7 -0
  39. package/dist/asyncapi/UploadProbeStatus.js +8 -0
  40. package/dist/asyncapi/index.d.ts +13 -0
  41. package/dist/asyncapi/index.js +4 -0
  42. package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +64 -0
  43. package/dist/openapi/models/AudioWatermarkDecodeRequest.js +53 -0
  44. package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +80 -0
  45. package/dist/openapi/models/AudioWatermarkDecodeResponse.js +64 -0
  46. package/dist/openapi/models/AuthErrorResponse.d.ts +135 -0
  47. package/dist/openapi/models/AuthErrorResponse.js +66 -0
  48. package/dist/openapi/models/AuthErrorType.d.ts +73 -0
  49. package/dist/openapi/models/AuthErrorType.js +91 -0
  50. package/dist/openapi/models/AvailabilityValue.d.ts +43 -0
  51. package/dist/openapi/models/AvailabilityValue.js +61 -0
  52. package/dist/openapi/models/BalanceExhaustedResponse.d.ts +176 -0
  53. package/dist/openapi/models/BalanceExhaustedResponse.js +86 -0
  54. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +38 -0
  55. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +43 -0
  56. package/dist/openapi/models/CallbackEventType.d.ts +2 -2
  57. package/dist/openapi/models/CallbackEventType.js +2 -2
  58. package/dist/openapi/models/ConnectionSource.d.ts +64 -0
  59. package/dist/openapi/models/ConnectionSource.js +57 -0
  60. package/dist/openapi/models/ContactRequest.d.ts +2 -2
  61. package/dist/openapi/models/ContactRequest.js +2 -2
  62. package/dist/openapi/models/ContactSubject.d.ts +2 -2
  63. package/dist/openapi/models/ContactSubject.js +2 -2
  64. package/dist/openapi/models/ContactValidationErrorResponse.d.ts +2 -2
  65. package/dist/openapi/models/ContactValidationErrorResponse.js +2 -2
  66. package/dist/openapi/models/CreateExternalImport403Response.d.ts +24 -0
  67. package/dist/openapi/models/CreateExternalImport403Response.js +58 -0
  68. package/dist/openapi/models/CreateExternalImport422Response.d.ts +23 -0
  69. package/dist/openapi/models/CreateExternalImport422Response.js +51 -0
  70. package/dist/openapi/models/CreateWorkflow422Response.d.ts +24 -0
  71. package/dist/openapi/models/CreateWorkflow422Response.js +58 -0
  72. package/dist/openapi/models/CreditTransaction.d.ts +186 -0
  73. package/dist/openapi/models/CreditTransaction.js +100 -0
  74. package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +46 -0
  75. package/dist/openapi/models/CreditTransactionSourceBucket.js +64 -0
  76. package/dist/openapi/models/CreditsBalanceResponse.d.ts +84 -0
  77. package/dist/openapi/models/CreditsBalanceResponse.js +68 -0
  78. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +46 -0
  79. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +54 -0
  80. package/dist/openapi/models/CreditsUsageResponse.d.ts +51 -0
  81. package/dist/openapi/models/CreditsUsageResponse.js +56 -0
  82. package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +46 -0
  83. package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +54 -0
  84. package/dist/openapi/models/Delivery.d.ts +98 -0
  85. package/dist/openapi/models/Delivery.js +65 -0
  86. package/dist/openapi/models/DeliveryOutputRef.d.ts +44 -0
  87. package/dist/openapi/models/DeliveryOutputRef.js +45 -0
  88. package/dist/openapi/models/DeliveryPlan.d.ts +77 -0
  89. package/dist/openapi/models/DeliveryPlan.js +72 -0
  90. package/dist/openapi/models/DeliveryPlanOutput.d.ts +53 -0
  91. package/dist/openapi/models/DeliveryPlanOutput.js +52 -0
  92. package/dist/openapi/models/DeliveryPlanReason.d.ts +35 -0
  93. package/dist/openapi/models/DeliveryPlanReason.js +53 -0
  94. package/dist/openapi/models/DeliverySelection.d.ts +62 -0
  95. package/dist/openapi/models/DeliverySelection.js +54 -0
  96. package/dist/openapi/models/ErrorEnvelope.d.ts +102 -5
  97. package/dist/openapi/models/ErrorEnvelope.js +10 -2
  98. package/dist/openapi/models/EstimateQuality.d.ts +34 -0
  99. package/dist/openapi/models/EstimateQuality.js +52 -0
  100. package/dist/openapi/models/EstimateRange.d.ts +48 -0
  101. package/dist/openapi/models/EstimateRange.js +51 -0
  102. package/dist/openapi/models/ExternalDestination.d.ts +41 -0
  103. package/dist/openapi/models/ExternalDestination.js +47 -0
  104. package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +49 -0
  105. package/dist/openapi/models/ExternalImportCreatedResponse.js +51 -0
  106. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +46 -0
  107. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +54 -0
  108. package/dist/openapi/models/ExternalImportRequest.d.ts +92 -0
  109. package/dist/openapi/models/ExternalImportRequest.js +61 -0
  110. package/dist/openapi/models/ExternalImportToken.d.ts +51 -0
  111. package/dist/openapi/models/ExternalImportToken.js +53 -0
  112. package/dist/openapi/models/ExternalSource.d.ts +31 -0
  113. package/dist/openapi/models/ExternalSource.js +47 -0
  114. package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +163 -0
  115. package/dist/openapi/models/FeatureNotAvailableResponse.js +76 -0
  116. package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +154 -0
  117. package/dist/openapi/models/FeatureTierRestrictedResponse.js +76 -0
  118. package/dist/openapi/models/FeatureViolation.d.ts +108 -0
  119. package/dist/openapi/models/FeatureViolation.js +63 -0
  120. package/dist/openapi/models/JobDefinition.d.ts +125 -14
  121. package/dist/openapi/models/JobDefinition.js +25 -4
  122. package/dist/openapi/models/JobDownload.d.ts +2 -2
  123. package/dist/openapi/models/JobDownload.js +2 -2
  124. package/dist/openapi/models/JobInputV2.d.ts +89 -0
  125. package/dist/openapi/models/JobInputV2.js +56 -0
  126. package/dist/openapi/models/JobOutputSource.d.ts +57 -0
  127. package/dist/openapi/models/JobOutputSource.js +55 -0
  128. package/dist/openapi/models/JobResponse.d.ts +2 -2
  129. package/dist/openapi/models/JobResponse.js +2 -2
  130. package/dist/openapi/models/JobStatus.d.ts +17 -8
  131. package/dist/openapi/models/JobStatus.js +17 -8
  132. package/dist/openapi/models/JobType.d.ts +2 -2
  133. package/dist/openapi/models/JobType.js +2 -2
  134. package/dist/openapi/models/LivenessResponse.d.ts +2 -2
  135. package/dist/openapi/models/LivenessResponse.js +2 -2
  136. package/dist/openapi/models/LoginUser200Response.d.ts +46 -0
  137. package/dist/openapi/models/LoginUser200Response.js +54 -0
  138. package/dist/openapi/models/LoginUser200ResponseData.d.ts +33 -0
  139. package/dist/openapi/models/LoginUser200ResponseData.js +44 -0
  140. package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +50 -0
  141. package/dist/openapi/models/LoginUser200ResponseDataUser.js +51 -0
  142. package/dist/openapi/models/LoginUserRequest.d.ts +38 -0
  143. package/dist/openapi/models/LoginUserRequest.js +47 -0
  144. package/dist/openapi/models/LogoutUser200Response.d.ts +50 -0
  145. package/dist/openapi/models/LogoutUser200Response.js +53 -0
  146. package/dist/openapi/models/MetadataResponse.d.ts +13 -2
  147. package/dist/openapi/models/MetadataResponse.js +6 -2
  148. package/dist/openapi/models/MetadataResponseDimensions.d.ts +2 -2
  149. package/dist/openapi/models/MetadataResponseDimensions.js +2 -2
  150. package/dist/openapi/models/MetadataResponseExif.d.ts +2 -2
  151. package/dist/openapi/models/MetadataResponseExif.js +3 -3
  152. package/dist/openapi/models/MetadataResponseExifGps.d.ts +2 -2
  153. package/dist/openapi/models/MetadataResponseExifGps.js +2 -2
  154. package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +3 -3
  155. package/dist/openapi/models/MetadataSuccessEnvelope.js +2 -2
  156. package/dist/openapi/models/MimeGroupSchema.d.ts +46 -2
  157. package/dist/openapi/models/MimeGroupSchema.js +11 -2
  158. package/dist/openapi/models/MultipartCompleteRequest.d.ts +3 -3
  159. package/dist/openapi/models/MultipartCompleteRequest.js +2 -2
  160. package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +2 -2
  161. package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +2 -2
  162. package/dist/openapi/models/MultipartCompleteResponse.d.ts +7 -4
  163. package/dist/openapi/models/MultipartCompleteResponse.js +2 -2
  164. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +3 -3
  165. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +2 -2
  166. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +56 -0
  167. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +45 -0
  168. package/dist/openapi/models/MultipartInitiateResponse.d.ts +38 -6
  169. package/dist/openapi/models/MultipartInitiateResponse.js +7 -2
  170. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +3 -3
  171. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +2 -2
  172. package/dist/openapi/models/MultipartKeepaliveResponse.d.ts +43 -0
  173. package/dist/openapi/models/MultipartKeepaliveResponse.js +47 -0
  174. package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.d.ts +46 -0
  175. package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.js +54 -0
  176. package/dist/openapi/models/MultipartPartListing.d.ts +59 -0
  177. package/dist/openapi/models/MultipartPartListing.js +55 -0
  178. package/dist/openapi/models/MultipartPresignRequest.d.ts +41 -0
  179. package/dist/openapi/models/MultipartPresignRequest.js +43 -0
  180. package/dist/openapi/models/MultipartPresignResponse.d.ts +46 -0
  181. package/dist/openapi/models/MultipartPresignResponse.js +48 -0
  182. package/dist/openapi/models/MultipartPresignSuccessEnvelope.d.ts +46 -0
  183. package/dist/openapi/models/MultipartPresignSuccessEnvelope.js +54 -0
  184. package/dist/openapi/models/MultipartStatusResponse.d.ts +103 -0
  185. package/dist/openapi/models/MultipartStatusResponse.js +76 -0
  186. package/dist/openapi/models/MultipartStatusSuccessEnvelope.d.ts +46 -0
  187. package/dist/openapi/models/MultipartStatusSuccessEnvelope.js +54 -0
  188. package/dist/openapi/models/OperationDefinition.d.ts +2 -2
  189. package/dist/openapi/models/OperationDefinition.js +2 -2
  190. package/dist/openapi/models/OperationDownload.d.ts +30 -2
  191. package/dist/openapi/models/OperationDownload.js +6 -2
  192. package/dist/openapi/models/OperationInputModel.d.ts +4 -4
  193. package/dist/openapi/models/OperationInputModel.js +4 -4
  194. package/dist/openapi/models/OperationResponse.d.ts +21 -2
  195. package/dist/openapi/models/OperationResponse.js +6 -2
  196. package/dist/openapi/models/OperationResult.d.ts +2 -2
  197. package/dist/openapi/models/OperationResult.js +2 -2
  198. package/dist/openapi/models/OperationResultMetrics.d.ts +2 -2
  199. package/dist/openapi/models/OperationResultMetrics.js +2 -2
  200. package/dist/openapi/models/OperationSchemaDefinition.d.ts +52 -5
  201. package/dist/openapi/models/OperationSchemaDefinition.js +10 -6
  202. package/dist/openapi/models/OperationStatus.d.ts +2 -2
  203. package/dist/openapi/models/OperationStatus.js +2 -2
  204. package/dist/openapi/models/OperationType.d.ts +17 -5
  205. package/dist/openapi/models/OperationType.js +18 -6
  206. package/dist/openapi/models/OperationsSchemaResponse.d.ts +70 -10
  207. package/dist/openapi/models/OperationsSchemaResponse.js +17 -2
  208. package/dist/openapi/models/OptionSchema.d.ts +42 -4
  209. package/dist/openapi/models/OptionSchema.js +12 -2
  210. package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +80 -0
  211. package/dist/openapi/models/PerValueAvailabilityEntry.js +53 -0
  212. package/dist/openapi/models/PresignedUrlPart.d.ts +2 -2
  213. package/dist/openapi/models/PresignedUrlPart.js +3 -3
  214. package/dist/openapi/models/ProcessingClass.d.ts +35 -0
  215. package/dist/openapi/models/ProcessingClass.js +53 -0
  216. package/dist/openapi/models/ProcessingClassBandViolation.d.ts +149 -0
  217. package/dist/openapi/models/ProcessingClassBandViolation.js +81 -0
  218. package/dist/openapi/models/ProcessingClassExceedsBandResponse.d.ts +174 -0
  219. package/dist/openapi/models/ProcessingClassExceedsBandResponse.js +76 -0
  220. package/dist/openapi/models/ProcessingClassHint.d.ts +36 -0
  221. package/dist/openapi/models/ProcessingClassHint.js +54 -0
  222. package/dist/openapi/models/ProcessingClassReason.d.ts +46 -0
  223. package/dist/openapi/models/ProcessingClassReason.js +64 -0
  224. package/dist/openapi/models/ProcessingClassRejectReason.d.ts +53 -0
  225. package/dist/openapi/models/ProcessingClassRejectReason.js +71 -0
  226. package/dist/openapi/models/ProcessingPlan.d.ts +70 -0
  227. package/dist/openapi/models/ProcessingPlan.js +49 -0
  228. package/dist/openapi/models/ProcessingPlanJob.d.ts +81 -0
  229. package/dist/openapi/models/ProcessingPlanJob.js +71 -0
  230. package/dist/openapi/models/ReadinessResponse.d.ts +2 -2
  231. package/dist/openapi/models/ReadinessResponse.js +2 -2
  232. package/dist/openapi/models/ResponseEnvelope.d.ts +2 -2
  233. package/dist/openapi/models/ResponseEnvelope.js +2 -2
  234. package/dist/openapi/models/RetryResponse.d.ts +5 -5
  235. package/dist/openapi/models/RetryResponse.js +2 -2
  236. package/dist/openapi/models/RetrySuccessEnvelope.d.ts +3 -3
  237. package/dist/openapi/models/RetrySuccessEnvelope.js +2 -2
  238. package/dist/openapi/models/SseEventType.d.ts +2 -2
  239. package/dist/openapi/models/SseEventType.js +2 -2
  240. package/dist/openapi/models/SseJobCompletedData.d.ts +3 -3
  241. package/dist/openapi/models/SseJobCompletedData.js +2 -2
  242. package/dist/openapi/models/SseJobFailedData.d.ts +3 -3
  243. package/dist/openapi/models/SseJobFailedData.js +2 -2
  244. package/dist/openapi/models/SseOperationCompletedData.d.ts +4 -4
  245. package/dist/openapi/models/SseOperationCompletedData.js +2 -2
  246. package/dist/openapi/models/SseOperationFailedData.d.ts +3 -3
  247. package/dist/openapi/models/SseOperationFailedData.js +2 -2
  248. package/dist/openapi/models/SseOperationProgressData.d.ts +61 -3
  249. package/dist/openapi/models/SseOperationProgressData.js +22 -2
  250. package/dist/openapi/models/SseWorkflowTerminalData.d.ts +26 -4
  251. package/dist/openapi/models/SseWorkflowTerminalData.js +4 -2
  252. package/dist/openapi/models/TierRestrictionKind.d.ts +33 -0
  253. package/dist/openapi/models/TierRestrictionKind.js +51 -0
  254. package/dist/openapi/models/TierRestrictionResponse.d.ts +173 -0
  255. package/dist/openapi/models/TierRestrictionResponse.js +83 -0
  256. package/dist/openapi/models/UploadConstraintsApplied.d.ts +70 -0
  257. package/dist/openapi/models/UploadConstraintsApplied.js +57 -0
  258. package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +155 -0
  259. package/dist/openapi/models/UploadDurationExceedsTierResponse.js +82 -0
  260. package/dist/openapi/models/UploadFile403Response.d.ts +27 -0
  261. package/dist/openapi/models/UploadFile403Response.js +47 -0
  262. package/dist/openapi/models/UploadFile422Response.d.ts +27 -0
  263. package/dist/openapi/models/UploadFile422Response.js +47 -0
  264. package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +172 -0
  265. package/dist/openapi/models/UploadProbeMediaMetadata.js +69 -0
  266. package/dist/openapi/models/UploadProbeProcessingClass.d.ts +33 -0
  267. package/dist/openapi/models/UploadProbeProcessingClass.js +51 -0
  268. package/dist/openapi/models/UploadProbeResponse.d.ts +58 -0
  269. package/dist/openapi/models/UploadProbeResponse.js +58 -0
  270. package/dist/openapi/models/UploadProbeStatus.d.ts +41 -0
  271. package/dist/openapi/models/UploadProbeStatus.js +59 -0
  272. package/dist/openapi/models/UploadResponse.d.ts +17 -3
  273. package/dist/openapi/models/UploadResponse.js +7 -2
  274. package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +155 -0
  275. package/dist/openapi/models/UploadSizeExceedsTierResponse.js +82 -0
  276. package/dist/openapi/models/UploadSource.d.ts +48 -0
  277. package/dist/openapi/models/UploadSource.js +53 -0
  278. package/dist/openapi/models/UploadSuccessEnvelope.d.ts +3 -3
  279. package/dist/openapi/models/UploadSuccessEnvelope.js +2 -2
  280. package/dist/openapi/models/UploadThresholds.d.ts +126 -0
  281. package/dist/openapi/models/UploadThresholds.js +79 -0
  282. package/dist/openapi/models/UserTier.d.ts +41 -0
  283. package/dist/openapi/models/UserTier.js +59 -0
  284. package/dist/openapi/models/ValidationErrorEnvelope.d.ts +51 -4
  285. package/dist/openapi/models/ValidationErrorEnvelope.js +10 -2
  286. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +37 -4
  287. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +6 -2
  288. package/dist/openapi/models/WarningType.d.ts +48 -0
  289. package/dist/openapi/models/WarningType.js +66 -0
  290. package/dist/openapi/models/WebhookOperationContext.d.ts +3 -3
  291. package/dist/openapi/models/WebhookOperationContext.js +2 -2
  292. package/dist/openapi/models/WebhookPayload.d.ts +2 -2
  293. package/dist/openapi/models/WebhookPayload.js +3 -3
  294. package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +36 -0
  295. package/dist/openapi/models/WorkflowCancelBillingEffect.js +54 -0
  296. package/dist/openapi/models/WorkflowCancelResponse.d.ts +66 -0
  297. package/dist/openapi/models/WorkflowCancelResponse.js +62 -0
  298. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +46 -0
  299. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +54 -0
  300. package/dist/openapi/models/WorkflowCreateRequest.d.ts +39 -5
  301. package/dist/openapi/models/WorkflowCreateRequest.js +11 -5
  302. package/dist/openapi/models/WorkflowCreateResponse.d.ts +63 -2
  303. package/dist/openapi/models/WorkflowCreateResponse.js +21 -2
  304. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +3 -3
  305. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +2 -2
  306. package/dist/openapi/models/WorkflowDownloadResponse.d.ts +2 -2
  307. package/dist/openapi/models/WorkflowDownloadResponse.js +2 -2
  308. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +3 -3
  309. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +2 -2
  310. package/dist/openapi/models/WorkflowEdge.d.ts +2 -2
  311. package/dist/openapi/models/WorkflowEdge.js +2 -2
  312. package/dist/openapi/models/WorkflowExpiredResponse.d.ts +145 -0
  313. package/dist/openapi/models/WorkflowExpiredResponse.js +75 -0
  314. package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +30 -0
  315. package/dist/openapi/models/WorkflowPauseRequiredAction.js +48 -0
  316. package/dist/openapi/models/WorkflowPausedDetail.d.ts +99 -0
  317. package/dist/openapi/models/WorkflowPausedDetail.js +65 -0
  318. package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +47 -0
  319. package/dist/openapi/models/WorkflowPausedDetailLinks.js +45 -0
  320. package/dist/openapi/models/WorkflowProcessing.d.ts +36 -0
  321. package/dist/openapi/models/WorkflowProcessing.js +42 -0
  322. package/dist/openapi/models/WorkflowResumeResponse.d.ts +55 -0
  323. package/dist/openapi/models/WorkflowResumeResponse.js +57 -0
  324. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +46 -0
  325. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +54 -0
  326. package/dist/openapi/models/WorkflowSource.d.ts +40 -0
  327. package/dist/openapi/models/WorkflowSource.js +57 -0
  328. package/dist/openapi/models/WorkflowStatus.d.ts +31 -8
  329. package/dist/openapi/models/WorkflowStatus.js +32 -9
  330. package/dist/openapi/models/WorkflowStatusResponse.d.ts +34 -2
  331. package/dist/openapi/models/WorkflowStatusResponse.js +13 -2
  332. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +3 -3
  333. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +2 -2
  334. package/dist/openapi/models/WorkflowWarning.d.ts +119 -0
  335. package/dist/openapi/models/WorkflowWarning.js +63 -0
  336. package/dist/openapi/models/WorkflowWarningSeverity.d.ts +29 -0
  337. package/dist/openapi/models/WorkflowWarningSeverity.js +47 -0
  338. package/dist/openapi/models/index.d.ts +87 -3
  339. package/dist/openapi/models/index.js +87 -3
  340. package/dist/openapi/runtime.d.ts +2 -2
  341. package/dist/openapi/runtime.js +17 -2
  342. package/dist/operations/archive.metadata.d.ts +2 -0
  343. package/dist/operations/archive.metadata.js +13 -0
  344. package/dist/operations/audio_overlay.d.ts +48 -0
  345. package/dist/operations/audio_overlay.js +19 -0
  346. package/dist/operations/audio_overlay.metadata.d.ts +2 -0
  347. package/dist/operations/audio_overlay.metadata.js +167 -0
  348. package/dist/operations/audio_watermark.d.ts +42 -0
  349. package/dist/operations/audio_watermark.js +37 -0
  350. package/dist/operations/audio_watermark.metadata.d.ts +2 -0
  351. package/dist/operations/audio_watermark.metadata.js +94 -0
  352. package/dist/operations/compress.metadata.d.ts +2 -0
  353. package/dist/operations/compress.metadata.js +205 -0
  354. package/dist/operations/convert.metadata.d.ts +2 -0
  355. package/dist/operations/convert.metadata.js +85 -0
  356. package/dist/operations/custom_luma.d.ts +7 -0
  357. package/dist/operations/custom_luma.js +2 -0
  358. package/dist/operations/custom_luma.metadata.d.ts +2 -0
  359. package/dist/operations/custom_luma.metadata.js +49 -0
  360. package/dist/operations/image_watermark.d.ts +54 -0
  361. package/dist/operations/image_watermark.js +37 -0
  362. package/dist/operations/image_watermark.metadata.d.ts +2 -0
  363. package/dist/operations/image_watermark.metadata.js +97 -0
  364. package/dist/operations/index.d.ts +16 -1
  365. package/dist/operations/index.js +16 -1
  366. package/dist/operations/merge.d.ts +111 -31
  367. package/dist/operations/merge.js +106 -20
  368. package/dist/operations/merge.metadata.d.ts +2 -0
  369. package/dist/operations/merge.metadata.js +385 -0
  370. package/dist/operations/metadata-types.d.ts +47 -0
  371. package/dist/operations/metadata-types.js +2 -0
  372. package/dist/operations/text_watermark.d.ts +31 -0
  373. package/dist/operations/text_watermark.js +22 -0
  374. package/dist/operations/text_watermark.metadata.d.ts +2 -0
  375. package/dist/operations/text_watermark.metadata.js +46 -0
  376. package/dist/operations/thumbnail.metadata.d.ts +2 -0
  377. package/dist/operations/thumbnail.metadata.js +88 -0
  378. package/openapi/api.yaml +6413 -821
  379. package/operations/schemas/audio_overlay.yaml +409 -0
  380. package/operations/schemas/audio_watermark.yaml +192 -0
  381. package/operations/schemas/compress.yaml +26 -3
  382. package/operations/schemas/convert.yaml +25 -3
  383. package/operations/schemas/custom_luma.yaml +116 -0
  384. package/operations/schemas/image_watermark.yaml +287 -0
  385. package/operations/schemas/merge.yaml +301 -66
  386. package/operations/schemas/text_watermark.yaml +147 -0
  387. package/operations/schemas/thumbnail.yaml +22 -0
  388. package/package.json +10 -4
  389. package/dist/openapi/models/ExportConfig.d.ts +0 -63
  390. package/dist/openapi/models/ExportConfig.js +0 -59
  391. package/dist/openapi/models/JobInput.d.ts +0 -53
  392. package/dist/openapi/models/JobInput.js +0 -47
  393. package/dist/openapi/models/JobSource.d.ts +0 -43
  394. package/dist/openapi/models/JobSource.js +0 -45
  395. package/dist/operations/watermark.d.ts +0 -28
  396. package/dist/operations/watermark.js +0 -19
  397. package/operations/schemas/watermark.yaml +0 -87
@@ -0,0 +1,40 @@
1
+ /**
2
+ * GISL Compression API
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.12.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ConnectionSource } from './ConnectionSource.js';
13
+ import type { ExternalImportToken } from './ExternalImportToken.js';
14
+ import type { JobOutputSource } from './JobOutputSource.js';
15
+ import type { UploadSource } from './UploadSource.js';
16
+ /**
17
+ * @type WorkflowSource
18
+ * Discriminated union of source leaves consumed by V2
19
+ * `JobDefinition.source` and `JobInputV2.source`. Per
20
+ * [ADR-0005](../docs/decisions/0005-external-sources.md) +
21
+ * [ADR-0004](../docs/decisions/0004-job-shape.md).
22
+ *
23
+ * Wiring into `JobDefinition` lands via ticket
24
+ * [I12 (`Gr0VKFya`)](https://trello.com/c/Gr0VKFya).
25
+ *
26
+ * @export
27
+ */
28
+ export type WorkflowSource = {
29
+ type: 'connection';
30
+ } & ConnectionSource | {
31
+ type: 'external_import';
32
+ } & ExternalImportToken | {
33
+ type: 'job_output';
34
+ } & JobOutputSource | {
35
+ type: 'upload';
36
+ } & UploadSource;
37
+ export declare function WorkflowSourceFromJSON(json: any): WorkflowSource;
38
+ export declare function WorkflowSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowSource;
39
+ export declare function WorkflowSourceToJSON(json: any): any;
40
+ export declare function WorkflowSourceToJSONTyped(value?: WorkflowSource | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * GISL Compression API
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.12.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ConnectionSourceFromJSONTyped, ConnectionSourceToJSON, } from './ConnectionSource.js';
15
+ import { ExternalImportTokenFromJSONTyped, ExternalImportTokenToJSON, } from './ExternalImportToken.js';
16
+ import { JobOutputSourceFromJSONTyped, JobOutputSourceToJSON, } from './JobOutputSource.js';
17
+ import { UploadSourceFromJSONTyped, UploadSourceToJSON, } from './UploadSource.js';
18
+ export function WorkflowSourceFromJSON(json) {
19
+ return WorkflowSourceFromJSONTyped(json, false);
20
+ }
21
+ export function WorkflowSourceFromJSONTyped(json, ignoreDiscriminator) {
22
+ if (json == null) {
23
+ return json;
24
+ }
25
+ switch (json['type']) {
26
+ case 'connection':
27
+ return Object.assign({}, ConnectionSourceFromJSONTyped(json, true), { type: 'connection' });
28
+ case 'external_import':
29
+ return Object.assign({}, ExternalImportTokenFromJSONTyped(json, true), { type: 'external_import' });
30
+ case 'job_output':
31
+ return Object.assign({}, JobOutputSourceFromJSONTyped(json, true), { type: 'job_output' });
32
+ case 'upload':
33
+ return Object.assign({}, UploadSourceFromJSONTyped(json, true), { type: 'upload' });
34
+ default:
35
+ return json;
36
+ }
37
+ }
38
+ export function WorkflowSourceToJSON(json) {
39
+ return WorkflowSourceToJSONTyped(json, false);
40
+ }
41
+ export function WorkflowSourceToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ switch (value['type']) {
46
+ case 'connection':
47
+ return Object.assign({}, ConnectionSourceToJSON(value), { type: 'connection' });
48
+ case 'external_import':
49
+ return Object.assign({}, ExternalImportTokenToJSON(value), { type: 'external_import' });
50
+ case 'job_output':
51
+ return Object.assign({}, JobOutputSourceToJSON(value), { type: 'job_output' });
52
+ case 'upload':
53
+ return Object.assign({}, UploadSourceToJSON(value), { type: 'upload' });
54
+ default:
55
+ return value;
56
+ }
57
+ }
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
5
+ * The version of the OpenAPI document: 2.12.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,12 +10,32 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Workflow lifecycle status:
14
- * - pending: Created but no jobs have started
15
- * - in_progress: At least one job is running
16
- * - completed: All jobs completed successfully
17
- * - failed: All jobs finished, at least one failed, none succeeded
18
- * - partially_failed: Some jobs succeeded, some failed
13
+ * Workflow lifecycle status. The `paused_insufficient_credits`,
14
+ * `cancelled`, and `expired` states were added per ticket
15
+ * [I24 `e50uXLcl`](https://trello.com/c/e50uXLcl) additive
16
+ * widening; V1 clients ignoring unknown enum values continue
17
+ * to function.
18
+ * - `pending`: Created but no jobs have started.
19
+ * - `in_progress`: At least one job is running.
20
+ * - `completed`: All jobs completed successfully.
21
+ * - `failed`: All jobs finished, at least one failed, none succeeded.
22
+ * - `partially_failed`: Some jobs succeeded, some failed.
23
+ * - `paused_insufficient_credits`: Workflow paused at a job/
24
+ * stage boundary because the next reservation exceeded the
25
+ * caller's available credits. Pause occurs at boundaries
26
+ * only — never mid-stream within a running operation.
27
+ * Resumable via `POST /api/workflows/{id}/resume` once the
28
+ * caller tops up; expires after a 7-day TTL by default.
29
+ * - `cancelled`: Caller-initiated termination via
30
+ * `POST /api/workflows/{id}/cancel`. Idempotent — cancelling
31
+ * already-cancelled returns 200 with the same shape.
32
+ * `billing_effect` on the cancel response indicates whether
33
+ * unspent reservations were released.
34
+ * - `expired`: Workflow was in `paused_insufficient_credits`
35
+ * past its `expires_at` and was auto-cancelled by the
36
+ * server. Equivalent to `cancelled` for downstream
37
+ * accounting; distinct status so dashboards can surface the
38
+ * natural-expiry vs caller-initiated distinction.
19
39
  *
20
40
  * @export
21
41
  */
@@ -25,6 +45,9 @@ export declare const WorkflowStatus: {
25
45
  readonly completed: "completed";
26
46
  readonly failed: "failed";
27
47
  readonly partially_failed: "partially_failed";
48
+ readonly paused_insufficient_credits: "paused_insufficient_credits";
49
+ readonly cancelled: "cancelled";
50
+ readonly expired: "expired";
28
51
  };
29
52
  export type WorkflowStatus = typeof WorkflowStatus[keyof typeof WorkflowStatus];
30
53
  export declare function instanceOfWorkflowStatus(value: any): boolean;
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
7
+ * The version of the OpenAPI document: 2.12.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,12 +12,32 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Workflow lifecycle status:
16
- * - pending: Created but no jobs have started
17
- * - in_progress: At least one job is running
18
- * - completed: All jobs completed successfully
19
- * - failed: All jobs finished, at least one failed, none succeeded
20
- * - partially_failed: Some jobs succeeded, some failed
15
+ * Workflow lifecycle status. The `paused_insufficient_credits`,
16
+ * `cancelled`, and `expired` states were added per ticket
17
+ * [I24 `e50uXLcl`](https://trello.com/c/e50uXLcl) additive
18
+ * widening; V1 clients ignoring unknown enum values continue
19
+ * to function.
20
+ * - `pending`: Created but no jobs have started.
21
+ * - `in_progress`: At least one job is running.
22
+ * - `completed`: All jobs completed successfully.
23
+ * - `failed`: All jobs finished, at least one failed, none succeeded.
24
+ * - `partially_failed`: Some jobs succeeded, some failed.
25
+ * - `paused_insufficient_credits`: Workflow paused at a job/
26
+ * stage boundary because the next reservation exceeded the
27
+ * caller's available credits. Pause occurs at boundaries
28
+ * only — never mid-stream within a running operation.
29
+ * Resumable via `POST /api/workflows/{id}/resume` once the
30
+ * caller tops up; expires after a 7-day TTL by default.
31
+ * - `cancelled`: Caller-initiated termination via
32
+ * `POST /api/workflows/{id}/cancel`. Idempotent — cancelling
33
+ * already-cancelled returns 200 with the same shape.
34
+ * `billing_effect` on the cancel response indicates whether
35
+ * unspent reservations were released.
36
+ * - `expired`: Workflow was in `paused_insufficient_credits`
37
+ * past its `expires_at` and was auto-cancelled by the
38
+ * server. Equivalent to `cancelled` for downstream
39
+ * accounting; distinct status so dashboards can surface the
40
+ * natural-expiry vs caller-initiated distinction.
21
41
  *
22
42
  * @export
23
43
  */
@@ -26,7 +46,10 @@ export const WorkflowStatus = {
26
46
  in_progress: 'in_progress',
27
47
  completed: 'completed',
28
48
  failed: 'failed',
29
- partially_failed: 'partially_failed'
49
+ partially_failed: 'partially_failed',
50
+ paused_insufficient_credits: 'paused_insufficient_credits',
51
+ cancelled: 'cancelled',
52
+ expired: 'expired'
30
53
  };
31
54
  export function instanceOfWorkflowStatus(value) {
32
55
  for (const key in WorkflowStatus) {
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
5
+ * The version of the OpenAPI document: 2.12.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { JobResponse } from './JobResponse.js';
13
+ import type { WorkflowPausedDetail } from './WorkflowPausedDetail.js';
13
14
  import type { WorkflowStatus } from './WorkflowStatus.js';
14
15
  /**
15
16
  *
@@ -29,12 +30,43 @@ export interface WorkflowStatusResponse {
29
30
  * @memberof WorkflowStatusResponse
30
31
  */
31
32
  status: WorkflowStatus;
33
+ /**
34
+ * ISO-8601 timestamp at which the workflow row was
35
+ * committed (matches `WorkflowCreateResponse.created_at`
36
+ * for the same workflow). Per ticket
37
+ * [0HFbi9kh](https://trello.com/c/0HFbi9kh).
38
+ *
39
+ * @type {Date}
40
+ * @memberof WorkflowStatusResponse
41
+ */
42
+ createdAt: Date;
43
+ /**
44
+ * ISO-8601 timestamp at which the workflow row was last
45
+ * updated server-side (status transition, terminal-event
46
+ * commit, paused/resumed state change, etc.). The API
47
+ * always emits this field; spec catches up to behaviour
48
+ * shipping since `WorkflowController.php:178-179`.
49
+ *
50
+ * @type {Date}
51
+ * @memberof WorkflowStatusResponse
52
+ */
53
+ updatedAt: Date;
32
54
  /**
33
55
  *
34
56
  * @type {Array<JobResponse>}
35
57
  * @memberof WorkflowStatusResponse
36
58
  */
37
59
  jobs: Array<JobResponse>;
60
+ /**
61
+ * Present only when `status = paused_insufficient_credits`
62
+ * (per ticket [I24](https://trello.com/c/e50uXLcl)). Carries
63
+ * `paused_at`, `expires_at`, `required_action`, and
64
+ * actionable `links` (resume / top_up / upgrade).
65
+ *
66
+ * @type {WorkflowPausedDetail}
67
+ * @memberof WorkflowStatusResponse
68
+ */
69
+ pausedDetail?: WorkflowPausedDetail;
38
70
  }
39
71
  /**
40
72
  * Check if a given object implements the WorkflowStatusResponse interface.
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
7
+ * The version of the OpenAPI document: 2.12.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { JobResponseFromJSON, JobResponseToJSON, } from './JobResponse.js';
15
+ import { WorkflowPausedDetailFromJSON, WorkflowPausedDetailToJSON, } from './WorkflowPausedDetail.js';
15
16
  import { WorkflowStatusFromJSON, WorkflowStatusToJSON, } from './WorkflowStatus.js';
16
17
  /**
17
18
  * Check if a given object implements the WorkflowStatusResponse interface.
@@ -21,6 +22,10 @@ export function instanceOfWorkflowStatusResponse(value) {
21
22
  return false;
22
23
  if (!('status' in value) || value['status'] === undefined)
23
24
  return false;
25
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
26
+ return false;
27
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
28
+ return false;
24
29
  if (!('jobs' in value) || value['jobs'] === undefined)
25
30
  return false;
26
31
  return true;
@@ -35,7 +40,10 @@ export function WorkflowStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
35
40
  return {
36
41
  'workflowId': json['workflow_id'],
37
42
  'status': WorkflowStatusFromJSON(json['status']),
43
+ 'createdAt': (new Date(json['created_at'])),
44
+ 'updatedAt': (new Date(json['updated_at'])),
38
45
  'jobs': (json['jobs'].map(JobResponseFromJSON)),
46
+ 'pausedDetail': json['paused_detail'] == null ? undefined : WorkflowPausedDetailFromJSON(json['paused_detail']),
39
47
  };
40
48
  }
41
49
  export function WorkflowStatusResponseToJSON(json) {
@@ -48,6 +56,9 @@ export function WorkflowStatusResponseToJSONTyped(value, ignoreDiscriminator = f
48
56
  return {
49
57
  'workflow_id': value['workflowId'],
50
58
  'status': WorkflowStatusToJSON(value['status']),
59
+ 'created_at': value['createdAt'].toISOString(),
60
+ 'updated_at': value['updatedAt'].toISOString(),
51
61
  'jobs': (value['jobs'].map(JobResponseToJSON)),
62
+ 'paused_detail': WorkflowPausedDetailToJSON(value['pausedDetail']),
52
63
  };
53
64
  }
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
5
+ * The version of the OpenAPI document: 2.12.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,7 +18,7 @@ import type { WorkflowStatusResponse } from './WorkflowStatusResponse.js';
18
18
  export interface WorkflowStatusSuccessEnvelope {
19
19
  /**
20
20
  *
21
- * @type {boolean}
21
+ * @type {WorkflowStatusSuccessEnvelopeSuccessEnum}
22
22
  * @memberof WorkflowStatusSuccessEnvelope
23
23
  */
24
24
  success: WorkflowStatusSuccessEnvelopeSuccessEnum;
@@ -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, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, 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.0.0
7
+ * The version of the OpenAPI document: 2.12.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,119 @@
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.12.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { WarningType } from './WarningType.js';
13
+ import type { WorkflowWarningSeverity } from './WorkflowWarningSeverity.js';
14
+ /**
15
+ * Advisory warning surfaced on `POST /api/workflows` when the
16
+ * server detects a likely-wasteful pattern. Non-blocking —
17
+ * the workflow is created and dispatched regardless. Per
18
+ * ticket [I25 `i5yCuSZc`](https://trello.com/c/i5yCuSZc) +
19
+ * plan v5 §F11 round 10/11.
20
+ *
21
+ * **V2.0 detection rule** (`redundant_pre_encode_before_reencode_merge`):
22
+ *
23
+ * 1. Upstream jobs are single-output `compress` / `convert`
24
+ * (transcode).
25
+ * 2. Outputs feed exactly one downstream `merge` job.
26
+ * 3. Merge has `re_encode_mode != never` (will re-encode
27
+ * regardless).
28
+ * 4. Upstream jobs are not `deliver: true` and not in
29
+ * `delivery.selection.explicit.refs[]` (i.e. their output
30
+ * is not separately delivered).
31
+ * 5. Upstream encode options are identical to or subsumed by
32
+ * the downstream merge transcode options.
33
+ *
34
+ * All five conditions must hold. Detection is server-side
35
+ * and deliberately opaque (algorithm can evolve without
36
+ * contract churn).
37
+ *
38
+ * Carries the I26 localisation triple — `message` is
39
+ * localised per `Accept-Language`; `message_key` is the
40
+ * stable lookup key. See `ErrorEnvelope` for the canonical
41
+ * convention.
42
+ *
43
+ * @export
44
+ * @interface WorkflowWarning
45
+ */
46
+ export interface WorkflowWarning {
47
+ /**
48
+ *
49
+ * @type {WarningType}
50
+ * @memberof WorkflowWarning
51
+ */
52
+ warningType: WarningType;
53
+ /**
54
+ *
55
+ * @type {WorkflowWarningSeverity}
56
+ * @memberof WorkflowWarning
57
+ */
58
+ severity: WorkflowWarningSeverity;
59
+ /**
60
+ * UUID-v7 job IDs the warning applies to. For
61
+ * `redundant_pre_encode_before_reencode_merge`, this is
62
+ * the upstream encode jobs that produce the redundant
63
+ * work (NOT the downstream merge).
64
+ *
65
+ * @type {Array<string>}
66
+ * @memberof WorkflowWarning
67
+ */
68
+ jobs: Array<string>;
69
+ /**
70
+ * Human-readable, optionally localised explanation. See
71
+ * `ErrorEnvelope.message`. Never parse for control flow.
72
+ *
73
+ * @type {string}
74
+ * @memberof WorkflowWarning
75
+ */
76
+ message?: string;
77
+ /**
78
+ * Canonical lookup key per ticket
79
+ * [I26](https://trello.com/c/rcnqwgI4). See
80
+ * `ErrorEnvelope.message_key`.
81
+ *
82
+ * @type {string}
83
+ * @memberof WorkflowWarning
84
+ */
85
+ messageKey?: string;
86
+ /**
87
+ * BCP 47 locale tag. See `ErrorEnvelope.locale`.
88
+ * @type {string}
89
+ * @memberof WorkflowWarning
90
+ */
91
+ locale?: string;
92
+ /**
93
+ * Optional interpolation values for the localised
94
+ * `message`. See `ErrorEnvelope.message_params`. Excludes
95
+ * cost numbers.
96
+ *
97
+ * @type {{ [key: string]: any; }}
98
+ * @memberof WorkflowWarning
99
+ */
100
+ messageParams?: {
101
+ [key: string]: any;
102
+ };
103
+ /**
104
+ * Optional link to detection-rule documentation
105
+ * explaining the wasteful pattern + recommended fix.
106
+ *
107
+ * @type {string}
108
+ * @memberof WorkflowWarning
109
+ */
110
+ documentationUrl?: string;
111
+ }
112
+ /**
113
+ * Check if a given object implements the WorkflowWarning interface.
114
+ */
115
+ export declare function instanceOfWorkflowWarning(value: object): value is WorkflowWarning;
116
+ export declare function WorkflowWarningFromJSON(json: any): WorkflowWarning;
117
+ export declare function WorkflowWarningFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowWarning;
118
+ export declare function WorkflowWarningToJSON(json: any): WorkflowWarning;
119
+ export declare function WorkflowWarningToJSONTyped(value?: WorkflowWarning | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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.12.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { WarningTypeFromJSON, WarningTypeToJSON, } from './WarningType.js';
15
+ import { WorkflowWarningSeverityFromJSON, WorkflowWarningSeverityToJSON, } from './WorkflowWarningSeverity.js';
16
+ /**
17
+ * Check if a given object implements the WorkflowWarning interface.
18
+ */
19
+ export function instanceOfWorkflowWarning(value) {
20
+ if (!('warningType' in value) || value['warningType'] === undefined)
21
+ return false;
22
+ if (!('severity' in value) || value['severity'] === undefined)
23
+ return false;
24
+ if (!('jobs' in value) || value['jobs'] === undefined)
25
+ return false;
26
+ return true;
27
+ }
28
+ export function WorkflowWarningFromJSON(json) {
29
+ return WorkflowWarningFromJSONTyped(json, false);
30
+ }
31
+ export function WorkflowWarningFromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'warningType': WarningTypeFromJSON(json['warning_type']),
37
+ 'severity': WorkflowWarningSeverityFromJSON(json['severity']),
38
+ 'jobs': json['jobs'],
39
+ 'message': json['message'] == null ? undefined : json['message'],
40
+ 'messageKey': json['message_key'] == null ? undefined : json['message_key'],
41
+ 'locale': json['locale'] == null ? undefined : json['locale'],
42
+ 'messageParams': json['message_params'] == null ? undefined : json['message_params'],
43
+ 'documentationUrl': json['documentation_url'] == null ? undefined : json['documentation_url'],
44
+ };
45
+ }
46
+ export function WorkflowWarningToJSON(json) {
47
+ return WorkflowWarningToJSONTyped(json, false);
48
+ }
49
+ export function WorkflowWarningToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'warning_type': WarningTypeToJSON(value['warningType']),
55
+ 'severity': WorkflowWarningSeverityToJSON(value['severity']),
56
+ 'jobs': value['jobs'],
57
+ 'message': value['message'],
58
+ 'message_key': value['messageKey'],
59
+ 'locale': value['locale'],
60
+ 'message_params': value['messageParams'],
61
+ 'documentation_url': value['documentationUrl'],
62
+ };
63
+ }