@giveitsmaller/contracts 0.2.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (369) hide show
  1. package/asyncapi/events.yaml +1777 -172
  2. package/availability/availability.json +2403 -0
  3. package/dist/asyncapi/AnonymousSchema_13.d.ts +6 -0
  4. package/dist/asyncapi/AnonymousSchema_13.js +7 -0
  5. package/dist/asyncapi/AnonymousSchema_152.d.ts +5 -0
  6. package/dist/asyncapi/AnonymousSchema_152.js +6 -0
  7. package/dist/asyncapi/Failure.d.ts +25 -0
  8. package/dist/asyncapi/Failure.js +1 -0
  9. package/dist/asyncapi/JobInputRole.d.ts +6 -0
  10. package/dist/asyncapi/JobInputRole.js +7 -0
  11. package/dist/asyncapi/MergeOutputType.d.ts +1 -3
  12. package/dist/asyncapi/MergeOutputType.js +0 -2
  13. package/dist/asyncapi/MultiOutputCompletion.d.ts +25 -0
  14. package/dist/asyncapi/MultiOutputCompletion.js +1 -0
  15. package/dist/asyncapi/NotificationsOperationsQueue.d.ts +4 -2
  16. package/dist/asyncapi/OperationMetrics.d.ts +3 -0
  17. package/dist/asyncapi/OperationProgress.d.ts +2 -0
  18. package/dist/asyncapi/OperationResult.d.ts +4 -19
  19. package/dist/asyncapi/OperationType.d.ts +6 -6
  20. package/dist/asyncapi/OperationType.js +5 -5
  21. package/dist/asyncapi/PageIndexed.d.ts +8 -0
  22. package/dist/asyncapi/PageIndexed.js +1 -0
  23. package/dist/asyncapi/PositionIndexed.d.ts +8 -0
  24. package/dist/asyncapi/PositionIndexed.js +1 -0
  25. package/dist/asyncapi/ProgressStatus.d.ts +3 -0
  26. package/dist/asyncapi/ProgressStatus.js +3 -0
  27. package/dist/asyncapi/ReEncodeDecision.d.ts +5 -0
  28. package/dist/asyncapi/ReEncodeDecision.js +6 -0
  29. package/dist/asyncapi/SingleOutputCompletion.d.ts +25 -0
  30. package/dist/asyncapi/SingleOutputCompletion.js +1 -0
  31. package/dist/asyncapi/SourceEntry.d.ts +2 -1
  32. package/dist/asyncapi/Unindexed.d.ts +8 -0
  33. package/dist/asyncapi/Unindexed.js +1 -0
  34. package/dist/asyncapi/UploadProbeCompletion.d.ts +16 -0
  35. package/dist/asyncapi/UploadProbeCompletion.js +1 -0
  36. package/dist/asyncapi/UploadProbeMediaMetadata.d.ts +18 -0
  37. package/dist/asyncapi/UploadProbeMediaMetadata.js +1 -0
  38. package/dist/asyncapi/UploadProbeProcessingClass.d.ts +6 -0
  39. package/dist/asyncapi/UploadProbeProcessingClass.js +7 -0
  40. package/dist/asyncapi/UploadProbeRequest.d.ts +10 -0
  41. package/dist/asyncapi/UploadProbeRequest.js +1 -0
  42. package/dist/asyncapi/UploadProbeStatus.d.ts +7 -0
  43. package/dist/asyncapi/UploadProbeStatus.js +8 -0
  44. package/dist/asyncapi/index.d.ts +13 -0
  45. package/dist/asyncapi/index.js +4 -0
  46. package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +64 -0
  47. package/dist/openapi/models/AudioWatermarkDecodeRequest.js +53 -0
  48. package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +80 -0
  49. package/dist/openapi/models/AudioWatermarkDecodeResponse.js +64 -0
  50. package/dist/openapi/models/AuthErrorResponse.d.ts +116 -0
  51. package/dist/openapi/models/AuthErrorResponse.js +66 -0
  52. package/dist/openapi/models/AuthErrorType.d.ts +73 -0
  53. package/dist/openapi/models/AuthErrorType.js +91 -0
  54. package/dist/openapi/models/AvailabilityValue.d.ts +43 -0
  55. package/dist/openapi/models/AvailabilityValue.js +61 -0
  56. package/dist/openapi/models/BalanceExhaustedResponse.d.ts +157 -0
  57. package/dist/openapi/models/BalanceExhaustedResponse.js +86 -0
  58. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +38 -0
  59. package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +43 -0
  60. package/dist/openapi/models/CallbackEventType.d.ts +2 -2
  61. package/dist/openapi/models/CallbackEventType.js +2 -2
  62. package/dist/openapi/models/ConnectionSource.d.ts +64 -0
  63. package/dist/openapi/models/ConnectionSource.js +57 -0
  64. package/dist/openapi/models/ContactRequest.d.ts +2 -2
  65. package/dist/openapi/models/ContactRequest.js +2 -2
  66. package/dist/openapi/models/ContactSubject.d.ts +2 -2
  67. package/dist/openapi/models/ContactSubject.js +2 -2
  68. package/dist/openapi/models/ContactValidationErrorResponse.d.ts +2 -2
  69. package/dist/openapi/models/ContactValidationErrorResponse.js +2 -2
  70. package/dist/openapi/models/CreateExternalImport403Response.d.ts +24 -0
  71. package/dist/openapi/models/CreateExternalImport403Response.js +58 -0
  72. package/dist/openapi/models/CreateWorkflow422Response.d.ts +23 -0
  73. package/dist/openapi/models/CreateWorkflow422Response.js +51 -0
  74. package/dist/openapi/models/CreditTransaction.d.ts +186 -0
  75. package/dist/openapi/models/CreditTransaction.js +100 -0
  76. package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +46 -0
  77. package/dist/openapi/models/CreditTransactionSourceBucket.js +64 -0
  78. package/dist/openapi/models/CreditsBalanceResponse.d.ts +84 -0
  79. package/dist/openapi/models/CreditsBalanceResponse.js +68 -0
  80. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +46 -0
  81. package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +54 -0
  82. package/dist/openapi/models/CreditsUsageResponse.d.ts +51 -0
  83. package/dist/openapi/models/CreditsUsageResponse.js +56 -0
  84. package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +46 -0
  85. package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +54 -0
  86. package/dist/openapi/models/Delivery.d.ts +98 -0
  87. package/dist/openapi/models/Delivery.js +65 -0
  88. package/dist/openapi/models/DeliveryOutputRef.d.ts +44 -0
  89. package/dist/openapi/models/DeliveryOutputRef.js +45 -0
  90. package/dist/openapi/models/DeliveryPlan.d.ts +77 -0
  91. package/dist/openapi/models/DeliveryPlan.js +72 -0
  92. package/dist/openapi/models/DeliveryPlanOutput.d.ts +53 -0
  93. package/dist/openapi/models/DeliveryPlanOutput.js +52 -0
  94. package/dist/openapi/models/DeliveryPlanReason.d.ts +35 -0
  95. package/dist/openapi/models/DeliveryPlanReason.js +53 -0
  96. package/dist/openapi/models/DeliverySelection.d.ts +62 -0
  97. package/dist/openapi/models/DeliverySelection.js +54 -0
  98. package/dist/openapi/models/ErrorEnvelope.d.ts +83 -5
  99. package/dist/openapi/models/ErrorEnvelope.js +10 -2
  100. package/dist/openapi/models/EstimateQuality.d.ts +34 -0
  101. package/dist/openapi/models/EstimateQuality.js +52 -0
  102. package/dist/openapi/models/EstimateRange.d.ts +48 -0
  103. package/dist/openapi/models/EstimateRange.js +51 -0
  104. package/dist/openapi/models/ExternalDestination.d.ts +41 -0
  105. package/dist/openapi/models/ExternalDestination.js +47 -0
  106. package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +49 -0
  107. package/dist/openapi/models/ExternalImportCreatedResponse.js +51 -0
  108. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +46 -0
  109. package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +54 -0
  110. package/dist/openapi/models/ExternalImportRequest.d.ts +92 -0
  111. package/dist/openapi/models/ExternalImportRequest.js +61 -0
  112. package/dist/openapi/models/ExternalImportToken.d.ts +51 -0
  113. package/dist/openapi/models/ExternalImportToken.js +53 -0
  114. package/dist/openapi/models/ExternalSource.d.ts +31 -0
  115. package/dist/openapi/models/ExternalSource.js +47 -0
  116. package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +140 -0
  117. package/dist/openapi/models/FeatureNotAvailableResponse.js +76 -0
  118. package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +135 -0
  119. package/dist/openapi/models/FeatureTierRestrictedResponse.js +76 -0
  120. package/dist/openapi/models/FeatureViolation.d.ts +108 -0
  121. package/dist/openapi/models/FeatureViolation.js +63 -0
  122. package/dist/openapi/models/JobDefinition.d.ts +125 -14
  123. package/dist/openapi/models/JobDefinition.js +25 -4
  124. package/dist/openapi/models/JobDownload.d.ts +2 -2
  125. package/dist/openapi/models/JobDownload.js +2 -2
  126. package/dist/openapi/models/JobInputV2.d.ts +89 -0
  127. package/dist/openapi/models/JobInputV2.js +56 -0
  128. package/dist/openapi/models/JobOutputSource.d.ts +57 -0
  129. package/dist/openapi/models/JobOutputSource.js +55 -0
  130. package/dist/openapi/models/JobResponse.d.ts +2 -2
  131. package/dist/openapi/models/JobResponse.js +2 -2
  132. package/dist/openapi/models/JobStatus.d.ts +17 -8
  133. package/dist/openapi/models/JobStatus.js +17 -8
  134. package/dist/openapi/models/JobType.d.ts +2 -2
  135. package/dist/openapi/models/JobType.js +2 -2
  136. package/dist/openapi/models/LivenessResponse.d.ts +2 -2
  137. package/dist/openapi/models/LivenessResponse.js +2 -2
  138. package/dist/openapi/models/LoginUser200Response.d.ts +46 -0
  139. package/dist/openapi/models/LoginUser200Response.js +54 -0
  140. package/dist/openapi/models/LoginUser200ResponseData.d.ts +33 -0
  141. package/dist/openapi/models/LoginUser200ResponseData.js +44 -0
  142. package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +50 -0
  143. package/dist/openapi/models/LoginUser200ResponseDataUser.js +51 -0
  144. package/dist/openapi/models/LoginUserRequest.d.ts +38 -0
  145. package/dist/openapi/models/LoginUserRequest.js +47 -0
  146. package/dist/openapi/models/LogoutUser200Response.d.ts +50 -0
  147. package/dist/openapi/models/LogoutUser200Response.js +53 -0
  148. package/dist/openapi/models/MetadataResponse.d.ts +13 -2
  149. package/dist/openapi/models/MetadataResponse.js +6 -2
  150. package/dist/openapi/models/MetadataResponseDimensions.d.ts +2 -2
  151. package/dist/openapi/models/MetadataResponseDimensions.js +2 -2
  152. package/dist/openapi/models/MetadataResponseExif.d.ts +2 -2
  153. package/dist/openapi/models/MetadataResponseExif.js +3 -3
  154. package/dist/openapi/models/MetadataResponseExifGps.d.ts +2 -2
  155. package/dist/openapi/models/MetadataResponseExifGps.js +2 -2
  156. package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +3 -3
  157. package/dist/openapi/models/MetadataSuccessEnvelope.js +2 -2
  158. package/dist/openapi/models/MimeGroupSchema.d.ts +46 -2
  159. package/dist/openapi/models/MimeGroupSchema.js +11 -2
  160. package/dist/openapi/models/MultipartCompleteRequest.d.ts +3 -3
  161. package/dist/openapi/models/MultipartCompleteRequest.js +2 -2
  162. package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +2 -2
  163. package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +2 -2
  164. package/dist/openapi/models/MultipartCompleteResponse.d.ts +7 -4
  165. package/dist/openapi/models/MultipartCompleteResponse.js +2 -2
  166. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +3 -3
  167. package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +2 -2
  168. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +56 -0
  169. package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +45 -0
  170. package/dist/openapi/models/MultipartInitiateResponse.d.ts +19 -3
  171. package/dist/openapi/models/MultipartInitiateResponse.js +7 -2
  172. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +3 -3
  173. package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +2 -2
  174. package/dist/openapi/models/OperationDefinition.d.ts +2 -2
  175. package/dist/openapi/models/OperationDefinition.js +2 -2
  176. package/dist/openapi/models/OperationDownload.d.ts +2 -2
  177. package/dist/openapi/models/OperationDownload.js +2 -2
  178. package/dist/openapi/models/OperationInputModel.d.ts +4 -4
  179. package/dist/openapi/models/OperationInputModel.js +4 -4
  180. package/dist/openapi/models/OperationResponse.d.ts +2 -2
  181. package/dist/openapi/models/OperationResponse.js +2 -2
  182. package/dist/openapi/models/OperationResult.d.ts +2 -2
  183. package/dist/openapi/models/OperationResult.js +2 -2
  184. package/dist/openapi/models/OperationResultMetrics.d.ts +2 -2
  185. package/dist/openapi/models/OperationResultMetrics.js +2 -2
  186. package/dist/openapi/models/OperationSchemaDefinition.d.ts +52 -5
  187. package/dist/openapi/models/OperationSchemaDefinition.js +10 -6
  188. package/dist/openapi/models/OperationStatus.d.ts +2 -2
  189. package/dist/openapi/models/OperationStatus.js +2 -2
  190. package/dist/openapi/models/OperationType.d.ts +17 -5
  191. package/dist/openapi/models/OperationType.js +18 -6
  192. package/dist/openapi/models/OperationsSchemaResponse.d.ts +70 -10
  193. package/dist/openapi/models/OperationsSchemaResponse.js +17 -2
  194. package/dist/openapi/models/OptionSchema.d.ts +42 -4
  195. package/dist/openapi/models/OptionSchema.js +12 -2
  196. package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +80 -0
  197. package/dist/openapi/models/PerValueAvailabilityEntry.js +53 -0
  198. package/dist/openapi/models/PresignedUrlPart.d.ts +2 -2
  199. package/dist/openapi/models/PresignedUrlPart.js +3 -3
  200. package/dist/openapi/models/ProcessingClass.d.ts +35 -0
  201. package/dist/openapi/models/ProcessingClass.js +53 -0
  202. package/dist/openapi/models/ProcessingClassHint.d.ts +36 -0
  203. package/dist/openapi/models/ProcessingClassHint.js +54 -0
  204. package/dist/openapi/models/ProcessingClassReason.d.ts +46 -0
  205. package/dist/openapi/models/ProcessingClassReason.js +64 -0
  206. package/dist/openapi/models/ProcessingPlan.d.ts +70 -0
  207. package/dist/openapi/models/ProcessingPlan.js +49 -0
  208. package/dist/openapi/models/ProcessingPlanJob.d.ts +81 -0
  209. package/dist/openapi/models/ProcessingPlanJob.js +71 -0
  210. package/dist/openapi/models/ReadinessResponse.d.ts +2 -2
  211. package/dist/openapi/models/ReadinessResponse.js +2 -2
  212. package/dist/openapi/models/ResponseEnvelope.d.ts +2 -2
  213. package/dist/openapi/models/ResponseEnvelope.js +2 -2
  214. package/dist/openapi/models/RetryResponse.d.ts +5 -5
  215. package/dist/openapi/models/RetryResponse.js +2 -2
  216. package/dist/openapi/models/RetrySuccessEnvelope.d.ts +3 -3
  217. package/dist/openapi/models/RetrySuccessEnvelope.js +2 -2
  218. package/dist/openapi/models/SseEventType.d.ts +2 -2
  219. package/dist/openapi/models/SseEventType.js +2 -2
  220. package/dist/openapi/models/SseJobCompletedData.d.ts +3 -3
  221. package/dist/openapi/models/SseJobCompletedData.js +2 -2
  222. package/dist/openapi/models/SseJobFailedData.d.ts +3 -3
  223. package/dist/openapi/models/SseJobFailedData.js +2 -2
  224. package/dist/openapi/models/SseOperationCompletedData.d.ts +4 -4
  225. package/dist/openapi/models/SseOperationCompletedData.js +2 -2
  226. package/dist/openapi/models/SseOperationFailedData.d.ts +3 -3
  227. package/dist/openapi/models/SseOperationFailedData.js +2 -2
  228. package/dist/openapi/models/SseOperationProgressData.d.ts +61 -3
  229. package/dist/openapi/models/SseOperationProgressData.js +22 -2
  230. package/dist/openapi/models/SseWorkflowTerminalData.d.ts +26 -4
  231. package/dist/openapi/models/SseWorkflowTerminalData.js +4 -2
  232. package/dist/openapi/models/TierRestrictionKind.d.ts +33 -0
  233. package/dist/openapi/models/TierRestrictionKind.js +51 -0
  234. package/dist/openapi/models/TierRestrictionResponse.d.ts +154 -0
  235. package/dist/openapi/models/TierRestrictionResponse.js +83 -0
  236. package/dist/openapi/models/UploadConstraintsApplied.d.ts +70 -0
  237. package/dist/openapi/models/UploadConstraintsApplied.js +57 -0
  238. package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +136 -0
  239. package/dist/openapi/models/UploadDurationExceedsTierResponse.js +82 -0
  240. package/dist/openapi/models/UploadFile403Response.d.ts +27 -0
  241. package/dist/openapi/models/UploadFile403Response.js +47 -0
  242. package/dist/openapi/models/UploadFile422Response.d.ts +27 -0
  243. package/dist/openapi/models/UploadFile422Response.js +47 -0
  244. package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +172 -0
  245. package/dist/openapi/models/UploadProbeMediaMetadata.js +69 -0
  246. package/dist/openapi/models/UploadProbeProcessingClass.d.ts +33 -0
  247. package/dist/openapi/models/UploadProbeProcessingClass.js +51 -0
  248. package/dist/openapi/models/UploadProbeResponse.d.ts +58 -0
  249. package/dist/openapi/models/UploadProbeResponse.js +58 -0
  250. package/dist/openapi/models/UploadProbeStatus.d.ts +41 -0
  251. package/dist/openapi/models/UploadProbeStatus.js +59 -0
  252. package/dist/openapi/models/UploadResponse.d.ts +17 -3
  253. package/dist/openapi/models/UploadResponse.js +7 -2
  254. package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +136 -0
  255. package/dist/openapi/models/UploadSizeExceedsTierResponse.js +82 -0
  256. package/dist/openapi/models/UploadSource.d.ts +48 -0
  257. package/dist/openapi/models/UploadSource.js +53 -0
  258. package/dist/openapi/models/UploadSuccessEnvelope.d.ts +3 -3
  259. package/dist/openapi/models/UploadSuccessEnvelope.js +2 -2
  260. package/dist/openapi/models/UploadThresholds.d.ts +119 -0
  261. package/dist/openapi/models/UploadThresholds.js +79 -0
  262. package/dist/openapi/models/UserTier.d.ts +41 -0
  263. package/dist/openapi/models/UserTier.js +59 -0
  264. package/dist/openapi/models/ValidationErrorEnvelope.d.ts +51 -4
  265. package/dist/openapi/models/ValidationErrorEnvelope.js +10 -2
  266. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +37 -4
  267. package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +6 -2
  268. package/dist/openapi/models/WarningType.d.ts +48 -0
  269. package/dist/openapi/models/WarningType.js +66 -0
  270. package/dist/openapi/models/WebhookOperationContext.d.ts +3 -3
  271. package/dist/openapi/models/WebhookOperationContext.js +2 -2
  272. package/dist/openapi/models/WebhookPayload.d.ts +2 -2
  273. package/dist/openapi/models/WebhookPayload.js +3 -3
  274. package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +36 -0
  275. package/dist/openapi/models/WorkflowCancelBillingEffect.js +54 -0
  276. package/dist/openapi/models/WorkflowCancelResponse.d.ts +66 -0
  277. package/dist/openapi/models/WorkflowCancelResponse.js +62 -0
  278. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +46 -0
  279. package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +54 -0
  280. package/dist/openapi/models/WorkflowCreateRequest.d.ts +39 -5
  281. package/dist/openapi/models/WorkflowCreateRequest.js +11 -5
  282. package/dist/openapi/models/WorkflowCreateResponse.d.ts +63 -2
  283. package/dist/openapi/models/WorkflowCreateResponse.js +21 -2
  284. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +3 -3
  285. package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +2 -2
  286. package/dist/openapi/models/WorkflowDownloadResponse.d.ts +2 -2
  287. package/dist/openapi/models/WorkflowDownloadResponse.js +2 -2
  288. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +3 -3
  289. package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +2 -2
  290. package/dist/openapi/models/WorkflowEdge.d.ts +2 -2
  291. package/dist/openapi/models/WorkflowEdge.js +2 -2
  292. package/dist/openapi/models/WorkflowExpiredResponse.d.ts +126 -0
  293. package/dist/openapi/models/WorkflowExpiredResponse.js +75 -0
  294. package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +30 -0
  295. package/dist/openapi/models/WorkflowPauseRequiredAction.js +48 -0
  296. package/dist/openapi/models/WorkflowPausedDetail.d.ts +99 -0
  297. package/dist/openapi/models/WorkflowPausedDetail.js +65 -0
  298. package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +47 -0
  299. package/dist/openapi/models/WorkflowPausedDetailLinks.js +45 -0
  300. package/dist/openapi/models/WorkflowProcessing.d.ts +36 -0
  301. package/dist/openapi/models/WorkflowProcessing.js +42 -0
  302. package/dist/openapi/models/WorkflowResumeResponse.d.ts +55 -0
  303. package/dist/openapi/models/WorkflowResumeResponse.js +57 -0
  304. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +46 -0
  305. package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +54 -0
  306. package/dist/openapi/models/WorkflowSource.d.ts +40 -0
  307. package/dist/openapi/models/WorkflowSource.js +57 -0
  308. package/dist/openapi/models/WorkflowStatus.d.ts +31 -8
  309. package/dist/openapi/models/WorkflowStatus.js +32 -9
  310. package/dist/openapi/models/WorkflowStatusResponse.d.ts +34 -2
  311. package/dist/openapi/models/WorkflowStatusResponse.js +13 -2
  312. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +3 -3
  313. package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +2 -2
  314. package/dist/openapi/models/WorkflowWarning.d.ts +119 -0
  315. package/dist/openapi/models/WorkflowWarning.js +63 -0
  316. package/dist/openapi/models/WorkflowWarningSeverity.d.ts +29 -0
  317. package/dist/openapi/models/WorkflowWarningSeverity.js +47 -0
  318. package/dist/openapi/models/index.d.ts +75 -3
  319. package/dist/openapi/models/index.js +75 -3
  320. package/dist/openapi/runtime.d.ts +2 -2
  321. package/dist/openapi/runtime.js +17 -2
  322. package/dist/operations/archive.metadata.d.ts +2 -0
  323. package/dist/operations/archive.metadata.js +13 -0
  324. package/dist/operations/audio_overlay.d.ts +48 -0
  325. package/dist/operations/audio_overlay.js +19 -0
  326. package/dist/operations/audio_overlay.metadata.d.ts +2 -0
  327. package/dist/operations/audio_overlay.metadata.js +167 -0
  328. package/dist/operations/audio_watermark.d.ts +42 -0
  329. package/dist/operations/audio_watermark.js +37 -0
  330. package/dist/operations/audio_watermark.metadata.d.ts +2 -0
  331. package/dist/operations/audio_watermark.metadata.js +94 -0
  332. package/dist/operations/compress.metadata.d.ts +2 -0
  333. package/dist/operations/compress.metadata.js +205 -0
  334. package/dist/operations/convert.metadata.d.ts +2 -0
  335. package/dist/operations/convert.metadata.js +85 -0
  336. package/dist/operations/custom_luma.d.ts +7 -0
  337. package/dist/operations/custom_luma.js +2 -0
  338. package/dist/operations/custom_luma.metadata.d.ts +2 -0
  339. package/dist/operations/custom_luma.metadata.js +49 -0
  340. package/dist/operations/image_watermark.d.ts +54 -0
  341. package/dist/operations/image_watermark.js +37 -0
  342. package/dist/operations/image_watermark.metadata.d.ts +2 -0
  343. package/dist/operations/image_watermark.metadata.js +97 -0
  344. package/dist/operations/index.d.ts +16 -1
  345. package/dist/operations/index.js +16 -1
  346. package/dist/operations/merge.d.ts +111 -31
  347. package/dist/operations/merge.js +106 -20
  348. package/dist/operations/merge.metadata.d.ts +2 -0
  349. package/dist/operations/merge.metadata.js +385 -0
  350. package/dist/operations/metadata-types.d.ts +47 -0
  351. package/dist/operations/metadata-types.js +2 -0
  352. package/dist/operations/text_watermark.d.ts +31 -0
  353. package/dist/operations/text_watermark.js +22 -0
  354. package/dist/operations/text_watermark.metadata.d.ts +2 -0
  355. package/dist/operations/text_watermark.metadata.js +46 -0
  356. package/dist/operations/thumbnail.metadata.d.ts +2 -0
  357. package/dist/operations/thumbnail.metadata.js +88 -0
  358. package/openapi/api.yaml +5070 -449
  359. package/operations/schemas/audio_overlay.yaml +397 -0
  360. package/operations/schemas/audio_watermark.yaml +184 -0
  361. package/operations/schemas/compress.yaml +20 -3
  362. package/operations/schemas/convert.yaml +18 -3
  363. package/operations/schemas/custom_luma.yaml +109 -0
  364. package/operations/schemas/image_watermark.yaml +280 -0
  365. package/operations/schemas/merge.yaml +295 -66
  366. package/operations/schemas/text_watermark.yaml +147 -0
  367. package/operations/schemas/thumbnail.yaml +15 -0
  368. package/package.json +10 -4
  369. package/operations/schemas/watermark.yaml +0 -87
@@ -0,0 +1,29 @@
1
+ /**
2
+ * GISL Compression API
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
4
+ *
5
+ * The version of the OpenAPI document: 2.7.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Severity of a workflow advisory warning. V2.0 ships with a
14
+ * single value `advisory` — non-blocking; the workflow
15
+ * proceeds regardless. Future severities reserved for cases
16
+ * where a warning escalates to blocking-but-overrideable (no
17
+ * such cases in V2.0).
18
+ *
19
+ * @export
20
+ */
21
+ export declare const WorkflowWarningSeverity: {
22
+ readonly advisory: "advisory";
23
+ };
24
+ export type WorkflowWarningSeverity = typeof WorkflowWarningSeverity[keyof typeof WorkflowWarningSeverity];
25
+ export declare function instanceOfWorkflowWarningSeverity(value: any): boolean;
26
+ export declare function WorkflowWarningSeverityFromJSON(json: any): WorkflowWarningSeverity;
27
+ export declare function WorkflowWarningSeverityFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowWarningSeverity;
28
+ export declare function WorkflowWarningSeverityToJSON(value?: WorkflowWarningSeverity | null): any;
29
+ export declare function WorkflowWarningSeverityToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowWarningSeverity;
@@ -0,0 +1,47 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * GISL Compression API
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
6
+ *
7
+ * The version of the OpenAPI document: 2.7.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Severity of a workflow advisory warning. V2.0 ships with a
16
+ * single value `advisory` — non-blocking; the workflow
17
+ * proceeds regardless. Future severities reserved for cases
18
+ * where a warning escalates to blocking-but-overrideable (no
19
+ * such cases in V2.0).
20
+ *
21
+ * @export
22
+ */
23
+ export const WorkflowWarningSeverity = {
24
+ advisory: 'advisory'
25
+ };
26
+ export function instanceOfWorkflowWarningSeverity(value) {
27
+ for (const key in WorkflowWarningSeverity) {
28
+ if (Object.prototype.hasOwnProperty.call(WorkflowWarningSeverity, key)) {
29
+ if (WorkflowWarningSeverity[key] === value) {
30
+ return true;
31
+ }
32
+ }
33
+ }
34
+ return false;
35
+ }
36
+ export function WorkflowWarningSeverityFromJSON(json) {
37
+ return WorkflowWarningSeverityFromJSONTyped(json, false);
38
+ }
39
+ export function WorkflowWarningSeverityFromJSONTyped(json, ignoreDiscriminator) {
40
+ return json;
41
+ }
42
+ export function WorkflowWarningSeverityToJSON(value) {
43
+ return value;
44
+ }
45
+ export function WorkflowWarningSeverityToJSONTyped(value, ignoreDiscriminator) {
46
+ return value;
47
+ }
@@ -1,17 +1,54 @@
1
+ export * from './AudioWatermarkDecodeRequest.js';
2
+ export * from './AudioWatermarkDecodeResponse.js';
3
+ export * from './AuthErrorResponse.js';
4
+ export * from './AuthErrorType.js';
5
+ export * from './AvailabilityValue.js';
6
+ export * from './BalanceExhaustedResponse.js';
7
+ export * from './BalanceExhaustedResponseAllOfLinks.js';
1
8
  export * from './CallbackEventType.js';
9
+ export * from './ConnectionSource.js';
2
10
  export * from './ContactRequest.js';
3
11
  export * from './ContactSubject.js';
4
12
  export * from './ContactValidationErrorResponse.js';
13
+ export * from './CreateExternalImport403Response.js';
14
+ export * from './CreateWorkflow422Response.js';
15
+ export * from './CreditTransaction.js';
16
+ export * from './CreditTransactionSourceBucket.js';
17
+ export * from './CreditsBalanceResponse.js';
18
+ export * from './CreditsBalanceSuccessEnvelope.js';
19
+ export * from './CreditsUsageResponse.js';
20
+ export * from './CreditsUsageSuccessEnvelope.js';
21
+ export * from './Delivery.js';
22
+ export * from './DeliveryOutputRef.js';
23
+ export * from './DeliveryPlan.js';
24
+ export * from './DeliveryPlanOutput.js';
25
+ export * from './DeliveryPlanReason.js';
26
+ export * from './DeliverySelection.js';
5
27
  export * from './ErrorEnvelope.js';
6
- export * from './ExportConfig.js';
28
+ export * from './EstimateQuality.js';
29
+ export * from './EstimateRange.js';
30
+ export * from './ExternalDestination.js';
31
+ export * from './ExternalImportCreatedResponse.js';
32
+ export * from './ExternalImportCreatedSuccessEnvelope.js';
33
+ export * from './ExternalImportRequest.js';
34
+ export * from './ExternalImportToken.js';
35
+ export * from './ExternalSource.js';
36
+ export * from './FeatureNotAvailableResponse.js';
37
+ export * from './FeatureTierRestrictedResponse.js';
38
+ export * from './FeatureViolation.js';
7
39
  export * from './JobDefinition.js';
8
40
  export * from './JobDownload.js';
9
- export * from './JobInput.js';
41
+ export * from './JobInputV2.js';
42
+ export * from './JobOutputSource.js';
10
43
  export * from './JobResponse.js';
11
- export * from './JobSource.js';
12
44
  export * from './JobStatus.js';
13
45
  export * from './JobType.js';
14
46
  export * from './LivenessResponse.js';
47
+ export * from './LoginUser200Response.js';
48
+ export * from './LoginUser200ResponseData.js';
49
+ export * from './LoginUser200ResponseDataUser.js';
50
+ export * from './LoginUserRequest.js';
51
+ export * from './LogoutUser200Response.js';
15
52
  export * from './MetadataResponse.js';
16
53
  export * from './MetadataResponseDimensions.js';
17
54
  export * from './MetadataResponseExif.js';
@@ -22,6 +59,7 @@ export * from './MultipartCompleteRequest.js';
22
59
  export * from './MultipartCompleteRequestPartsInner.js';
23
60
  export * from './MultipartCompleteResponse.js';
24
61
  export * from './MultipartCompleteSuccessEnvelope.js';
62
+ export * from './MultipartInitiateRequestMetadataHint.js';
25
63
  export * from './MultipartInitiateResponse.js';
26
64
  export * from './MultipartInitiateSuccessEnvelope.js';
27
65
  export * from './OperationDefinition.js';
@@ -35,7 +73,13 @@ export * from './OperationStatus.js';
35
73
  export * from './OperationType.js';
36
74
  export * from './OperationsSchemaResponse.js';
37
75
  export * from './OptionSchema.js';
76
+ export * from './PerValueAvailabilityEntry.js';
38
77
  export * from './PresignedUrlPart.js';
78
+ export * from './ProcessingClass.js';
79
+ export * from './ProcessingClassHint.js';
80
+ export * from './ProcessingClassReason.js';
81
+ export * from './ProcessingPlan.js';
82
+ export * from './ProcessingPlanJob.js';
39
83
  export * from './ReadinessResponse.js';
40
84
  export * from './ResponseEnvelope.js';
41
85
  export * from './RetryResponse.js';
@@ -47,18 +91,46 @@ export * from './SseOperationCompletedData.js';
47
91
  export * from './SseOperationFailedData.js';
48
92
  export * from './SseOperationProgressData.js';
49
93
  export * from './SseWorkflowTerminalData.js';
94
+ export * from './TierRestrictionKind.js';
95
+ export * from './TierRestrictionResponse.js';
96
+ export * from './UploadConstraintsApplied.js';
97
+ export * from './UploadDurationExceedsTierResponse.js';
98
+ export * from './UploadFile403Response.js';
99
+ export * from './UploadFile422Response.js';
100
+ export * from './UploadProbeMediaMetadata.js';
101
+ export * from './UploadProbeProcessingClass.js';
102
+ export * from './UploadProbeResponse.js';
103
+ export * from './UploadProbeStatus.js';
50
104
  export * from './UploadResponse.js';
105
+ export * from './UploadSizeExceedsTierResponse.js';
106
+ export * from './UploadSource.js';
51
107
  export * from './UploadSuccessEnvelope.js';
108
+ export * from './UploadThresholds.js';
109
+ export * from './UserTier.js';
52
110
  export * from './ValidationErrorEnvelope.js';
53
111
  export * from './ValidationErrorEnvelopeDetailsInner.js';
112
+ export * from './WarningType.js';
54
113
  export * from './WebhookOperationContext.js';
55
114
  export * from './WebhookPayload.js';
115
+ export * from './WorkflowCancelBillingEffect.js';
116
+ export * from './WorkflowCancelResponse.js';
117
+ export * from './WorkflowCancelSuccessEnvelope.js';
56
118
  export * from './WorkflowCreateRequest.js';
57
119
  export * from './WorkflowCreateResponse.js';
58
120
  export * from './WorkflowCreateSuccessEnvelope.js';
59
121
  export * from './WorkflowDownloadResponse.js';
60
122
  export * from './WorkflowDownloadSuccessEnvelope.js';
61
123
  export * from './WorkflowEdge.js';
124
+ export * from './WorkflowExpiredResponse.js';
125
+ export * from './WorkflowPauseRequiredAction.js';
126
+ export * from './WorkflowPausedDetail.js';
127
+ export * from './WorkflowPausedDetailLinks.js';
128
+ export * from './WorkflowProcessing.js';
129
+ export * from './WorkflowResumeResponse.js';
130
+ export * from './WorkflowResumeSuccessEnvelope.js';
131
+ export * from './WorkflowSource.js';
62
132
  export * from './WorkflowStatus.js';
63
133
  export * from './WorkflowStatusResponse.js';
64
134
  export * from './WorkflowStatusSuccessEnvelope.js';
135
+ export * from './WorkflowWarning.js';
136
+ export * from './WorkflowWarningSeverity.js';
@@ -1,19 +1,56 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
+ export * from './AudioWatermarkDecodeRequest.js';
4
+ export * from './AudioWatermarkDecodeResponse.js';
5
+ export * from './AuthErrorResponse.js';
6
+ export * from './AuthErrorType.js';
7
+ export * from './AvailabilityValue.js';
8
+ export * from './BalanceExhaustedResponse.js';
9
+ export * from './BalanceExhaustedResponseAllOfLinks.js';
3
10
  export * from './CallbackEventType.js';
11
+ export * from './ConnectionSource.js';
4
12
  export * from './ContactRequest.js';
5
13
  export * from './ContactSubject.js';
6
14
  export * from './ContactValidationErrorResponse.js';
15
+ export * from './CreateExternalImport403Response.js';
16
+ export * from './CreateWorkflow422Response.js';
17
+ export * from './CreditTransaction.js';
18
+ export * from './CreditTransactionSourceBucket.js';
19
+ export * from './CreditsBalanceResponse.js';
20
+ export * from './CreditsBalanceSuccessEnvelope.js';
21
+ export * from './CreditsUsageResponse.js';
22
+ export * from './CreditsUsageSuccessEnvelope.js';
23
+ export * from './Delivery.js';
24
+ export * from './DeliveryOutputRef.js';
25
+ export * from './DeliveryPlan.js';
26
+ export * from './DeliveryPlanOutput.js';
27
+ export * from './DeliveryPlanReason.js';
28
+ export * from './DeliverySelection.js';
7
29
  export * from './ErrorEnvelope.js';
8
- export * from './ExportConfig.js';
30
+ export * from './EstimateQuality.js';
31
+ export * from './EstimateRange.js';
32
+ export * from './ExternalDestination.js';
33
+ export * from './ExternalImportCreatedResponse.js';
34
+ export * from './ExternalImportCreatedSuccessEnvelope.js';
35
+ export * from './ExternalImportRequest.js';
36
+ export * from './ExternalImportToken.js';
37
+ export * from './ExternalSource.js';
38
+ export * from './FeatureNotAvailableResponse.js';
39
+ export * from './FeatureTierRestrictedResponse.js';
40
+ export * from './FeatureViolation.js';
9
41
  export * from './JobDefinition.js';
10
42
  export * from './JobDownload.js';
11
- export * from './JobInput.js';
43
+ export * from './JobInputV2.js';
44
+ export * from './JobOutputSource.js';
12
45
  export * from './JobResponse.js';
13
- export * from './JobSource.js';
14
46
  export * from './JobStatus.js';
15
47
  export * from './JobType.js';
16
48
  export * from './LivenessResponse.js';
49
+ export * from './LoginUser200Response.js';
50
+ export * from './LoginUser200ResponseData.js';
51
+ export * from './LoginUser200ResponseDataUser.js';
52
+ export * from './LoginUserRequest.js';
53
+ export * from './LogoutUser200Response.js';
17
54
  export * from './MetadataResponse.js';
18
55
  export * from './MetadataResponseDimensions.js';
19
56
  export * from './MetadataResponseExif.js';
@@ -24,6 +61,7 @@ export * from './MultipartCompleteRequest.js';
24
61
  export * from './MultipartCompleteRequestPartsInner.js';
25
62
  export * from './MultipartCompleteResponse.js';
26
63
  export * from './MultipartCompleteSuccessEnvelope.js';
64
+ export * from './MultipartInitiateRequestMetadataHint.js';
27
65
  export * from './MultipartInitiateResponse.js';
28
66
  export * from './MultipartInitiateSuccessEnvelope.js';
29
67
  export * from './OperationDefinition.js';
@@ -37,7 +75,13 @@ export * from './OperationStatus.js';
37
75
  export * from './OperationType.js';
38
76
  export * from './OperationsSchemaResponse.js';
39
77
  export * from './OptionSchema.js';
78
+ export * from './PerValueAvailabilityEntry.js';
40
79
  export * from './PresignedUrlPart.js';
80
+ export * from './ProcessingClass.js';
81
+ export * from './ProcessingClassHint.js';
82
+ export * from './ProcessingClassReason.js';
83
+ export * from './ProcessingPlan.js';
84
+ export * from './ProcessingPlanJob.js';
41
85
  export * from './ReadinessResponse.js';
42
86
  export * from './ResponseEnvelope.js';
43
87
  export * from './RetryResponse.js';
@@ -49,18 +93,46 @@ export * from './SseOperationCompletedData.js';
49
93
  export * from './SseOperationFailedData.js';
50
94
  export * from './SseOperationProgressData.js';
51
95
  export * from './SseWorkflowTerminalData.js';
96
+ export * from './TierRestrictionKind.js';
97
+ export * from './TierRestrictionResponse.js';
98
+ export * from './UploadConstraintsApplied.js';
99
+ export * from './UploadDurationExceedsTierResponse.js';
100
+ export * from './UploadFile403Response.js';
101
+ export * from './UploadFile422Response.js';
102
+ export * from './UploadProbeMediaMetadata.js';
103
+ export * from './UploadProbeProcessingClass.js';
104
+ export * from './UploadProbeResponse.js';
105
+ export * from './UploadProbeStatus.js';
52
106
  export * from './UploadResponse.js';
107
+ export * from './UploadSizeExceedsTierResponse.js';
108
+ export * from './UploadSource.js';
53
109
  export * from './UploadSuccessEnvelope.js';
110
+ export * from './UploadThresholds.js';
111
+ export * from './UserTier.js';
54
112
  export * from './ValidationErrorEnvelope.js';
55
113
  export * from './ValidationErrorEnvelopeDetailsInner.js';
114
+ export * from './WarningType.js';
56
115
  export * from './WebhookOperationContext.js';
57
116
  export * from './WebhookPayload.js';
117
+ export * from './WorkflowCancelBillingEffect.js';
118
+ export * from './WorkflowCancelResponse.js';
119
+ export * from './WorkflowCancelSuccessEnvelope.js';
58
120
  export * from './WorkflowCreateRequest.js';
59
121
  export * from './WorkflowCreateResponse.js';
60
122
  export * from './WorkflowCreateSuccessEnvelope.js';
61
123
  export * from './WorkflowDownloadResponse.js';
62
124
  export * from './WorkflowDownloadSuccessEnvelope.js';
63
125
  export * from './WorkflowEdge.js';
126
+ export * from './WorkflowExpiredResponse.js';
127
+ export * from './WorkflowPauseRequiredAction.js';
128
+ export * from './WorkflowPausedDetail.js';
129
+ export * from './WorkflowPausedDetailLinks.js';
130
+ export * from './WorkflowProcessing.js';
131
+ export * from './WorkflowResumeResponse.js';
132
+ export * from './WorkflowResumeSuccessEnvelope.js';
133
+ export * from './WorkflowSource.js';
64
134
  export * from './WorkflowStatus.js';
65
135
  export * from './WorkflowStatusResponse.js';
66
136
  export * from './WorkflowStatusSuccessEnvelope.js';
137
+ export * from './WorkflowWarning.js';
138
+ export * from './WorkflowWarningSeverity.js';
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * GISL Compression API
3
- * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
3
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
4
4
  *
5
- * The version of the OpenAPI document: 2.0.0
5
+ * The version of the OpenAPI document: 2.7.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * GISL Compression API
5
- * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body.
5
+ * REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
6
6
  *
7
- * The version of the OpenAPI document: 2.0.0
7
+ * The version of the OpenAPI document: 2.7.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -223,6 +223,11 @@ export class ResponseError extends Error {
223
223
  constructor(response, msg) {
224
224
  super(msg);
225
225
  this.response = response;
226
+ // restore prototype chain
227
+ const actualProto = new.target.prototype;
228
+ if (Object.setPrototypeOf) {
229
+ Object.setPrototypeOf(this, actualProto);
230
+ }
226
231
  }
227
232
  }
228
233
  export class FetchError extends Error {
@@ -231,6 +236,11 @@ export class FetchError extends Error {
231
236
  constructor(cause, msg) {
232
237
  super(msg);
233
238
  this.cause = cause;
239
+ // restore prototype chain
240
+ const actualProto = new.target.prototype;
241
+ if (Object.setPrototypeOf) {
242
+ Object.setPrototypeOf(this, actualProto);
243
+ }
234
244
  }
235
245
  }
236
246
  export class RequiredError extends Error {
@@ -239,6 +249,11 @@ export class RequiredError extends Error {
239
249
  constructor(field, msg) {
240
250
  super(msg);
241
251
  this.field = field;
252
+ // restore prototype chain
253
+ const actualProto = new.target.prototype;
254
+ if (Object.setPrototypeOf) {
255
+ Object.setPrototypeOf(this, actualProto);
256
+ }
242
257
  }
243
258
  }
244
259
  export const COLLECTION_FORMATS = {
@@ -0,0 +1,2 @@
1
+ import type { OperationMetadata } from './metadata-types.js';
2
+ export declare const archiveMetadata: OperationMetadata;
@@ -0,0 +1,13 @@
1
+ // Auto-generated from archive.yaml -- do not edit
2
+ export const archiveMetadata = {
3
+ features: {},
4
+ mime_groups: {},
5
+ direct_options: {
6
+ format: {
7
+ per_value_availability: {},
8
+ },
9
+ folder_structure: {
10
+ per_value_availability: {},
11
+ },
12
+ },
13
+ };
@@ -0,0 +1,48 @@
1
+ export declare enum AudioOverlayAudioMode {
2
+ Mix = "mix",
3
+ Duck = "duck",
4
+ Replace = "replace"
5
+ }
6
+ export interface AudioOverlayAudioOptions {
7
+ start_at?: number;
8
+ duration?: number;
9
+ overlay_gain_db?: number;
10
+ mode?: AudioOverlayAudioMode;
11
+ duck_threshold?: number;
12
+ duck_ratio?: number;
13
+ duck_attack_ms?: number;
14
+ duck_release_ms?: number;
15
+ fade_in_ms?: number;
16
+ fade_out_ms?: number;
17
+ loop?: boolean;
18
+ loop_interval?: number;
19
+ silence_threshold_db?: number;
20
+ min_silence_ms?: number;
21
+ }
22
+ export declare enum AudioOverlayVideoMode {
23
+ Mix = "mix",
24
+ Duck = "duck",
25
+ Replace = "replace"
26
+ }
27
+ export declare enum AudioOverlayVideoNoAudioTrackBehaviour {
28
+ Reject = "reject",
29
+ CreateSilent = "create_silent",
30
+ Replace = "replace"
31
+ }
32
+ export interface AudioOverlayVideoOptions {
33
+ start_at?: number;
34
+ duration?: number;
35
+ overlay_gain_db?: number;
36
+ mode?: AudioOverlayVideoMode;
37
+ duck_threshold?: number;
38
+ duck_ratio?: number;
39
+ duck_attack_ms?: number;
40
+ duck_release_ms?: number;
41
+ fade_in_ms?: number;
42
+ fade_out_ms?: number;
43
+ loop?: boolean;
44
+ loop_interval?: number;
45
+ no_audio_track_behaviour?: AudioOverlayVideoNoAudioTrackBehaviour;
46
+ silence_threshold_db?: number;
47
+ min_silence_ms?: number;
48
+ }
@@ -0,0 +1,19 @@
1
+ // Auto-generated from audio_overlay.yaml -- do not edit
2
+ export var AudioOverlayAudioMode;
3
+ (function (AudioOverlayAudioMode) {
4
+ AudioOverlayAudioMode["Mix"] = "mix";
5
+ AudioOverlayAudioMode["Duck"] = "duck";
6
+ AudioOverlayAudioMode["Replace"] = "replace";
7
+ })(AudioOverlayAudioMode || (AudioOverlayAudioMode = {}));
8
+ export var AudioOverlayVideoMode;
9
+ (function (AudioOverlayVideoMode) {
10
+ AudioOverlayVideoMode["Mix"] = "mix";
11
+ AudioOverlayVideoMode["Duck"] = "duck";
12
+ AudioOverlayVideoMode["Replace"] = "replace";
13
+ })(AudioOverlayVideoMode || (AudioOverlayVideoMode = {}));
14
+ export var AudioOverlayVideoNoAudioTrackBehaviour;
15
+ (function (AudioOverlayVideoNoAudioTrackBehaviour) {
16
+ AudioOverlayVideoNoAudioTrackBehaviour["Reject"] = "reject";
17
+ AudioOverlayVideoNoAudioTrackBehaviour["CreateSilent"] = "create_silent";
18
+ AudioOverlayVideoNoAudioTrackBehaviour["Replace"] = "replace";
19
+ })(AudioOverlayVideoNoAudioTrackBehaviour || (AudioOverlayVideoNoAudioTrackBehaviour = {}));
@@ -0,0 +1,2 @@
1
+ import type { OperationMetadata } from './metadata-types.js';
2
+ export declare const audioOverlayMetadata: OperationMetadata;