@epistola.app/epistola-client 1.3.0 → 1.4.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 +38 -37
- package/README.md +21 -15
- package/dist/auth/jwtSigner.d.ts +3 -0
- package/dist/auth/jwtSigner.d.ts.map +1 -1
- package/dist/auth/jwtSigner.js +3 -0
- package/dist/auth/jwtSigner.js.map +1 -1
- package/dist/generated/api/apis/AttributesApi.d.ts +88 -3
- package/dist/generated/api/apis/AttributesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/AttributesApi.js +82 -42
- package/dist/generated/api/apis/AttributesApi.js.map +1 -1
- package/dist/generated/api/apis/CatalogsApi.d.ts +85 -3
- package/dist/generated/api/apis/CatalogsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/CatalogsApi.js +82 -39
- package/dist/generated/api/apis/CatalogsApi.js.map +1 -1
- package/dist/generated/api/apis/CodeListsApi.d.ts +139 -3
- package/dist/generated/api/apis/CodeListsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/CodeListsApi.js +130 -66
- package/dist/generated/api/apis/CodeListsApi.js.map +1 -1
- package/dist/generated/api/apis/ConsumersApi.d.ts +126 -19
- package/dist/generated/api/apis/ConsumersApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ConsumersApi.js +130 -66
- package/dist/generated/api/apis/ConsumersApi.js.map +1 -1
- package/dist/generated/api/apis/ContractsApi.d.ts +66 -3
- package/dist/generated/api/apis/ContractsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ContractsApi.js +71 -35
- package/dist/generated/api/apis/ContractsApi.js.map +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.d.ts +73 -3
- package/dist/generated/api/apis/EnvironmentsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.js +77 -37
- package/dist/generated/api/apis/EnvironmentsApi.js.map +1 -1
- package/dist/generated/api/apis/FontsApi.d.ts +44 -3
- package/dist/generated/api/apis/FontsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/FontsApi.js +35 -18
- package/dist/generated/api/apis/FontsApi.js.map +1 -1
- package/dist/generated/api/apis/GenerationApi.d.ts +128 -3
- package/dist/generated/api/apis/GenerationApi.d.ts.map +1 -1
- package/dist/generated/api/apis/GenerationApi.js +148 -68
- package/dist/generated/api/apis/GenerationApi.js.map +1 -1
- package/dist/generated/api/apis/ImagesApi.d.ts +74 -3
- package/dist/generated/api/apis/ImagesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ImagesApi.js +64 -33
- package/dist/generated/api/apis/ImagesApi.js.map +1 -1
- package/dist/generated/api/apis/StencilsApi.d.ts +283 -3
- package/dist/generated/api/apis/StencilsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/StencilsApi.js +234 -123
- package/dist/generated/api/apis/StencilsApi.js.map +1 -1
- package/dist/generated/api/apis/SystemApi.d.ts +11 -3
- package/dist/generated/api/apis/SystemApi.d.ts.map +1 -1
- package/dist/generated/api/apis/SystemApi.js +16 -8
- package/dist/generated/api/apis/SystemApi.js.map +1 -1
- package/dist/generated/api/apis/TemplatesApi.d.ts +111 -5
- package/dist/generated/api/apis/TemplatesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/TemplatesApi.js +101 -51
- package/dist/generated/api/apis/TemplatesApi.js.map +1 -1
- package/dist/generated/api/apis/TenantsApi.d.ts +61 -3
- package/dist/generated/api/apis/TenantsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/TenantsApi.js +72 -32
- package/dist/generated/api/apis/TenantsApi.js.map +1 -1
- package/dist/generated/api/apis/ThemesApi.d.ts +91 -3
- package/dist/generated/api/apis/ThemesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ThemesApi.js +82 -42
- package/dist/generated/api/apis/ThemesApi.js.map +1 -1
- package/dist/generated/api/apis/VariantsApi.d.ts +259 -3
- package/dist/generated/api/apis/VariantsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/VariantsApi.js +235 -129
- package/dist/generated/api/apis/VariantsApi.js.map +1 -1
- package/dist/generated/api/apis/VersionsApi.d.ts +124 -3
- package/dist/generated/api/apis/VersionsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/VersionsApi.js +94 -54
- package/dist/generated/api/apis/VersionsApi.js.map +1 -1
- package/dist/generated/api/models/ActivationDto.d.ts +2 -10
- package/dist/generated/api/models/ActivationDto.d.ts.map +1 -1
- package/dist/generated/api/models/ActivationDto.js +5 -5
- package/dist/generated/api/models/ActivationDto.js.map +1 -1
- package/dist/generated/api/models/ActivationListResponse.d.ts +2 -4
- package/dist/generated/api/models/ActivationListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ActivationListResponse.js +2 -2
- package/dist/generated/api/models/ActivationListResponse.js.map +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +2 -10
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js.map +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +2 -10
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +2 -2
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js.map +1 -1
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts +2 -6
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts.map +1 -1
- package/dist/generated/api/models/ApproveConsumerRequest.js +5 -5
- package/dist/generated/api/models/ApproveConsumerRequest.js.map +1 -1
- package/dist/generated/api/models/AttributeDto.d.ts +10 -28
- package/dist/generated/api/models/AttributeDto.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDto.js +11 -13
- package/dist/generated/api/models/AttributeDto.js.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +2 -6
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js +2 -2
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/AttributeListResponse.d.ts +2 -6
- package/dist/generated/api/models/AttributeListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeListResponse.js +2 -2
- package/dist/generated/api/models/AttributeListResponse.js.map +1 -1
- package/dist/generated/api/models/BatchGenerationItem.d.ts +2 -22
- package/dist/generated/api/models/BatchGenerationItem.d.ts.map +1 -1
- package/dist/generated/api/models/BatchGenerationItem.js +8 -8
- package/dist/generated/api/models/BatchGenerationItem.js.map +1 -1
- package/dist/generated/api/models/BlockStylePreset.d.ts +2 -8
- package/dist/generated/api/models/BlockStylePreset.d.ts.map +1 -1
- package/dist/generated/api/models/BlockStylePreset.js +2 -2
- package/dist/generated/api/models/BlockStylePreset.js.map +1 -1
- package/dist/generated/api/models/CatalogDto.d.ts +9 -17
- package/dist/generated/api/models/CatalogDto.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogDto.js +7 -9
- package/dist/generated/api/models/CatalogDto.js.map +1 -1
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts +2 -10
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogInstallResultDto.js +4 -4
- package/dist/generated/api/models/CatalogInstallResultDto.js.map +1 -1
- package/dist/generated/api/models/CatalogListResponse.d.ts +2 -6
- package/dist/generated/api/models/CatalogListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogListResponse.js +2 -2
- package/dist/generated/api/models/CatalogListResponse.js.map +1 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +2 -22
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.js +3 -3
- package/dist/generated/api/models/CatalogUpgradeDiff.js.map +1 -1
- package/dist/generated/api/models/CodeListDto.d.ts +2 -30
- package/dist/generated/api/models/CodeListDto.d.ts.map +1 -1
- package/dist/generated/api/models/CodeListDto.js +15 -15
- package/dist/generated/api/models/CodeListDto.js.map +1 -1
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts +2 -4
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts.map +1 -1
- package/dist/generated/api/models/CodeListEntriesResponse.js +2 -2
- package/dist/generated/api/models/CodeListEntriesResponse.js.map +1 -1
- package/dist/generated/api/models/CodeListEntryDto.d.ts +2 -10
- package/dist/generated/api/models/CodeListEntryDto.d.ts.map +1 -1
- package/dist/generated/api/models/CodeListEntryDto.js +2 -2
- package/dist/generated/api/models/CodeListEntryDto.js.map +1 -1
- package/dist/generated/api/models/CodeListListResponse.d.ts +2 -6
- package/dist/generated/api/models/CodeListListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/CodeListListResponse.js +2 -2
- package/dist/generated/api/models/CodeListListResponse.js.map +1 -1
- package/dist/generated/api/models/CollectMeta.d.ts +2 -12
- package/dist/generated/api/models/CollectMeta.d.ts.map +1 -1
- package/dist/generated/api/models/CollectMeta.js +3 -3
- package/dist/generated/api/models/CollectMeta.js.map +1 -1
- package/dist/generated/api/models/CollectRequest.d.ts +2 -6
- package/dist/generated/api/models/CollectRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CollectRequest.js +3 -3
- package/dist/generated/api/models/CollectRequest.js.map +1 -1
- package/dist/generated/api/models/ConsumerDto.d.ts +12 -43
- package/dist/generated/api/models/ConsumerDto.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerDto.js +18 -18
- package/dist/generated/api/models/ConsumerDto.js.map +1 -1
- package/dist/generated/api/models/ConsumerListResponse.d.ts +2 -6
- package/dist/generated/api/models/ConsumerListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerListResponse.js +2 -2
- package/dist/generated/api/models/ConsumerListResponse.js.map +1 -1
- package/dist/generated/api/models/ConsumerNodeDto.d.ts +2 -10
- package/dist/generated/api/models/ConsumerNodeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerNodeDto.js +6 -6
- package/dist/generated/api/models/ConsumerNodeDto.js.map +1 -1
- package/dist/generated/api/models/ConsumerPermissions.d.ts +2 -20
- package/dist/generated/api/models/ConsumerPermissions.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerPermissions.js +11 -11
- package/dist/generated/api/models/ConsumerPermissions.js.map +1 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +2 -8
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.js +3 -3
- package/dist/generated/api/models/ContractBreakingChangeDto.js.map +1 -1
- package/dist/generated/api/models/ContractVersionListResponse.d.ts +2 -4
- package/dist/generated/api/models/ContractVersionListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ContractVersionListResponse.js +2 -2
- package/dist/generated/api/models/ContractVersionListResponse.js.map +1 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +2 -10
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.js +8 -8
- package/dist/generated/api/models/ContractVersionSummaryDto.js.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.d.ts +3 -13
- package/dist/generated/api/models/CreateAttributeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.js +4 -4
- package/dist/generated/api/models/CreateAttributeRequest.js.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +2 -6
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +2 -2
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/CreateCodeListRequest.d.ts +2 -18
- package/dist/generated/api/models/CreateCodeListRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateCodeListRequest.js +7 -7
- package/dist/generated/api/models/CreateCodeListRequest.js.map +1 -1
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts +2 -6
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts.map +1 -1
- package/dist/generated/api/models/CreateContractDraftResponse.js +5 -3
- package/dist/generated/api/models/CreateContractDraftResponse.js.map +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +2 -6
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.js +2 -2
- package/dist/generated/api/models/CreateEnvironmentRequest.js.map +1 -1
- package/dist/generated/api/models/CreateStencilRequest.d.ts +2 -14
- package/dist/generated/api/models/CreateStencilRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateStencilRequest.js +3 -3
- package/dist/generated/api/models/CreateStencilRequest.js.map +1 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +2 -6
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.js +3 -3
- package/dist/generated/api/models/CreateStencilVersionRequest.js.map +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.d.ts +2 -8
- package/dist/generated/api/models/CreateTemplateRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.js +2 -2
- package/dist/generated/api/models/CreateTemplateRequest.js.map +1 -1
- package/dist/generated/api/models/CreateTenantRequest.d.ts +2 -6
- package/dist/generated/api/models/CreateTenantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateTenantRequest.js +2 -2
- package/dist/generated/api/models/CreateTenantRequest.js.map +1 -1
- package/dist/generated/api/models/CreateThemeRequest.d.ts +2 -16
- package/dist/generated/api/models/CreateThemeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateThemeRequest.js +2 -2
- package/dist/generated/api/models/CreateThemeRequest.js.map +1 -1
- package/dist/generated/api/models/CreateVariantRequest.d.ts +2 -10
- package/dist/generated/api/models/CreateVariantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateVariantRequest.js +3 -3
- package/dist/generated/api/models/CreateVariantRequest.js.map +1 -1
- package/dist/generated/api/models/DataExampleDto.d.ts +2 -8
- package/dist/generated/api/models/DataExampleDto.d.ts.map +1 -1
- package/dist/generated/api/models/DataExampleDto.js +2 -2
- package/dist/generated/api/models/DataExampleDto.js.map +1 -1
- package/dist/generated/api/models/DataModelValidationError.d.ts +2 -6
- package/dist/generated/api/models/DataModelValidationError.d.ts.map +1 -1
- package/dist/generated/api/models/DataModelValidationError.js +2 -2
- package/dist/generated/api/models/DataModelValidationError.js.map +1 -1
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +2 -14
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts.map +1 -1
- package/dist/generated/api/models/DataModelValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/DataModelValidationProblemDetail.js.map +1 -1
- package/dist/generated/api/models/DocumentDto.d.ts +2 -24
- package/dist/generated/api/models/DocumentDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentDto.js +7 -7
- package/dist/generated/api/models/DocumentDto.js.map +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +2 -30
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.js +16 -16
- package/dist/generated/api/models/DocumentGenerationItemDto.js.map +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +2 -24
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.js +12 -12
- package/dist/generated/api/models/DocumentGenerationJobDto.js.map +1 -1
- package/dist/generated/api/models/DocumentListResponse.d.ts +2 -6
- package/dist/generated/api/models/DocumentListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentListResponse.js +2 -2
- package/dist/generated/api/models/DocumentListResponse.js.map +1 -1
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts +2 -6
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts.map +1 -1
- package/dist/generated/api/models/DroppedStencilFillDto.js +2 -2
- package/dist/generated/api/models/DroppedStencilFillDto.js.map +1 -1
- package/dist/generated/api/models/EnvironmentDto.d.ts +9 -13
- package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -1
- package/dist/generated/api/models/EnvironmentDto.js +6 -8
- package/dist/generated/api/models/EnvironmentDto.js.map +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.d.ts +2 -6
- package/dist/generated/api/models/EnvironmentListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.js +2 -2
- package/dist/generated/api/models/EnvironmentListResponse.js.map +1 -1
- package/dist/generated/api/models/FontDto.d.ts +2 -20
- package/dist/generated/api/models/FontDto.d.ts.map +1 -1
- package/dist/generated/api/models/FontDto.js +9 -9
- package/dist/generated/api/models/FontDto.js.map +1 -1
- package/dist/generated/api/models/FontListResponse.d.ts +2 -6
- package/dist/generated/api/models/FontListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/FontListResponse.js +2 -2
- package/dist/generated/api/models/FontListResponse.js.map +1 -1
- package/dist/generated/api/models/FontVariantDto.d.ts +2 -6
- package/dist/generated/api/models/FontVariantDto.d.ts.map +1 -1
- package/dist/generated/api/models/FontVariantDto.js +2 -2
- package/dist/generated/api/models/FontVariantDto.js.map +1 -1
- package/dist/generated/api/models/GenerateBatchRequest.d.ts +2 -6
- package/dist/generated/api/models/GenerateBatchRequest.d.ts.map +1 -1
- package/dist/generated/api/models/GenerateBatchRequest.js +3 -3
- package/dist/generated/api/models/GenerateBatchRequest.js.map +1 -1
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts +2 -22
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/GenerateDocumentRequest.js +8 -8
- package/dist/generated/api/models/GenerateDocumentRequest.js.map +1 -1
- package/dist/generated/api/models/GenerationJobDetail.d.ts +2 -6
- package/dist/generated/api/models/GenerationJobDetail.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationJobDetail.js +2 -2
- package/dist/generated/api/models/GenerationJobDetail.js.map +1 -1
- package/dist/generated/api/models/GenerationJobListResponse.d.ts +2 -6
- package/dist/generated/api/models/GenerationJobListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationJobListResponse.js +2 -2
- package/dist/generated/api/models/GenerationJobListResponse.js.map +1 -1
- package/dist/generated/api/models/GenerationJobResponse.d.ts +2 -12
- package/dist/generated/api/models/GenerationJobResponse.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationJobResponse.js +7 -7
- package/dist/generated/api/models/GenerationJobResponse.js.map +1 -1
- package/dist/generated/api/models/GenerationResult.d.ts +2 -32
- package/dist/generated/api/models/GenerationResult.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationResult.js +16 -16
- package/dist/generated/api/models/GenerationResult.js.map +1 -1
- package/dist/generated/api/models/ImageDto.d.ts +2 -24
- package/dist/generated/api/models/ImageDto.d.ts.map +1 -1
- package/dist/generated/api/models/ImageDto.js +8 -8
- package/dist/generated/api/models/ImageDto.js.map +1 -1
- package/dist/generated/api/models/ImageListResponse.d.ts +2 -6
- package/dist/generated/api/models/ImageListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ImageListResponse.js +2 -2
- package/dist/generated/api/models/ImageListResponse.js.map +1 -1
- package/dist/generated/api/models/ImportCatalogResponse.d.ts +2 -16
- package/dist/generated/api/models/ImportCatalogResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ImportCatalogResponse.js +2 -2
- package/dist/generated/api/models/ImportCatalogResponse.js.map +1 -1
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts +2 -12
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts.map +1 -1
- package/dist/generated/api/models/ImportTemplateResultDto.js +4 -4
- package/dist/generated/api/models/ImportTemplateResultDto.js.map +1 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +2 -8
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts.map +1 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +2 -2
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js.map +1 -1
- package/dist/generated/api/models/InvalidDataField.d.ts +45 -0
- package/dist/generated/api/models/InvalidDataField.d.ts.map +1 -0
- package/dist/generated/api/models/InvalidDataField.js +55 -0
- package/dist/generated/api/models/InvalidDataField.js.map +1 -0
- package/dist/generated/api/models/Margins.d.ts +2 -10
- package/dist/generated/api/models/Margins.d.ts.map +1 -1
- package/dist/generated/api/models/Margins.js +2 -2
- package/dist/generated/api/models/Margins.js.map +1 -1
- package/dist/generated/api/models/MissingDataField.d.ts +41 -0
- package/dist/generated/api/models/MissingDataField.d.ts.map +1 -0
- package/dist/generated/api/models/MissingDataField.js +53 -0
- package/dist/generated/api/models/MissingDataField.js.map +1 -0
- package/dist/generated/api/models/Node.d.ts +2 -14
- package/dist/generated/api/models/Node.d.ts.map +1 -1
- package/dist/generated/api/models/Node.js +2 -2
- package/dist/generated/api/models/Node.js.map +1 -1
- package/dist/generated/api/models/Orientation.d.ts +2 -2
- package/dist/generated/api/models/Orientation.js +3 -3
- package/dist/generated/api/models/PageFormat.d.ts +2 -2
- package/dist/generated/api/models/PageFormat.js +3 -3
- package/dist/generated/api/models/PageMeta.d.ts +2 -10
- package/dist/generated/api/models/PageMeta.d.ts.map +1 -1
- package/dist/generated/api/models/PageMeta.js +2 -2
- package/dist/generated/api/models/PageMeta.js.map +1 -1
- package/dist/generated/api/models/PageSettings.d.ts +2 -10
- package/dist/generated/api/models/PageSettings.d.ts.map +1 -1
- package/dist/generated/api/models/PageSettings.js +2 -2
- package/dist/generated/api/models/PageSettings.js.map +1 -1
- package/dist/generated/api/models/PartitionAssignment.d.ts +2 -8
- package/dist/generated/api/models/PartitionAssignment.d.ts.map +1 -1
- package/dist/generated/api/models/PartitionAssignment.js +5 -3
- package/dist/generated/api/models/PartitionAssignment.js.map +1 -1
- package/dist/generated/api/models/PingRequest.d.ts +2 -8
- package/dist/generated/api/models/PingRequest.d.ts.map +1 -1
- package/dist/generated/api/models/PingRequest.js +2 -2
- package/dist/generated/api/models/PingRequest.js.map +1 -1
- package/dist/generated/api/models/PongDetailsDto.d.ts +2 -10
- package/dist/generated/api/models/PongDetailsDto.d.ts.map +1 -1
- package/dist/generated/api/models/PongDetailsDto.js +2 -2
- package/dist/generated/api/models/PongDetailsDto.js.map +1 -1
- package/dist/generated/api/models/PongResponse.d.ts +2 -8
- package/dist/generated/api/models/PongResponse.d.ts.map +1 -1
- package/dist/generated/api/models/PongResponse.js +6 -6
- package/dist/generated/api/models/PongResponse.js.map +1 -1
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts +2 -16
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/PreviewDocumentRequest.js +5 -5
- package/dist/generated/api/models/PreviewDocumentRequest.js.map +1 -1
- package/dist/generated/api/models/ProblemDetail.d.ts +2 -12
- package/dist/generated/api/models/ProblemDetail.d.ts.map +1 -1
- package/dist/generated/api/models/ProblemDetail.js +2 -2
- package/dist/generated/api/models/ProblemDetail.js.map +1 -1
- package/dist/generated/api/models/PublishContractRequest.d.ts +2 -4
- package/dist/generated/api/models/PublishContractRequest.d.ts.map +1 -1
- package/dist/generated/api/models/PublishContractRequest.js +2 -2
- package/dist/generated/api/models/PublishContractRequest.js.map +1 -1
- package/dist/generated/api/models/PublishContractResponse.d.ts +2 -10
- package/dist/generated/api/models/PublishContractResponse.d.ts.map +1 -1
- package/dist/generated/api/models/PublishContractResponse.js +2 -2
- package/dist/generated/api/models/PublishContractResponse.js.map +1 -1
- package/dist/generated/api/models/PublishVersionRequest.d.ts +2 -4
- package/dist/generated/api/models/PublishVersionRequest.d.ts.map +1 -1
- package/dist/generated/api/models/PublishVersionRequest.js +2 -2
- package/dist/generated/api/models/PublishVersionRequest.js.map +1 -1
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts +2 -14
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts.map +1 -1
- package/dist/generated/api/models/RegisterConsumerRequest.js +2 -2
- package/dist/generated/api/models/RegisterConsumerRequest.js.map +1 -1
- package/dist/generated/api/models/RejectConsumerRequest.d.ts +2 -4
- package/dist/generated/api/models/RejectConsumerRequest.d.ts.map +1 -1
- package/dist/generated/api/models/RejectConsumerRequest.js +2 -2
- package/dist/generated/api/models/RejectConsumerRequest.js.map +1 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +2 -6
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts.map +1 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.js +3 -3
- package/dist/generated/api/models/ReleaseCatalogRequest.js.map +1 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +2 -12
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.js +6 -6
- package/dist/generated/api/models/ReleaseCatalogResponse.js.map +1 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +2 -6
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts.map +1 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.js +2 -2
- package/dist/generated/api/models/RemovedCatalogResourceDto.js.map +1 -1
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +2 -4
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts.map +1 -1
- package/dist/generated/api/models/RotatePublicKeyRequest.js +2 -2
- package/dist/generated/api/models/RotatePublicKeyRequest.js.map +1 -1
- package/dist/generated/api/models/Slot.d.ts +2 -10
- package/dist/generated/api/models/Slot.d.ts.map +1 -1
- package/dist/generated/api/models/Slot.js +2 -2
- package/dist/generated/api/models/Slot.js.map +1 -1
- package/dist/generated/api/models/StencilDto.d.ts +9 -21
- package/dist/generated/api/models/StencilDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilDto.js +9 -11
- package/dist/generated/api/models/StencilDto.js.map +1 -1
- package/dist/generated/api/models/StencilListResponse.d.ts +2 -6
- package/dist/generated/api/models/StencilListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/StencilListResponse.js +2 -2
- package/dist/generated/api/models/StencilListResponse.js.map +1 -1
- package/dist/generated/api/models/StencilSummaryDto.d.ts +9 -21
- package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilSummaryDto.js +9 -11
- package/dist/generated/api/models/StencilSummaryDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.d.ts +2 -12
- package/dist/generated/api/models/StencilUsageDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.js +2 -2
- package/dist/generated/api/models/StencilUsageDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageListResponse.d.ts +2 -6
- package/dist/generated/api/models/StencilUsageListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/StencilUsageListResponse.js +2 -2
- package/dist/generated/api/models/StencilUsageListResponse.js.map +1 -1
- package/dist/generated/api/models/StencilVersionDto.d.ts +2 -18
- package/dist/generated/api/models/StencilVersionDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilVersionDto.js +11 -11
- package/dist/generated/api/models/StencilVersionDto.js.map +1 -1
- package/dist/generated/api/models/StencilVersionListResponse.d.ts +2 -6
- package/dist/generated/api/models/StencilVersionListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/StencilVersionListResponse.js +2 -2
- package/dist/generated/api/models/StencilVersionListResponse.js.map +1 -1
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +2 -12
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilVersionSummaryDto.js +10 -10
- package/dist/generated/api/models/StencilVersionSummaryDto.js.map +1 -1
- package/dist/generated/api/models/TemplateDataValidationError.d.ts +2 -8
- package/dist/generated/api/models/TemplateDataValidationError.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDataValidationError.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationError.js.map +1 -1
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.d.ts +66 -0
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.js +66 -0
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.js.map +1 -0
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts +16 -6
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDataValidationResult.js +8 -2
- package/dist/generated/api/models/TemplateDataValidationResult.js.map +1 -1
- package/dist/generated/api/models/TemplateDocument.d.ts +2 -16
- package/dist/generated/api/models/TemplateDocument.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDocument.js +5 -3
- package/dist/generated/api/models/TemplateDocument.js.map +1 -1
- package/dist/generated/api/models/TemplateDto.d.ts +9 -23
- package/dist/generated/api/models/TemplateDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDto.js +8 -10
- package/dist/generated/api/models/TemplateDto.js.map +1 -1
- package/dist/generated/api/models/TemplateListResponse.d.ts +2 -6
- package/dist/generated/api/models/TemplateListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateListResponse.js +2 -2
- package/dist/generated/api/models/TemplateListResponse.js.map +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.d.ts +9 -15
- package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.js +8 -10
- package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -1
- package/dist/generated/api/models/TenantDto.d.ts +9 -11
- package/dist/generated/api/models/TenantDto.d.ts.map +1 -1
- package/dist/generated/api/models/TenantDto.js +6 -8
- package/dist/generated/api/models/TenantDto.js.map +1 -1
- package/dist/generated/api/models/TenantListResponse.d.ts +2 -6
- package/dist/generated/api/models/TenantListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/TenantListResponse.js +2 -2
- package/dist/generated/api/models/TenantListResponse.js.map +1 -1
- package/dist/generated/api/models/ThemeDto.d.ts +9 -25
- package/dist/generated/api/models/ThemeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeDto.js +8 -10
- package/dist/generated/api/models/ThemeDto.js.map +1 -1
- package/dist/generated/api/models/ThemeListResponse.d.ts +2 -6
- package/dist/generated/api/models/ThemeListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeListResponse.js +2 -2
- package/dist/generated/api/models/ThemeListResponse.js.map +1 -1
- package/dist/generated/api/models/ThemeRef.d.ts +2 -8
- package/dist/generated/api/models/ThemeRef.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeRef.js +3 -3
- package/dist/generated/api/models/ThemeRef.js.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts +3 -11
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequest.js +4 -4
- package/dist/generated/api/models/UpdateAttributeRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +2 -6
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +2 -2
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +2 -4
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +2 -2
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts +2 -14
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateCodeListRequest.js +6 -6
- package/dist/generated/api/models/UpdateCodeListRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts +2 -14
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.js +8 -8
- package/dist/generated/api/models/UpdateConsumerRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +2 -8
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.js +3 -3
- package/dist/generated/api/models/UpdateContractDraftRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +2 -10
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.js +5 -3
- package/dist/generated/api/models/UpdateContractDraftResponse.js.map +1 -1
- package/dist/generated/api/models/UpdateDraftRequest.d.ts +2 -4
- package/dist/generated/api/models/UpdateDraftRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateDraftRequest.js +2 -2
- package/dist/generated/api/models/UpdateDraftRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +2 -4
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.js +2 -2
- package/dist/generated/api/models/UpdateEnvironmentRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +2 -6
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.js +3 -3
- package/dist/generated/api/models/UpdateStencilDraftRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.d.ts +2 -8
- package/dist/generated/api/models/UpdateStencilRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.js +3 -3
- package/dist/generated/api/models/UpdateStencilRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts +2 -12
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.js +2 -2
- package/dist/generated/api/models/UpdateTemplateRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateTenantRequest.d.ts +2 -4
- package/dist/generated/api/models/UpdateTenantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateTenantRequest.js +2 -2
- package/dist/generated/api/models/UpdateTenantRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateThemeRequest.d.ts +3 -15
- package/dist/generated/api/models/UpdateThemeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateThemeRequest.js +5 -5
- package/dist/generated/api/models/UpdateThemeRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateVariantRequest.d.ts +2 -8
- package/dist/generated/api/models/UpdateVariantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateVariantRequest.js +3 -3
- package/dist/generated/api/models/UpdateVariantRequest.js.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +3 -4
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.js +2 -2
- package/dist/generated/api/models/UpgradeCatalogRequest.js.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +2 -12
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts.map +1 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.js +3 -3
- package/dist/generated/api/models/UpgradeCatalogResponse.js.map +1 -1
- package/dist/generated/api/models/UpgradePreviewDto.d.ts +2 -16
- package/dist/generated/api/models/UpgradePreviewDto.d.ts.map +1 -1
- package/dist/generated/api/models/UpgradePreviewDto.js +2 -2
- package/dist/generated/api/models/UpgradePreviewDto.js.map +1 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +2 -4
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.js +2 -2
- package/dist/generated/api/models/UpgradePreviewListResponse.js.map +1 -1
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +21 -5
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts.map +1 -1
- package/dist/generated/api/models/ValidateTemplateDataRequest.js +8 -2
- package/dist/generated/api/models/ValidateTemplateDataRequest.js.map +1 -1
- package/dist/generated/api/models/ValidationError.d.ts +3 -9
- package/dist/generated/api/models/ValidationError.d.ts.map +1 -1
- package/dist/generated/api/models/ValidationError.js +3 -3
- package/dist/generated/api/models/ValidationError.js.map +1 -1
- package/dist/generated/api/models/ValidationProblemDetail.d.ts +2 -14
- package/dist/generated/api/models/ValidationProblemDetail.d.ts.map +1 -1
- package/dist/generated/api/models/ValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/ValidationProblemDetail.js.map +1 -1
- package/dist/generated/api/models/VariantDto.d.ts +9 -25
- package/dist/generated/api/models/VariantDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantDto.js +9 -11
- package/dist/generated/api/models/VariantDto.js.map +1 -1
- package/dist/generated/api/models/VariantListResponse.d.ts +2 -6
- package/dist/generated/api/models/VariantListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/VariantListResponse.js +2 -2
- package/dist/generated/api/models/VariantListResponse.js.map +1 -1
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts +2 -10
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSelectionAttribute.js +3 -3
- package/dist/generated/api/models/VariantSelectionAttribute.js.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.d.ts +9 -17
- package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.js +3 -5
- package/dist/generated/api/models/VariantSummaryDto.js.map +1 -1
- package/dist/generated/api/models/VersionDto.d.ts +2 -16
- package/dist/generated/api/models/VersionDto.d.ts.map +1 -1
- package/dist/generated/api/models/VersionDto.js +10 -10
- package/dist/generated/api/models/VersionDto.js.map +1 -1
- package/dist/generated/api/models/VersionListResponse.d.ts +2 -6
- package/dist/generated/api/models/VersionListResponse.d.ts.map +1 -1
- package/dist/generated/api/models/VersionListResponse.js +2 -2
- package/dist/generated/api/models/VersionListResponse.js.map +1 -1
- package/dist/generated/api/models/VersionSummaryDto.d.ts +2 -14
- package/dist/generated/api/models/VersionSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/VersionSummaryDto.js +10 -10
- package/dist/generated/api/models/VersionSummaryDto.js.map +1 -1
- package/dist/generated/api/models/index.d.ts +3 -0
- package/dist/generated/api/models/index.d.ts.map +1 -1
- package/dist/generated/api/models/index.js +3 -0
- package/dist/generated/api/models/index.js.map +1 -1
- package/dist/generated/api/runtime.d.ts +14 -2
- package/dist/generated/api/runtime.d.ts.map +1 -1
- package/dist/generated/api/runtime.js +70 -5
- package/dist/generated/api/runtime.js.map +1 -1
- package/dist/generated/contractVersion.d.ts +1 -1
- package/dist/generated/contractVersion.js +1 -1
- package/dist/generated/knownProblemSlugs.d.ts +6 -0
- package/dist/generated/knownProblemSlugs.d.ts.map +1 -1
- package/dist/generated/knownProblemSlugs.js +6 -0
- package/dist/generated/knownProblemSlugs.js.map +1 -1
- package/dist/generated/modelValidation.d.ts +4 -2
- package/dist/generated/modelValidation.d.ts.map +1 -1
- package/dist/generated/modelValidation.js +20 -10
- package/dist/generated/modelValidation.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,47 +1,48 @@
|
|
|
1
1
|
# Changelog — Epistola Node.js Client
|
|
2
2
|
|
|
3
|
-
All notable changes to the `@epistola.app/epistola-client`
|
|
3
|
+
All notable changes to the `@epistola.app/epistola-client` package are documented here.
|
|
4
4
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). This package's
|
|
6
6
|
version tracks the Epistola contract version (`info.version` in the OpenAPI spec), so it releases in
|
|
7
|
-
lockstep with the other generated artifacts
|
|
8
|
-
records contract
|
|
7
|
+
lockstep with the other generated artifacts. The repository-level [CHANGELOG](../../../../CHANGELOG.md)
|
|
8
|
+
records contract changes; this file records changes to the hand-written library only.
|
|
9
9
|
|
|
10
10
|
## [Unreleased]
|
|
11
11
|
|
|
12
|
+
## [1.4.0] - 2026-09-30
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- A date property that is `null` in a response is read as `null` instead of `undefined`, matching
|
|
17
|
+
its declared `Date | null` type. Code that checks such a field with `=== undefined` must also
|
|
18
|
+
handle `null`.
|
|
19
|
+
|
|
20
|
+
## [1.3.1] - 2026-09-21
|
|
21
|
+
|
|
22
|
+
### Changed
|
|
23
|
+
|
|
24
|
+
- `JwtSigner` is documented as **experimental**: Epistola Suite may not implement self-signed JWT
|
|
25
|
+
authentication yet. The README's quick start authenticates with an API key.
|
|
26
|
+
|
|
27
|
+
## [1.3.0] - 2026-09-21
|
|
28
|
+
|
|
12
29
|
### Added
|
|
13
30
|
|
|
14
|
-
- **Initial release
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
- `EpistolaClient
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- `
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
it) zstd decompression chosen by sniffing the stream rather than trusting `Content-Encoding`,
|
|
33
|
-
adaptive polling floored at the minimum interval, sequence-based acknowledgement that leaves a
|
|
34
|
-
batch unacknowledged when the handler throws, and murmur3 partition-routing helpers.
|
|
35
|
-
- Client-side JSON Schema validation of template data (`TemplateSchemaValidator`,
|
|
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.
|
|
41
|
-
- `CONTRACT_OPERATIONS` — the method, path template and declared response media types of every
|
|
42
|
-
operation, generated from the spec. The generated API classes set `Content-Type` but never
|
|
43
|
-
`Accept`, and Node's `fetch` sends `*/*` by default, so the client asks for exactly what each
|
|
44
|
-
operation is declared to return — the problem document included.
|
|
45
|
-
- A problem-registry guard test keeping the hand-written problem-type base in sync with the value
|
|
46
|
-
the build-time generator derives from the spec, and a driver for the cross-client conformance
|
|
47
|
-
suite, which holds this client to the same wire behaviour as the other four.
|
|
31
|
+
- **Initial release:** a TypeScript client on the platform's `fetch`, generated with OpenAPI
|
|
32
|
+
Generator (`typescript-fetch`), at feature parity with the Kotlin, Jakarta EE, .NET and Python
|
|
33
|
+
clients. It has no runtime dependencies.
|
|
34
|
+
- `EpistolaClient`: one entry point that assembles identity, API-key or JWT authentication, the
|
|
35
|
+
`Accept` header and RFC 9457 problem parsing. Problem parsing is always installed.
|
|
36
|
+
- `ClientIdentity`: the required `User-Agent` and `X-EP-Node-Id` headers, generated from
|
|
37
|
+
`x-client-identity`.
|
|
38
|
+
- `JwtSigner`: self-signed RS256 and ES256 JWT bearer authentication on `node:crypto`.
|
|
39
|
+
- `ProblemDetailException`: extends the generated `ResponseError` with `typeSlug`, `errors`,
|
|
40
|
+
`validationErrors` and a catch-all `extensions` map. `KnownProblemSlugs` is generated from
|
|
41
|
+
`x-problem-types`.
|
|
42
|
+
- `ResultCollector`: constant-memory NDJSON result streaming with gzip and, where Node supports
|
|
43
|
+
it, zstd, detected from the stream. It polls adaptively, leaves a batch unacknowledged when the
|
|
44
|
+
handler throws, and provides murmur3 partition routing.
|
|
45
|
+
- Client-side JSON Schema validation (`TemplateSchemaValidator`, `ValidatingGenerationApi`) on
|
|
46
|
+
Ajv, an optional peer dependency loaded on first use, and generated `validate<Model>` helpers.
|
|
47
|
+
- `CONTRACT_OPERATIONS`, generated from the spec, so each request asks for exactly the media
|
|
48
|
+
types its operation declares.
|
package/README.md
CHANGED
|
@@ -11,9 +11,9 @@ It adds, on top of the stock generated client:
|
|
|
11
11
|
- **Client identity** headers (`User-Agent` + `X-EP-Node-Id`) required on every request.
|
|
12
12
|
- **RFC 9457 problem-detail** error handling — a typed `ProblemDetailException` with a `typeSlug`
|
|
13
13
|
discriminator and generated `KnownProblemSlugs` constants.
|
|
14
|
-
- **
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
- **Static API-key** authentication via `Authorization: ApiKey <key>`, the supported method.
|
|
15
|
+
- **Self-signed JWT** authentication (`JwtSigner`, **experimental**), minting a fresh short-lived
|
|
16
|
+
token per request on `node:crypto` alone.
|
|
17
17
|
- **The `Accept` header each operation is declared with.** The generated classes never set one, and
|
|
18
18
|
Node's `fetch` sends `*/*` by default — so without this a request never says it accepts
|
|
19
19
|
`application/problem+json`, the document every error handler here is built to parse.
|
|
@@ -42,32 +42,38 @@ npm install @epistola.app/epistola-client
|
|
|
42
42
|
## Quick start
|
|
43
43
|
|
|
44
44
|
```ts
|
|
45
|
-
import { ClientIdentity, EpistolaClient,
|
|
45
|
+
import { ClientIdentity, EpistolaClient, TemplatesApi } from '@epistola.app/epistola-client'
|
|
46
46
|
|
|
47
47
|
const identity = ClientIdentity.builder()
|
|
48
48
|
.nodeId('my-pod-123') // defaults to the hostname
|
|
49
49
|
.product('my-app', '1.0.0') // appended to User-Agent
|
|
50
50
|
.build()
|
|
51
51
|
|
|
52
|
-
const signer = JwtSigner.builder()
|
|
53
|
-
.consumerId('invoice-service')
|
|
54
|
-
.privateKey(JwtSigner.loadPrivateKey('private.pem'))
|
|
55
|
-
.build()
|
|
56
|
-
|
|
57
52
|
const client = EpistolaClient.builder('https://epistola.example.com/api')
|
|
58
53
|
.identity(identity) // User-Agent + X-EP-Node-Id
|
|
59
|
-
.
|
|
54
|
+
.apiKey('epk_...') // Authorization: ApiKey <key>
|
|
60
55
|
.build()
|
|
61
56
|
|
|
62
57
|
const templates = new TemplatesApi(client)
|
|
63
58
|
const template = await templates.getTemplate({ tenantId: 'acme', catalogId: 'invoices', templateId: 'invoice' })
|
|
64
59
|
```
|
|
65
60
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
61
|
+
`EpistolaClient.builder(baseUrl, apiKey)` is a shorthand for the same thing. The legacy `X-API-Key`
|
|
62
|
+
header is not sent: it remains supported server-side but is deprecated. Some Epistola Suite
|
|
63
|
+
deployments disable API-key authentication entirely; switch on
|
|
64
|
+
`e.typeSlug === KnownProblemSlugs.API_KEY_AUTH_DISABLED` and guide the caller to JWT auth.
|
|
65
|
+
|
|
66
|
+
Self-signed JWT authentication is **experimental**: Epistola Suite may not implement it yet, and the
|
|
67
|
+
flow may still change. To try it, pass `.jwtSigner(signer)` instead of `.apiKey(...)`:
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
import { JwtSigner } from '@epistola.app/epistola-client'
|
|
71
|
+
|
|
72
|
+
const signer = JwtSigner.builder()
|
|
73
|
+
.consumerId('invoice-service')
|
|
74
|
+
.privateKey(JwtSigner.loadPrivateKey('private.pem'))
|
|
75
|
+
.build()
|
|
76
|
+
```
|
|
71
77
|
|
|
72
78
|
`EpistolaClient` *is* a generated `Configuration`, so every generated API class takes it directly.
|
|
73
79
|
One builder can produce more than one client: call `build()` again after changing
|
package/dist/auth/jwtSigner.d.ts
CHANGED
|
@@ -4,6 +4,9 @@ export type JwtAlgorithm = 'RS256' | 'ES256';
|
|
|
4
4
|
/**
|
|
5
5
|
* Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
|
|
6
6
|
*
|
|
7
|
+
* **Experimental.** Epistola Suite may not implement self-signed JWT authentication yet, and the
|
|
8
|
+
* flow may still change. Use API-key authentication (`apiKey`) for production integrations.
|
|
9
|
+
*
|
|
7
10
|
* Each token carries:
|
|
8
11
|
* - `iss` — the consumer ID
|
|
9
12
|
* - `iat` — issued-at
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jwtSigner.d.ts","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAA;AAGhF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAA;AAI5C
|
|
1
|
+
{"version":3,"file":"jwtSigner.d.ts","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAIA,OAAO,EAAsC,KAAK,SAAS,EAAE,MAAM,aAAa,CAAA;AAGhF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,OAAO,CAAA;AAI5C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,SAAS;IAElB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,YAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IALvC,OAAO,eAMH;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO,IAAI,gBAAgB,CAEjC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAE7C;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMzD;IAED,sEAAsE;IACtE,WAAW,IAAI,MAAM,CAWpB;IAED,OAAO,CAAC,IAAI;IAOZ,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAElG;CACF;AAED,4CAA4C;AAC5C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,yBAAyB,CAAiC;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAMnC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAGtC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAM1C;IAED,8CAA8C;IAC9C,KAAK,IAAI,SAAS,CAQjB;CACF"}
|
package/dist/auth/jwtSigner.js
CHANGED
|
@@ -7,6 +7,9 @@ const DEFAULT_TOKEN_LIFETIME_SECONDS = 60;
|
|
|
7
7
|
/**
|
|
8
8
|
* Mints the short-lived self-signed JWTs Epistola accepts for consumer authentication.
|
|
9
9
|
*
|
|
10
|
+
* **Experimental.** Epistola Suite may not implement self-signed JWT authentication yet, and the
|
|
11
|
+
* flow may still change. Use API-key authentication (`apiKey`) for production integrations.
|
|
12
|
+
*
|
|
10
13
|
* Each token carries:
|
|
11
14
|
* - `iss` — the consumer ID
|
|
12
15
|
* - `iat` — issued-at
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jwtSigner.js","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAKtC,MAAM,8BAA8B,GAAG,EAAE,CAAA;AAEzC
|
|
1
|
+
{"version":3,"file":"jwtSigner.js","sourceRoot":"","sources":["../../src/auth/jwtSigner.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAKtC,MAAM,8BAA8B,GAAG,EAAE,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,SAAS;IAED,UAAU;IACV,UAAU;IAElB,SAAS;IACD,oBAAoB;IALvC,YACmB,UAAkB,EAClB,UAAqB;IACtC,oEAAoE;IAC3D,SAAuB,EACf,oBAA4B;0BAJ5B,UAAU;0BACV,UAAU;yBAElB,SAAS;oCACD,oBAAoB;IACpC,CAAC;IAEJ,8CAA8C;IAC9C,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;IAED,yFAAyF;IACzF,MAAM,CAAC,cAAc,CAAC,IAAY;QAChC,OAAO,SAAS,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,sFAAsF;IACtF,MAAM,CAAC,kBAAkB,CAAC,GAAoB;QAC5C,IAAI,CAAC;YACH,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,SAAS,CAAC,uFAAuF,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;QAClD,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,IAAI,CAAC,UAAU;YACpB,GAAG,EAAE,UAAU;YACf,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC,oBAAoB;YAC3C,GAAG,EAAE,UAAU,EAAE;SAClB,CAAA;QACD,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;QAChG,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAA;IAC3E,CAAC;IAEO,IAAI,CAAC,YAAoB;QAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO;YAC/B,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IAC3C,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,QAAQ,CAAC,UAAkB,EAAE,UAAqB,EAAE,oBAA4B;QACrF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC,CAAA;IACjG,CAAC;CACF;AAED,4CAA4C;AAC5C,MAAM,OAAO,gBAAgB;IACnB,eAAe,CAAoB;IACnC,eAAe,CAAuB;IACtC,yBAAyB,GAAG,8BAA8B,CAAA;IAElE,mDAAmD;IACnD,UAAU,CAAC,UAAkB;QAC3B,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAqB;QAC9B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,+CAA+C;IAC/C,oBAAoB,CAAC,OAAe;QAClC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,OAAO,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,8CAA8C;IAC9C,KAAK;QACH,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACvG,CAAC;CACF;AAED,SAAS,eAAe,CAAC,GAAc;IACrC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,oCAAoC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAA;IACzE,CAAC;IACD,QAAQ,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC9B,KAAK,KAAK;YACR,OAAO,OAAO,CAAA;QAChB,KAAK,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,GAAG,GAAG,CAAC,oBAAoB,EAAE,UAAU,CAAA;YAClD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;gBAC3B,MAAM,IAAI,SAAS,CAAC,yBAAyB,KAAK,IAAI,SAAS,iCAAiC,CAAC,CAAA;YACnG,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD;YACE,MAAM,IAAI,SAAS,CAAC,yBAAyB,GAAG,CAAC,iBAAiB,IAAI,SAAS,sCAAsC,CAAC,CAAA;IAC1H,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;AACzD,CAAC"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Epistola API
|
|
3
|
-
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **Bearer JWT
|
|
3
|
+
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.4.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,40 +10,109 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime.js';
|
|
13
|
-
import type
|
|
13
|
+
import { type AttributeDto } from '../models/AttributeDto.js';
|
|
14
|
+
import { type AttributeListResponse } from '../models/AttributeListResponse.js';
|
|
15
|
+
import { type CreateAttributeRequest } from '../models/CreateAttributeRequest.js';
|
|
16
|
+
import { type UpdateAttributeRequest } from '../models/UpdateAttributeRequest.js';
|
|
14
17
|
export interface CreateAttributeOperationRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Unique slug identifier of the tenant (e.g., "acme-corp")
|
|
20
|
+
*/
|
|
15
21
|
tenantId: string;
|
|
22
|
+
/**
|
|
23
|
+
* Slug identifier of the catalog
|
|
24
|
+
*/
|
|
16
25
|
catalogId: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
17
29
|
createAttributeRequest: CreateAttributeRequest;
|
|
18
30
|
}
|
|
19
31
|
export interface DeleteAttributeRequest {
|
|
32
|
+
/**
|
|
33
|
+
* Unique slug identifier of the tenant (e.g., "acme-corp")
|
|
34
|
+
*/
|
|
20
35
|
tenantId: string;
|
|
36
|
+
/**
|
|
37
|
+
* Slug identifier of the catalog
|
|
38
|
+
*/
|
|
21
39
|
catalogId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The attribute key (e.g., "language", "brand")
|
|
42
|
+
*/
|
|
22
43
|
attributeKey: string;
|
|
23
44
|
}
|
|
24
45
|
export interface GetAttributeRequest {
|
|
46
|
+
/**
|
|
47
|
+
* Unique slug identifier of the tenant (e.g., "acme-corp")
|
|
48
|
+
*/
|
|
25
49
|
tenantId: string;
|
|
50
|
+
/**
|
|
51
|
+
* Slug identifier of the catalog
|
|
52
|
+
*/
|
|
26
53
|
catalogId: string;
|
|
54
|
+
/**
|
|
55
|
+
* The attribute key (e.g., "language", "brand")
|
|
56
|
+
*/
|
|
27
57
|
attributeKey: string;
|
|
28
58
|
}
|
|
29
59
|
export interface ListAttributesRequest {
|
|
60
|
+
/**
|
|
61
|
+
* Unique slug identifier of the tenant (e.g., "acme-corp")
|
|
62
|
+
*/
|
|
30
63
|
tenantId: string;
|
|
64
|
+
/**
|
|
65
|
+
* Slug identifier of the catalog
|
|
66
|
+
*/
|
|
31
67
|
catalogId: string;
|
|
68
|
+
/**
|
|
69
|
+
* Page number (0-based)
|
|
70
|
+
*/
|
|
32
71
|
page?: number;
|
|
72
|
+
/**
|
|
73
|
+
* Number of items per page
|
|
74
|
+
*/
|
|
33
75
|
size?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Field to sort by. The set of allowed fields depends on the resource; an
|
|
78
|
+
* unsupported value is rejected by the server, which also applies the
|
|
79
|
+
* per-resource default when omitted.
|
|
80
|
+
*
|
|
81
|
+
*/
|
|
34
82
|
sort?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Sort direction, applied when a `sort` field is selected. An unsupported value
|
|
85
|
+
* is rejected.
|
|
86
|
+
*
|
|
87
|
+
*/
|
|
35
88
|
direction?: ListAttributesDirectionEnum;
|
|
36
89
|
}
|
|
37
90
|
export interface UpdateAttributeOperationRequest {
|
|
91
|
+
/**
|
|
92
|
+
* Unique slug identifier of the tenant (e.g., "acme-corp")
|
|
93
|
+
*/
|
|
38
94
|
tenantId: string;
|
|
95
|
+
/**
|
|
96
|
+
* Slug identifier of the catalog
|
|
97
|
+
*/
|
|
39
98
|
catalogId: string;
|
|
99
|
+
/**
|
|
100
|
+
* The attribute key (e.g., "language", "brand")
|
|
101
|
+
*/
|
|
40
102
|
attributeKey: string;
|
|
103
|
+
/**
|
|
104
|
+
*
|
|
105
|
+
*/
|
|
41
106
|
updateAttributeRequest: UpdateAttributeRequest;
|
|
42
107
|
}
|
|
43
108
|
/**
|
|
44
109
|
*
|
|
45
110
|
*/
|
|
46
111
|
export declare class AttributesApi extends runtime.BaseAPI {
|
|
112
|
+
/**
|
|
113
|
+
* Creates request options for createAttribute without sending the request
|
|
114
|
+
*/
|
|
115
|
+
createAttributeRequestOpts(requestParameters: CreateAttributeOperationRequest): Promise<runtime.RequestOpts>;
|
|
47
116
|
/**
|
|
48
117
|
* Create a new attribute definition for the specified tenant.
|
|
49
118
|
* Create a new attribute definition
|
|
@@ -54,6 +123,10 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
54
123
|
* Create a new attribute definition
|
|
55
124
|
*/
|
|
56
125
|
createAttribute(requestParameters: CreateAttributeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeDto>;
|
|
126
|
+
/**
|
|
127
|
+
* Creates request options for deleteAttribute without sending the request
|
|
128
|
+
*/
|
|
129
|
+
deleteAttributeRequestOpts(requestParameters: DeleteAttributeRequest): Promise<runtime.RequestOpts>;
|
|
57
130
|
/**
|
|
58
131
|
* Delete an attribute definition. Existing variant attributes using this key are not affected.
|
|
59
132
|
* Delete an attribute definition
|
|
@@ -64,6 +137,10 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
64
137
|
* Delete an attribute definition
|
|
65
138
|
*/
|
|
66
139
|
deleteAttribute(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Creates request options for getAttribute without sending the request
|
|
142
|
+
*/
|
|
143
|
+
getAttributeRequestOpts(requestParameters: GetAttributeRequest): Promise<runtime.RequestOpts>;
|
|
67
144
|
/**
|
|
68
145
|
* Retrieve a specific attribute definition by key.
|
|
69
146
|
* Get an attribute definition
|
|
@@ -74,6 +151,10 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
74
151
|
* Get an attribute definition
|
|
75
152
|
*/
|
|
76
153
|
getAttribute(requestParameters: GetAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeDto>;
|
|
154
|
+
/**
|
|
155
|
+
* Creates request options for listAttributes without sending the request
|
|
156
|
+
*/
|
|
157
|
+
listAttributesRequestOpts(requestParameters: ListAttributesRequest): Promise<runtime.RequestOpts>;
|
|
77
158
|
/**
|
|
78
159
|
* Retrieve all attribute definitions configured for a specific tenant. Attribute definitions describe the keys that can be used for variant selection.
|
|
79
160
|
* List attribute definitions for a tenant
|
|
@@ -84,6 +165,10 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
84
165
|
* List attribute definitions for a tenant
|
|
85
166
|
*/
|
|
86
167
|
listAttributes(requestParameters: ListAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeListResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* Creates request options for updateAttribute without sending the request
|
|
170
|
+
*/
|
|
171
|
+
updateAttributeRequestOpts(requestParameters: UpdateAttributeOperationRequest): Promise<runtime.RequestOpts>;
|
|
87
172
|
/**
|
|
88
173
|
* Update the description of an existing attribute definition.
|
|
89
174
|
* Update an attribute definition
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AttributesApi.d.ts","sourceRoot":"","sources":["../../../../src/generated/api/apis/AttributesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;
|
|
1
|
+
{"version":3,"file":"AttributesApi.d.ts","sourceRoot":"","sources":["../../../../src/generated/api/apis/AttributesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EACH,KAAK,YAAY,EAGpB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,KAAK,qBAAqB,EAG7B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACH,KAAK,sBAAsB,EAG9B,MAAM,qCAAqC,CAAC;AAM7C,OAAO,EACH,KAAK,sBAAsB,EAG9B,MAAM,qCAAqC,CAAC;AAO7C,MAAM,WAAW,+BAA+B;IAC5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;CAClD;AAED,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,2BAA2B,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;CAClD;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,OAAO,CAAC,OAAO;IAE9C;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAwDjH;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKnL;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG3J;IAED;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAsDxG;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAKlK;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1I;IAED;;OAEG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAsDlG;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKpK;IAED;;;OAGG;IACG,YAAY,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG5I;IAED;;OAEG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CA8DtG;IAED;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAKjL;IAED;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAGzJ;IAED;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAgEjH;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKnL;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG3J;CAEJ;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B;aACpC,GAAG,EAAE,KAAK;aACV,IAAI,EAAE,MAAM;CACN,CAAC;AACX,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC"}
|