@epistola.app/epistola-client 1.2.1-rc.1 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -2
- package/README.md +31 -1
- package/dist/generated/api/apis/AttributesApi.d.ts +1 -1
- package/dist/generated/api/apis/AttributesApi.js +1 -1
- package/dist/generated/api/apis/CatalogsApi.d.ts +3 -3
- package/dist/generated/api/apis/CatalogsApi.js +3 -3
- package/dist/generated/api/apis/CodeListsApi.d.ts +1 -1
- package/dist/generated/api/apis/CodeListsApi.js +1 -1
- package/dist/generated/api/apis/ConsumersApi.d.ts +1 -1
- package/dist/generated/api/apis/ConsumersApi.js +1 -1
- package/dist/generated/api/apis/ContractsApi.d.ts +1 -1
- package/dist/generated/api/apis/ContractsApi.js +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.d.ts +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.js +1 -1
- package/dist/generated/api/apis/FontsApi.d.ts +1 -1
- package/dist/generated/api/apis/FontsApi.js +1 -1
- package/dist/generated/api/apis/GenerationApi.d.ts +1 -1
- package/dist/generated/api/apis/GenerationApi.js +1 -1
- package/dist/generated/api/apis/{AssetsApi.d.ts → ImagesApi.d.ts} +34 -44
- package/dist/generated/api/apis/ImagesApi.d.ts.map +1 -0
- package/dist/generated/api/apis/{AssetsApi.js → ImagesApi.js} +53 -64
- package/dist/generated/api/apis/ImagesApi.js.map +1 -0
- package/dist/generated/api/apis/StencilsApi.d.ts +1 -1
- package/dist/generated/api/apis/StencilsApi.js +1 -1
- package/dist/generated/api/apis/SystemApi.d.ts +1 -1
- package/dist/generated/api/apis/SystemApi.js +1 -1
- package/dist/generated/api/apis/TemplatesApi.d.ts +1 -1
- package/dist/generated/api/apis/TemplatesApi.js +1 -1
- package/dist/generated/api/apis/TenantsApi.d.ts +1 -1
- package/dist/generated/api/apis/TenantsApi.js +1 -1
- package/dist/generated/api/apis/ThemesApi.d.ts +1 -1
- package/dist/generated/api/apis/ThemesApi.js +1 -1
- package/dist/generated/api/apis/VariantsApi.d.ts +1 -1
- package/dist/generated/api/apis/VariantsApi.js +1 -1
- package/dist/generated/api/apis/VersionsApi.d.ts +1 -1
- package/dist/generated/api/apis/VersionsApi.js +1 -1
- package/dist/generated/api/apis/index.d.ts +1 -1
- package/dist/generated/api/apis/index.d.ts.map +1 -1
- package/dist/generated/api/apis/index.js +1 -1
- package/dist/generated/api/apis/index.js.map +1 -1
- package/dist/generated/api/models/ActivationDto.d.ts +1 -1
- package/dist/generated/api/models/ActivationDto.js +1 -1
- package/dist/generated/api/models/ActivationListResponse.d.ts +1 -1
- package/dist/generated/api/models/ActivationListResponse.js +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +1 -1
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts +1 -1
- package/dist/generated/api/models/ApproveConsumerRequest.js +1 -1
- package/dist/generated/api/models/AttributeDto.d.ts +12 -1
- package/dist/generated/api/models/AttributeDto.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDto.js +5 -1
- package/dist/generated/api/models/AttributeDto.js.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js +1 -1
- package/dist/generated/api/models/AttributeListResponse.d.ts +1 -1
- package/dist/generated/api/models/AttributeListResponse.js +1 -1
- package/dist/generated/api/models/BatchGenerationItem.d.ts +1 -1
- package/dist/generated/api/models/BatchGenerationItem.js +1 -1
- package/dist/generated/api/models/BlockStylePreset.d.ts +1 -1
- package/dist/generated/api/models/BlockStylePreset.js +1 -1
- package/dist/generated/api/models/CatalogDto.d.ts +10 -1
- package/dist/generated/api/models/CatalogDto.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogDto.js +5 -1
- package/dist/generated/api/models/CatalogDto.js.map +1 -1
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts +1 -1
- package/dist/generated/api/models/CatalogInstallResultDto.js +1 -1
- package/dist/generated/api/models/CatalogListResponse.d.ts +1 -1
- package/dist/generated/api/models/CatalogListResponse.js +1 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +1 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.js +1 -1
- package/dist/generated/api/models/CodeListDto.d.ts +1 -1
- package/dist/generated/api/models/CodeListDto.js +1 -1
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts +1 -1
- package/dist/generated/api/models/CodeListEntriesResponse.js +1 -1
- package/dist/generated/api/models/CodeListEntryDto.d.ts +1 -1
- package/dist/generated/api/models/CodeListEntryDto.js +1 -1
- package/dist/generated/api/models/CodeListListResponse.d.ts +1 -1
- package/dist/generated/api/models/CodeListListResponse.js +1 -1
- package/dist/generated/api/models/CollectMeta.d.ts +1 -1
- package/dist/generated/api/models/CollectMeta.js +1 -1
- package/dist/generated/api/models/CollectRequest.d.ts +1 -1
- package/dist/generated/api/models/CollectRequest.js +1 -1
- package/dist/generated/api/models/ConsumerDto.d.ts +1 -1
- package/dist/generated/api/models/ConsumerDto.js +1 -1
- package/dist/generated/api/models/ConsumerListResponse.d.ts +1 -1
- package/dist/generated/api/models/ConsumerListResponse.js +1 -1
- package/dist/generated/api/models/ConsumerNodeDto.d.ts +1 -1
- package/dist/generated/api/models/ConsumerNodeDto.js +1 -1
- package/dist/generated/api/models/ConsumerPermissions.d.ts +1 -1
- package/dist/generated/api/models/ConsumerPermissions.js +1 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +1 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.js +1 -1
- package/dist/generated/api/models/ContractVersionListResponse.d.ts +1 -1
- package/dist/generated/api/models/ContractVersionListResponse.js +1 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +1 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.js +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.js +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +1 -1
- package/dist/generated/api/models/CreateCodeListRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateCodeListRequest.js +1 -1
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts +1 -1
- package/dist/generated/api/models/CreateContractDraftResponse.js +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.js +1 -1
- package/dist/generated/api/models/CreateStencilRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateStencilRequest.js +1 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.js +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.js +1 -1
- package/dist/generated/api/models/CreateTenantRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateTenantRequest.js +1 -1
- package/dist/generated/api/models/CreateThemeRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateThemeRequest.js +1 -1
- package/dist/generated/api/models/CreateVariantRequest.d.ts +1 -1
- package/dist/generated/api/models/CreateVariantRequest.js +1 -1
- package/dist/generated/api/models/DataExampleDto.d.ts +1 -1
- package/dist/generated/api/models/DataExampleDto.js +1 -1
- package/dist/generated/api/models/DataModelValidationError.d.ts +1 -1
- package/dist/generated/api/models/DataModelValidationError.js +1 -1
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +1 -1
- package/dist/generated/api/models/DataModelValidationProblemDetail.js +1 -1
- package/dist/generated/api/models/DocumentDto.d.ts +1 -1
- package/dist/generated/api/models/DocumentDto.js +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.js +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.js +1 -1
- package/dist/generated/api/models/DocumentListResponse.d.ts +1 -1
- package/dist/generated/api/models/DocumentListResponse.js +1 -1
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts +1 -1
- package/dist/generated/api/models/DroppedStencilFillDto.js +1 -1
- package/dist/generated/api/models/EnvironmentDto.d.ts +10 -1
- package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -1
- package/dist/generated/api/models/EnvironmentDto.js +5 -1
- package/dist/generated/api/models/EnvironmentDto.js.map +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.d.ts +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.js +1 -1
- package/dist/generated/api/models/FontDto.d.ts +1 -1
- package/dist/generated/api/models/FontDto.js +1 -1
- package/dist/generated/api/models/FontListResponse.d.ts +1 -1
- package/dist/generated/api/models/FontListResponse.js +1 -1
- package/dist/generated/api/models/FontVariantDto.d.ts +1 -1
- package/dist/generated/api/models/FontVariantDto.js +1 -1
- package/dist/generated/api/models/GenerateBatchRequest.d.ts +1 -1
- package/dist/generated/api/models/GenerateBatchRequest.js +1 -1
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts +1 -1
- package/dist/generated/api/models/GenerateDocumentRequest.js +1 -1
- package/dist/generated/api/models/GenerationJobDetail.d.ts +1 -1
- package/dist/generated/api/models/GenerationJobDetail.js +1 -1
- package/dist/generated/api/models/GenerationJobListResponse.d.ts +1 -1
- package/dist/generated/api/models/GenerationJobListResponse.js +1 -1
- package/dist/generated/api/models/GenerationJobResponse.d.ts +1 -1
- package/dist/generated/api/models/GenerationJobResponse.js +1 -1
- package/dist/generated/api/models/GenerationResult.d.ts +1 -1
- package/dist/generated/api/models/GenerationResult.js +1 -1
- package/dist/generated/api/models/{AssetDto.d.ts → ImageDto.d.ts} +46 -47
- package/dist/generated/api/models/ImageDto.d.ts.map +1 -0
- package/dist/generated/api/models/{AssetDto.js → ImageDto.js} +14 -26
- package/dist/generated/api/models/ImageDto.js.map +1 -0
- package/dist/generated/api/models/{AssetListResponse.d.ts → ImageListResponse.d.ts} +15 -15
- package/dist/generated/api/models/{AssetListResponse.d.ts.map → ImageListResponse.d.ts.map} +1 -1
- package/dist/generated/api/models/{AssetListResponse.js → ImageListResponse.js} +13 -13
- package/dist/generated/api/models/{AssetListResponse.js.map → ImageListResponse.js.map} +1 -1
- package/dist/generated/api/models/ImportCatalogResponse.d.ts +1 -1
- package/dist/generated/api/models/ImportCatalogResponse.js +1 -1
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts +1 -1
- package/dist/generated/api/models/ImportTemplateResultDto.js +1 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +1 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +1 -1
- package/dist/generated/api/models/Margins.d.ts +1 -1
- package/dist/generated/api/models/Margins.js +1 -1
- package/dist/generated/api/models/Node.d.ts +1 -1
- package/dist/generated/api/models/Node.js +1 -1
- package/dist/generated/api/models/Orientation.d.ts +1 -1
- package/dist/generated/api/models/Orientation.js +1 -1
- package/dist/generated/api/models/PageFormat.d.ts +1 -1
- package/dist/generated/api/models/PageFormat.js +1 -1
- package/dist/generated/api/models/PageMeta.d.ts +1 -1
- package/dist/generated/api/models/PageMeta.js +1 -1
- package/dist/generated/api/models/PageSettings.d.ts +1 -1
- package/dist/generated/api/models/PageSettings.js +1 -1
- package/dist/generated/api/models/PartitionAssignment.d.ts +1 -1
- package/dist/generated/api/models/PartitionAssignment.js +1 -1
- package/dist/generated/api/models/PingRequest.d.ts +1 -1
- package/dist/generated/api/models/PingRequest.js +1 -1
- package/dist/generated/api/models/PongDetailsDto.d.ts +1 -1
- package/dist/generated/api/models/PongDetailsDto.js +1 -1
- package/dist/generated/api/models/PongResponse.d.ts +1 -1
- package/dist/generated/api/models/PongResponse.js +1 -1
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts +1 -1
- package/dist/generated/api/models/PreviewDocumentRequest.js +1 -1
- package/dist/generated/api/models/ProblemDetail.d.ts +1 -1
- package/dist/generated/api/models/ProblemDetail.js +1 -1
- package/dist/generated/api/models/PublishContractRequest.d.ts +1 -1
- package/dist/generated/api/models/PublishContractRequest.js +1 -1
- package/dist/generated/api/models/PublishContractResponse.d.ts +1 -1
- package/dist/generated/api/models/PublishContractResponse.js +1 -1
- package/dist/generated/api/models/PublishVersionRequest.d.ts +1 -1
- package/dist/generated/api/models/PublishVersionRequest.js +1 -1
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts +1 -1
- package/dist/generated/api/models/RegisterConsumerRequest.js +1 -1
- package/dist/generated/api/models/RejectConsumerRequest.d.ts +1 -1
- package/dist/generated/api/models/RejectConsumerRequest.js +1 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +1 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.js +1 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +1 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.js +1 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +1 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.js +1 -1
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +1 -1
- package/dist/generated/api/models/RotatePublicKeyRequest.js +1 -1
- package/dist/generated/api/models/Slot.d.ts +1 -1
- package/dist/generated/api/models/Slot.js +1 -1
- package/dist/generated/api/models/StencilDto.d.ts +10 -1
- package/dist/generated/api/models/StencilDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilDto.js +5 -1
- package/dist/generated/api/models/StencilDto.js.map +1 -1
- package/dist/generated/api/models/StencilListResponse.d.ts +1 -1
- package/dist/generated/api/models/StencilListResponse.js +1 -1
- package/dist/generated/api/models/StencilSummaryDto.d.ts +10 -1
- package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilSummaryDto.js +5 -1
- package/dist/generated/api/models/StencilSummaryDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.d.ts +1 -1
- package/dist/generated/api/models/StencilUsageDto.js +1 -1
- package/dist/generated/api/models/StencilUsageListResponse.d.ts +1 -1
- package/dist/generated/api/models/StencilUsageListResponse.js +1 -1
- package/dist/generated/api/models/StencilVersionDto.d.ts +1 -1
- package/dist/generated/api/models/StencilVersionDto.js +1 -1
- package/dist/generated/api/models/StencilVersionListResponse.d.ts +1 -1
- package/dist/generated/api/models/StencilVersionListResponse.js +1 -1
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +1 -1
- package/dist/generated/api/models/StencilVersionSummaryDto.js +1 -1
- package/dist/generated/api/models/TemplateDataValidationError.d.ts +1 -1
- package/dist/generated/api/models/TemplateDataValidationError.js +1 -1
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts +1 -1
- package/dist/generated/api/models/TemplateDataValidationResult.js +1 -1
- package/dist/generated/api/models/TemplateDocument.d.ts +1 -1
- package/dist/generated/api/models/TemplateDocument.js +1 -1
- package/dist/generated/api/models/TemplateDto.d.ts +10 -1
- package/dist/generated/api/models/TemplateDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDto.js +5 -1
- package/dist/generated/api/models/TemplateDto.js.map +1 -1
- package/dist/generated/api/models/TemplateListResponse.d.ts +1 -1
- package/dist/generated/api/models/TemplateListResponse.js +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.d.ts +10 -1
- package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.js +5 -1
- package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -1
- package/dist/generated/api/models/TenantDto.d.ts +10 -1
- package/dist/generated/api/models/TenantDto.d.ts.map +1 -1
- package/dist/generated/api/models/TenantDto.js +5 -1
- package/dist/generated/api/models/TenantDto.js.map +1 -1
- package/dist/generated/api/models/TenantListResponse.d.ts +1 -1
- package/dist/generated/api/models/TenantListResponse.js +1 -1
- package/dist/generated/api/models/ThemeDto.d.ts +10 -1
- package/dist/generated/api/models/ThemeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeDto.js +5 -1
- package/dist/generated/api/models/ThemeDto.js.map +1 -1
- package/dist/generated/api/models/ThemeListResponse.d.ts +1 -1
- package/dist/generated/api/models/ThemeListResponse.js +1 -1
- package/dist/generated/api/models/ThemeRef.d.ts +1 -1
- package/dist/generated/api/models/ThemeRef.js +1 -1
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateAttributeRequest.js +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +1 -1
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +1 -1
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateCodeListRequest.js +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.js +1 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.js +1 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +1 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.js +1 -1
- package/dist/generated/api/models/UpdateDraftRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateDraftRequest.js +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.js +1 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.js +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.js +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.js +1 -1
- package/dist/generated/api/models/UpdateTenantRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateTenantRequest.js +1 -1
- package/dist/generated/api/models/UpdateThemeRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateThemeRequest.js +1 -1
- package/dist/generated/api/models/UpdateVariantRequest.d.ts +1 -1
- package/dist/generated/api/models/UpdateVariantRequest.js +1 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +14 -2
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.js +1 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.js.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +1 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.js +1 -1
- package/dist/generated/api/models/UpgradePreviewDto.d.ts +1 -1
- package/dist/generated/api/models/UpgradePreviewDto.js +1 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +1 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.js +1 -1
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +1 -1
- package/dist/generated/api/models/ValidateTemplateDataRequest.js +1 -1
- package/dist/generated/api/models/ValidationError.d.ts +1 -1
- package/dist/generated/api/models/ValidationError.js +1 -1
- package/dist/generated/api/models/ValidationProblemDetail.d.ts +1 -1
- package/dist/generated/api/models/ValidationProblemDetail.js +1 -1
- package/dist/generated/api/models/VariantDto.d.ts +10 -1
- package/dist/generated/api/models/VariantDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantDto.js +5 -1
- package/dist/generated/api/models/VariantDto.js.map +1 -1
- package/dist/generated/api/models/VariantListResponse.d.ts +1 -1
- package/dist/generated/api/models/VariantListResponse.js +1 -1
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts +1 -1
- package/dist/generated/api/models/VariantSelectionAttribute.js +1 -1
- package/dist/generated/api/models/VariantSummaryDto.d.ts +10 -1
- package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.js +5 -1
- package/dist/generated/api/models/VariantSummaryDto.js.map +1 -1
- package/dist/generated/api/models/VersionDto.d.ts +1 -1
- package/dist/generated/api/models/VersionDto.js +1 -1
- package/dist/generated/api/models/VersionListResponse.d.ts +1 -1
- package/dist/generated/api/models/VersionListResponse.js +1 -1
- package/dist/generated/api/models/VersionSummaryDto.d.ts +1 -1
- package/dist/generated/api/models/VersionSummaryDto.js +1 -1
- package/dist/generated/api/models/index.d.ts +2 -2
- package/dist/generated/api/models/index.d.ts.map +1 -1
- package/dist/generated/api/models/index.js +2 -2
- package/dist/generated/api/models/index.js.map +1 -1
- package/dist/generated/api/runtime.d.ts +1 -1
- package/dist/generated/api/runtime.js +1 -1
- package/dist/generated/contractOperations.js +4 -4
- package/dist/generated/contractOperations.js.map +1 -1
- package/dist/generated/contractVersion.d.ts +1 -1
- package/dist/generated/contractVersion.d.ts.map +1 -1
- package/dist/generated/contractVersion.js +1 -1
- package/dist/generated/contractVersion.js.map +1 -1
- package/dist/generated/modelValidation.d.ts +4 -4
- package/dist/generated/modelValidation.d.ts.map +1 -1
- package/dist/generated/modelValidation.js +24 -13
- package/dist/generated/modelValidation.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/validation/ajvLoader.d.ts +52 -0
- package/dist/validation/ajvLoader.d.ts.map +1 -0
- package/dist/validation/ajvLoader.js +60 -0
- package/dist/validation/ajvLoader.js.map +1 -0
- package/dist/validation/templateSchemaValidator.d.ts +3 -0
- package/dist/validation/templateSchemaValidator.d.ts.map +1 -1
- package/dist/validation/templateSchemaValidator.js +10 -17
- package/dist/validation/templateSchemaValidator.js.map +1 -1
- package/package.json +21 -10
- package/dist/generated/api/apis/AssetsApi.d.ts.map +0 -1
- package/dist/generated/api/apis/AssetsApi.js.map +0 -1
- package/dist/generated/api/models/AssetDto.d.ts.map +0 -1
- package/dist/generated/api/models/AssetDto.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -33,8 +33,11 @@ records contract/spec changes. This file records changes specific to the Node.js
|
|
|
33
33
|
adaptive polling floored at the minimum interval, sequence-based acknowledgement that leaves a
|
|
34
34
|
batch unacknowledged when the handler throws, and murmur3 partition-routing helpers.
|
|
35
35
|
- Client-side JSON Schema validation of template data (`TemplateSchemaValidator`,
|
|
36
|
-
`ValidatingGenerationApi
|
|
37
|
-
|
|
36
|
+
`ValidatingGenerationApi`) and generated `validateModel` / `validate<Model>` helpers covering
|
|
37
|
+
every model that carries schema constraints. The schema validator runs on Ajv, which is an
|
|
38
|
+
optional peer dependency loaded on first use, so the package itself has no runtime
|
|
39
|
+
dependencies; without `ajv` and `ajv-formats` installed, the first validation rejects with an
|
|
40
|
+
error naming them.
|
|
38
41
|
- `CONTRACT_OPERATIONS` — the method, path template and declared response media types of every
|
|
39
42
|
operation, generated from the spec. The generated API classes set `Content-Type` but never
|
|
40
43
|
`Accept`, and Node's `fetch` sends `*/*` by default, so the client asks for exactly what each
|
package/README.md
CHANGED
|
@@ -26,6 +26,11 @@ The package version tracks the Epistola contract version (`info.version`) and re
|
|
|
26
26
|
with the Kotlin, Jakarta EE, .NET and Python clients. It needs Node.js 22.12 or later and ships as
|
|
27
27
|
an ES module (which Node's `require()` can load as well).
|
|
28
28
|
|
|
29
|
+
It has **no runtime dependencies**: HTTP is the platform's `fetch`, JWT signing is `node:crypto`,
|
|
30
|
+
decompression is `node:zlib`. The one optional feature that needs a library is client-side template
|
|
31
|
+
validation, which loads `ajv` and `ajv-formats` on first use; they are optional peer dependencies,
|
|
32
|
+
so install them only if you use it (see [Client-side validation](#client-side-validation)).
|
|
33
|
+
|
|
29
34
|
Release history: [CHANGELOG.md](CHANGELOG.md).
|
|
30
35
|
|
|
31
36
|
## Install
|
|
@@ -81,7 +86,22 @@ touches nothing else; `{ name: 'Billing', description: null }` also clears the d
|
|
|
81
86
|
### Binary downloads
|
|
82
87
|
|
|
83
88
|
Every operation the contract declares as `format: binary` — `downloadDocument`, `previewDocument`,
|
|
84
|
-
|
|
89
|
+
`downloadImageContent` — resolves to a `Blob`; `Buffer.from(await blob.arrayBuffer())` gives you the bytes.
|
|
90
|
+
|
|
91
|
+
### Uploading files
|
|
92
|
+
|
|
93
|
+
Multipart operations such as `uploadImage` and `importCatalog` take a `Blob`. Pass a `File`, which
|
|
94
|
+
carries a name and a type:
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
import { readFile } from 'node:fs/promises'
|
|
98
|
+
|
|
99
|
+
const file = new File([await readFile('logo.png')], 'logo.png', { type: 'image/png' })
|
|
100
|
+
const image = await new ImagesApi(client).uploadImage({ tenantId: 'acme-corp', catalogId: 'main', file, name: 'Logo' })
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
A plain `Blob` is always sent with the filename `blob`, and as `application/octet-stream` unless it
|
|
104
|
+
was given a type. The server then names the image `blob`.
|
|
85
105
|
|
|
86
106
|
## Error handling
|
|
87
107
|
|
|
@@ -146,6 +166,16 @@ whose result comes back to this node.
|
|
|
146
166
|
|
|
147
167
|
## Client-side validation
|
|
148
168
|
|
|
169
|
+
Validating template data against the template's JSON Schema needs Ajv, which is an optional peer
|
|
170
|
+
dependency so that consumers who never validate do not carry a schema compiler:
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
npm install ajv ajv-formats
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Without them, the first `validate` call rejects with an error saying exactly that. The generated
|
|
177
|
+
`validate<Model>` helpers for the contract's own constraints need nothing extra.
|
|
178
|
+
|
|
149
179
|
```ts
|
|
150
180
|
import { TemplateSchemaValidator, ValidatingGenerationApi, validateCreateTenantRequest } from '@epistola.app/epistola-client'
|
|
151
181
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -83,12 +83,12 @@ export declare class CatalogsApi extends runtime.BaseAPI {
|
|
|
83
83
|
*/
|
|
84
84
|
releaseCatalog(requestParameters: ReleaseCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseCatalogResponse>;
|
|
85
85
|
/**
|
|
86
|
-
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog.
|
|
86
|
+
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
|
|
87
87
|
* Upgrade a subscribed catalog
|
|
88
88
|
*/
|
|
89
89
|
upgradeCatalogRaw(requestParameters: UpgradeCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpgradeCatalogResponse>>;
|
|
90
90
|
/**
|
|
91
|
-
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog.
|
|
91
|
+
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
|
|
92
92
|
* Upgrade a subscribed catalog
|
|
93
93
|
*/
|
|
94
94
|
upgradeCatalog(requestParameters: UpgradeCatalogOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpgradeCatalogResponse>;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -235,7 +235,7 @@ export class CatalogsApi extends runtime.BaseAPI {
|
|
|
235
235
|
return await response.value();
|
|
236
236
|
}
|
|
237
237
|
/**
|
|
238
|
-
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog.
|
|
238
|
+
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
|
|
239
239
|
* Upgrade a subscribed catalog
|
|
240
240
|
*/
|
|
241
241
|
async upgradeCatalogRaw(requestParameters, initOverrides) {
|
|
@@ -274,7 +274,7 @@ export class CatalogsApi extends runtime.BaseAPI {
|
|
|
274
274
|
return new runtime.JSONApiResponse(response, (jsonValue) => UpgradeCatalogResponseFromJSON(jsonValue));
|
|
275
275
|
}
|
|
276
276
|
/**
|
|
277
|
-
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog.
|
|
277
|
+
* Re-fetch the source catalog and apply an upgrade to an existing SUBSCRIBED catalog. The whole manifest is reconciled: resources added since the installed release are installed, changed ones are updated in place, and resources the publisher no longer publishes are removed — the last only when nothing outside the catalog still references them, otherwise the upgrade is rejected and nothing changes. Use `GET .../upgrade-preview` to see all three before applying. `includeNewSlugs` on the request body is deprecated and ignored.
|
|
278
278
|
* Upgrade a subscribed catalog
|
|
279
279
|
*/
|
|
280
280
|
async upgradeCatalog(requestParameters, initOverrides) {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Epistola API
|
|
5
5
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Epistola API
|
|
3
3
|
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT**: `Authorization: Bearer <jwt>` using OAuth 2.0 Client Credentials or self-signed JWTs - **API key**: `Authorization: ApiKey <key>` for static tenant API keys The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. Permissions and allowed tenants are managed in Epistola\'s consumer record, not in JWT claims. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,27 +10,26 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime.js';
|
|
13
|
-
import type {
|
|
14
|
-
export interface
|
|
13
|
+
import type { ImageDto, ImageListResponse } from '../models/index.js';
|
|
14
|
+
export interface DeleteImageRequest {
|
|
15
15
|
tenantId: string;
|
|
16
16
|
catalogId: string;
|
|
17
|
-
|
|
17
|
+
imageSlug: string;
|
|
18
18
|
force?: boolean;
|
|
19
19
|
}
|
|
20
|
-
export interface
|
|
20
|
+
export interface DownloadImageContentRequest {
|
|
21
21
|
tenantId: string;
|
|
22
22
|
catalogId: string;
|
|
23
|
-
|
|
23
|
+
imageSlug: string;
|
|
24
24
|
}
|
|
25
|
-
export interface
|
|
25
|
+
export interface ListImagesRequest {
|
|
26
26
|
tenantId: string;
|
|
27
27
|
catalogId: string;
|
|
28
28
|
search?: string;
|
|
29
|
-
mediaCategory?: ListAssetsMediaCategoryEnum;
|
|
30
29
|
page?: number;
|
|
31
30
|
size?: number;
|
|
32
31
|
}
|
|
33
|
-
export interface
|
|
32
|
+
export interface UploadImageRequest {
|
|
34
33
|
tenantId: string;
|
|
35
34
|
catalogId: string;
|
|
36
35
|
file: Blob;
|
|
@@ -41,55 +40,46 @@ export interface UploadAssetRequest {
|
|
|
41
40
|
/**
|
|
42
41
|
*
|
|
43
42
|
*/
|
|
44
|
-
export declare class
|
|
43
|
+
export declare class ImagesApi extends runtime.BaseAPI {
|
|
45
44
|
/**
|
|
46
|
-
* Delete an
|
|
47
|
-
* Delete an
|
|
45
|
+
* Delete an image from an AUTHORED catalog. Returns 409 when the image is still referenced by templates unless `force=true` is supplied. Returns 404 when the catalog has no image with this key, including when the key belongs to a font binary.
|
|
46
|
+
* Delete an image
|
|
48
47
|
*/
|
|
49
|
-
|
|
48
|
+
deleteImageRaw(requestParameters: DeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
50
49
|
/**
|
|
51
|
-
* Delete an
|
|
52
|
-
* Delete an
|
|
50
|
+
* Delete an image from an AUTHORED catalog. Returns 409 when the image is still referenced by templates unless `force=true` is supplied. Returns 404 when the catalog has no image with this key, including when the key belongs to a font binary.
|
|
51
|
+
* Delete an image
|
|
53
52
|
*/
|
|
54
|
-
|
|
53
|
+
deleteImage(requestParameters: DeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
55
54
|
/**
|
|
56
|
-
* Download
|
|
57
|
-
* Download
|
|
55
|
+
* Download the image\'s bytes, served with the image\'s own media type. Returns 404 when the catalog has no image with this key, including when the key belongs to a font binary.
|
|
56
|
+
* Download image content
|
|
58
57
|
*/
|
|
59
|
-
|
|
58
|
+
downloadImageContentRaw(requestParameters: DownloadImageContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
60
59
|
/**
|
|
61
|
-
* Download
|
|
62
|
-
* Download
|
|
60
|
+
* Download the image\'s bytes, served with the image\'s own media type. Returns 404 when the catalog has no image with this key, including when the key belongs to a font binary.
|
|
61
|
+
* Download image content
|
|
63
62
|
*/
|
|
64
|
-
|
|
63
|
+
downloadImageContent(requestParameters: DownloadImageContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
65
64
|
/**
|
|
66
|
-
* List
|
|
67
|
-
* List
|
|
65
|
+
* List the images in a catalog, as metadata. Images from a SUBSCRIBED catalog are flagged `readOnly: true`. Only images are listed. The binaries behind font faces are not images; the Fonts API describes them as faces of a family.
|
|
66
|
+
* List images in a catalog
|
|
68
67
|
*/
|
|
69
|
-
|
|
68
|
+
listImagesRaw(requestParameters: ListImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageListResponse>>;
|
|
70
69
|
/**
|
|
71
|
-
* List
|
|
72
|
-
* List
|
|
70
|
+
* List the images in a catalog, as metadata. Images from a SUBSCRIBED catalog are flagged `readOnly: true`. Only images are listed. The binaries behind font faces are not images; the Fonts API describes them as faces of a family.
|
|
71
|
+
* List images in a catalog
|
|
73
72
|
*/
|
|
74
|
-
|
|
73
|
+
listImages(requestParameters: ListImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageListResponse>;
|
|
75
74
|
/**
|
|
76
|
-
* Upload
|
|
77
|
-
* Upload an
|
|
75
|
+
* Upload an image into an AUTHORED catalog. The suite currently limits image content to 5 MiB. Supported image types are deployment-configured; common ones are `image/png`, `image/jpeg`, `image/svg+xml`, and `image/webp`. Content whose media type is not a supported image type is rejected with 400. The response carries the new image\'s generated `key`.
|
|
76
|
+
* Upload an image
|
|
78
77
|
*/
|
|
79
|
-
|
|
78
|
+
uploadImageRaw(requestParameters: UploadImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageDto>>;
|
|
80
79
|
/**
|
|
81
|
-
* Upload
|
|
82
|
-
* Upload an
|
|
80
|
+
* Upload an image into an AUTHORED catalog. The suite currently limits image content to 5 MiB. Supported image types are deployment-configured; common ones are `image/png`, `image/jpeg`, `image/svg+xml`, and `image/webp`. Content whose media type is not a supported image type is rejected with 400. The response carries the new image\'s generated `key`.
|
|
81
|
+
* Upload an image
|
|
83
82
|
*/
|
|
84
|
-
|
|
83
|
+
uploadImage(requestParameters: UploadImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageDto>;
|
|
85
84
|
}
|
|
86
|
-
|
|
87
|
-
* @export
|
|
88
|
-
*/
|
|
89
|
-
export declare const ListAssetsMediaCategoryEnum: {
|
|
90
|
-
readonly Image: 'IMAGE';
|
|
91
|
-
readonly Font: 'FONT';
|
|
92
|
-
readonly Other: 'OTHER';
|
|
93
|
-
};
|
|
94
|
-
export type ListAssetsMediaCategoryEnum = typeof ListAssetsMediaCategoryEnum[keyof typeof ListAssetsMediaCategoryEnum];
|
|
95
|
-
//# sourceMappingURL=AssetsApi.d.ts.map
|
|
85
|
+
//# sourceMappingURL=ImagesApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ImagesApi.d.ts","sourceRoot":"","sources":["../../../../src/generated/api/apis/ImagesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EAGlB,MAAM,oBAAoB,CAAC;AAY5B,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,OAAO,CAAC,OAAO;IAE1C;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CA4D1J;IAED;;;OAGG;IACG,WAAW,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAElI;IAED;;;OAGG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAwD5K;IAED;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGpJ;IAED;;;OAGG;IACG,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CA4DrK;IAED;;;OAGG;IACG,UAAU,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAG7I;IAED;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAwF9J;IAED;;;OAGG;IACG,WAAW,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAGtI;CAEJ"}
|