Expand description
Normalized core entity contracts for locations, customers, pets, reservations, and records. Core pet-resort entities and operational records.
§Operator-summary
This module supports the shared staff view of pets, customers, reservations, care profiles, documents, vaccine records, care notes, incidents, messages, and approval records. It can reduce labor by keeping the facts needed for triage, safety review, handoff, document review, customer-message approval, and manager queues in one normalized shape instead of scattering them across source-system payloads and free-text notes.
It must not automate live booking changes, provider writes, customer sends, payment/refund actions, medical/vaccine/behavior decisions, incident closure, or policy exceptions. Authoritative facts remain the named source record, source document/storage object, policy snapshot, reviewer approval, audit event, and typed domain value for each field. Review gates protect pets, customers, and staff by tying sensitive records to explicit approval targets and lifecycle states before downstream workflows may treat them as cleared.
These structs and enums are the normalized domain facts used by workflow, policy, storage, and source adapters. They should be read as normalized operating records: every field is either a source-backed fact, a reviewable derived state, or a safety/labor signal used to reduce manual resort work without bypassing manager, medical, behavior, payment, or customer-message gates.
Modules§
- approval
- Approval record vocabulary for review-gated automation outcomes.
- audit
- Audit vocabulary for source-backed event trails across automated and staff actions.
- care_
note - Care-note vocabulary for staff-visible, customer-visible, and internal handoff notes.
- reservation
- Reservation-facing source vocabulary embedded in core entity records.
Structs§
- Care
Note - Care note with author, visibility, subject, body, source, and review-sensitive timestamps.
- Care
Note Builder - Use builder syntax to set the inputs and finish with
build(). - Care
Profile - Feeding, medication, handling, and special-care summary used for staff handoffs and briefings.
- Customer
- Customer/account profile used for reservation ownership, consent-sensitive messaging, and follow-up work.
- Customer
Builder - Use builder syntax to set the inputs and finish with
build(). - Customer
Id - Stable identifier for the customer/account responsible for pets, reservations, messages, and payments.
- Document
- Document record tying storage, classification, source, scan, redaction, and review status together.
- Document
Builder - Use builder syntax to set the inputs and finish with
build(). - Document
Id - Stable identifier for a document artifact used as vaccine, waiver, medical, or incident evidence.
- Incident
- Incident record used for manager attention, safety follow-up, customer messaging, and audit evidence.
- Incident
Builder - Use builder syntax to set the inputs and finish with
build(). - Incident
Id - Stable identifier for a pet, customer, or operational incident requiring evidence and follow-up.
- Location
- Resort location record that scopes local capabilities, timezone, brand, and policy references.
- Location
Id - Stable identifier for a resort location across source imports, policies, reports, and workflows.
- Location
Policy Refs - References to the local policy set that controls automation, vaccine, and play-safety decisions.
- Manager
Id - Manager identifier used when approvals, overrides, or escalations require accountable leadership.
- Medication
Instruction - Medication instruction that must remain explicit for care safety and shift handoff evidence.
- Medication
Instruction Builder - Use builder syntax to set the inputs and finish with
build(). - Message
- Customer/internal message record that tracks subject, channel, draft/reference body, approval, and delivery state.
- Message
Builder - Use builder syntax to set the inputs and finish with
build(). - Message
Id - Stable identifier for a customer or internal message workflow.
- Pet
- Pet profile carrying identity, species, age, sex, sterilization, temperament, and care facts for safe service decisions.
- PetBuilder
- Use builder syntax to set the inputs and finish with
build(). - PetId
- Stable identifier for a pet whose care, temperament, vaccine, and reservation facts drive safety decisions.
- Portal
Account Ref - Link to the customer portal account that supplied or owns source records.
- Reservation
- Reservation record tying customer, pet, service, status, deposit, add-ons, and safety stops together.
- Reservation
Builder - Use builder syntax to set the inputs and finish with
build(). - StaffId
- Temperament
Profile - Temperament evidence used to decide group-play, individual care, and behavior-review routing.
- Temperament
Profile Builder - Use builder syntax to set the inputs and finish with
build(). - Vaccine
Record - Vaccine compliance record linking pet, vaccine name, expiration, proof document, and review status.
- Vaccine
Record Builder - Use builder syntax to set the inputs and finish with
build(). - Vaccine
Record Id - Stable identifier for a vaccine compliance record tied to a pet and proof document.
Enums§
- Actor
Ref - Actor that performed or is accountable for an audited action.
- AddOn
- Optional reservation add-ons that affect labor, revenue, care planning, or customer follow-up.
- Brand
- Brand family used to group multi-site operating records without losing local resort identity.
- Contact
Channel - Customer contact channel preference or observed route used by draft/message workflows.
- Document
Subject - Entity or workflow subject a document is evidence for.
- Hard
Stop - Non-ignorable condition that blocks or routes a reservation before staff or customer action proceeds.
- Incident
Subject - Entity or workflow subject affected by an incident.
- Manager
IdError - Message
Subject - Entity or workflow subject that a message refers to.
- Portal
Provider - Portal provider that owns the account or operational record.
- Service
Kind - Resort service line used for labor planning, capacity, policy, upsell, and workflow routing.
- Sex
- Recorded pet sex when the source system supplies it.
- Spay
Neuter Status - Spay/neuter status used by group-play eligibility, safety review, and policy gating.
- Species
- Pet species category used by boarding/daycare/play policies and labor planning.
- Staff
IdError
Type Aliases§
- Deposit
- Shared deposit type used by reservation, payment, and approval records.
- Payment
Status - Shared payment status used by checkout, deposit, refund, and approval records.