@epistola.app/epistola-client 1.2.1-rc.1 → 1.3.1

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 (376) hide show
  1. package/CHANGELOG.md +10 -2
  2. package/README.md +52 -16
  3. package/dist/auth/jwtSigner.d.ts +3 -0
  4. package/dist/auth/jwtSigner.d.ts.map +1 -1
  5. package/dist/auth/jwtSigner.js +3 -0
  6. package/dist/auth/jwtSigner.js.map +1 -1
  7. package/dist/generated/api/apis/AttributesApi.d.ts +2 -2
  8. package/dist/generated/api/apis/AttributesApi.js +2 -2
  9. package/dist/generated/api/apis/CatalogsApi.d.ts +4 -4
  10. package/dist/generated/api/apis/CatalogsApi.js +4 -4
  11. package/dist/generated/api/apis/CodeListsApi.d.ts +2 -2
  12. package/dist/generated/api/apis/CodeListsApi.js +2 -2
  13. package/dist/generated/api/apis/ConsumersApi.d.ts +18 -18
  14. package/dist/generated/api/apis/ConsumersApi.js +18 -18
  15. package/dist/generated/api/apis/ContractsApi.d.ts +2 -2
  16. package/dist/generated/api/apis/ContractsApi.js +2 -2
  17. package/dist/generated/api/apis/EnvironmentsApi.d.ts +2 -2
  18. package/dist/generated/api/apis/EnvironmentsApi.js +2 -2
  19. package/dist/generated/api/apis/FontsApi.d.ts +2 -2
  20. package/dist/generated/api/apis/FontsApi.js +2 -2
  21. package/dist/generated/api/apis/GenerationApi.d.ts +2 -2
  22. package/dist/generated/api/apis/GenerationApi.js +2 -2
  23. package/dist/generated/api/apis/ImagesApi.d.ts +85 -0
  24. package/dist/generated/api/apis/ImagesApi.d.ts.map +1 -0
  25. package/dist/generated/api/apis/{AssetsApi.js → ImagesApi.js} +54 -65
  26. package/dist/generated/api/apis/ImagesApi.js.map +1 -0
  27. package/dist/generated/api/apis/StencilsApi.d.ts +2 -2
  28. package/dist/generated/api/apis/StencilsApi.js +2 -2
  29. package/dist/generated/api/apis/SystemApi.d.ts +2 -2
  30. package/dist/generated/api/apis/SystemApi.js +2 -2
  31. package/dist/generated/api/apis/TemplatesApi.d.ts +2 -2
  32. package/dist/generated/api/apis/TemplatesApi.js +2 -2
  33. package/dist/generated/api/apis/TenantsApi.d.ts +2 -2
  34. package/dist/generated/api/apis/TenantsApi.js +2 -2
  35. package/dist/generated/api/apis/ThemesApi.d.ts +2 -2
  36. package/dist/generated/api/apis/ThemesApi.js +2 -2
  37. package/dist/generated/api/apis/VariantsApi.d.ts +2 -2
  38. package/dist/generated/api/apis/VariantsApi.js +2 -2
  39. package/dist/generated/api/apis/VersionsApi.d.ts +2 -2
  40. package/dist/generated/api/apis/VersionsApi.js +2 -2
  41. package/dist/generated/api/apis/index.d.ts +1 -1
  42. package/dist/generated/api/apis/index.d.ts.map +1 -1
  43. package/dist/generated/api/apis/index.js +1 -1
  44. package/dist/generated/api/apis/index.js.map +1 -1
  45. package/dist/generated/api/models/ActivationDto.d.ts +2 -2
  46. package/dist/generated/api/models/ActivationDto.js +2 -2
  47. package/dist/generated/api/models/ActivationListResponse.d.ts +2 -2
  48. package/dist/generated/api/models/ActivationListResponse.js +2 -2
  49. package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +2 -2
  50. package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +2 -2
  51. package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +2 -2
  52. package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +2 -2
  53. package/dist/generated/api/models/ApproveConsumerRequest.d.ts +2 -2
  54. package/dist/generated/api/models/ApproveConsumerRequest.js +2 -2
  55. package/dist/generated/api/models/AttributeDto.d.ts +19 -2
  56. package/dist/generated/api/models/AttributeDto.d.ts.map +1 -1
  57. package/dist/generated/api/models/AttributeDto.js +4 -2
  58. package/dist/generated/api/models/AttributeDto.js.map +1 -1
  59. package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +2 -2
  60. package/dist/generated/api/models/AttributeDtoCodeListBinding.js +2 -2
  61. package/dist/generated/api/models/AttributeListResponse.d.ts +2 -2
  62. package/dist/generated/api/models/AttributeListResponse.js +2 -2
  63. package/dist/generated/api/models/BatchGenerationItem.d.ts +2 -2
  64. package/dist/generated/api/models/BatchGenerationItem.js +2 -2
  65. package/dist/generated/api/models/BlockStylePreset.d.ts +2 -2
  66. package/dist/generated/api/models/BlockStylePreset.js +2 -2
  67. package/dist/generated/api/models/CatalogDto.d.ts +17 -2
  68. package/dist/generated/api/models/CatalogDto.d.ts.map +1 -1
  69. package/dist/generated/api/models/CatalogDto.js +4 -2
  70. package/dist/generated/api/models/CatalogDto.js.map +1 -1
  71. package/dist/generated/api/models/CatalogInstallResultDto.d.ts +2 -2
  72. package/dist/generated/api/models/CatalogInstallResultDto.js +2 -2
  73. package/dist/generated/api/models/CatalogListResponse.d.ts +2 -2
  74. package/dist/generated/api/models/CatalogListResponse.js +2 -2
  75. package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +2 -2
  76. package/dist/generated/api/models/CatalogUpgradeDiff.js +2 -2
  77. package/dist/generated/api/models/CodeListDto.d.ts +2 -2
  78. package/dist/generated/api/models/CodeListDto.js +2 -2
  79. package/dist/generated/api/models/CodeListEntriesResponse.d.ts +2 -2
  80. package/dist/generated/api/models/CodeListEntriesResponse.js +2 -2
  81. package/dist/generated/api/models/CodeListEntryDto.d.ts +2 -2
  82. package/dist/generated/api/models/CodeListEntryDto.js +2 -2
  83. package/dist/generated/api/models/CodeListListResponse.d.ts +2 -2
  84. package/dist/generated/api/models/CodeListListResponse.js +2 -2
  85. package/dist/generated/api/models/CollectMeta.d.ts +2 -2
  86. package/dist/generated/api/models/CollectMeta.js +2 -2
  87. package/dist/generated/api/models/CollectRequest.d.ts +2 -2
  88. package/dist/generated/api/models/CollectRequest.js +2 -2
  89. package/dist/generated/api/models/ConsumerDto.d.ts +12 -9
  90. package/dist/generated/api/models/ConsumerDto.d.ts.map +1 -1
  91. package/dist/generated/api/models/ConsumerDto.js +2 -2
  92. package/dist/generated/api/models/ConsumerDto.js.map +1 -1
  93. package/dist/generated/api/models/ConsumerListResponse.d.ts +2 -2
  94. package/dist/generated/api/models/ConsumerListResponse.js +2 -2
  95. package/dist/generated/api/models/ConsumerNodeDto.d.ts +2 -2
  96. package/dist/generated/api/models/ConsumerNodeDto.js +2 -2
  97. package/dist/generated/api/models/ConsumerPermissions.d.ts +2 -2
  98. package/dist/generated/api/models/ConsumerPermissions.js +2 -2
  99. package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +2 -2
  100. package/dist/generated/api/models/ContractBreakingChangeDto.js +2 -2
  101. package/dist/generated/api/models/ContractVersionListResponse.d.ts +2 -2
  102. package/dist/generated/api/models/ContractVersionListResponse.js +2 -2
  103. package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +2 -2
  104. package/dist/generated/api/models/ContractVersionSummaryDto.js +2 -2
  105. package/dist/generated/api/models/CreateAttributeRequest.d.ts +2 -2
  106. package/dist/generated/api/models/CreateAttributeRequest.js +2 -2
  107. package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +2 -2
  108. package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +2 -2
  109. package/dist/generated/api/models/CreateCodeListRequest.d.ts +2 -2
  110. package/dist/generated/api/models/CreateCodeListRequest.js +2 -2
  111. package/dist/generated/api/models/CreateContractDraftResponse.d.ts +2 -2
  112. package/dist/generated/api/models/CreateContractDraftResponse.js +2 -2
  113. package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +2 -2
  114. package/dist/generated/api/models/CreateEnvironmentRequest.js +2 -2
  115. package/dist/generated/api/models/CreateStencilRequest.d.ts +2 -2
  116. package/dist/generated/api/models/CreateStencilRequest.js +2 -2
  117. package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +2 -2
  118. package/dist/generated/api/models/CreateStencilVersionRequest.js +2 -2
  119. package/dist/generated/api/models/CreateTemplateRequest.d.ts +2 -2
  120. package/dist/generated/api/models/CreateTemplateRequest.js +2 -2
  121. package/dist/generated/api/models/CreateTenantRequest.d.ts +2 -2
  122. package/dist/generated/api/models/CreateTenantRequest.js +2 -2
  123. package/dist/generated/api/models/CreateThemeRequest.d.ts +2 -2
  124. package/dist/generated/api/models/CreateThemeRequest.js +2 -2
  125. package/dist/generated/api/models/CreateVariantRequest.d.ts +2 -2
  126. package/dist/generated/api/models/CreateVariantRequest.js +2 -2
  127. package/dist/generated/api/models/DataExampleDto.d.ts +2 -2
  128. package/dist/generated/api/models/DataExampleDto.js +2 -2
  129. package/dist/generated/api/models/DataModelValidationError.d.ts +2 -2
  130. package/dist/generated/api/models/DataModelValidationError.js +2 -2
  131. package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +2 -2
  132. package/dist/generated/api/models/DataModelValidationProblemDetail.js +2 -2
  133. package/dist/generated/api/models/DocumentDto.d.ts +2 -2
  134. package/dist/generated/api/models/DocumentDto.js +2 -2
  135. package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +2 -2
  136. package/dist/generated/api/models/DocumentGenerationItemDto.js +2 -2
  137. package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +2 -2
  138. package/dist/generated/api/models/DocumentGenerationJobDto.js +2 -2
  139. package/dist/generated/api/models/DocumentListResponse.d.ts +2 -2
  140. package/dist/generated/api/models/DocumentListResponse.js +2 -2
  141. package/dist/generated/api/models/DroppedStencilFillDto.d.ts +2 -2
  142. package/dist/generated/api/models/DroppedStencilFillDto.js +2 -2
  143. package/dist/generated/api/models/EnvironmentDto.d.ts +17 -2
  144. package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -1
  145. package/dist/generated/api/models/EnvironmentDto.js +4 -2
  146. package/dist/generated/api/models/EnvironmentDto.js.map +1 -1
  147. package/dist/generated/api/models/EnvironmentListResponse.d.ts +2 -2
  148. package/dist/generated/api/models/EnvironmentListResponse.js +2 -2
  149. package/dist/generated/api/models/FontDto.d.ts +2 -2
  150. package/dist/generated/api/models/FontDto.js +2 -2
  151. package/dist/generated/api/models/FontListResponse.d.ts +2 -2
  152. package/dist/generated/api/models/FontListResponse.js +2 -2
  153. package/dist/generated/api/models/FontVariantDto.d.ts +2 -2
  154. package/dist/generated/api/models/FontVariantDto.js +2 -2
  155. package/dist/generated/api/models/GenerateBatchRequest.d.ts +2 -2
  156. package/dist/generated/api/models/GenerateBatchRequest.js +2 -2
  157. package/dist/generated/api/models/GenerateDocumentRequest.d.ts +2 -2
  158. package/dist/generated/api/models/GenerateDocumentRequest.js +2 -2
  159. package/dist/generated/api/models/GenerationJobDetail.d.ts +2 -2
  160. package/dist/generated/api/models/GenerationJobDetail.js +2 -2
  161. package/dist/generated/api/models/GenerationJobListResponse.d.ts +2 -2
  162. package/dist/generated/api/models/GenerationJobListResponse.js +2 -2
  163. package/dist/generated/api/models/GenerationJobResponse.d.ts +2 -2
  164. package/dist/generated/api/models/GenerationJobResponse.js +2 -2
  165. package/dist/generated/api/models/GenerationResult.d.ts +2 -2
  166. package/dist/generated/api/models/GenerationResult.js +2 -2
  167. package/dist/generated/api/models/ImageDto.d.ts +115 -0
  168. package/dist/generated/api/models/ImageDto.d.ts.map +1 -0
  169. package/dist/generated/api/models/ImageDto.js +88 -0
  170. package/dist/generated/api/models/ImageDto.js.map +1 -0
  171. package/dist/generated/api/models/ImageListResponse.d.ts +41 -0
  172. package/dist/generated/api/models/{AssetListResponse.d.ts.map → ImageListResponse.d.ts.map} +1 -1
  173. package/dist/generated/api/models/ImageListResponse.js +51 -0
  174. package/dist/generated/api/models/{AssetListResponse.js.map → ImageListResponse.js.map} +1 -1
  175. package/dist/generated/api/models/ImportCatalogResponse.d.ts +2 -2
  176. package/dist/generated/api/models/ImportCatalogResponse.js +2 -2
  177. package/dist/generated/api/models/ImportTemplateResultDto.d.ts +2 -2
  178. package/dist/generated/api/models/ImportTemplateResultDto.js +2 -2
  179. package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +2 -2
  180. package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +2 -2
  181. package/dist/generated/api/models/Margins.d.ts +2 -2
  182. package/dist/generated/api/models/Margins.js +2 -2
  183. package/dist/generated/api/models/Node.d.ts +2 -2
  184. package/dist/generated/api/models/Node.js +2 -2
  185. package/dist/generated/api/models/Orientation.d.ts +2 -2
  186. package/dist/generated/api/models/Orientation.js +2 -2
  187. package/dist/generated/api/models/PageFormat.d.ts +2 -2
  188. package/dist/generated/api/models/PageFormat.js +2 -2
  189. package/dist/generated/api/models/PageMeta.d.ts +2 -2
  190. package/dist/generated/api/models/PageMeta.js +2 -2
  191. package/dist/generated/api/models/PageSettings.d.ts +2 -2
  192. package/dist/generated/api/models/PageSettings.js +2 -2
  193. package/dist/generated/api/models/PartitionAssignment.d.ts +2 -2
  194. package/dist/generated/api/models/PartitionAssignment.js +2 -2
  195. package/dist/generated/api/models/PingRequest.d.ts +2 -2
  196. package/dist/generated/api/models/PingRequest.js +2 -2
  197. package/dist/generated/api/models/PongDetailsDto.d.ts +2 -2
  198. package/dist/generated/api/models/PongDetailsDto.js +2 -2
  199. package/dist/generated/api/models/PongResponse.d.ts +2 -2
  200. package/dist/generated/api/models/PongResponse.js +2 -2
  201. package/dist/generated/api/models/PreviewDocumentRequest.d.ts +2 -2
  202. package/dist/generated/api/models/PreviewDocumentRequest.js +2 -2
  203. package/dist/generated/api/models/ProblemDetail.d.ts +2 -2
  204. package/dist/generated/api/models/ProblemDetail.js +2 -2
  205. package/dist/generated/api/models/PublishContractRequest.d.ts +2 -2
  206. package/dist/generated/api/models/PublishContractRequest.js +2 -2
  207. package/dist/generated/api/models/PublishContractResponse.d.ts +2 -2
  208. package/dist/generated/api/models/PublishContractResponse.js +2 -2
  209. package/dist/generated/api/models/PublishVersionRequest.d.ts +2 -2
  210. package/dist/generated/api/models/PublishVersionRequest.js +2 -2
  211. package/dist/generated/api/models/RegisterConsumerRequest.d.ts +2 -2
  212. package/dist/generated/api/models/RegisterConsumerRequest.js +2 -2
  213. package/dist/generated/api/models/RejectConsumerRequest.d.ts +2 -2
  214. package/dist/generated/api/models/RejectConsumerRequest.js +2 -2
  215. package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +2 -2
  216. package/dist/generated/api/models/ReleaseCatalogRequest.js +2 -2
  217. package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +2 -2
  218. package/dist/generated/api/models/ReleaseCatalogResponse.js +2 -2
  219. package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +2 -2
  220. package/dist/generated/api/models/RemovedCatalogResourceDto.js +2 -2
  221. package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +2 -2
  222. package/dist/generated/api/models/RotatePublicKeyRequest.js +2 -2
  223. package/dist/generated/api/models/Slot.d.ts +2 -2
  224. package/dist/generated/api/models/Slot.js +2 -2
  225. package/dist/generated/api/models/StencilDto.d.ts +17 -2
  226. package/dist/generated/api/models/StencilDto.d.ts.map +1 -1
  227. package/dist/generated/api/models/StencilDto.js +4 -2
  228. package/dist/generated/api/models/StencilDto.js.map +1 -1
  229. package/dist/generated/api/models/StencilListResponse.d.ts +2 -2
  230. package/dist/generated/api/models/StencilListResponse.js +2 -2
  231. package/dist/generated/api/models/StencilSummaryDto.d.ts +17 -2
  232. package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -1
  233. package/dist/generated/api/models/StencilSummaryDto.js +4 -2
  234. package/dist/generated/api/models/StencilSummaryDto.js.map +1 -1
  235. package/dist/generated/api/models/StencilUsageDto.d.ts +2 -2
  236. package/dist/generated/api/models/StencilUsageDto.js +2 -2
  237. package/dist/generated/api/models/StencilUsageListResponse.d.ts +2 -2
  238. package/dist/generated/api/models/StencilUsageListResponse.js +2 -2
  239. package/dist/generated/api/models/StencilVersionDto.d.ts +2 -2
  240. package/dist/generated/api/models/StencilVersionDto.js +2 -2
  241. package/dist/generated/api/models/StencilVersionListResponse.d.ts +2 -2
  242. package/dist/generated/api/models/StencilVersionListResponse.js +2 -2
  243. package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +2 -2
  244. package/dist/generated/api/models/StencilVersionSummaryDto.js +2 -2
  245. package/dist/generated/api/models/TemplateDataValidationError.d.ts +2 -2
  246. package/dist/generated/api/models/TemplateDataValidationError.js +2 -2
  247. package/dist/generated/api/models/TemplateDataValidationResult.d.ts +2 -2
  248. package/dist/generated/api/models/TemplateDataValidationResult.js +2 -2
  249. package/dist/generated/api/models/TemplateDocument.d.ts +2 -2
  250. package/dist/generated/api/models/TemplateDocument.js +2 -2
  251. package/dist/generated/api/models/TemplateDto.d.ts +17 -2
  252. package/dist/generated/api/models/TemplateDto.d.ts.map +1 -1
  253. package/dist/generated/api/models/TemplateDto.js +4 -2
  254. package/dist/generated/api/models/TemplateDto.js.map +1 -1
  255. package/dist/generated/api/models/TemplateListResponse.d.ts +2 -2
  256. package/dist/generated/api/models/TemplateListResponse.js +2 -2
  257. package/dist/generated/api/models/TemplateSummaryDto.d.ts +17 -2
  258. package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -1
  259. package/dist/generated/api/models/TemplateSummaryDto.js +4 -2
  260. package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -1
  261. package/dist/generated/api/models/TenantDto.d.ts +17 -2
  262. package/dist/generated/api/models/TenantDto.d.ts.map +1 -1
  263. package/dist/generated/api/models/TenantDto.js +4 -2
  264. package/dist/generated/api/models/TenantDto.js.map +1 -1
  265. package/dist/generated/api/models/TenantListResponse.d.ts +2 -2
  266. package/dist/generated/api/models/TenantListResponse.js +2 -2
  267. package/dist/generated/api/models/ThemeDto.d.ts +17 -2
  268. package/dist/generated/api/models/ThemeDto.d.ts.map +1 -1
  269. package/dist/generated/api/models/ThemeDto.js +4 -2
  270. package/dist/generated/api/models/ThemeDto.js.map +1 -1
  271. package/dist/generated/api/models/ThemeListResponse.d.ts +2 -2
  272. package/dist/generated/api/models/ThemeListResponse.js +2 -2
  273. package/dist/generated/api/models/ThemeRef.d.ts +2 -2
  274. package/dist/generated/api/models/ThemeRef.js +2 -2
  275. package/dist/generated/api/models/UpdateAttributeRequest.d.ts +2 -2
  276. package/dist/generated/api/models/UpdateAttributeRequest.js +2 -2
  277. package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +2 -2
  278. package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +2 -2
  279. package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +2 -2
  280. package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +2 -2
  281. package/dist/generated/api/models/UpdateCodeListRequest.d.ts +2 -2
  282. package/dist/generated/api/models/UpdateCodeListRequest.js +2 -2
  283. package/dist/generated/api/models/UpdateConsumerRequest.d.ts +2 -2
  284. package/dist/generated/api/models/UpdateConsumerRequest.js +2 -2
  285. package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +2 -2
  286. package/dist/generated/api/models/UpdateContractDraftRequest.js +2 -2
  287. package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +2 -2
  288. package/dist/generated/api/models/UpdateContractDraftResponse.js +2 -2
  289. package/dist/generated/api/models/UpdateDraftRequest.d.ts +2 -2
  290. package/dist/generated/api/models/UpdateDraftRequest.js +2 -2
  291. package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +2 -2
  292. package/dist/generated/api/models/UpdateEnvironmentRequest.js +2 -2
  293. package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +2 -2
  294. package/dist/generated/api/models/UpdateStencilDraftRequest.js +2 -2
  295. package/dist/generated/api/models/UpdateStencilRequest.d.ts +2 -2
  296. package/dist/generated/api/models/UpdateStencilRequest.js +2 -2
  297. package/dist/generated/api/models/UpdateTemplateRequest.d.ts +2 -2
  298. package/dist/generated/api/models/UpdateTemplateRequest.js +2 -2
  299. package/dist/generated/api/models/UpdateTenantRequest.d.ts +2 -2
  300. package/dist/generated/api/models/UpdateTenantRequest.js +2 -2
  301. package/dist/generated/api/models/UpdateThemeRequest.d.ts +2 -2
  302. package/dist/generated/api/models/UpdateThemeRequest.js +2 -2
  303. package/dist/generated/api/models/UpdateVariantRequest.d.ts +2 -2
  304. package/dist/generated/api/models/UpdateVariantRequest.js +2 -2
  305. package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +15 -3
  306. package/dist/generated/api/models/UpgradeCatalogRequest.d.ts.map +1 -1
  307. package/dist/generated/api/models/UpgradeCatalogRequest.js +2 -2
  308. package/dist/generated/api/models/UpgradeCatalogRequest.js.map +1 -1
  309. package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +2 -2
  310. package/dist/generated/api/models/UpgradeCatalogResponse.js +2 -2
  311. package/dist/generated/api/models/UpgradePreviewDto.d.ts +2 -2
  312. package/dist/generated/api/models/UpgradePreviewDto.js +2 -2
  313. package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +2 -2
  314. package/dist/generated/api/models/UpgradePreviewListResponse.js +2 -2
  315. package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +2 -2
  316. package/dist/generated/api/models/ValidateTemplateDataRequest.js +2 -2
  317. package/dist/generated/api/models/ValidationError.d.ts +2 -2
  318. package/dist/generated/api/models/ValidationError.js +2 -2
  319. package/dist/generated/api/models/ValidationProblemDetail.d.ts +2 -2
  320. package/dist/generated/api/models/ValidationProblemDetail.js +2 -2
  321. package/dist/generated/api/models/VariantDto.d.ts +17 -2
  322. package/dist/generated/api/models/VariantDto.d.ts.map +1 -1
  323. package/dist/generated/api/models/VariantDto.js +4 -2
  324. package/dist/generated/api/models/VariantDto.js.map +1 -1
  325. package/dist/generated/api/models/VariantListResponse.d.ts +2 -2
  326. package/dist/generated/api/models/VariantListResponse.js +2 -2
  327. package/dist/generated/api/models/VariantSelectionAttribute.d.ts +2 -2
  328. package/dist/generated/api/models/VariantSelectionAttribute.js +2 -2
  329. package/dist/generated/api/models/VariantSummaryDto.d.ts +17 -2
  330. package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -1
  331. package/dist/generated/api/models/VariantSummaryDto.js +4 -2
  332. package/dist/generated/api/models/VariantSummaryDto.js.map +1 -1
  333. package/dist/generated/api/models/VersionDto.d.ts +2 -2
  334. package/dist/generated/api/models/VersionDto.js +2 -2
  335. package/dist/generated/api/models/VersionListResponse.d.ts +2 -2
  336. package/dist/generated/api/models/VersionListResponse.js +2 -2
  337. package/dist/generated/api/models/VersionSummaryDto.d.ts +2 -2
  338. package/dist/generated/api/models/VersionSummaryDto.js +2 -2
  339. package/dist/generated/api/models/index.d.ts +2 -2
  340. package/dist/generated/api/models/index.d.ts.map +1 -1
  341. package/dist/generated/api/models/index.js +2 -2
  342. package/dist/generated/api/models/index.js.map +1 -1
  343. package/dist/generated/api/runtime.d.ts +2 -2
  344. package/dist/generated/api/runtime.js +2 -2
  345. package/dist/generated/contractOperations.js +4 -4
  346. package/dist/generated/contractOperations.js.map +1 -1
  347. package/dist/generated/contractVersion.d.ts +1 -1
  348. package/dist/generated/contractVersion.d.ts.map +1 -1
  349. package/dist/generated/contractVersion.js +1 -1
  350. package/dist/generated/contractVersion.js.map +1 -1
  351. package/dist/generated/modelValidation.d.ts +4 -4
  352. package/dist/generated/modelValidation.d.ts.map +1 -1
  353. package/dist/generated/modelValidation.js +24 -13
  354. package/dist/generated/modelValidation.js.map +1 -1
  355. package/dist/index.d.ts +1 -0
  356. package/dist/index.d.ts.map +1 -1
  357. package/dist/index.js +1 -0
  358. package/dist/index.js.map +1 -1
  359. package/dist/validation/ajvLoader.d.ts +52 -0
  360. package/dist/validation/ajvLoader.d.ts.map +1 -0
  361. package/dist/validation/ajvLoader.js +60 -0
  362. package/dist/validation/ajvLoader.js.map +1 -0
  363. package/dist/validation/templateSchemaValidator.d.ts +3 -0
  364. package/dist/validation/templateSchemaValidator.d.ts.map +1 -1
  365. package/dist/validation/templateSchemaValidator.js +10 -17
  366. package/dist/validation/templateSchemaValidator.js.map +1 -1
  367. package/package.json +21 -10
  368. package/dist/generated/api/apis/AssetsApi.d.ts +0 -95
  369. package/dist/generated/api/apis/AssetsApi.d.ts.map +0 -1
  370. package/dist/generated/api/apis/AssetsApi.js.map +0 -1
  371. package/dist/generated/api/models/AssetDto.d.ts +0 -116
  372. package/dist/generated/api/models/AssetDto.d.ts.map +0 -1
  373. package/dist/generated/api/models/AssetDto.js +0 -100
  374. package/dist/generated/api/models/AssetDto.js.map +0 -1
  375. package/dist/generated/api/models/AssetListResponse.d.ts +0 -41
  376. package/dist/generated/api/models/AssetListResponse.js +0 -51
package/CHANGELOG.md CHANGED
@@ -9,6 +9,11 @@ records contract/spec changes. This file records changes specific to the Node.js
9
9
 
10
10
  ## [Unreleased]
11
11
 
12
+ ### Changed
13
+
14
+ - `JwtSigner` is documented as **experimental**: Epistola Suite may not implement self-signed JWT
15
+ authentication yet. The README's quick start now authenticates with an API key.
16
+
12
17
  ### Added
13
18
 
14
19
  - **Initial release** — a Node.js client for the Epistola API, generated from the OpenAPI contract
@@ -33,8 +38,11 @@ records contract/spec changes. This file records changes specific to the Node.js
33
38
  adaptive polling floored at the minimum interval, sequence-based acknowledgement that leaves a
34
39
  batch unacknowledged when the handler throws, and murmur3 partition-routing helpers.
35
40
  - Client-side JSON Schema validation of template data (`TemplateSchemaValidator`,
36
- `ValidatingGenerationApi`, on Ajv) and generated `validateModel` / `validate<Model>` helpers
37
- covering every model that carries schema constraints.
41
+ `ValidatingGenerationApi`) and generated `validateModel` / `validate<Model>` helpers covering
42
+ every model that carries schema constraints. The schema validator runs on Ajv, which is an
43
+ optional peer dependency loaded on first use, so the package itself has no runtime
44
+ dependencies; without `ajv` and `ajv-formats` installed, the first validation rejects with an
45
+ error naming them.
38
46
  - `CONTRACT_OPERATIONS` — the method, path template and declared response media types of every
39
47
  operation, generated from the spec. The generated API classes set `Content-Type` but never
40
48
  `Accept`, and Node's `fetch` sends `*/*` by default, so the client asks for exactly what each
package/README.md CHANGED
@@ -11,9 +11,9 @@ It adds, on top of the stock generated client:
11
11
  - **Client identity** headers (`User-Agent` + `X-EP-Node-Id`) required on every request.
12
12
  - **RFC 9457 problem-detail** error handling — a typed `ProblemDetailException` with a `typeSlug`
13
13
  discriminator and generated `KnownProblemSlugs` constants.
14
- - **Self-signed JWT** authentication (`JwtSigner`), minting a fresh short-lived token per request on
15
- `node:crypto` alone.
16
- - **Static API-key** authentication via `Authorization: ApiKey <key>`.
14
+ - **Static API-key** authentication via `Authorization: ApiKey <key>`, the supported method.
15
+ - **Self-signed JWT** authentication (`JwtSigner`, **experimental**), minting a fresh short-lived
16
+ token per request on `node:crypto` alone.
17
17
  - **The `Accept` header each operation is declared with.** The generated classes never set one, and
18
18
  Node's `fetch` sends `*/*` by default — so without this a request never says it accepts
19
19
  `application/problem+json`, the document every error handler here is built to parse.
@@ -26,6 +26,11 @@ The package version tracks the Epistola contract version (`info.version`) and re
26
26
  with the Kotlin, Jakarta EE, .NET and Python clients. It needs Node.js 22.12 or later and ships as
27
27
  an ES module (which Node's `require()` can load as well).
28
28
 
29
+ It has **no runtime dependencies**: HTTP is the platform's `fetch`, JWT signing is `node:crypto`,
30
+ decompression is `node:zlib`. The one optional feature that needs a library is client-side template
31
+ validation, which loads `ajv` and `ajv-formats` on first use; they are optional peer dependencies,
32
+ so install them only if you use it (see [Client-side validation](#client-side-validation)).
33
+
29
34
  Release history: [CHANGELOG.md](CHANGELOG.md).
30
35
 
31
36
  ## Install
@@ -37,32 +42,38 @@ npm install @epistola.app/epistola-client
37
42
  ## Quick start
38
43
 
39
44
  ```ts
40
- import { ClientIdentity, EpistolaClient, JwtSigner, TemplatesApi } from '@epistola.app/epistola-client'
45
+ import { ClientIdentity, EpistolaClient, TemplatesApi } from '@epistola.app/epistola-client'
41
46
 
42
47
  const identity = ClientIdentity.builder()
43
48
  .nodeId('my-pod-123') // defaults to the hostname
44
49
  .product('my-app', '1.0.0') // appended to User-Agent
45
50
  .build()
46
51
 
47
- const signer = JwtSigner.builder()
48
- .consumerId('invoice-service')
49
- .privateKey(JwtSigner.loadPrivateKey('private.pem'))
50
- .build()
51
-
52
52
  const client = EpistolaClient.builder('https://epistola.example.com/api')
53
53
  .identity(identity) // User-Agent + X-EP-Node-Id
54
- .jwtSigner(signer) // Authorization: Bearer <jwt>, fresh per request
54
+ .apiKey('epk_...') // Authorization: ApiKey <key>
55
55
  .build()
56
56
 
57
57
  const templates = new TemplatesApi(client)
58
58
  const template = await templates.getTemplate({ tenantId: 'acme', catalogId: 'invoices', templateId: 'invoice' })
59
59
  ```
60
60
 
61
- For static tenant API keys, use `.apiKey('epk_...')` instead of `.jwtSigner(...)`, or the shorthand
62
- `EpistolaClient.builder(baseUrl, apiKey)`. The legacy `X-API-Key` header is not sent: it remains
63
- supported server-side but is deprecated. Some Epistola Suite deployments disable API-key
64
- authentication entirely; switch on `e.typeSlug === KnownProblemSlugs.API_KEY_AUTH_DISABLED` and
65
- guide the caller to JWT auth.
61
+ `EpistolaClient.builder(baseUrl, apiKey)` is a shorthand for the same thing. The legacy `X-API-Key`
62
+ header is not sent: it remains supported server-side but is deprecated. Some Epistola Suite
63
+ deployments disable API-key authentication entirely; switch on
64
+ `e.typeSlug === KnownProblemSlugs.API_KEY_AUTH_DISABLED` and guide the caller to JWT auth.
65
+
66
+ Self-signed JWT authentication is **experimental**: Epistola Suite may not implement it yet, and the
67
+ flow may still change. To try it, pass `.jwtSigner(signer)` instead of `.apiKey(...)`:
68
+
69
+ ```ts
70
+ import { JwtSigner } from '@epistola.app/epistola-client'
71
+
72
+ const signer = JwtSigner.builder()
73
+ .consumerId('invoice-service')
74
+ .privateKey(JwtSigner.loadPrivateKey('private.pem'))
75
+ .build()
76
+ ```
66
77
 
67
78
  `EpistolaClient` *is* a generated `Configuration`, so every generated API class takes it directly.
68
79
  One builder can produce more than one client: call `build()` again after changing
@@ -81,7 +92,22 @@ touches nothing else; `{ name: 'Billing', description: null }` also clears the d
81
92
  ### Binary downloads
82
93
 
83
94
  Every operation the contract declares as `format: binary` — `downloadDocument`, `previewDocument`,
84
- asset content — resolves to a `Blob`; `Buffer.from(await blob.arrayBuffer())` gives you the bytes.
95
+ `downloadImageContent` — resolves to a `Blob`; `Buffer.from(await blob.arrayBuffer())` gives you the bytes.
96
+
97
+ ### Uploading files
98
+
99
+ Multipart operations such as `uploadImage` and `importCatalog` take a `Blob`. Pass a `File`, which
100
+ carries a name and a type:
101
+
102
+ ```ts
103
+ import { readFile } from 'node:fs/promises'
104
+
105
+ const file = new File([await readFile('logo.png')], 'logo.png', { type: 'image/png' })
106
+ const image = await new ImagesApi(client).uploadImage({ tenantId: 'acme-corp', catalogId: 'main', file, name: 'Logo' })
107
+ ```
108
+
109
+ A plain `Blob` is always sent with the filename `blob`, and as `application/octet-stream` unless it
110
+ was given a type. The server then names the image `blob`.
85
111
 
86
112
  ## Error handling
87
113
 
@@ -146,6 +172,16 @@ whose result comes back to this node.
146
172
 
147
173
  ## Client-side validation
148
174
 
175
+ Validating template data against the template's JSON Schema needs Ajv, which is an optional peer
176
+ dependency so that consumers who never validate do not carry a schema compiler:
177
+
178
+ ```bash
179
+ npm install ajv ajv-formats
180
+ ```
181
+
182
+ Without them, the first `validate` call rejects with an error saying exactly that. The generated
183
+ `validate<Model>` helpers for the contract's own constraints need nothing extra.
184
+
149
185
  ```ts
150
186
  import { TemplateSchemaValidator, ValidatingGenerationApi, validateCreateTenantRequest } from '@epistola.app/epistola-client'
151
187
 
@@ -4,6 +4,9 @@ export type JwtAlgorithm = 'RS256' | 'ES256';
4
4
  /**
5
5
  * Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
6
6
  *
7
+ * **Experimental.** Epistola Suite may not implement self-signed JWT authentication yet, and the
8
+ * flow may still change. Use API-key authentication (`apiKey`) for production integrations.
9
+ *
7
10
  * Each token carries:
8
11
  * - `iss` — the consumer ID
9
12
  * - `iat` — issued-at
@@ -1 +1 @@
1
- {"version":3,"file":"jwtSigner.d.ts","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAA;AAGhF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAA;AAI5C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,YAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IALvC,OAAO,eAMH;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO,IAAI,gBAAgB,CAEjC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAE7C;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMzD;IAED,sEAAsE;IACtE,WAAW,IAAI,MAAM,CAWpB;IAED,OAAO,CAAC,IAAI;IAOZ,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAElG;CACF;AAED,4CAA4C;AAC5C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,yBAAyB,CAAiC;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAMnC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAGtC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAM1C;IAED,8CAA8C;IAC9C,KAAK,IAAI,SAAS,CAQjB;CACF"}
1
+ {"version":3,"file":"jwtSigner.d.ts","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAA;AAGhF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAA;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,YAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IALvC,OAAO,eAMH;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO,IAAI,gBAAgB,CAEjC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAE7C;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMzD;IAED,sEAAsE;IACtE,WAAW,IAAI,MAAM,CAWpB;IAED,OAAO,CAAC,IAAI;IAOZ,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAElG;CACF;AAED,4CAA4C;AAC5C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,yBAAyB,CAAiC;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAMnC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAGtC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAM1C;IAED,8CAA8C;IAC9C,KAAK,IAAI,SAAS,CAQjB;CACF"}
@@ -7,6 +7,9 @@ const DEFAULT_TOKEN_LIFETIME_SECONDS = 60;
7
7
  /**
8
8
  * Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
9
9
  *
10
+ * **Experimental.** Epistola Suite may not implement self-signed JWT authentication yet, and the
11
+ * flow may still change. Use API-key authentication (`apiKey`) for production integrations.
12
+ *
10
13
  * Each token carries:
11
14
  * - `iss` — the consumer ID
12
15
  * - `iat` — issued-at
@@ -1 +1 @@
1
- {"version":3,"file":"jwtSigner.js","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAKtC,MAAM,8BAA8B,GAAG,EAAE,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,SAAS;IAED,UAAU;IACV,UAAU;IAElB,SAAS;IACD,oBAAoB;IALvC,YACmB,UAAkB,EAClB,UAAqB;IACtC,oEAAoE;IAC3D,SAAuB,EACf,oBAA4B;0BAJ5B,UAAU;0BACV,UAAU;yBAElB,SAAS;oCACD,oBAAoB;IACpC,CAAC;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAY;QAChC,OAAO,SAAS,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAoB;QAC5C,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,SAAS,CAAC,uFAAuF,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;QAClD,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,UAAU;YACpB,GAAG,EAAE,UAAU;YACf,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC,oBAAoB;YAC3C,GAAG,EAAE,UAAU,EAAE;SAClB,CAAA;QACD,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;QAChG,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAA;IAC3E,CAAC;IAEO,IAAI,CAAC,YAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO;YAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAC3C,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAkB,EAAE,UAAqB,EAAE,oBAA4B;QACrF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC,CAAA;IACjG,CAAC;CACF;AAED,4CAA4C;AAC5C,MAAM,OAAO,gBAAgB;IACnB,eAAe,CAAoB;IACnC,eAAe,CAAuB;IACtC,yBAAyB,GAAG,8BAA8B,CAAA;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAkB;QAC3B,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAqB;QAC9B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAe;QAClC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,8CAA8C;IAC9C,KAAK;QACH,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACvG,CAAC;CACF;AAED,SAAS,eAAe,CAAC,GAAc;IACrC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,oCAAoC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAA;IACzE,CAAC;IACD,QAAQ,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC9B,KAAK,KAAK;YACR,OAAO,OAAO,CAAA;QAChB,KAAK,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,GAAG,GAAG,CAAC,oBAAoB,EAAE,UAAU,CAAA;YAClD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,MAAM,IAAI,SAAS,CAAC,yBAAyB,KAAK,IAAI,SAAS,iCAAiC,CAAC,CAAA;YACnG,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD;YACE,MAAM,IAAI,SAAS,CAAC,yBAAyB,GAAG,CAAC,iBAAiB,IAAI,SAAS,sCAAsC,CAAC,CAAA;IAC1H,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACzD,CAAC"}
1
+ {"version":3,"file":"jwtSigner.js","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAKtC,MAAM,8BAA8B,GAAG,EAAE,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,SAAS;IAED,UAAU;IACV,UAAU;IAElB,SAAS;IACD,oBAAoB;IALvC,YACmB,UAAkB,EAClB,UAAqB;IACtC,oEAAoE;IAC3D,SAAuB,EACf,oBAA4B;0BAJ5B,UAAU;0BACV,UAAU;yBAElB,SAAS;oCACD,oBAAoB;IACpC,CAAC;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAY;QAChC,OAAO,SAAS,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAoB;QAC5C,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,SAAS,CAAC,uFAAuF,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;QAClD,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,UAAU;YACpB,GAAG,EAAE,UAAU;YACf,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC,oBAAoB;YAC3C,GAAG,EAAE,UAAU,EAAE;SAClB,CAAA;QACD,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;QAChG,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAA;IAC3E,CAAC;IAEO,IAAI,CAAC,YAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO;YAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAC3C,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAkB,EAAE,UAAqB,EAAE,oBAA4B;QACrF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC,CAAA;IACjG,CAAC;CACF;AAED,4CAA4C;AAC5C,MAAM,OAAO,gBAAgB;IACnB,eAAe,CAAoB;IACnC,eAAe,CAAuB;IACtC,yBAAyB,GAAG,8BAA8B,CAAA;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAkB;QAC3B,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAqB;QAC9B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAe;QAClC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,8CAA8C;IAC9C,KAAK;QACH,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACvG,CAAC;CACF;AAED,SAAS,eAAe,CAAC,GAAc;IACrC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,oCAAoC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAA;IACzE,CAAC;IACD,QAAQ,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC9B,KAAK,KAAK;YACR,OAAO,OAAO,CAAA;QAChB,KAAK,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,GAAG,GAAG,CAAC,oBAAoB,EAAE,UAAU,CAAA;YAClD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,MAAM,IAAI,SAAS,CAAC,yBAAyB,KAAK,IAAI,SAAS,iCAAiC,CAAC,CAAA;YACnG,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD;YACE,MAAM,IAAI,SAAS,CAAC,yBAAyB,GAAG,CAAC,iBAAiB,IAAI,SAAS,sCAAsC,CAAC,CAAA;IAC1H,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACzD,CAAC"}
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Epistola API
3
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
3
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
4
4
  *
5
- * The version of the OpenAPI document: 1.2.1-rc.1
5
+ * The version of the OpenAPI document: 1.3.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
  * Epistola API
5
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
5
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
6
6
  *
7
- * The version of the OpenAPI document: 1.2.1-rc.1
7
+ * The version of the OpenAPI document: 1.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Epistola API
3
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
3
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
4
4
  *
5
- * The version of the OpenAPI document: 1.2.1-rc.1
5
+ * The version of the OpenAPI document: 1.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -83,12 +83,12 @@ export declare class CatalogsApi extends runtime.BaseAPI {
83
83
  */
84
84
  releaseCatalog(requestParameters: ReleaseCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseCatalogResponse>;
85
85
  /**
86
- * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. Existing resources are upgraded in place. New resources are only installed when listed in `includeNewSlugs`.
86
+ * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
87
87
  * Upgrade a subscribed catalog
88
88
  */
89
89
  upgradeCatalogRaw(requestParameters: UpgradeCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpgradeCatalogResponse>>;
90
90
  /**
91
- * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. Existing resources are upgraded in place. New resources are only installed when listed in `includeNewSlugs`.
91
+ * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
92
92
  * Upgrade a subscribed catalog
93
93
  */
94
94
  upgradeCatalog(requestParameters: UpgradeCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeCatalogResponse>;
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Epistola API
5
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
5
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
6
6
  *
7
- * The version of the OpenAPI document: 1.2.1-rc.1
7
+ * The version of the OpenAPI document: 1.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -235,7 +235,7 @@ export class CatalogsApi extends runtime.BaseAPI {
235
235
  return await response.value();
236
236
  }
237
237
  /**
238
- * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. Existing resources are upgraded in place. New resources are only installed when listed in `includeNewSlugs`.
238
+ * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
239
239
  * Upgrade a subscribed catalog
240
240
  */
241
241
  async upgradeCatalogRaw(requestParameters, initOverrides) {
@@ -274,7 +274,7 @@ export class CatalogsApi extends runtime.BaseAPI {
274
274
  return new runtime.JSONApiResponse(response, (jsonValue) => UpgradeCatalogResponseFromJSON(jsonValue));
275
275
  }
276
276
  /**
277
- * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. Existing resources are upgraded in place. New resources are only installed when listed in `includeNewSlugs`.
277
+ * Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
278
278
  * Upgrade a subscribed catalog
279
279
  */
280
280
  async upgradeCatalog(requestParameters, initOverrides) {
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Epistola API
3
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
3
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
4
4
  *
5
- * The version of the OpenAPI document: 1.2.1-rc.1
5
+ * The version of the OpenAPI document: 1.3.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
  * Epistola API
5
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
5
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
6
6
  *
7
- * The version of the OpenAPI document: 1.2.1-rc.1
7
+ * The version of the OpenAPI document: 1.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Epistola API
3
- * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
3
+ * Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
4
4
  *
5
- * The version of the OpenAPI document: 1.2.1-rc.1
5
+ * The version of the OpenAPI document: 1.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -55,82 +55,82 @@ export interface UpdateConsumerOperationRequest {
55
55
  */
56
56
  export declare class ConsumersApi extends runtime.BaseAPI {
57
57
  /**
58
- * Approve a consumer registration within this tenant. Sets the granted permissions and optional expiry. The consumer transitions from `pending` to `active`.
58
+ * **Experimental** — Epistola Suite may not implement this operation yet. Approve a consumer registration within this tenant. Sets the granted permissions and optional expiry. The consumer transitions from `pending` to `active`.
59
59
  * Approve a pending consumer
60
60
  */
61
61
  approveConsumerRaw(requestParameters: ApproveConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
62
62
  /**
63
- * Approve a consumer registration within this tenant. Sets the granted permissions and optional expiry. The consumer transitions from `pending` to `active`.
63
+ * **Experimental** — Epistola Suite may not implement this operation yet. Approve a consumer registration within this tenant. Sets the granted permissions and optional expiry. The consumer transitions from `pending` to `active`.
64
64
  * Approve a pending consumer
65
65
  */
66
66
  approveConsumer(requestParameters: ApproveConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;
67
67
  /**
68
- * Permanently remove a consumer from this tenant. **Effect on generation results:** - Partitions assigned to this consumer\'s nodes are released. - Uncollected generation results remain in the system but are no longer deliverable via the `/generation/collect` endpoint. - Generated documents can still be accessed directly via `GET /tenants/{tenantId}/documents/{documentId}`. - The `createdBy` field on documents retains the consumer ID (orphaned reference).
68
+ * **Experimental** — Epistola Suite may not implement this operation yet. Permanently remove a consumer from this tenant. **Effect on generation results:** - Partitions assigned to this consumer\'s nodes are released. - Uncollected generation results remain in the system but are no longer deliverable via the `/generation/collect` endpoint. - Generated documents can still be accessed directly via `GET /tenants/{tenantId}/documents/{documentId}`. - The `createdBy` field on documents retains the consumer ID (orphaned reference).
69
69
  * Delete a consumer
70
70
  */
71
71
  deleteConsumerRaw(requestParameters: DeleteConsumerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
72
72
  /**
73
- * Permanently remove a consumer from this tenant. **Effect on generation results:** - Partitions assigned to this consumer\'s nodes are released. - Uncollected generation results remain in the system but are no longer deliverable via the `/generation/collect` endpoint. - Generated documents can still be accessed directly via `GET /tenants/{tenantId}/documents/{documentId}`. - The `createdBy` field on documents retains the consumer ID (orphaned reference).
73
+ * **Experimental** — Epistola Suite may not implement this operation yet. Permanently remove a consumer from this tenant. **Effect on generation results:** - Partitions assigned to this consumer\'s nodes are released. - Uncollected generation results remain in the system but are no longer deliverable via the `/generation/collect` endpoint. - Generated documents can still be accessed directly via `GET /tenants/{tenantId}/documents/{documentId}`. - The `createdBy` field on documents retains the consumer ID (orphaned reference).
74
74
  * Delete a consumer
75
75
  */
76
76
  deleteConsumer(requestParameters: DeleteConsumerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
77
77
  /**
78
- * Retrieve details of a specific consumer in this tenant.
78
+ * **Experimental** — Epistola Suite may not implement this operation yet. Retrieve details of a specific consumer in this tenant.
79
79
  * Get consumer by ID
80
80
  */
81
81
  getConsumerRaw(requestParameters: GetConsumerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
82
82
  /**
83
- * Retrieve details of a specific consumer in this tenant.
83
+ * **Experimental** — Epistola Suite may not implement this operation yet. Retrieve details of a specific consumer in this tenant.
84
84
  * Get consumer by ID
85
85
  */
86
86
  getConsumer(requestParameters: GetConsumerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;
87
87
  /**
88
- * Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
88
+ * **Experimental** — Epistola Suite may not implement this operation yet. Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
89
89
  * List consumers in this tenant
90
90
  */
91
91
  listConsumersRaw(requestParameters: ListConsumersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerListResponse>>;
92
92
  /**
93
- * Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
93
+ * **Experimental** — Epistola Suite may not implement this operation yet. Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
94
94
  * List consumers in this tenant
95
95
  */
96
96
  listConsumers(requestParameters: ListConsumersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerListResponse>;
97
97
  /**
98
- * Self-service registration for consumer applications using self-signed JWT authentication. The consumer is created in `pending` status within this tenant until a tenant manager approves the registration. This endpoint requires no authentication — the public key in the request body establishes the consumer\'s identity for future authentication. OAuth consumers do not use this endpoint. They are auto-registered as `pending` on their first authenticated request to this tenant. API-key consumers do not use this endpoint either. They are provisioned out of band by a tenant manager (api-key creation is a manager-side action, not a self-service flow) and materialize directly as `active`.
98
+ * **Experimental** — Epistola Suite may not implement this operation yet. Self-service registration for consumer applications using self-signed JWT authentication. The consumer is created in `pending` status within this tenant until a tenant manager approves the registration. This endpoint requires no authentication — the public key in the request body establishes the consumer\'s identity for future authentication. OAuth consumers do not use this endpoint. They are auto-registered as `pending` on their first authenticated request to this tenant. API-key consumers do not use this endpoint either. They are provisioned out of band by a tenant manager (api-key creation is a manager-side action, not a self-service flow) and materialize directly as `active`.
99
99
  * Register a new consumer in this tenant
100
100
  */
101
101
  registerConsumerRaw(requestParameters: RegisterConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
102
102
  /**
103
- * Self-service registration for consumer applications using self-signed JWT authentication. The consumer is created in `pending` status within this tenant until a tenant manager approves the registration. This endpoint requires no authentication — the public key in the request body establishes the consumer\'s identity for future authentication. OAuth consumers do not use this endpoint. They are auto-registered as `pending` on their first authenticated request to this tenant. API-key consumers do not use this endpoint either. They are provisioned out of band by a tenant manager (api-key creation is a manager-side action, not a self-service flow) and materialize directly as `active`.
103
+ * **Experimental** — Epistola Suite may not implement this operation yet. Self-service registration for consumer applications using self-signed JWT authentication. The consumer is created in `pending` status within this tenant until a tenant manager approves the registration. This endpoint requires no authentication — the public key in the request body establishes the consumer\'s identity for future authentication. OAuth consumers do not use this endpoint. They are auto-registered as `pending` on their first authenticated request to this tenant. API-key consumers do not use this endpoint either. They are provisioned out of band by a tenant manager (api-key creation is a manager-side action, not a self-service flow) and materialize directly as `active`.
104
104
  * Register a new consumer in this tenant
105
105
  */
106
106
  registerConsumer(requestParameters: RegisterConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;
107
107
  /**
108
- * Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
108
+ * **Experimental** — Epistola Suite may not implement this operation yet. Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
109
109
  * Reject a pending consumer
110
110
  */
111
111
  rejectConsumerRaw(requestParameters: RejectConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
112
112
  /**
113
- * Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
113
+ * **Experimental** — Epistola Suite may not implement this operation yet. Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
114
114
  * Reject a pending consumer
115
115
  */
116
116
  rejectConsumer(requestParameters: RejectConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;
117
117
  /**
118
- * Replace the public key for a self-signed JWT consumer. Must authenticate with a valid JWT signed by the current key. After rotation, the old key is immediately invalidated.
118
+ * **Experimental** — Epistola Suite may not implement this operation yet. Replace the public key for a self-signed JWT consumer. Must authenticate with a valid JWT signed by the current key. After rotation, the old key is immediately invalidated.
119
119
  * Rotate public key
120
120
  */
121
121
  rotatePublicKeyRaw(requestParameters: RotatePublicKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
122
122
  /**
123
- * Replace the public key for a self-signed JWT consumer. Must authenticate with a valid JWT signed by the current key. After rotation, the old key is immediately invalidated.
123
+ * **Experimental** — Epistola Suite may not implement this operation yet. Replace the public key for a self-signed JWT consumer. Must authenticate with a valid JWT signed by the current key. After rotation, the old key is immediately invalidated.
124
124
  * Rotate public key
125
125
  */
126
126
  rotatePublicKey(requestParameters: RotatePublicKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;
127
127
  /**
128
- * Update a consumer\'s metadata or permissions within this tenant.
128
+ * **Experimental** — Epistola Suite may not implement this operation yet. Update a consumer\'s metadata or permissions within this tenant.
129
129
  * Update consumer metadata or permissions
130
130
  */
131
131
  updateConsumerRaw(requestParameters: UpdateConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConsumerDto>>;
132
132
  /**
133
- * Update a consumer\'s metadata or permissions within this tenant.
133
+ * **Experimental** — Epistola Suite may not implement this operation yet. Update a consumer\'s metadata or permissions within this tenant.
134
134
  * Update consumer metadata or permissions
135
135
  */
136
136
  updateConsumer(requestParameters: UpdateConsumerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConsumerDto>;