Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.18 KB

Program.md

File metadata and controls

42 lines (26 loc) · 1.18 KB

Program

A loyalty program.

Properties

Name Type Description
id String Unique program identifier.
name String Program name.
status StatusEnum Program status.
startDate OffsetDateTime Program validity start date (ISO 8601), or `null` when not set.
endDate OffsetDateTime Program validity end date (ISO 8601), or `null` when not set.
validityHours ProgramValidityHours
metadata Object Arbitrary key-value metadata. Defaults to `{}`.
createdAt OffsetDateTime Creation timestamp (ISO 8601).
updatedAt OffsetDateTime Last update timestamp (ISO 8601), or `null` when never updated.
_object ObjectEnum Object type marker.

Enum: StatusEnum

Name Value
DRAFT "DRAFT"
ACTIVE "ACTIVE"
INACTIVE "INACTIVE"
DELETED "DELETED"

Enum: ObjectEnum

Name Value
PROGRAM "program"