Class data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
descriptionstringNo
mediaLmsMedia[]No
media[].urlstringNo
media[].namestringNo
media[].descriptionstringNo
media[].typeenumNoValues: IMAGE, HEADSHOT, VIDEO, WEB, DOCUMENT, TEXT, HTML, OTHER
media[].thumbnail_urlstringNo
media[].contentstringNoInline text/HTML/markdown content (use when url is empty or for embedded content)
media[].languagesstring[]NoISO 2-digit language codes
course_idstringNo(reference to Course)
languagesstring[]No
instructorsLmsReference[]No
instructors[].idstringNo
instructors[].namestringNo
studentsLmsReference[]No
students[].idstringNo
students[].namestringNo
metadataLmsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type LmsClass = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	description?: string;
	media?: [];
	course_id?: string; // (reference to Course)
	languages?: string[];
	instructors?: [];
	students?: [];
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodLmsClass = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	description: z.string().optional(),
	media: z.array().optional(),
	course_id: z.string().optional().describe("(reference to Course)"),
	languages: z.array().optional(),
	instructors: z.array().optional(),
	students: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class LmsClass:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	description: Optional[str]
	media: Optional[PropertyLmsClassMedia]
	"""(reference to Course)"""
	course_id: Optional[str]
	languages: Optional[List[List[str]]]
	instructors: Optional[PropertyLmsClassInstructors]
	students: Optional[PropertyLmsClassStudents]
	metadata: Optional[PropertyLmsClassMetadata]
Are we missing anything? Let us know
Was this page helpful?