type: object

required:
  - event
  - description
  - action_required

properties:
  event:
    type: string
    enum:
      - package_accepted
      - package_arrived
      - package_departed
      - package_processing
      - package_processed
      - package_in_local_area
      - delivery_scheduled
      - out_for_delivery
      - pickup_available
      - delivered
      - package_forwarded
      - returned_to_sender
      - address_issue
      - contact_carrier
      - delayed
      - delivery_attempted
      - delivery_rescheduled
      - location_inaccessible
      - notice_left
      - package_damaged
      - package_disposed
      - package_held
      - package_lost
      - package_unclaimed
      - package_undeliverable
      - reschedule_delivery
      - other
    description: |
      Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event:
      * `package_accepted` - Package has been accepted into the carrier network for delivery.
      * `package_arrived` - Package has arrived at an intermediate location in the carrier network.
      * `package_departed` - Package has departed from an intermediate location in the carrier network.
      * `package_processing` - Package is processing at an intermediate location in the carrier network.
      * `package_processed` - Package has been processed at an intermediate location.
      * `package_in_local_area` - Package is at a location near the end destination.
      * `delivery_scheduled` - Package is scheduled for delivery.
      * `out_for_delivery` - Package is out for delivery.
      * `pickup_available` - Package is available for pickup at carrier location.
      * `delivered` - Package has been delivered.
      * `package_forwarded` - Package has been forwarded.
      * `returned_to_sender` - Package is to be returned to sender.
      * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery.
      * `contact_carrier` - Contact the carrier for more information.
      * `delayed` - Delivery of package is delayed.
      * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery.
      * `delivery_rescheduled` - Delivery of package has been rescheduled.
      * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery.
      * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice.
      * `package_damaged` - Package has been damaged. Contact carrier for more details.
      * `package_disposed` - Package has been disposed.
      * `package_held` - Package held at carrier location. Contact carrier for more details.
      * `package_lost` - Package has been lost. Contact carrier for more details.
      * `package_unclaimed` - Package is unclaimed.
      * `package_undeliverable` - Package is not able to be delivered.
      * `reschedule_delivery` - Contact carrier to reschedule delivery.
      * `other` - Unrecognized carrier status.

  description:
    type: string
    description: The description as listed in the description for event.

  notes:
    type: string
    description: Event-specific notes from USPS about the tracking event.

  action_required:
    type: boolean
    description: >
      `true` if action is required by the end recipient, `false` otherwise.