From ReminderEventMetadata.schema.yaml (cleo/ReminderEventMetadata.schema)
---
$id: https://skeleton.botmd.io/cleo/ReminderEventMetadata.schema
$schema: http://json-schema.org/draft-07/schema#
title: Reminder Event Metadata
description: Schema to describe how the reminder event metadata will look like.
additionalProperties: false
required: []
properties:
status:
title: Status
description: >-
Status of this reminder event.
1. `queued`: The reminder has been queued by the job scheduler (i.e., celery) but has yet to be processed.
2. `processing`: The reminder has been processed by the scheduler (i.e., celery) but the final outcome is not known yet. In this stage, no attempts will be made at all.
3. `delivered`: The reminder has been delivered by the Ratatoskr provider (i.e., a `Delivery` object has been created).
3. `completed`: The reminder action has been performed. Note that this is the equivalent of `delivered` for non-delivery actions.
4. `failed`: The reminder has been considered a failure and no more attempts will be made. Examples includes missing delivery object for `SendTemplate` action.
5. `skipped`: The reminder has been skipped because the patient already has a recent submission.
enum: [queued, processing, delivered, completed, failed, skipped]
first_reminder:
title: Follow Up
description: For follow up reminder events, this object will contain metadata about the first reminder.
type: object
additionalProperties: false
required: [uid, interval]
properties:
uid:
title: UID
description: UID for first reminder event.
type: string
minLength: 1
interval:
title: Interval
description: This is the interval between this current reminder event and the first reminder event.
type: number
exclusiveMinimum: 0
#end properties
#end properties