@giveitsmaller/contracts 0.4.0 → 0.7.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 (358) hide show
  1. package/asyncapi/events.yaml +455 -41
  2. package/availability/availability.json +706 -83
  3. package/dist/asyncapi/OperationType.d.ts +5 -1
  4. package/dist/asyncapi/OperationType.js +4 -0
  5. package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +1 -1
  6. package/dist/openapi/models/AudioWatermarkDecodeRequest.js +1 -1
  7. package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +1 -1
  8. package/dist/openapi/models/AudioWatermarkDecodeResponse.js +1 -1
  9. package/dist/openapi/models/AuthErrorResponse.d.ts +1 -1
  10. package/dist/openapi/models/AuthErrorResponse.js +1 -1
  11. package/dist/openapi/models/AuthErrorType.d.ts +1 -1
  12. package/dist/openapi/models/AuthErrorType.js +1 -1
  13. package/dist/openapi/models/AvailabilityValue.d.ts +1 -1
  14. package/dist/openapi/models/AvailabilityValue.js +1 -1
  15. package/dist/openapi/models/BalanceExhaustedResponse.d.ts +1 -1
  16. package/dist/openapi/models/BalanceExhaustedResponse.js +1 -1
  17. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +1 -1
  18. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +1 -1
  19. package/dist/openapi/models/CallbackEventType.d.ts +1 -1
  20. package/dist/openapi/models/CallbackEventType.js +1 -1
  21. package/dist/openapi/models/ConnectionSource.d.ts +1 -1
  22. package/dist/openapi/models/ConnectionSource.js +1 -1
  23. package/dist/openapi/models/ContactRequest.d.ts +1 -1
  24. package/dist/openapi/models/ContactRequest.js +1 -1
  25. package/dist/openapi/models/ContactSubject.d.ts +1 -1
  26. package/dist/openapi/models/ContactSubject.js +1 -1
  27. package/dist/openapi/models/ContactValidationErrorResponse.d.ts +1 -1
  28. package/dist/openapi/models/ContactValidationErrorResponse.js +1 -1
  29. package/dist/openapi/models/CreateExternalImport403Response.d.ts +1 -1
  30. package/dist/openapi/models/CreateExternalImport403Response.js +1 -1
  31. package/dist/openapi/models/CreateExternalImport422Response.d.ts +1 -1
  32. package/dist/openapi/models/CreateExternalImport422Response.js +1 -1
  33. package/dist/openapi/models/CreateWorkflow422Response.d.ts +3 -2
  34. package/dist/openapi/models/CreateWorkflow422Response.js +8 -1
  35. package/dist/openapi/models/CreditTransaction.d.ts +1 -1
  36. package/dist/openapi/models/CreditTransaction.js +1 -1
  37. package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +1 -1
  38. package/dist/openapi/models/CreditTransactionSourceBucket.js +1 -1
  39. package/dist/openapi/models/CreditsBalanceResponse.d.ts +1 -1
  40. package/dist/openapi/models/CreditsBalanceResponse.js +1 -1
  41. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +1 -1
  42. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +1 -1
  43. package/dist/openapi/models/CreditsUsageResponse.d.ts +1 -1
  44. package/dist/openapi/models/CreditsUsageResponse.js +1 -1
  45. package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +1 -1
  46. package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +1 -1
  47. package/dist/openapi/models/Delivery.d.ts +1 -1
  48. package/dist/openapi/models/Delivery.js +1 -1
  49. package/dist/openapi/models/DeliveryOutputRef.d.ts +1 -1
  50. package/dist/openapi/models/DeliveryOutputRef.js +1 -1
  51. package/dist/openapi/models/DeliveryPlan.d.ts +1 -1
  52. package/dist/openapi/models/DeliveryPlan.js +1 -1
  53. package/dist/openapi/models/DeliveryPlanOutput.d.ts +1 -1
  54. package/dist/openapi/models/DeliveryPlanOutput.js +1 -1
  55. package/dist/openapi/models/DeliveryPlanReason.d.ts +1 -1
  56. package/dist/openapi/models/DeliveryPlanReason.js +1 -1
  57. package/dist/openapi/models/DeliverySelection.d.ts +1 -1
  58. package/dist/openapi/models/DeliverySelection.js +1 -1
  59. package/dist/openapi/models/EndpointProjection.d.ts +98 -0
  60. package/dist/openapi/models/EndpointProjection.js +78 -0
  61. package/dist/openapi/models/ErrorEnvelope.d.ts +1 -1
  62. package/dist/openapi/models/ErrorEnvelope.js +1 -1
  63. package/dist/openapi/models/EstimateQuality.d.ts +1 -1
  64. package/dist/openapi/models/EstimateQuality.js +1 -1
  65. package/dist/openapi/models/EstimateRange.d.ts +1 -1
  66. package/dist/openapi/models/EstimateRange.js +1 -1
  67. package/dist/openapi/models/ExternalDestination.d.ts +1 -1
  68. package/dist/openapi/models/ExternalDestination.js +1 -1
  69. package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +1 -1
  70. package/dist/openapi/models/ExternalImportCreatedResponse.js +1 -1
  71. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +1 -1
  72. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +1 -1
  73. package/dist/openapi/models/ExternalImportRequest.d.ts +1 -1
  74. package/dist/openapi/models/ExternalImportRequest.js +1 -1
  75. package/dist/openapi/models/ExternalImportToken.d.ts +1 -1
  76. package/dist/openapi/models/ExternalImportToken.js +1 -1
  77. package/dist/openapi/models/ExternalSource.d.ts +1 -1
  78. package/dist/openapi/models/ExternalSource.js +1 -1
  79. package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +1 -1
  80. package/dist/openapi/models/FeatureNotAvailableResponse.js +1 -1
  81. package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +1 -1
  82. package/dist/openapi/models/FeatureTierRestrictedResponse.js +1 -1
  83. package/dist/openapi/models/FeatureViolation.d.ts +1 -1
  84. package/dist/openapi/models/FeatureViolation.js +1 -1
  85. package/dist/openapi/models/JobDefinition.d.ts +17 -6
  86. package/dist/openapi/models/JobDefinition.js +1 -1
  87. package/dist/openapi/models/JobDownload.d.ts +1 -1
  88. package/dist/openapi/models/JobDownload.js +1 -1
  89. package/dist/openapi/models/JobInputV2.d.ts +16 -1
  90. package/dist/openapi/models/JobInputV2.js +1 -1
  91. package/dist/openapi/models/JobOutputSource.d.ts +1 -1
  92. package/dist/openapi/models/JobOutputSource.js +1 -1
  93. package/dist/openapi/models/JobResponse.d.ts +1 -1
  94. package/dist/openapi/models/JobResponse.js +1 -1
  95. package/dist/openapi/models/JobStatus.d.ts +1 -1
  96. package/dist/openapi/models/JobStatus.js +1 -1
  97. package/dist/openapi/models/JobType.d.ts +1 -1
  98. package/dist/openapi/models/JobType.js +1 -1
  99. package/dist/openapi/models/LivenessResponse.d.ts +1 -1
  100. package/dist/openapi/models/LivenessResponse.js +1 -1
  101. package/dist/openapi/models/LoginUser200Response.d.ts +1 -1
  102. package/dist/openapi/models/LoginUser200Response.js +1 -1
  103. package/dist/openapi/models/LoginUser200ResponseData.d.ts +1 -1
  104. package/dist/openapi/models/LoginUser200ResponseData.js +1 -1
  105. package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +1 -1
  106. package/dist/openapi/models/LoginUser200ResponseDataUser.js +1 -1
  107. package/dist/openapi/models/LoginUserRequest.d.ts +1 -1
  108. package/dist/openapi/models/LoginUserRequest.js +1 -1
  109. package/dist/openapi/models/LogoutUser200Response.d.ts +1 -1
  110. package/dist/openapi/models/LogoutUser200Response.js +1 -1
  111. package/dist/openapi/models/MetadataResponse.d.ts +1 -1
  112. package/dist/openapi/models/MetadataResponse.js +1 -1
  113. package/dist/openapi/models/MetadataResponseDimensions.d.ts +1 -1
  114. package/dist/openapi/models/MetadataResponseDimensions.js +1 -1
  115. package/dist/openapi/models/MetadataResponseExif.d.ts +1 -1
  116. package/dist/openapi/models/MetadataResponseExif.js +1 -1
  117. package/dist/openapi/models/MetadataResponseExifGps.d.ts +1 -1
  118. package/dist/openapi/models/MetadataResponseExifGps.js +1 -1
  119. package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +1 -1
  120. package/dist/openapi/models/MetadataSuccessEnvelope.js +1 -1
  121. package/dist/openapi/models/MimeGroupSchema.d.ts +1 -1
  122. package/dist/openapi/models/MimeGroupSchema.js +1 -1
  123. package/dist/openapi/models/MultipartCompleteRequest.d.ts +1 -1
  124. package/dist/openapi/models/MultipartCompleteRequest.js +1 -1
  125. package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +1 -1
  126. package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +1 -1
  127. package/dist/openapi/models/MultipartCompleteResponse.d.ts +1 -1
  128. package/dist/openapi/models/MultipartCompleteResponse.js +1 -1
  129. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +1 -1
  130. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +1 -1
  131. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +1 -1
  132. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +1 -1
  133. package/dist/openapi/models/MultipartInitiateResponse.d.ts +1 -1
  134. package/dist/openapi/models/MultipartInitiateResponse.js +1 -1
  135. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +1 -1
  136. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +1 -1
  137. package/dist/openapi/models/MultipartKeepaliveResponse.d.ts +1 -1
  138. package/dist/openapi/models/MultipartKeepaliveResponse.js +1 -1
  139. package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.d.ts +1 -1
  140. package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.js +1 -1
  141. package/dist/openapi/models/MultipartPartListing.d.ts +1 -1
  142. package/dist/openapi/models/MultipartPartListing.js +1 -1
  143. package/dist/openapi/models/MultipartPresignRequest.d.ts +1 -1
  144. package/dist/openapi/models/MultipartPresignRequest.js +1 -1
  145. package/dist/openapi/models/MultipartPresignResponse.d.ts +1 -1
  146. package/dist/openapi/models/MultipartPresignResponse.js +1 -1
  147. package/dist/openapi/models/MultipartPresignSuccessEnvelope.d.ts +1 -1
  148. package/dist/openapi/models/MultipartPresignSuccessEnvelope.js +1 -1
  149. package/dist/openapi/models/MultipartStatusResponse.d.ts +1 -1
  150. package/dist/openapi/models/MultipartStatusResponse.js +1 -1
  151. package/dist/openapi/models/MultipartStatusSuccessEnvelope.d.ts +1 -1
  152. package/dist/openapi/models/MultipartStatusSuccessEnvelope.js +1 -1
  153. package/dist/openapi/models/OperationDefinition.d.ts +1 -1
  154. package/dist/openapi/models/OperationDefinition.js +1 -1
  155. package/dist/openapi/models/OperationDownload.d.ts +1 -1
  156. package/dist/openapi/models/OperationDownload.js +1 -1
  157. package/dist/openapi/models/OperationInputModel.d.ts +4 -3
  158. package/dist/openapi/models/OperationInputModel.js +4 -3
  159. package/dist/openapi/models/OperationResponse.d.ts +1 -1
  160. package/dist/openapi/models/OperationResponse.js +1 -1
  161. package/dist/openapi/models/OperationResult.d.ts +1 -1
  162. package/dist/openapi/models/OperationResult.js +1 -1
  163. package/dist/openapi/models/OperationResultMetrics.d.ts +1 -1
  164. package/dist/openapi/models/OperationResultMetrics.js +1 -1
  165. package/dist/openapi/models/OperationSchemaDefinition.d.ts +23 -2
  166. package/dist/openapi/models/OperationSchemaDefinition.js +4 -1
  167. package/dist/openapi/models/OperationStatus.d.ts +1 -1
  168. package/dist/openapi/models/OperationStatus.js +1 -1
  169. package/dist/openapi/models/OperationType.d.ts +10 -2
  170. package/dist/openapi/models/OperationType.js +11 -3
  171. package/dist/openapi/models/OperationsSchemaResponse.d.ts +29 -1
  172. package/dist/openapi/models/OperationsSchemaResponse.js +4 -1
  173. package/dist/openapi/models/OptionSchema.d.ts +2 -1
  174. package/dist/openapi/models/OptionSchema.js +3 -2
  175. package/dist/openapi/models/PerRoleCardinalityEntry.d.ts +47 -0
  176. package/dist/openapi/models/PerRoleCardinalityEntry.js +47 -0
  177. package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +1 -1
  178. package/dist/openapi/models/PerValueAvailabilityEntry.js +1 -1
  179. package/dist/openapi/models/PresignedUrlPart.d.ts +1 -1
  180. package/dist/openapi/models/PresignedUrlPart.js +1 -1
  181. package/dist/openapi/models/ProbePendingResponse.d.ts +171 -0
  182. package/dist/openapi/models/ProbePendingResponse.js +75 -0
  183. package/dist/openapi/models/ProcessingClass.d.ts +1 -1
  184. package/dist/openapi/models/ProcessingClass.js +1 -1
  185. package/dist/openapi/models/ProcessingClassBandViolation.d.ts +1 -1
  186. package/dist/openapi/models/ProcessingClassBandViolation.js +1 -1
  187. package/dist/openapi/models/ProcessingClassExceedsBandResponse.d.ts +1 -1
  188. package/dist/openapi/models/ProcessingClassExceedsBandResponse.js +1 -1
  189. package/dist/openapi/models/ProcessingClassHint.d.ts +1 -1
  190. package/dist/openapi/models/ProcessingClassHint.js +1 -1
  191. package/dist/openapi/models/ProcessingClassReason.d.ts +1 -1
  192. package/dist/openapi/models/ProcessingClassReason.js +1 -1
  193. package/dist/openapi/models/ProcessingClassRejectReason.d.ts +1 -1
  194. package/dist/openapi/models/ProcessingClassRejectReason.js +1 -1
  195. package/dist/openapi/models/ProcessingPlan.d.ts +1 -1
  196. package/dist/openapi/models/ProcessingPlan.js +1 -1
  197. package/dist/openapi/models/ProcessingPlanJob.d.ts +1 -1
  198. package/dist/openapi/models/ProcessingPlanJob.js +1 -1
  199. package/dist/openapi/models/ReadinessResponse.d.ts +1 -1
  200. package/dist/openapi/models/ReadinessResponse.js +1 -1
  201. package/dist/openapi/models/ResponseEnvelope.d.ts +1 -1
  202. package/dist/openapi/models/ResponseEnvelope.js +1 -1
  203. package/dist/openapi/models/RetryResponse.d.ts +1 -1
  204. package/dist/openapi/models/RetryResponse.js +1 -1
  205. package/dist/openapi/models/RetrySuccessEnvelope.d.ts +1 -1
  206. package/dist/openapi/models/RetrySuccessEnvelope.js +1 -1
  207. package/dist/openapi/models/SseCompletionBase.d.ts +63 -0
  208. package/dist/openapi/models/SseCompletionBase.js +50 -0
  209. package/dist/openapi/models/SseEventType.d.ts +1 -1
  210. package/dist/openapi/models/SseEventType.js +1 -1
  211. package/dist/openapi/models/SseJobCompletedData.d.ts +1 -1
  212. package/dist/openapi/models/SseJobCompletedData.js +1 -1
  213. package/dist/openapi/models/SseJobFailedData.d.ts +1 -1
  214. package/dist/openapi/models/SseJobFailedData.js +1 -1
  215. package/dist/openapi/models/SseMultiOutputCompletion.d.ts +60 -0
  216. package/dist/openapi/models/SseMultiOutputCompletion.js +51 -0
  217. package/dist/openapi/models/SseMultiOutputCompletionMetrics.d.ts +38 -0
  218. package/dist/openapi/models/SseMultiOutputCompletionMetrics.js +43 -0
  219. package/dist/openapi/models/SseMultiOutputCompletionWithKind.d.ts +73 -0
  220. package/dist/openapi/models/SseMultiOutputCompletionWithKind.js +61 -0
  221. package/dist/openapi/models/SseMultiOutputResultEntry.d.ts +74 -0
  222. package/dist/openapi/models/SseMultiOutputResultEntry.js +51 -0
  223. package/dist/openapi/models/SseOperationCompletedData.d.ts +4 -4
  224. package/dist/openapi/models/SseOperationCompletedData.js +4 -4
  225. package/dist/openapi/models/SseOperationCompletionResult.d.ts +100 -0
  226. package/dist/openapi/models/SseOperationCompletionResult.js +47 -0
  227. package/dist/openapi/models/SseOperationFailedData.d.ts +1 -1
  228. package/dist/openapi/models/SseOperationFailedData.js +1 -1
  229. package/dist/openapi/models/SseOperationProgressData.d.ts +1 -1
  230. package/dist/openapi/models/SseOperationProgressData.js +1 -1
  231. package/dist/openapi/models/SseSingleOutputCompletion.d.ts +69 -0
  232. package/dist/openapi/models/SseSingleOutputCompletion.js +62 -0
  233. package/dist/openapi/models/SseWorkflowTerminalData.d.ts +1 -1
  234. package/dist/openapi/models/SseWorkflowTerminalData.js +1 -1
  235. package/dist/openapi/models/TierRestrictionKind.d.ts +1 -1
  236. package/dist/openapi/models/TierRestrictionKind.js +1 -1
  237. package/dist/openapi/models/TierRestrictionResponse.d.ts +1 -1
  238. package/dist/openapi/models/TierRestrictionResponse.js +1 -1
  239. package/dist/openapi/models/UploadConstraintsApplied.d.ts +1 -1
  240. package/dist/openapi/models/UploadConstraintsApplied.js +1 -1
  241. package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +1 -1
  242. package/dist/openapi/models/UploadDurationExceedsTierResponse.js +1 -1
  243. package/dist/openapi/models/UploadFile403Response.d.ts +1 -1
  244. package/dist/openapi/models/UploadFile403Response.js +1 -1
  245. package/dist/openapi/models/UploadFile422Response.d.ts +1 -1
  246. package/dist/openapi/models/UploadFile422Response.js +1 -1
  247. package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +1 -1
  248. package/dist/openapi/models/UploadProbeMediaMetadata.js +1 -1
  249. package/dist/openapi/models/UploadProbeProcessingClass.d.ts +1 -1
  250. package/dist/openapi/models/UploadProbeProcessingClass.js +1 -1
  251. package/dist/openapi/models/UploadProbeResponse.d.ts +4 -2
  252. package/dist/openapi/models/UploadProbeResponse.js +1 -1
  253. package/dist/openapi/models/UploadProbeStatus.d.ts +1 -1
  254. package/dist/openapi/models/UploadProbeStatus.js +1 -1
  255. package/dist/openapi/models/UploadProbeSuccessEnvelope.d.ts +56 -0
  256. package/dist/openapi/models/UploadProbeSuccessEnvelope.js +54 -0
  257. package/dist/openapi/models/UploadResponse.d.ts +1 -1
  258. package/dist/openapi/models/UploadResponse.js +1 -1
  259. package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +1 -1
  260. package/dist/openapi/models/UploadSizeExceedsTierResponse.js +1 -1
  261. package/dist/openapi/models/UploadSource.d.ts +1 -1
  262. package/dist/openapi/models/UploadSource.js +1 -1
  263. package/dist/openapi/models/UploadSuccessEnvelope.d.ts +1 -1
  264. package/dist/openapi/models/UploadSuccessEnvelope.js +1 -1
  265. package/dist/openapi/models/UploadThresholds.d.ts +1 -1
  266. package/dist/openapi/models/UploadThresholds.js +1 -1
  267. package/dist/openapi/models/UserTier.d.ts +1 -1
  268. package/dist/openapi/models/UserTier.js +1 -1
  269. package/dist/openapi/models/ValidationErrorEnvelope.d.ts +1 -1
  270. package/dist/openapi/models/ValidationErrorEnvelope.js +1 -1
  271. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +1 -1
  272. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +1 -1
  273. package/dist/openapi/models/WarningType.d.ts +1 -1
  274. package/dist/openapi/models/WarningType.js +1 -1
  275. package/dist/openapi/models/WebhookOperationContext.d.ts +1 -1
  276. package/dist/openapi/models/WebhookOperationContext.js +1 -1
  277. package/dist/openapi/models/WebhookPayload.d.ts +1 -1
  278. package/dist/openapi/models/WebhookPayload.js +1 -1
  279. package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +1 -1
  280. package/dist/openapi/models/WorkflowCancelBillingEffect.js +1 -1
  281. package/dist/openapi/models/WorkflowCancelResponse.d.ts +1 -1
  282. package/dist/openapi/models/WorkflowCancelResponse.js +1 -1
  283. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +1 -1
  284. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +1 -1
  285. package/dist/openapi/models/WorkflowCreateRequest.d.ts +1 -1
  286. package/dist/openapi/models/WorkflowCreateRequest.js +1 -1
  287. package/dist/openapi/models/WorkflowCreateResponse.d.ts +1 -1
  288. package/dist/openapi/models/WorkflowCreateResponse.js +1 -1
  289. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +1 -1
  290. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +1 -1
  291. package/dist/openapi/models/WorkflowDownloadResponse.d.ts +1 -1
  292. package/dist/openapi/models/WorkflowDownloadResponse.js +1 -1
  293. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +1 -1
  294. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +1 -1
  295. package/dist/openapi/models/WorkflowEdge.d.ts +1 -1
  296. package/dist/openapi/models/WorkflowEdge.js +1 -1
  297. package/dist/openapi/models/WorkflowExpiredResponse.d.ts +1 -1
  298. package/dist/openapi/models/WorkflowExpiredResponse.js +1 -1
  299. package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +1 -1
  300. package/dist/openapi/models/WorkflowPauseRequiredAction.js +1 -1
  301. package/dist/openapi/models/WorkflowPausedDetail.d.ts +1 -1
  302. package/dist/openapi/models/WorkflowPausedDetail.js +1 -1
  303. package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +1 -1
  304. package/dist/openapi/models/WorkflowPausedDetailLinks.js +1 -1
  305. package/dist/openapi/models/WorkflowProcessing.d.ts +1 -1
  306. package/dist/openapi/models/WorkflowProcessing.js +1 -1
  307. package/dist/openapi/models/WorkflowResumeResponse.d.ts +1 -1
  308. package/dist/openapi/models/WorkflowResumeResponse.js +1 -1
  309. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +1 -1
  310. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +1 -1
  311. package/dist/openapi/models/WorkflowSource.d.ts +1 -1
  312. package/dist/openapi/models/WorkflowSource.js +1 -1
  313. package/dist/openapi/models/WorkflowStatus.d.ts +1 -1
  314. package/dist/openapi/models/WorkflowStatus.js +1 -1
  315. package/dist/openapi/models/WorkflowStatusResponse.d.ts +1 -1
  316. package/dist/openapi/models/WorkflowStatusResponse.js +1 -1
  317. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +1 -1
  318. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +1 -1
  319. package/dist/openapi/models/WorkflowWarning.d.ts +1 -1
  320. package/dist/openapi/models/WorkflowWarning.js +1 -1
  321. package/dist/openapi/models/WorkflowWarningSeverity.d.ts +1 -1
  322. package/dist/openapi/models/WorkflowWarningSeverity.js +1 -1
  323. package/dist/openapi/models/index.d.ts +11 -0
  324. package/dist/openapi/models/index.js +11 -0
  325. package/dist/openapi/runtime.d.ts +1 -1
  326. package/dist/openapi/runtime.js +1 -1
  327. package/dist/operations/audio_to_video.d.ts +20 -0
  328. package/dist/operations/audio_to_video.js +17 -0
  329. package/dist/operations/audio_to_video.metadata.d.ts +2 -0
  330. package/dist/operations/audio_to_video.metadata.js +29 -0
  331. package/dist/operations/image_watermark.d.ts +0 -18
  332. package/dist/operations/image_watermark.js +0 -12
  333. package/dist/operations/image_watermark.metadata.js +0 -41
  334. package/dist/operations/index.d.ts +8 -0
  335. package/dist/operations/index.js +8 -0
  336. package/dist/operations/metadata-types.d.ts +17 -0
  337. package/dist/operations/split.d.ts +50 -0
  338. package/dist/operations/split.js +34 -0
  339. package/dist/operations/split.metadata.d.ts +2 -0
  340. package/dist/operations/split.metadata.js +103 -0
  341. package/dist/operations/video_text_watermark.d.ts +31 -0
  342. package/dist/operations/video_text_watermark.js +22 -0
  343. package/dist/operations/video_text_watermark.metadata.d.ts +2 -0
  344. package/dist/operations/video_text_watermark.metadata.js +65 -0
  345. package/dist/operations/video_watermark.d.ts +18 -0
  346. package/dist/operations/video_watermark.js +13 -0
  347. package/dist/operations/video_watermark.metadata.d.ts +2 -0
  348. package/dist/operations/video_watermark.metadata.js +52 -0
  349. package/openapi/api.yaml +772 -72
  350. package/operations/schemas/audio_to_video.yaml +122 -0
  351. package/operations/schemas/compress.yaml +0 -3
  352. package/operations/schemas/convert.yaml +14 -1
  353. package/operations/schemas/image_watermark.yaml +15 -103
  354. package/operations/schemas/split.yaml +309 -0
  355. package/operations/schemas/thumbnail.yaml +7 -1
  356. package/operations/schemas/video_text_watermark.yaml +174 -0
  357. package/operations/schemas/video_watermark.yaml +136 -0
  358. package/package.json +8 -3
@@ -4,15 +4,15 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { OperationResultFromJSON, OperationResultToJSON, } from './OperationResult.js';
15
14
  import { OperationTypeFromJSON, OperationTypeToJSON, } from './OperationType.js';
15
+ import { SseOperationCompletionResultFromJSON, SseOperationCompletionResultToJSON, } from './SseOperationCompletionResult.js';
16
16
  /**
17
17
  * @export
18
18
  */
@@ -54,7 +54,7 @@ export function SseOperationCompletedDataFromJSONTyped(json, ignoreDiscriminator
54
54
  'type': OperationTypeFromJSON(json['type']),
55
55
  'status': json['status'],
56
56
  'progress': json['progress'],
57
- 'result': json['result'] == null ? undefined : OperationResultFromJSON(json['result']),
57
+ 'result': json['result'] == null ? undefined : SseOperationCompletionResultFromJSON(json['result']),
58
58
  };
59
59
  }
60
60
  export function SseOperationCompletedDataToJSON(json) {
@@ -70,6 +70,6 @@ export function SseOperationCompletedDataToJSONTyped(value, ignoreDiscriminator
70
70
  'type': OperationTypeToJSON(value['type']),
71
71
  'status': value['status'],
72
72
  'progress': value['progress'],
73
- 'result': OperationResultToJSON(value['result']),
73
+ 'result': SseOperationCompletionResultToJSON(value['result']),
74
74
  };
75
75
  }
@@ -0,0 +1,100 @@
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.17.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 { SseMultiOutputCompletionWithKind } from './SseMultiOutputCompletionWithKind.js';
13
+ import type { SseSingleOutputCompletion } from './SseSingleOutputCompletion.js';
14
+ /**
15
+ * @type SseOperationCompletionResult
16
+ * Result payload carried on the SSE `operation.completed` event
17
+ * (`SseOperationCompletedData.result`). A 2-branch `oneOf` mirroring the
18
+ * single-output vs multi-output completion split of the AsyncAPI
19
+ * `OperationResult` union (per [ADR-0009](../docs/decisions/0009-multi-output-result-envelope.md)),
20
+ * projected into the client-facing (download-URL) shape rather than the
21
+ * S3-wire shape.
22
+ *
23
+ * - **Single-output**: `SseSingleOutputCompletion` (allOf wrap of
24
+ * `OperationResult` + a `result_kind: "single"` discriminator field).
25
+ * `download_url` + `size_bytes`, optional `export_key` / `metrics`. Every
26
+ * operation that produces one canonical output.
27
+ * - **Multi-output**: `SseMultiOutputCompletionWithKind` (allOf wrap of
28
+ * `SseMultiOutputCompletion` + a `result_kind: "multi"` discriminator
29
+ * field). `outputs[]` + `total_output_size_bytes`. Used by convert
30
+ * PDF->image and future fan-out operations.
31
+ *
32
+ * Failure is **not** a branch here — it is carried by the separate
33
+ * `operation.failed` event (`SseOperationFailedData`), unlike the AsyncAPI
34
+ * `OperationResult` which folds failure into the same union.
35
+ *
36
+ * **Branch dispatch via `result_kind` discriminator.** The branches are
37
+ * disambiguated by an explicit `result_kind` field (`"single"` |
38
+ * `"multi"`) that the API SSE emitter populates. The wrapper allOf shape
39
+ * keeps the underlying `OperationResult` and `SseMultiOutputCompletion`
40
+ * schemas unchanged (they continue to be used elsewhere — REST polling,
41
+ * AsyncAPI Lambda→API — without the discriminator). The discriminator
42
+ * approach replaces the v2.15.1 bare-`$ref` design, which dispatched
43
+ * correctly at validation but generated TS deserialization code that
44
+ * checked camelCase property names against snake_case wire payloads —
45
+ * silent data-loss on every single-output completion. The
46
+ * discriminator-based dispatch reads the snake_case wire key directly
47
+ * (`switch (json['result_kind'])`), avoiding the case-mismatch bug
48
+ * entirely.
49
+ *
50
+ * **v2.16.1 attempted PHP-template fix (superseded by v2.16.5).**
51
+ * The v2.16.1 cut introduced the shared `SseCompletionBase`
52
+ * schema declaring `result_kind: { enum: [single, multi] }` (both
53
+ * literal values together) and had the branch wrappers
54
+ * allOf-merge it. The intent was to fix the v2.15.3 design where
55
+ * `result_kind` was declared only as `enum: [single]` /
56
+ * `enum: [multi]` inside each branch's inline `allOf` block —
57
+ * which made the openapi-generator PHP template flatten only one
58
+ * branch's enum into `getResultKindAllowableValues()`. The
59
+ * v2.16.1 verification at the time confirmed PHP emitted both
60
+ * values, but against the v2.15.3-generated tree, not against a
61
+ * fresh v2.16.1 regen. SDKs later caught (via codex on the
62
+ * v2.16.3 regen, surfaced by ChSmslxj) that v2.16.1's shared-base
63
+ * fix did NOT actually propagate through the PHP template — the
64
+ * template visits each oneOf branch's allOf and only flattens the
65
+ * per-branch single-value enum, NOT the shared base's full-union
66
+ * enum. PHP root model still emitted `RESULT_KIND_MULTI` only
67
+ * (the second branch's value). SseCompletionBase is RETAINED in
68
+ * v2.16.5 for documentation + JSON Schema branch identification
69
+ * + consumers that traverse the allOf chain, but on its own it
70
+ * is NOT load-bearing for PHP correctness.
71
+ *
72
+ * **v2.16.5 ChSmslxj PHP-template fix (load-bearing).**
73
+ * Declares `result_kind` with the full `enum: [single, multi]`
74
+ * directly on the ROOT `SseOperationCompletionResult` schema as
75
+ * a sibling of `oneOf` and `discriminator` (with `type: object`
76
+ * + `required: [result_kind]`). The openapi-generator PHP
77
+ * template flattens this root enum cleanly into
78
+ * `getResultKindAllowableValues()`, emitting both
79
+ * `RESULT_KIND_SINGLE` and `RESULT_KIND_MULTI`. The triple
80
+ * declaration (root + SseCompletionBase + per-branch wrappers)
81
+ * is harmless redundancy: the root carries the full union for
82
+ * the PHP template; SseCompletionBase carries the full union
83
+ * for allOf-chain consumers; per-branch wrappers pin to a
84
+ * single literal value for OpenAPI discriminator semantics +
85
+ * JSON Schema branch identification. TypeScript dispatch is
86
+ * unchanged (`switch (json['result_kind'])` reads the
87
+ * snake_case wire key directly — verified on openapi-generator-
88
+ * cli v7.21.0).
89
+ *
90
+ * @export
91
+ */
92
+ export type SseOperationCompletionResult = {
93
+ resultKind: 'multi';
94
+ } & SseMultiOutputCompletionWithKind | {
95
+ resultKind: 'single';
96
+ } & SseSingleOutputCompletion;
97
+ export declare function SseOperationCompletionResultFromJSON(json: any): SseOperationCompletionResult;
98
+ export declare function SseOperationCompletionResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseOperationCompletionResult;
99
+ export declare function SseOperationCompletionResultToJSON(json: any): any;
100
+ export declare function SseOperationCompletionResultToJSONTyped(value?: SseOperationCompletionResult | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * GISL Compression API
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
6
+ *
7
+ * The version of the OpenAPI document: 2.17.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 { SseMultiOutputCompletionWithKindFromJSONTyped, SseMultiOutputCompletionWithKindToJSON, } from './SseMultiOutputCompletionWithKind.js';
15
+ import { SseSingleOutputCompletionFromJSONTyped, SseSingleOutputCompletionToJSON, } from './SseSingleOutputCompletion.js';
16
+ export function SseOperationCompletionResultFromJSON(json) {
17
+ return SseOperationCompletionResultFromJSONTyped(json, false);
18
+ }
19
+ export function SseOperationCompletionResultFromJSONTyped(json, ignoreDiscriminator) {
20
+ if (json == null) {
21
+ return json;
22
+ }
23
+ switch (json['result_kind']) {
24
+ case 'multi':
25
+ return Object.assign({}, SseMultiOutputCompletionWithKindFromJSONTyped(json, true), { resultKind: 'multi' });
26
+ case 'single':
27
+ return Object.assign({}, SseSingleOutputCompletionFromJSONTyped(json, true), { resultKind: 'single' });
28
+ default:
29
+ return json;
30
+ }
31
+ }
32
+ export function SseOperationCompletionResultToJSON(json) {
33
+ return SseOperationCompletionResultToJSONTyped(json, false);
34
+ }
35
+ export function SseOperationCompletionResultToJSONTyped(value, ignoreDiscriminator = false) {
36
+ if (value == null) {
37
+ return value;
38
+ }
39
+ switch (value['resultKind']) {
40
+ case 'multi':
41
+ return Object.assign({}, SseMultiOutputCompletionWithKindToJSON(value), { resultKind: 'multi' });
42
+ case 'single':
43
+ return Object.assign({}, SseSingleOutputCompletionToJSON(value), { resultKind: 'single' });
44
+ default:
45
+ return value;
46
+ }
47
+ }
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,69 @@
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.17.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 { OperationResultMetrics } from './OperationResultMetrics.js';
13
+ /**
14
+ * Single-output branch of `SseOperationCompletionResult` — wraps
15
+ * `OperationResult` + the shared `SseCompletionBase` + pins
16
+ * `result_kind` to the literal `"single"`. See
17
+ * `SseOperationCompletionResult` description for the rationale +
18
+ * codegen-quirk context.
19
+ *
20
+ * @export
21
+ * @interface SseSingleOutputCompletion
22
+ */
23
+ export interface SseSingleOutputCompletion {
24
+ /**
25
+ * Pre-signed download URL for the operation output
26
+ * @type {string}
27
+ * @memberof SseSingleOutputCompletion
28
+ */
29
+ downloadUrl: string;
30
+ /**
31
+ * Output file size in bytes
32
+ * @type {number}
33
+ * @memberof SseSingleOutputCompletion
34
+ */
35
+ sizeBytes: number;
36
+ /**
37
+ * Key in the customer's export destination (if export configured)
38
+ * @type {string}
39
+ * @memberof SseSingleOutputCompletion
40
+ */
41
+ exportKey?: string;
42
+ /**
43
+ *
44
+ * @type {OperationResultMetrics}
45
+ * @memberof SseSingleOutputCompletion
46
+ */
47
+ metrics?: OperationResultMetrics;
48
+ /**
49
+ *
50
+ * @type {SseSingleOutputCompletionResultKindEnum}
51
+ * @memberof SseSingleOutputCompletion
52
+ */
53
+ resultKind: SseSingleOutputCompletionResultKindEnum;
54
+ }
55
+ /**
56
+ * @export
57
+ */
58
+ export declare const SseSingleOutputCompletionResultKindEnum: {
59
+ readonly single: "single";
60
+ };
61
+ export type SseSingleOutputCompletionResultKindEnum = typeof SseSingleOutputCompletionResultKindEnum[keyof typeof SseSingleOutputCompletionResultKindEnum];
62
+ /**
63
+ * Check if a given object implements the SseSingleOutputCompletion interface.
64
+ */
65
+ export declare function instanceOfSseSingleOutputCompletion(value: object): value is SseSingleOutputCompletion;
66
+ export declare function SseSingleOutputCompletionFromJSON(json: any): SseSingleOutputCompletion;
67
+ export declare function SseSingleOutputCompletionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseSingleOutputCompletion;
68
+ export declare function SseSingleOutputCompletionToJSON(json: any): SseSingleOutputCompletion;
69
+ export declare function SseSingleOutputCompletionToJSONTyped(value?: SseSingleOutputCompletion | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,62 @@
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.17.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 { OperationResultMetricsFromJSON, OperationResultMetricsToJSON, } from './OperationResultMetrics.js';
15
+ /**
16
+ * @export
17
+ */
18
+ export const SseSingleOutputCompletionResultKindEnum = {
19
+ single: 'single'
20
+ };
21
+ /**
22
+ * Check if a given object implements the SseSingleOutputCompletion interface.
23
+ */
24
+ export function instanceOfSseSingleOutputCompletion(value) {
25
+ if (!('downloadUrl' in value) || value['downloadUrl'] === undefined)
26
+ return false;
27
+ if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
28
+ return false;
29
+ if (!('resultKind' in value) || value['resultKind'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ export function SseSingleOutputCompletionFromJSON(json) {
34
+ return SseSingleOutputCompletionFromJSONTyped(json, false);
35
+ }
36
+ export function SseSingleOutputCompletionFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'downloadUrl': json['download_url'],
42
+ 'sizeBytes': json['size_bytes'],
43
+ 'exportKey': json['export_key'] == null ? undefined : json['export_key'],
44
+ 'metrics': json['metrics'] == null ? undefined : OperationResultMetricsFromJSON(json['metrics']),
45
+ 'resultKind': json['result_kind'],
46
+ };
47
+ }
48
+ export function SseSingleOutputCompletionToJSON(json) {
49
+ return SseSingleOutputCompletionToJSONTyped(json, false);
50
+ }
51
+ export function SseSingleOutputCompletionToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'download_url': value['downloadUrl'],
57
+ 'size_bytes': value['sizeBytes'],
58
+ 'export_key': value['exportKey'],
59
+ 'metrics': OperationResultMetricsToJSON(value['metrics']),
60
+ 'result_kind': value['resultKind'],
61
+ };
62
+ }
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GISL Compression API
3
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.12.0
5
+ * The version of the OpenAPI document: 2.17.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GISL Compression API
5
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.12.0
7
+ * The version of the OpenAPI document: 2.17.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).