// -----------------------------------------------------------------------------
// Enum Typedefs
// -----------------------------------------------------------------------------

/**
 * Error types for field validation.
 * @typedef {"isNull" | "isEmpty" | "minimumLength" | "maximumLength" | "pattern" | "syntax"} FieldValidationErrorType
 */

// -----------------------------------------------------------------------------
// Model Typedefs
// -----------------------------------------------------------------------------

/**
 * A response object for field 409 conflict errors resulting from trying to create a resource that already exists.
 * @typedef {Object} ConflictResourceExistsResponse
 * @property {number} status The response status.
 * @property {string} message The response message.
 */

/**
 * Error description object for a single field.
 * @typedef {Object} FieldValidationError
 * @property {string} path The object path of the field.
 * @property {string} message A user friendly error message.
 */

/**
 * A single validation error description.
 * @typedef {Object} FieldValidationErrorEntry
 * @property {string} message A user friendly error message.
 * @property {FieldValidationErrorType} errors A field validation type.
 */

/**
 * A response object for field validation errors.
 * @typedef {Object} FieldValidationResponse
 * @property {number} status The response status.
 * @property {string} message The response message.
 * @property {FieldValidationError[]} errors A set of field validation errors.
 */

// -----------------------------------------------------------------------------
// Union Typedefs
// -----------------------------------------------------------------------------