@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,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,60 @@
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 { SseMultiOutputResultEntry } from './SseMultiOutputResultEntry.js';
13
+ import type { SseMultiOutputCompletionMetrics } from './SseMultiOutputCompletionMetrics.js';
14
+ /**
15
+ * Multi-output completion body for the SSE `operation.completed` event.
16
+ * Per-output details plus an aggregate size, mirroring the AsyncAPI
17
+ * `MultiOutputCompletion` branch of `OperationResult` (per
18
+ * [ADR-0009](../docs/decisions/0009-multi-output-result-envelope.md)) in
19
+ * the client-facing (download-URL) projection.
20
+ *
21
+ * @export
22
+ * @interface SseMultiOutputCompletion
23
+ */
24
+ export interface SseMultiOutputCompletion {
25
+ /**
26
+ * Per-output deliverables for a multi-output operation (e.g. convert
27
+ * PDF->image emits one entry per page). Consumers use `outputs.length`
28
+ * for the count — per ADR-0009 §D4 a denormalised `output_count` was
29
+ * deliberately rejected. `maxItems: 200` mirrors the AsyncAPI
30
+ * `OperationResult.outputs` transport bound.
31
+ *
32
+ * @type {Array<SseMultiOutputResultEntry>}
33
+ * @memberof SseMultiOutputCompletion
34
+ */
35
+ outputs: Array<SseMultiOutputResultEntry>;
36
+ /**
37
+ * Aggregate size of all `outputs[]` in bytes. Equals
38
+ * `sum(outputs[].size_bytes)`. Per ADR-0009 §D4 this is denormalised
39
+ * against the per-entry sum; consumers SHOULD trust the per-entry sum
40
+ * if the two disagree (and log a warning).
41
+ *
42
+ * @type {number}
43
+ * @memberof SseMultiOutputCompletion
44
+ */
45
+ totalOutputSizeBytes: number;
46
+ /**
47
+ *
48
+ * @type {SseMultiOutputCompletionMetrics}
49
+ * @memberof SseMultiOutputCompletion
50
+ */
51
+ metrics?: SseMultiOutputCompletionMetrics;
52
+ }
53
+ /**
54
+ * Check if a given object implements the SseMultiOutputCompletion interface.
55
+ */
56
+ export declare function instanceOfSseMultiOutputCompletion(value: object): value is SseMultiOutputCompletion;
57
+ export declare function SseMultiOutputCompletionFromJSON(json: any): SseMultiOutputCompletion;
58
+ export declare function SseMultiOutputCompletionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseMultiOutputCompletion;
59
+ export declare function SseMultiOutputCompletionToJSON(json: any): SseMultiOutputCompletion;
60
+ export declare function SseMultiOutputCompletionToJSONTyped(value?: SseMultiOutputCompletion | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * GISL Compression API
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/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 { SseMultiOutputResultEntryFromJSON, SseMultiOutputResultEntryToJSON, } from './SseMultiOutputResultEntry.js';
15
+ import { SseMultiOutputCompletionMetricsFromJSON, SseMultiOutputCompletionMetricsToJSON, } from './SseMultiOutputCompletionMetrics.js';
16
+ /**
17
+ * Check if a given object implements the SseMultiOutputCompletion interface.
18
+ */
19
+ export function instanceOfSseMultiOutputCompletion(value) {
20
+ if (!('outputs' in value) || value['outputs'] === undefined)
21
+ return false;
22
+ if (!('totalOutputSizeBytes' in value) || value['totalOutputSizeBytes'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function SseMultiOutputCompletionFromJSON(json) {
27
+ return SseMultiOutputCompletionFromJSONTyped(json, false);
28
+ }
29
+ export function SseMultiOutputCompletionFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'outputs': (json['outputs'].map(SseMultiOutputResultEntryFromJSON)),
35
+ 'totalOutputSizeBytes': json['total_output_size_bytes'],
36
+ 'metrics': json['metrics'] == null ? undefined : SseMultiOutputCompletionMetricsFromJSON(json['metrics']),
37
+ };
38
+ }
39
+ export function SseMultiOutputCompletionToJSON(json) {
40
+ return SseMultiOutputCompletionToJSONTyped(json, false);
41
+ }
42
+ export function SseMultiOutputCompletionToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'outputs': (value['outputs'].map(SseMultiOutputResultEntryToJSON)),
48
+ 'total_output_size_bytes': value['totalOutputSizeBytes'],
49
+ 'metrics': SseMultiOutputCompletionMetricsToJSON(value['metrics']),
50
+ };
51
+ }
@@ -0,0 +1,38 @@
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
+ /**
13
+ * Operation-specific performance metrics (aggregate)
14
+ * @export
15
+ * @interface SseMultiOutputCompletionMetrics
16
+ */
17
+ export interface SseMultiOutputCompletionMetrics {
18
+ /**
19
+ * Ratio of output size to input size (e.g. 0.45 = 55% reduction)
20
+ * @type {number}
21
+ * @memberof SseMultiOutputCompletionMetrics
22
+ */
23
+ compressionRatio?: number;
24
+ /**
25
+ * Processing time in milliseconds
26
+ * @type {number}
27
+ * @memberof SseMultiOutputCompletionMetrics
28
+ */
29
+ durationMs?: number;
30
+ }
31
+ /**
32
+ * Check if a given object implements the SseMultiOutputCompletionMetrics interface.
33
+ */
34
+ export declare function instanceOfSseMultiOutputCompletionMetrics(value: object): value is SseMultiOutputCompletionMetrics;
35
+ export declare function SseMultiOutputCompletionMetricsFromJSON(json: any): SseMultiOutputCompletionMetrics;
36
+ export declare function SseMultiOutputCompletionMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseMultiOutputCompletionMetrics;
37
+ export declare function SseMultiOutputCompletionMetricsToJSON(json: any): SseMultiOutputCompletionMetrics;
38
+ export declare function SseMultiOutputCompletionMetricsToJSONTyped(value?: SseMultiOutputCompletionMetrics | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
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
+ /**
15
+ * Check if a given object implements the SseMultiOutputCompletionMetrics interface.
16
+ */
17
+ export function instanceOfSseMultiOutputCompletionMetrics(value) {
18
+ return true;
19
+ }
20
+ export function SseMultiOutputCompletionMetricsFromJSON(json) {
21
+ return SseMultiOutputCompletionMetricsFromJSONTyped(json, false);
22
+ }
23
+ export function SseMultiOutputCompletionMetricsFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'compressionRatio': json['compression_ratio'] == null ? undefined : json['compression_ratio'],
29
+ 'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
30
+ };
31
+ }
32
+ export function SseMultiOutputCompletionMetricsToJSON(json) {
33
+ return SseMultiOutputCompletionMetricsToJSONTyped(json, false);
34
+ }
35
+ export function SseMultiOutputCompletionMetricsToJSONTyped(value, ignoreDiscriminator = false) {
36
+ if (value == null) {
37
+ return value;
38
+ }
39
+ return {
40
+ 'compression_ratio': value['compressionRatio'],
41
+ 'duration_ms': value['durationMs'],
42
+ };
43
+ }
@@ -0,0 +1,73 @@
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 { SseMultiOutputResultEntry } from './SseMultiOutputResultEntry.js';
13
+ import type { SseMultiOutputCompletionMetrics } from './SseMultiOutputCompletionMetrics.js';
14
+ /**
15
+ * Multi-output branch of `SseOperationCompletionResult` — wraps
16
+ * `SseMultiOutputCompletion` + the shared `SseCompletionBase` +
17
+ * pins `result_kind` to the literal `"multi"`. See
18
+ * `SseOperationCompletionResult` description for the rationale +
19
+ * codegen-quirk context.
20
+ *
21
+ * @export
22
+ * @interface SseMultiOutputCompletionWithKind
23
+ */
24
+ export interface SseMultiOutputCompletionWithKind {
25
+ /**
26
+ * Per-output deliverables for a multi-output operation (e.g. convert
27
+ * PDF->image emits one entry per page). Consumers use `outputs.length`
28
+ * for the count — per ADR-0009 §D4 a denormalised `output_count` was
29
+ * deliberately rejected. `maxItems: 200` mirrors the AsyncAPI
30
+ * `OperationResult.outputs` transport bound.
31
+ *
32
+ * @type {Array<SseMultiOutputResultEntry>}
33
+ * @memberof SseMultiOutputCompletionWithKind
34
+ */
35
+ outputs: Array<SseMultiOutputResultEntry>;
36
+ /**
37
+ * Aggregate size of all `outputs[]` in bytes. Equals
38
+ * `sum(outputs[].size_bytes)`. Per ADR-0009 §D4 this is denormalised
39
+ * against the per-entry sum; consumers SHOULD trust the per-entry sum
40
+ * if the two disagree (and log a warning).
41
+ *
42
+ * @type {number}
43
+ * @memberof SseMultiOutputCompletionWithKind
44
+ */
45
+ totalOutputSizeBytes: number;
46
+ /**
47
+ *
48
+ * @type {SseMultiOutputCompletionMetrics}
49
+ * @memberof SseMultiOutputCompletionWithKind
50
+ */
51
+ metrics?: SseMultiOutputCompletionMetrics;
52
+ /**
53
+ *
54
+ * @type {SseMultiOutputCompletionWithKindResultKindEnum}
55
+ * @memberof SseMultiOutputCompletionWithKind
56
+ */
57
+ resultKind: SseMultiOutputCompletionWithKindResultKindEnum;
58
+ }
59
+ /**
60
+ * @export
61
+ */
62
+ export declare const SseMultiOutputCompletionWithKindResultKindEnum: {
63
+ readonly multi: "multi";
64
+ };
65
+ export type SseMultiOutputCompletionWithKindResultKindEnum = typeof SseMultiOutputCompletionWithKindResultKindEnum[keyof typeof SseMultiOutputCompletionWithKindResultKindEnum];
66
+ /**
67
+ * Check if a given object implements the SseMultiOutputCompletionWithKind interface.
68
+ */
69
+ export declare function instanceOfSseMultiOutputCompletionWithKind(value: object): value is SseMultiOutputCompletionWithKind;
70
+ export declare function SseMultiOutputCompletionWithKindFromJSON(json: any): SseMultiOutputCompletionWithKind;
71
+ export declare function SseMultiOutputCompletionWithKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseMultiOutputCompletionWithKind;
72
+ export declare function SseMultiOutputCompletionWithKindToJSON(json: any): SseMultiOutputCompletionWithKind;
73
+ export declare function SseMultiOutputCompletionWithKindToJSONTyped(value?: SseMultiOutputCompletionWithKind | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,61 @@
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 { SseMultiOutputResultEntryFromJSON, SseMultiOutputResultEntryToJSON, } from './SseMultiOutputResultEntry.js';
15
+ import { SseMultiOutputCompletionMetricsFromJSON, SseMultiOutputCompletionMetricsToJSON, } from './SseMultiOutputCompletionMetrics.js';
16
+ /**
17
+ * @export
18
+ */
19
+ export const SseMultiOutputCompletionWithKindResultKindEnum = {
20
+ multi: 'multi'
21
+ };
22
+ /**
23
+ * Check if a given object implements the SseMultiOutputCompletionWithKind interface.
24
+ */
25
+ export function instanceOfSseMultiOutputCompletionWithKind(value) {
26
+ if (!('outputs' in value) || value['outputs'] === undefined)
27
+ return false;
28
+ if (!('totalOutputSizeBytes' in value) || value['totalOutputSizeBytes'] === undefined)
29
+ return false;
30
+ if (!('resultKind' in value) || value['resultKind'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ export function SseMultiOutputCompletionWithKindFromJSON(json) {
35
+ return SseMultiOutputCompletionWithKindFromJSONTyped(json, false);
36
+ }
37
+ export function SseMultiOutputCompletionWithKindFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'outputs': (json['outputs'].map(SseMultiOutputResultEntryFromJSON)),
43
+ 'totalOutputSizeBytes': json['total_output_size_bytes'],
44
+ 'metrics': json['metrics'] == null ? undefined : SseMultiOutputCompletionMetricsFromJSON(json['metrics']),
45
+ 'resultKind': json['result_kind'],
46
+ };
47
+ }
48
+ export function SseMultiOutputCompletionWithKindToJSON(json) {
49
+ return SseMultiOutputCompletionWithKindToJSONTyped(json, false);
50
+ }
51
+ export function SseMultiOutputCompletionWithKindToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'outputs': (value['outputs'].map(SseMultiOutputResultEntryToJSON)),
57
+ 'total_output_size_bytes': value['totalOutputSizeBytes'],
58
+ 'metrics': SseMultiOutputCompletionMetricsToJSON(value['metrics']),
59
+ 'result_kind': value['resultKind'],
60
+ };
61
+ }
@@ -0,0 +1,74 @@
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
+ /**
13
+ * A single deliverable output file in an SSE multi-output
14
+ * `operation.completed` result (`SseMultiOutputCompletion.outputs[]`).
15
+ * This is the SSE-local, client-facing twin of the AsyncAPI
16
+ * `OperationResultOutputEntry` (which is S3-wire: `output_key`) and is
17
+ * deliberately **decoupled** from the REST `OperationDownload` schema — it
18
+ * carries `download_url` + `size_bytes` and the same `page_index` /
19
+ * `position` indexing model defined per
20
+ * [ADR-0009](../docs/decisions/0009-multi-output-result-envelope.md) §D2
21
+ * (`page_index` for PDF-page outputs, `position` for generic ordinals,
22
+ * mutually exclusive within an entry).
23
+ *
24
+ * @export
25
+ * @interface SseMultiOutputResultEntry
26
+ */
27
+ export interface SseMultiOutputResultEntry {
28
+ /**
29
+ * Pre-signed download URL for this individual output file.
30
+ * @type {string}
31
+ * @memberof SseMultiOutputResultEntry
32
+ */
33
+ downloadUrl: string;
34
+ /**
35
+ * Size of this individual output file in bytes. `minimum: 0` mirrors
36
+ * the AsyncAPI `OperationResultOutputEntry.output_size_bytes` bound and
37
+ * keeps `total_output_size_bytes` (the sum of these) internally
38
+ * consistent.
39
+ *
40
+ * @type {number}
41
+ * @memberof SseMultiOutputResultEntry
42
+ */
43
+ sizeBytes: number;
44
+ /**
45
+ * 1-based page number for PDF-page fan-out outputs (convert
46
+ * PDF->image). Gapless within an operation (an N-page conversion
47
+ * emits `page_index` 1..N). Mutually exclusive with `position`.
48
+ * Absent on non-indexed outputs. Mirrors
49
+ * `OperationResultOutputEntry.page_index`. Per ADR-0009 §D2.
50
+ *
51
+ * @type {number}
52
+ * @memberof SseMultiOutputResultEntry
53
+ */
54
+ pageIndex?: number;
55
+ /**
56
+ * 0-based ordinal for non-PDF multi-output operations (e.g. frame
57
+ * strip, chapter split). Mutually exclusive with `page_index`.
58
+ * Absent on non-indexed outputs. Forward-looking — not emitted by any
59
+ * current operation; declared for parity with
60
+ * `OperationResultOutputEntry.position`. Per ADR-0009 §D2.
61
+ *
62
+ * @type {number}
63
+ * @memberof SseMultiOutputResultEntry
64
+ */
65
+ position?: number;
66
+ }
67
+ /**
68
+ * Check if a given object implements the SseMultiOutputResultEntry interface.
69
+ */
70
+ export declare function instanceOfSseMultiOutputResultEntry(value: object): value is SseMultiOutputResultEntry;
71
+ export declare function SseMultiOutputResultEntryFromJSON(json: any): SseMultiOutputResultEntry;
72
+ export declare function SseMultiOutputResultEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SseMultiOutputResultEntry;
73
+ export declare function SseMultiOutputResultEntryToJSON(json: any): SseMultiOutputResultEntry;
74
+ export declare function SseMultiOutputResultEntryToJSONTyped(value?: SseMultiOutputResultEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * GISL Compression API
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/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
+ /**
15
+ * Check if a given object implements the SseMultiOutputResultEntry interface.
16
+ */
17
+ export function instanceOfSseMultiOutputResultEntry(value) {
18
+ if (!('downloadUrl' in value) || value['downloadUrl'] === undefined)
19
+ return false;
20
+ if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function SseMultiOutputResultEntryFromJSON(json) {
25
+ return SseMultiOutputResultEntryFromJSONTyped(json, false);
26
+ }
27
+ export function SseMultiOutputResultEntryFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'downloadUrl': json['download_url'],
33
+ 'sizeBytes': json['size_bytes'],
34
+ 'pageIndex': json['page_index'] == null ? undefined : json['page_index'],
35
+ 'position': json['position'] == null ? undefined : json['position'],
36
+ };
37
+ }
38
+ export function SseMultiOutputResultEntryToJSON(json) {
39
+ return SseMultiOutputResultEntryToJSONTyped(json, false);
40
+ }
41
+ export function SseMultiOutputResultEntryToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'download_url': value['downloadUrl'],
47
+ 'size_bytes': value['sizeBytes'],
48
+ 'page_index': value['pageIndex'],
49
+ 'position': value['position'],
50
+ };
51
+ }
@@ -2,15 +2,15 @@
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).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { OperationResult } from './OperationResult.js';
13
12
  import type { OperationType } from './OperationType.js';
13
+ import type { SseOperationCompletionResult } from './SseOperationCompletionResult.js';
14
14
  /**
15
15
  * Payload for `operation.completed` events
16
16
  * @export
@@ -49,10 +49,10 @@ export interface SseOperationCompletedData {
49
49
  progress: SseOperationCompletedDataProgressEnum;
50
50
  /**
51
51
  *
52
- * @type {OperationResult}
52
+ * @type {SseOperationCompletionResult}
53
53
  * @memberof SseOperationCompletedData
54
54
  */
55
- result?: OperationResult;
55
+ result?: SseOperationCompletionResult;
56
56
  }
57
57
  /**
58
58
  * @export