@epistola.app/epistola-client 1.3.0 → 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.
- package/CHANGELOG.md +5 -0
- package/README.md +21 -15
- package/dist/auth/jwtSigner.d.ts +3 -0
- package/dist/auth/jwtSigner.d.ts.map +1 -1
- package/dist/auth/jwtSigner.js +3 -0
- package/dist/auth/jwtSigner.js.map +1 -1
- package/dist/generated/api/apis/AttributesApi.d.ts +2 -2
- package/dist/generated/api/apis/AttributesApi.js +2 -2
- package/dist/generated/api/apis/CatalogsApi.d.ts +2 -2
- package/dist/generated/api/apis/CatalogsApi.js +2 -2
- package/dist/generated/api/apis/CodeListsApi.d.ts +2 -2
- package/dist/generated/api/apis/CodeListsApi.js +2 -2
- package/dist/generated/api/apis/ConsumersApi.d.ts +18 -18
- package/dist/generated/api/apis/ConsumersApi.js +18 -18
- package/dist/generated/api/apis/ContractsApi.d.ts +2 -2
- package/dist/generated/api/apis/ContractsApi.js +2 -2
- package/dist/generated/api/apis/EnvironmentsApi.d.ts +2 -2
- package/dist/generated/api/apis/EnvironmentsApi.js +2 -2
- package/dist/generated/api/apis/FontsApi.d.ts +2 -2
- package/dist/generated/api/apis/FontsApi.js +2 -2
- package/dist/generated/api/apis/GenerationApi.d.ts +2 -2
- package/dist/generated/api/apis/GenerationApi.js +2 -2
- package/dist/generated/api/apis/ImagesApi.d.ts +2 -2
- package/dist/generated/api/apis/ImagesApi.js +2 -2
- package/dist/generated/api/apis/StencilsApi.d.ts +2 -2
- package/dist/generated/api/apis/StencilsApi.js +2 -2
- package/dist/generated/api/apis/SystemApi.d.ts +2 -2
- package/dist/generated/api/apis/SystemApi.js +2 -2
- package/dist/generated/api/apis/TemplatesApi.d.ts +2 -2
- package/dist/generated/api/apis/TemplatesApi.js +2 -2
- package/dist/generated/api/apis/TenantsApi.d.ts +2 -2
- package/dist/generated/api/apis/TenantsApi.js +2 -2
- package/dist/generated/api/apis/ThemesApi.d.ts +2 -2
- package/dist/generated/api/apis/ThemesApi.js +2 -2
- package/dist/generated/api/apis/VariantsApi.d.ts +2 -2
- package/dist/generated/api/apis/VariantsApi.js +2 -2
- package/dist/generated/api/apis/VersionsApi.d.ts +2 -2
- package/dist/generated/api/apis/VersionsApi.js +2 -2
- package/dist/generated/api/models/ActivationDto.d.ts +2 -2
- package/dist/generated/api/models/ActivationDto.js +2 -2
- package/dist/generated/api/models/ActivationListResponse.d.ts +2 -2
- package/dist/generated/api/models/ActivationListResponse.js +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +2 -2
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/ApproveConsumerRequest.js +2 -2
- package/dist/generated/api/models/AttributeDto.d.ts +9 -3
- package/dist/generated/api/models/AttributeDto.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDto.js +3 -5
- package/dist/generated/api/models/AttributeDto.js.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +2 -2
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js +2 -2
- package/dist/generated/api/models/AttributeListResponse.d.ts +2 -2
- package/dist/generated/api/models/AttributeListResponse.js +2 -2
- package/dist/generated/api/models/BatchGenerationItem.d.ts +2 -2
- package/dist/generated/api/models/BatchGenerationItem.js +2 -2
- package/dist/generated/api/models/BlockStylePreset.d.ts +2 -2
- package/dist/generated/api/models/BlockStylePreset.js +2 -2
- package/dist/generated/api/models/CatalogDto.d.ts +9 -3
- package/dist/generated/api/models/CatalogDto.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogDto.js +3 -5
- package/dist/generated/api/models/CatalogDto.js.map +1 -1
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts +2 -2
- package/dist/generated/api/models/CatalogInstallResultDto.js +2 -2
- package/dist/generated/api/models/CatalogListResponse.d.ts +2 -2
- package/dist/generated/api/models/CatalogListResponse.js +2 -2
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +2 -2
- package/dist/generated/api/models/CatalogUpgradeDiff.js +2 -2
- package/dist/generated/api/models/CodeListDto.d.ts +2 -2
- package/dist/generated/api/models/CodeListDto.js +2 -2
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts +2 -2
- package/dist/generated/api/models/CodeListEntriesResponse.js +2 -2
- package/dist/generated/api/models/CodeListEntryDto.d.ts +2 -2
- package/dist/generated/api/models/CodeListEntryDto.js +2 -2
- package/dist/generated/api/models/CodeListListResponse.d.ts +2 -2
- package/dist/generated/api/models/CodeListListResponse.js +2 -2
- package/dist/generated/api/models/CollectMeta.d.ts +2 -2
- package/dist/generated/api/models/CollectMeta.js +2 -2
- package/dist/generated/api/models/CollectRequest.d.ts +2 -2
- package/dist/generated/api/models/CollectRequest.js +2 -2
- package/dist/generated/api/models/ConsumerDto.d.ts +12 -9
- package/dist/generated/api/models/ConsumerDto.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerDto.js +2 -2
- package/dist/generated/api/models/ConsumerDto.js.map +1 -1
- package/dist/generated/api/models/ConsumerListResponse.d.ts +2 -2
- package/dist/generated/api/models/ConsumerListResponse.js +2 -2
- package/dist/generated/api/models/ConsumerNodeDto.d.ts +2 -2
- package/dist/generated/api/models/ConsumerNodeDto.js +2 -2
- package/dist/generated/api/models/ConsumerPermissions.d.ts +2 -2
- package/dist/generated/api/models/ConsumerPermissions.js +2 -2
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +2 -2
- package/dist/generated/api/models/ContractBreakingChangeDto.js +2 -2
- package/dist/generated/api/models/ContractVersionListResponse.d.ts +2 -2
- package/dist/generated/api/models/ContractVersionListResponse.js +2 -2
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +2 -2
- package/dist/generated/api/models/ContractVersionSummaryDto.js +2 -2
- package/dist/generated/api/models/CreateAttributeRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateAttributeRequest.js +2 -2
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +2 -2
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +2 -2
- package/dist/generated/api/models/CreateCodeListRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateCodeListRequest.js +2 -2
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts +2 -2
- package/dist/generated/api/models/CreateContractDraftResponse.js +2 -2
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateEnvironmentRequest.js +2 -2
- package/dist/generated/api/models/CreateStencilRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateStencilRequest.js +2 -2
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateStencilVersionRequest.js +2 -2
- package/dist/generated/api/models/CreateTemplateRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateTemplateRequest.js +2 -2
- package/dist/generated/api/models/CreateTenantRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateTenantRequest.js +2 -2
- package/dist/generated/api/models/CreateThemeRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateThemeRequest.js +2 -2
- package/dist/generated/api/models/CreateVariantRequest.d.ts +2 -2
- package/dist/generated/api/models/CreateVariantRequest.js +2 -2
- package/dist/generated/api/models/DataExampleDto.d.ts +2 -2
- package/dist/generated/api/models/DataExampleDto.js +2 -2
- package/dist/generated/api/models/DataModelValidationError.d.ts +2 -2
- package/dist/generated/api/models/DataModelValidationError.js +2 -2
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/DataModelValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/DocumentDto.d.ts +2 -2
- package/dist/generated/api/models/DocumentDto.js +2 -2
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +2 -2
- package/dist/generated/api/models/DocumentGenerationItemDto.js +2 -2
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +2 -2
- package/dist/generated/api/models/DocumentGenerationJobDto.js +2 -2
- package/dist/generated/api/models/DocumentListResponse.d.ts +2 -2
- package/dist/generated/api/models/DocumentListResponse.js +2 -2
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts +2 -2
- package/dist/generated/api/models/DroppedStencilFillDto.js +2 -2
- package/dist/generated/api/models/EnvironmentDto.d.ts +9 -3
- package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -1
- package/dist/generated/api/models/EnvironmentDto.js +3 -5
- package/dist/generated/api/models/EnvironmentDto.js.map +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.d.ts +2 -2
- package/dist/generated/api/models/EnvironmentListResponse.js +2 -2
- package/dist/generated/api/models/FontDto.d.ts +2 -2
- package/dist/generated/api/models/FontDto.js +2 -2
- package/dist/generated/api/models/FontListResponse.d.ts +2 -2
- package/dist/generated/api/models/FontListResponse.js +2 -2
- package/dist/generated/api/models/FontVariantDto.d.ts +2 -2
- package/dist/generated/api/models/FontVariantDto.js +2 -2
- package/dist/generated/api/models/GenerateBatchRequest.d.ts +2 -2
- package/dist/generated/api/models/GenerateBatchRequest.js +2 -2
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts +2 -2
- package/dist/generated/api/models/GenerateDocumentRequest.js +2 -2
- package/dist/generated/api/models/GenerationJobDetail.d.ts +2 -2
- package/dist/generated/api/models/GenerationJobDetail.js +2 -2
- package/dist/generated/api/models/GenerationJobListResponse.d.ts +2 -2
- package/dist/generated/api/models/GenerationJobListResponse.js +2 -2
- package/dist/generated/api/models/GenerationJobResponse.d.ts +2 -2
- package/dist/generated/api/models/GenerationJobResponse.js +2 -2
- package/dist/generated/api/models/GenerationResult.d.ts +2 -2
- package/dist/generated/api/models/GenerationResult.js +2 -2
- package/dist/generated/api/models/ImageDto.d.ts +2 -2
- package/dist/generated/api/models/ImageDto.js +2 -2
- package/dist/generated/api/models/ImageListResponse.d.ts +2 -2
- package/dist/generated/api/models/ImageListResponse.js +2 -2
- package/dist/generated/api/models/ImportCatalogResponse.d.ts +2 -2
- package/dist/generated/api/models/ImportCatalogResponse.js +2 -2
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts +2 -2
- package/dist/generated/api/models/ImportTemplateResultDto.js +2 -2
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +2 -2
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +2 -2
- package/dist/generated/api/models/Margins.d.ts +2 -2
- package/dist/generated/api/models/Margins.js +2 -2
- package/dist/generated/api/models/Node.d.ts +2 -2
- package/dist/generated/api/models/Node.js +2 -2
- package/dist/generated/api/models/Orientation.d.ts +2 -2
- package/dist/generated/api/models/Orientation.js +2 -2
- package/dist/generated/api/models/PageFormat.d.ts +2 -2
- package/dist/generated/api/models/PageFormat.js +2 -2
- package/dist/generated/api/models/PageMeta.d.ts +2 -2
- package/dist/generated/api/models/PageMeta.js +2 -2
- package/dist/generated/api/models/PageSettings.d.ts +2 -2
- package/dist/generated/api/models/PageSettings.js +2 -2
- package/dist/generated/api/models/PartitionAssignment.d.ts +2 -2
- package/dist/generated/api/models/PartitionAssignment.js +2 -2
- package/dist/generated/api/models/PingRequest.d.ts +2 -2
- package/dist/generated/api/models/PingRequest.js +2 -2
- package/dist/generated/api/models/PongDetailsDto.d.ts +2 -2
- package/dist/generated/api/models/PongDetailsDto.js +2 -2
- package/dist/generated/api/models/PongResponse.d.ts +2 -2
- package/dist/generated/api/models/PongResponse.js +2 -2
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts +2 -2
- package/dist/generated/api/models/PreviewDocumentRequest.js +2 -2
- package/dist/generated/api/models/ProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/ProblemDetail.js +2 -2
- package/dist/generated/api/models/PublishContractRequest.d.ts +2 -2
- package/dist/generated/api/models/PublishContractRequest.js +2 -2
- package/dist/generated/api/models/PublishContractResponse.d.ts +2 -2
- package/dist/generated/api/models/PublishContractResponse.js +2 -2
- package/dist/generated/api/models/PublishVersionRequest.d.ts +2 -2
- package/dist/generated/api/models/PublishVersionRequest.js +2 -2
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/RegisterConsumerRequest.js +2 -2
- package/dist/generated/api/models/RejectConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/RejectConsumerRequest.js +2 -2
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +2 -2
- package/dist/generated/api/models/ReleaseCatalogRequest.js +2 -2
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +2 -2
- package/dist/generated/api/models/ReleaseCatalogResponse.js +2 -2
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +2 -2
- package/dist/generated/api/models/RemovedCatalogResourceDto.js +2 -2
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +2 -2
- package/dist/generated/api/models/RotatePublicKeyRequest.js +2 -2
- package/dist/generated/api/models/Slot.d.ts +2 -2
- package/dist/generated/api/models/Slot.js +2 -2
- package/dist/generated/api/models/StencilDto.d.ts +9 -3
- package/dist/generated/api/models/StencilDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilDto.js +3 -5
- package/dist/generated/api/models/StencilDto.js.map +1 -1
- package/dist/generated/api/models/StencilListResponse.d.ts +2 -2
- package/dist/generated/api/models/StencilListResponse.js +2 -2
- package/dist/generated/api/models/StencilSummaryDto.d.ts +9 -3
- package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilSummaryDto.js +3 -5
- package/dist/generated/api/models/StencilSummaryDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.d.ts +2 -2
- package/dist/generated/api/models/StencilUsageDto.js +2 -2
- package/dist/generated/api/models/StencilUsageListResponse.d.ts +2 -2
- package/dist/generated/api/models/StencilUsageListResponse.js +2 -2
- package/dist/generated/api/models/StencilVersionDto.d.ts +2 -2
- package/dist/generated/api/models/StencilVersionDto.js +2 -2
- package/dist/generated/api/models/StencilVersionListResponse.d.ts +2 -2
- package/dist/generated/api/models/StencilVersionListResponse.js +2 -2
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +2 -2
- package/dist/generated/api/models/StencilVersionSummaryDto.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationError.d.ts +2 -2
- package/dist/generated/api/models/TemplateDataValidationError.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts +2 -2
- package/dist/generated/api/models/TemplateDataValidationResult.js +2 -2
- package/dist/generated/api/models/TemplateDocument.d.ts +2 -2
- package/dist/generated/api/models/TemplateDocument.js +2 -2
- package/dist/generated/api/models/TemplateDto.d.ts +9 -3
- package/dist/generated/api/models/TemplateDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDto.js +3 -5
- package/dist/generated/api/models/TemplateDto.js.map +1 -1
- package/dist/generated/api/models/TemplateListResponse.d.ts +2 -2
- package/dist/generated/api/models/TemplateListResponse.js +2 -2
- package/dist/generated/api/models/TemplateSummaryDto.d.ts +9 -3
- package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.js +3 -5
- package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -1
- package/dist/generated/api/models/TenantDto.d.ts +9 -3
- package/dist/generated/api/models/TenantDto.d.ts.map +1 -1
- package/dist/generated/api/models/TenantDto.js +3 -5
- package/dist/generated/api/models/TenantDto.js.map +1 -1
- package/dist/generated/api/models/TenantListResponse.d.ts +2 -2
- package/dist/generated/api/models/TenantListResponse.js +2 -2
- package/dist/generated/api/models/ThemeDto.d.ts +9 -3
- package/dist/generated/api/models/ThemeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeDto.js +3 -5
- package/dist/generated/api/models/ThemeDto.js.map +1 -1
- package/dist/generated/api/models/ThemeListResponse.d.ts +2 -2
- package/dist/generated/api/models/ThemeListResponse.js +2 -2
- package/dist/generated/api/models/ThemeRef.d.ts +2 -2
- package/dist/generated/api/models/ThemeRef.js +2 -2
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateAttributeRequest.js +2 -2
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +2 -2
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +2 -2
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +2 -2
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateCodeListRequest.js +2 -2
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateConsumerRequest.js +2 -2
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateContractDraftRequest.js +2 -2
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +2 -2
- package/dist/generated/api/models/UpdateContractDraftResponse.js +2 -2
- package/dist/generated/api/models/UpdateDraftRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateDraftRequest.js +2 -2
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateEnvironmentRequest.js +2 -2
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateStencilDraftRequest.js +2 -2
- package/dist/generated/api/models/UpdateStencilRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateStencilRequest.js +2 -2
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateTemplateRequest.js +2 -2
- package/dist/generated/api/models/UpdateTenantRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateTenantRequest.js +2 -2
- package/dist/generated/api/models/UpdateThemeRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateThemeRequest.js +2 -2
- package/dist/generated/api/models/UpdateVariantRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateVariantRequest.js +2 -2
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +2 -2
- package/dist/generated/api/models/UpgradeCatalogRequest.js +2 -2
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +2 -2
- package/dist/generated/api/models/UpgradeCatalogResponse.js +2 -2
- package/dist/generated/api/models/UpgradePreviewDto.d.ts +2 -2
- package/dist/generated/api/models/UpgradePreviewDto.js +2 -2
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +2 -2
- package/dist/generated/api/models/UpgradePreviewListResponse.js +2 -2
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +2 -2
- package/dist/generated/api/models/ValidateTemplateDataRequest.js +2 -2
- package/dist/generated/api/models/ValidationError.d.ts +2 -2
- package/dist/generated/api/models/ValidationError.js +2 -2
- package/dist/generated/api/models/ValidationProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/ValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/VariantDto.d.ts +9 -3
- package/dist/generated/api/models/VariantDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantDto.js +3 -5
- package/dist/generated/api/models/VariantDto.js.map +1 -1
- package/dist/generated/api/models/VariantListResponse.d.ts +2 -2
- package/dist/generated/api/models/VariantListResponse.js +2 -2
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts +2 -2
- package/dist/generated/api/models/VariantSelectionAttribute.js +2 -2
- package/dist/generated/api/models/VariantSummaryDto.d.ts +9 -3
- package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.js +3 -5
- package/dist/generated/api/models/VariantSummaryDto.js.map +1 -1
- package/dist/generated/api/models/VersionDto.d.ts +2 -2
- package/dist/generated/api/models/VersionDto.js +2 -2
- package/dist/generated/api/models/VersionListResponse.d.ts +2 -2
- package/dist/generated/api/models/VersionListResponse.js +2 -2
- package/dist/generated/api/models/VersionSummaryDto.d.ts +2 -2
- package/dist/generated/api/models/VersionSummaryDto.js +2 -2
- package/dist/generated/api/runtime.d.ts +2 -2
- package/dist/generated/api/runtime.js +2 -2
- package/dist/generated/contractVersion.d.ts +1 -1
- package/dist/generated/contractVersion.js +1 -1
- package/dist/generated/modelValidation.js +10 -10
- package/dist/generated/modelValidation.js.map +1 -1
- package/package.json +1 -1
|
@@ -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
|
|
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.3.
|
|
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).
|
|
@@ -18,7 +18,7 @@ import { ApproveConsumerRequestFromJSON, ApproveConsumerRequestToJSON, ConsumerD
|
|
|
18
18
|
*/
|
|
19
19
|
export class ConsumersApi extends runtime.BaseAPI {
|
|
20
20
|
/**
|
|
21
|
-
* Approve a consumer registration within this tenant. Sets the granted permissions and optional expiry. The consumer transitions from `pending` to `active`.
|
|
21
|
+
* **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`.
|
|
22
22
|
* Approve a pending consumer
|
|
23
23
|
*/
|
|
24
24
|
async approveConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -60,7 +60,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
60
60
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
61
61
|
}
|
|
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
|
async approveConsumer(requestParameters, initOverrides) {
|
|
@@ -68,7 +68,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
68
68
|
return await response.value();
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* 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).
|
|
71
|
+
* **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).
|
|
72
72
|
* Delete a consumer
|
|
73
73
|
*/
|
|
74
74
|
async deleteConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -105,14 +105,14 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
105
105
|
return new runtime.VoidApiResponse(response);
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
* 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).
|
|
108
|
+
* **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).
|
|
109
109
|
* Delete a consumer
|
|
110
110
|
*/
|
|
111
111
|
async deleteConsumer(requestParameters, initOverrides) {
|
|
112
112
|
await this.deleteConsumerRaw(requestParameters, initOverrides);
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* Retrieve details of a specific consumer in this tenant.
|
|
115
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Retrieve details of a specific consumer in this tenant.
|
|
116
116
|
* Get consumer by ID
|
|
117
117
|
*/
|
|
118
118
|
async getConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -149,7 +149,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
149
149
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* Retrieve details of a specific consumer in this tenant.
|
|
152
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Retrieve details of a specific consumer in this tenant.
|
|
153
153
|
* Get consumer by ID
|
|
154
154
|
*/
|
|
155
155
|
async getConsumer(requestParameters, initOverrides) {
|
|
@@ -157,7 +157,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
157
157
|
return await response.value();
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
|
|
160
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
|
|
161
161
|
* List consumers in this tenant
|
|
162
162
|
*/
|
|
163
163
|
async listConsumersRaw(requestParameters, initOverrides) {
|
|
@@ -202,7 +202,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
202
202
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerListResponseFromJSON(jsonValue));
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
|
-
* Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
|
|
205
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Retrieve a paginated list of consumers registered in this tenant with optional filtering by status.
|
|
206
206
|
* List consumers in this tenant
|
|
207
207
|
*/
|
|
208
208
|
async listConsumers(requestParameters, initOverrides) {
|
|
@@ -210,7 +210,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
210
210
|
return await response.value();
|
|
211
211
|
}
|
|
212
212
|
/**
|
|
213
|
-
* 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`.
|
|
213
|
+
* **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`.
|
|
214
214
|
* Register a new consumer in this tenant
|
|
215
215
|
*/
|
|
216
216
|
async registerConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -235,7 +235,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
235
235
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
236
236
|
}
|
|
237
237
|
/**
|
|
238
|
-
* 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`.
|
|
238
|
+
* **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`.
|
|
239
239
|
* Register a new consumer in this tenant
|
|
240
240
|
*/
|
|
241
241
|
async registerConsumer(requestParameters, initOverrides) {
|
|
@@ -243,7 +243,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
243
243
|
return await response.value();
|
|
244
244
|
}
|
|
245
245
|
/**
|
|
246
|
-
* Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
|
|
246
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
|
|
247
247
|
* Reject a pending consumer
|
|
248
248
|
*/
|
|
249
249
|
async rejectConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -282,7 +282,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
282
282
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
|
|
285
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Reject a consumer registration. The consumer transitions from `pending` to `rejected`. Optionally provide a reason.
|
|
286
286
|
* Reject a pending consumer
|
|
287
287
|
*/
|
|
288
288
|
async rejectConsumer(requestParameters, initOverrides) {
|
|
@@ -290,7 +290,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
290
290
|
return await response.value();
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
|
-
* 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.
|
|
293
|
+
* **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.
|
|
294
294
|
* Rotate public key
|
|
295
295
|
*/
|
|
296
296
|
async rotatePublicKeyRaw(requestParameters, initOverrides) {
|
|
@@ -332,7 +332,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
332
332
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
333
333
|
}
|
|
334
334
|
/**
|
|
335
|
-
* 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.
|
|
335
|
+
* **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.
|
|
336
336
|
* Rotate public key
|
|
337
337
|
*/
|
|
338
338
|
async rotatePublicKey(requestParameters, initOverrides) {
|
|
@@ -340,7 +340,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
340
340
|
return await response.value();
|
|
341
341
|
}
|
|
342
342
|
/**
|
|
343
|
-
* Update a consumer\'s metadata or permissions within this tenant.
|
|
343
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Update a consumer\'s metadata or permissions within this tenant.
|
|
344
344
|
* Update consumer metadata or permissions
|
|
345
345
|
*/
|
|
346
346
|
async updateConsumerRaw(requestParameters, initOverrides) {
|
|
@@ -382,7 +382,7 @@ export class ConsumersApi extends runtime.BaseAPI {
|
|
|
382
382
|
return new runtime.JSONApiResponse(response, (jsonValue) => ConsumerDtoFromJSON(jsonValue));
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
|
-
* Update a consumer\'s metadata or permissions within this tenant.
|
|
385
|
+
* **Experimental** — Epistola Suite may not implement this operation yet. Update a consumer\'s metadata or permissions within this tenant.
|
|
386
386
|
* Update consumer metadata or permissions
|
|
387
387
|
*/
|
|
388
388
|
async updateConsumer(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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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
|
|
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.3.
|
|
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).
|