DoCurious API Reference / types / TeacherInvitation

Interface: TeacherInvitation

Defined in: types/school.types.ts:432

A pending email invitation for a teacher to join the school.

Remarks

Created when an SA invites a teacher by email. The teacher receives a link with a token to accept. Invitations expire after 30 days.

Extends

• BaseEntity

Properties

acceptedAt?

optional acceptedAt: string

Defined in: types/school.types.ts:439

---

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt

---

department?

optional department: string

Defined in: types/school.types.ts:436

---

email

email: string

Defined in: types/school.types.ts:434

---

expiresAt

expiresAt: string

Defined in: types/school.types.ts:440

---

id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id

---

invitedByUserId

invitedByUserId: string

Defined in: types/school.types.ts:437

---

role

role: "teacher" | "staff" | "admin"

Defined in: types/school.types.ts:435

---

schoolId

schoolId: string

Defined in: types/school.types.ts:433

---

status

status: "pending" | "cancelled" | "accepted" | "expired"

Defined in: types/school.types.ts:438

---

token

token: string

Defined in: types/school.types.ts:442

Shareable invite token

---

updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt