Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 3.76 KB

classcheckin.md

File metadata and controls

37 lines (31 loc) · 3.76 KB

ClassCheckin

Schema representing a checkin for a class

Example Usage

import { ClassCheckin } from "@pushpress/pushpress/models/components";

let value: ClassCheckin = {
  id: "chk_12345",
  customer: "usr_12345",
  company: "cli_12345",
  name: "My Class",
  typeId: "cit_12345",
  type: {
    id: "cit_12345",
    name: "Group HIIT Training",
  },
  timestamp: 1672531200000,
  role: "attendee",
};

Fields

Field Type Required Description
id string ✔️ Unique identifier for the checkin record
customer string ✔️ UUID of the customer who checked in
company string ✔️ UUID of the company hosting the class
name string ✔️ Name of the class that the customer checked into
typeId string ✔️ UUID of the class type
type components.ClassCheckinType ✔️ Detailed information about the type of the class
kind string ✔️ Indicates that this checkin is for a class
timestamp number ✔️ Unix timestamp representing the time of checkin
role components.ClassCheckinRole ✔️ Role of the customer in the class