Document Type Types

Python SDK - Document Type type definitions

Types for document type operations.

DocumentType

A document type definition.

Fields:

  • codeType: str - Unique document type code.

  • createdAt: datetime | None - Creation timestamp.

  • description: str | None - Document type description.

  • id: str - Unique document type ID.

  • isDraft: bool - Indicates if the document type is a draft.

  • isPublic: bool - Indicates if the document type is public.

  • model_config: Any

  • name: str - Document type name.

  • schema_: dict[str, Any] | None - JSON schema for the document type (when retrieved by ID).

  • updatedAt: datetime | None - Last update timestamp.

ValidationErrorInfo

Validation error information.

Fields:

  • count: int - Total number of errors found.

  • messages: list[str] - List of descriptive error messages.

  • model_config: Any

ValidationResult

Result of JSON validation against a document type schema.

Fields:

  • errors: ValidationErrorInfo - Validation errors.

  • model_config: Any

  • warnings: ValidationWarningInfo - Validation warnings.

ValidationWarningInfo

Validation warning information.

Fields:

  • count: int - Total number of warnings found.

  • messages: list[str] - List of descriptive warning messages.

  • model_config: Any

On this page