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

/**
 * @typedef {"HEALTHY" | "UNHEALTHY"} HealthCode
 */

/**
 * @typedef {"id" | "createdAt" | "updatedAt"} ObjectSortField
 */

/**
 * @typedef {"STARTING_UP" | "RUNNING" | "SHUTTING_DOWN"} ServiceStatus
 */

/**
 * @typedef {"asc" | "desc"} SortOrder
 */

/**
 * @typedef {"name" | "createdAt" | "updatedAt"} TagSortField
 */

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

/**
 * A response model for the standard health check resource.
 * @typedef {Object} HealthCheck
 * @property {HealthCode} health A general health status code.
 * @property {ServiceStatus} status A general service status code.
 */

/**
 * Encapsulates an Object UUID Id.
 * @typedef {Object} ObjectId
 * @property {string} id The tag services guid for this ObjectId.
 * @property {string} externalId The external caller systems resource id for this Object.
 * @property {string} [description] A short description of this object.
 */

/**
 * A slice of a set of objects.
 * @typedef {Object} ObjectsSlice
 * @property {Slice} slice The slice data for this slice.
 * @property {ObjectId[]} objects A set of ObjectId's for this slice.
 */

/**
 * An cursor Slice for iterating through sets.
 * @typedef {Object} Slice
 * @property {number} number The number of the current Slice.
 * @property {number} numberOfElements The number of elements currently on this Slice.
 * @property {number} size The size of this Slice.
 * @property {boolean} hasContent Is there any content for this Slice.
 * @property {boolean} hasNext Is there is a next Slice.
 * @property {boolean} hasPrevious Is there is a previous Slice.
 * @property {boolean} isFirst Is this the first Slice.
 * @property {boolean} isLast Is this the last Slice.
 */

/**
 * A field and an order used to sort sets.
 * @typedef {Object} SortField
 * @property {TagSortField} field The field you want to sort on.
 * @property {SortOrder} order The order you want to sort.
 */

/**
 * A tag.
 * @typedef {Object} Tag
 * @property {string} id A UUID string for this tag.
 * @property {string} value The tag value
 */

/**
 * A form for creating a tag object.
 * @typedef {Object} TagForm
 * @property {string} value The tag value
 */

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