@timeback/oneroster 0.1.6 → 0.1.7

package/dist/public-types.d.ts

@@ -0,0 +1,1885 @@
+/**
+ * OneRoster Primitives
+ *
+ * Enums and literal types specific to the OneRoster protocol.
+ * For shared Timeback primitives (TimebackGrade, TimebackSubject), see `@timeback/types`.
+ */
+
+/**
+ * OneRoster assessment result score status values.
+ * @see https://www.imsglobal.org/oneroster-v11-final-specification
+ */
+type ScoreStatus =
+	| 'exempt'
+	| 'fully graded'
+	| 'not submitted'
+	| 'partially graded'
+	| 'submitted'
+
+/**
+ * OneRoster organization types.
+ * @see https://www.imsglobal.org/oneroster-v11-final-specification
+ */
+type OrganizationType = 'department' | 'school' | 'district' | 'local' | 'state' | 'national'
+
+/**
+ * OneRoster user role types.
+ * @see https://www.imsglobal.org/oneroster-v11-final-specification
+ */
+type OneRosterUserRole =
+	| 'administrator'
+	| 'aide'
+	| 'guardian'
+	| 'parent'
+	| 'proctor'
+	| 'relative'
+	| 'student'
+	| 'teacher'
+
+/**
+ * Timeback Shared Primitives
+ *
+ * Core types used across multiple Timeback protocols.
+ *
+ * Organization:
+ * - Shared types (this file): Used by multiple protocols (Caliper, OneRoster, etc.)
+ * - Protocol-specific types: Live in their respective protocols/X/primitives.ts files
+ *
+ * What belongs here:
+ * - TimebackSubject - Used in OneRoster courses AND Caliper events
+ * - TimebackGrade - Used across OneRoster, Caliper, and QTI
+ * - IMSErrorResponse - IMS Global standard used by multiple 1EdTech protocols
+ *
+ * What doesn't belong here:
+ * - OneRoster-specific: protocols/oneroster/primitives.ts
+ * - QTI-specific: protocols/qti/primitives.ts
+ */
+
+// ─────────────────────────────────────────────────────────────────────────────
+// TIMEBACK SHARED TYPES
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Valid Timeback subject values.
+ * Used in OneRoster courses and Caliper events.
+ */
+type TimebackSubject =
+	| 'Reading'
+	| 'Language'
+	| 'Vocabulary'
+	| 'Social Studies'
+	| 'Writing'
+	| 'Science'
+	| 'FastMath'
+	| 'Math'
+	| 'None'
+	| 'Other'
+
+/**
+ * Grade levels per Timeback OneRoster GradeEnum (numeric).
+ * -1 = Pre-K, 0 = Kindergarten, 1-12 = Grades 1-12, 13 = AP
+ *
+ * Use for input types where numbers are accepted.
+ */
+type TimebackGrade = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
+
+// ─────────────────────────────────────────────────────────────────────────────
+// IMS GLOBAL COMMON TYPES
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * IMS Global error response format.
+ * Used across OneRoster, Caliper, and other 1EdTech protocols.
+ */
+interface IMSErrorResponse {
+	imsx_codeMajor: 'failure' | 'success'
+	imsx_severity: 'error' | 'warning' | 'status'
+	imsx_description: string
+	imsx_CodeMinor?: {
+		imsx_codeMinorField: Array<{
+			imsx_codeMinorFieldName: string
+			imsx_codeMinorFieldValue: string
+		}>
+	}
+	imsx_error_details?: Array<Record<string, string>>
+}
+
+/**
+ * QTI Primitives
+ *
+ * Enums and literal types specific to the QTI protocol.
+ * For shared Timeback primitives (TimebackGrade, TimebackSubject), see `@timeback/types`.
+ */
+
+/**
+ * Lesson types for PowerPath integration.
+ * Used to categorize assessment content by delivery mode.
+ */
+type LessonType =
+	| 'powerpath-100'
+	| 'quiz'
+	| 'test-out'
+	| 'placement'
+	| 'unit-test'
+	| 'alpha-read-article'
+	| null
+
+/**
+ * OneRoster Base Types
+ *
+ * Common types used across all OneRoster entities.
+ *
+ * - OneRoster-specific primitives: `./primitives.ts`
+ * - Shared Timeback primitives: `@timeback/types`
+ */
+
+
+
+/**
+ * Base interface for all OneRoster entities.
+ *
+ * All OneRoster resources share these common fields for identification,
+ * status tracking, and extensibility.
+ */
+interface Base {
+	/**
+	 * Globally unique identifier for the entity.
+	 * Typically a UUID assigned by the source system.
+	 */
+	sourcedId?: string
+
+	/**
+	 * The status of the entity.
+	 * - `active`: Entity is current and valid
+	 * - `tobedeleted`: Entity is marked for deletion
+	 */
+	status?: 'active' | 'tobedeleted'
+
+	/**
+	 * ISO 8601 timestamp of the last modification.
+	 * @example
+	 * // "2024-01-15T10:30:00Z"
+	 */
+	dateLastModified?: string
+
+	/**
+	 * Extensible metadata object for custom properties.
+	 * Used for vendor-specific extensions.
+	 */
+	metadata?: Record<string, unknown> | null
+}
+
+/**
+ * A score for a specific learning objective.
+ */
+interface LearningObjectiveResult {
+	/** Identifier of the learning objective */
+	learningObjectiveId: string
+	/** Numeric score */
+	score?: number
+	/** Text-based score (e.g., "Proficient") */
+	textScore?: string
+}
+
+/**
+ * A set of learning objectives with optional results.
+ */
+interface LearningObjectiveSetItem {
+	/** Source system for these learning objectives */
+	source: string
+	/** Learning objective IDs (for line items) */
+	learningObjectiveIds?: string[]
+	/** Learning objective results (for results) */
+	learningObjectiveResults?: LearningObjectiveResult[]
+}
+
+/**
+ * Array of learning objective sets, or null if not applicable.
+ */
+type LearningObjectiveSet = LearningObjectiveSetItem[] | null
+
+/**
+ * A reference to another OneRoster entity by sourcedId.
+ */
+interface Ref {
+	/** The sourcedId of the referenced entity */
+	sourcedId: string
+}
+
+/**
+ * A reference with an optional type discriminator.
+ */
+interface RefWithType extends Ref {
+	/** The type of the referenced entity (e.g., "user", "class") */
+	type?: string
+}
+
+/**
+ * A fully-qualified reference with href and type.
+ * Commonly returned in API responses for navigable links.
+ */
+interface RefWithHref extends Ref {
+	/** The URL to fetch the referenced entity */
+	href: string
+	/** The type of the referenced entity */
+	type: string
+}
+
+/**
+ * Response returned when creating a new entity.
+ * Contains the mapping between supplied and allocated IDs.
+ */
+interface CreateResponse {
+	sourcedIdPairs: {
+		/** The sourcedId provided in the create request */
+		suppliedSourcedId: string
+		/** The sourcedId allocated by the server (may differ) */
+		allocatedSourcedId: string
+	}
+}
+
+/**
+ * Filter Field Types
+ *
+ * These types define the server-side filterable fields for each OneRoster entity.
+ * They may differ from the entity structure (e.g., `role` vs `roles`).
+ */
+
+
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COMMON FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Base fields available for filtering on all entities.
+ */
+interface BaseFilterFields {
+	sourcedId: string
+	status: 'active' | 'tobedeleted'
+	dateLastModified: Date
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// USER FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for User entities.
+ *
+ * Note: The server accepts `role` (singular) even though the entity has `roles` (array).
+ */
+interface UserFilterFields extends BaseFilterFields {
+	givenName: string
+	familyName: string
+	email: string
+	username: string
+	enabledUser: string
+	identifier: string
+	userMasterIdentifier: string
+	/** Server accepts singular `role` for filtering, even though entity has `roles` array */
+	role: OneRosterUserRole
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ORGANIZATION FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Organization/School entities.
+ */
+interface OrganizationFilterFields extends BaseFilterFields {
+	name: string
+	identifier: string
+	type: OrganizationType
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// CLASS FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Class entities.
+ */
+interface ClassFilterFields extends BaseFilterFields {
+	title: string
+	classCode: string
+	classType: 'homeroom' | 'scheduled'
+	location: string
+	grades: string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COURSE FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Course entities.
+ */
+interface CourseFilterFields extends BaseFilterFields {
+	title: string
+	courseCode: string
+	grades: string
+	subjects: string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ENROLLMENT FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Enrollment entities.
+ */
+interface EnrollmentFilterFields extends BaseFilterFields {
+	role: OneRosterUserRole
+	primary: string
+	beginDate: Date
+	endDate: Date
+	'user.sourcedId': string
+	'class.sourcedId': string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ACADEMIC SESSION FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for AcademicSession entities.
+ */
+interface AcademicSessionFilterFields extends BaseFilterFields {
+	title: string
+	type: 'gradingPeriod' | 'semester' | 'schoolYear' | 'term'
+	startDate: Date
+	endDate: Date
+	schoolYear: string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// LINE ITEM FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for LineItem (gradebook) entities.
+ */
+interface LineItemFilterFields extends BaseFilterFields {
+	title: string
+	description: string
+	assignDate: Date
+	dueDate: Date
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// RESULT FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Result (grade) entities.
+ */
+interface ResultFilterFields extends BaseFilterFields {
+	score: number
+	scoreDate: Date
+	scoreStatus: 'exempt' | 'fully graded' | 'not submitted' | 'partially graded' | 'submitted'
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COURSE COMPONENT FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for CourseComponent entities.
+ */
+interface CourseComponentFilterFields extends BaseFilterFields {
+	title: string
+	resourceType: string
+	'course.sourcedId': string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COMPONENT RESOURCE FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for ComponentResource entities.
+ */
+interface ComponentResourceFilterFields extends BaseFilterFields {
+	title: string
+	lessonType: string
+	'courseComponent.sourcedId': string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ASSESSMENT FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for AssessmentLineItem entities.
+ */
+interface AssessmentLineItemFilterFields extends BaseFilterFields {
+	title: string
+	description: string
+	assignDate: Date
+	dueDate: Date
+}
+
+/**
+ * Filterable fields for AssessmentResult entities.
+ *
+ * Includes nested filter keys for efficient querying by line item and student.
+ */
+interface AssessmentResultFilterFields extends BaseFilterFields {
+	score: number
+	scoreDate: Date
+	scoreStatus: string
+	'assessmentLineItem.sourcedId': string
+	'student.sourcedId': string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// DEMOGRAPHICS FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Demographics entities.
+ */
+interface DemographicsFilterFields extends BaseFilterFields {
+	birthDate: string
+	sex: 'male' | 'female'
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// CATEGORY FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Category entities.
+ */
+interface CategoryFilterFields extends BaseFilterFields {
+	title: string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// SCORE SCALE FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for ScoreScale entities.
+ */
+interface ScoreScaleFilterFields extends BaseFilterFields {
+	title: string
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// RESOURCE FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Resource entities.
+ */
+interface ResourceFilterFields extends BaseFilterFields {
+	title: string
+	vendorResourceId: string
+	importance: 'primary' | 'secondary'
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// RESOURCE FILTER FIELDS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Filterable fields for Resource entities.
+ */
+interface ResourceFilterFields extends BaseFilterFields {
+	title: string
+	vendorResourceId: string
+	vendorId: string
+	applicationId: string
+}
+
+/**
+ * OneRoster Gradebook Types
+ *
+ * Types for gradebook entities: results, line items, categories, score scales, assessments.
+ */
+
+
+
+/**
+ * A value within a score scale (e.g., "A" = 90-100).
+ */
+interface ScoreScaleValue {
+	/** Left-hand side of the range (e.g., "90") */
+	itemValueLHS: string
+	/** Right-hand side of the range (e.g., "100") */
+	itemValueRHS: string
+	/** Display value (e.g., "A") */
+	value?: string
+	/** Description of this score level */
+	description?: string
+}
+
+/**
+ * A grading scale defining how scores are interpreted.
+ *
+ * Score scales can be associated with classes or courses and define
+ * the mapping between numeric scores and letter grades.
+ */
+interface ScoreScale extends Base {
+	/** Scale title (e.g., "Standard Grading Scale") */
+	title: string
+	/** Type of scale */
+	type?: string
+	/** Class this scale applies to */
+	class?: Ref
+	/** Course this scale applies to */
+	course?: Ref | null
+	/** Values defining the scale */
+	scoreScaleValue?: ScoreScaleValue[]
+	/** Minimum possible score */
+	minScore?: number
+	/** Maximum possible score */
+	maxScore?: number
+}
+
+/**
+ * A category for organizing line items (e.g., "Homework", "Tests", "Projects").
+ */
+interface Category extends Base {
+	/** Category name */
+	title: string
+	/** Weight for grade calculation (0.0 to 1.0) */
+	weight?: number | null
+}
+
+/**
+ * A line item (assignment, test, or other gradable item).
+ *
+ * Line items represent work that students complete and receive grades for.
+ */
+interface LineItem extends Base {
+	/** Title of the assignment */
+	title: string
+	/** Description of the assignment */
+	description?: string | null
+	/** Date the assignment was given (ISO 8601 datetime) */
+	assignDate: string
+	/** Due date for the assignment (ISO 8601 datetime) */
+	dueDate: string
+	/** Class this line item belongs to */
+	class: Ref
+	/** School */
+	school: Ref
+	/** Category for this line item */
+	category: Ref
+	/** Grading period */
+	gradingPeriod?: Ref | null
+	/** Academic session */
+	academicSession?: Ref | null
+	/** Score scale to use for grading */
+	scoreScale?: Ref | null
+	/** Minimum possible score */
+	resultValueMin?: number | null
+	/** Maximum possible score */
+	resultValueMax?: number | null
+	/** Associated learning objectives */
+	learningObjectiveSet?: LearningObjectiveSet
+}
+
+/**
+ * A result (grade) for a student on a line item.
+ *
+ * Results record the score a student received on an assignment.
+ */
+interface Result extends Base {
+	/** Line item this result is for */
+	lineItem: Ref
+	/** Student who received this grade */
+	student: Ref
+	/** Class (optional, for context) */
+	class?: Ref | null
+	/** Score scale used */
+	scoreScale?: Ref | null
+	/** Status of the score */
+	scoreStatus: ScoreStatus
+	/** Numeric score */
+	score?: number | null
+	/** Text-based score */
+	textScore?: string | null
+	/** Date the score was recorded */
+	scoreDate: string
+	/** Teacher comment */
+	comment?: string | null
+	/** Learning objective scores */
+	learningObjectiveSet?: LearningObjectiveSet
+	/** Whether work is in progress */
+	inProgress?: string
+	/** Whether work is incomplete */
+	incomplete?: string
+	/** Whether submission was late */
+	late?: string
+	/** Whether submission is missing */
+	missing?: string
+}
+
+/**
+ * An assessment line item for standardized or formal assessments.
+ *
+ * Assessment line items are similar to line items but designed for
+ * formal assessments with more detailed tracking capabilities.
+ */
+interface AssessmentLineItem extends Base {
+	/** Assessment title */
+	title: string
+	/** Assessment description */
+	description?: string | null
+	/** Class this assessment is for */
+	class?: Ref | null
+	/** Parent assessment (for hierarchical assessments) */
+	parentAssessmentLineItem?: Ref | null
+	/** Score scale */
+	scoreScale?: Ref | null
+	/** Minimum possible score */
+	resultValueMin?: number | null
+	/** Maximum possible score */
+	resultValueMax?: number | null
+	/** Course component reference (proprietary extension) */
+	component?: Ref | null
+	/** Component resource reference (proprietary extension) */
+	componentResource?: Ref | null
+	/** Learning objectives */
+	learningObjectiveSet?: LearningObjectiveSet
+	/** Course reference (proprietary extension) */
+	course?: Ref | null
+}
+
+/**
+ * A result for an assessment line item.
+ */
+interface AssessmentResult extends Base {
+	/** Assessment this result is for */
+	assessmentLineItem: Ref
+	/** Student who took the assessment */
+	student: Ref
+	/** Numeric score */
+	score?: number | null
+	/** Text-based score */
+	textScore?: string | null
+	/** Date of the assessment */
+	scoreDate: string
+	/** Score scale used */
+	scoreScale?: Ref | null
+	/** Percentile ranking */
+	scorePercentile?: number | null
+	/** Status of the score */
+	scoreStatus: ScoreStatus
+	/** Teacher/grader comment */
+	comment?: string | null
+	/** Learning objective scores */
+	learningObjectiveSet?: LearningObjectiveSet
+	/** Whether assessment is in progress */
+	inProgress?: string | null
+	/** Whether assessment is incomplete */
+	incomplete?: string | null
+	/** Whether submission was late */
+	late?: string | null
+	/** Whether assessment is missing */
+	missing?: string | null
+}
+
+/**
+ * OneRoster Resources Types
+ *
+ * Types for digital learning resources and content.
+ */
+
+
+
+/**
+ * Resource type - determines which path prefix to use.
+ */
+type ResourceType = 'rostering' | 'gradebook' | 'resources'
+
+/**
+ * Common metadata fields shared across all resource types.
+ */
+interface BaseResourceMetadata {
+	/** Academic subject area (e.g., "Math", "Science", "Language") */
+	subject?: string
+	/** Array or range of grade levels (e.g., ["03", "04"]) */
+	grades?: string[]
+	/** Language of the content, using standard IETF BCP 47 codes (e.g., "en-US") */
+	language?: string
+	/** Experience points (XP) assigned for completing this resource */
+	xp?: number
+	/** Learning objectives this resource is aligned to */
+	learningObjectiveSet?: LearningObjectiveSet
+	/** Array of topic-related tags or important terms covered by the content */
+	keywords?: string[]
+	/** Direct content URL or support URL */
+	url?: string
+	/** Estimated seconds for a student to consume the content */
+	timeLength?: number
+	/** UI label for the activity badge (e.g., "Article", "Exercise", "Quiz", "Video"). */
+	activityType?: string
+	/** Extensible for custom vendor-specific fields */
+	[key: string]: unknown
+}
+
+/**
+ * Metadata for QTI (IMS Question and Test Interoperability) resources.
+ */
+interface QtiResourceMetadata extends BaseResourceMetadata {
+	type: 'qti'
+	/** Specific QTI type: "qti-question", "qti-test", "qti-test-bank", "qti-stimulus" */
+	subType?: 'qti-question' | 'qti-test' | 'qti-test-bank' | 'qti-stimulus'
+}
+
+/**
+ * Metadata for textual resources (PDFs, eBooks, etc.).
+ */
+interface TextualResourceMetadata extends BaseResourceMetadata {
+	type: 'text'
+	/** File or content format (e.g., "pdf", "epub", "docx", "html") */
+	format?: string
+	/** Name of the person or organization that created the content */
+	author?: string
+	/** Number of pages if applicable */
+	pageCount?: number
+	/** Number of words in the content */
+	wordLength?: number
+}
+
+/**
+ * Metadata for audio recordings.
+ */
+interface AudioResourceMetadata extends BaseResourceMetadata {
+	type: 'audio'
+	/** Length of the audio in HH:MM:SS format */
+	duration?: string
+	/** Audio format (e.g., "mp3", "wav") */
+	format?: string
+	/** Name of the speaker or narrator */
+	speaker?: string
+}
+
+/**
+ * Metadata for video content.
+ */
+interface VideoResourceMetadata extends BaseResourceMetadata {
+	type: 'video'
+	/** Length of the video in HH:MM:SS format */
+	duration?: string
+	/** Indicates if closed captions are available */
+	captionsAvailable?: boolean
+	/** Video format (e.g., "mp4", "webm", "mov") */
+	format?: string
+}
+
+/**
+ * Metadata for interactive 3rd party tools (Desmos, LTI apps, etc.).
+ */
+interface InteractiveResourceMetadata extends BaseResourceMetadata {
+	type: 'interactive'
+	/** The URL used to launch the tool, often via LTI or similar protocols */
+	launchUrl?: string
+	/** Name of the external tool provider (e.g., "Desmos", "Khan Academy") */
+	toolProvider?: string
+	/** Teaching method supported (e.g., "exploratory", "direct-instruction") */
+	instructionalMethod?: string
+}
+
+/**
+ * Metadata for visual resources (images, diagrams, etc.).
+ */
+interface VisualResourceMetadata extends BaseResourceMetadata {
+	type: 'visual'
+	/** Image format (e.g., "png", "jpeg", "svg", "pdf") */
+	format?: string
+	/** Dimensions in pixels (e.g., "1920x1080") */
+	resolution?: string
+}
+
+/**
+ * Metadata for structured course materials.
+ */
+interface CourseMaterialResourceMetadata extends BaseResourceMetadata {
+	type: 'course-material'
+	/** Material classification: "unit", "course", "resource-collection" */
+	subType?: 'unit' | 'course' | 'resource-collection'
+	/** Name of the person or organization who created the material */
+	author?: string
+	/** File format (e.g., "docx", "pdf", "cc") */
+	format?: string
+	/** Teaching method supported (e.g., "direct-instruction", "project-based") */
+	instructionalMethod?: string
+}
+
+/**
+ * Metadata for a collection of assessments served in sequence.
+ */
+interface AssessmentBankResourceMetadata extends BaseResourceMetadata {
+	type: 'assessment-bank'
+	/** Array of individual test Resource IDs included in this bank */
+	resources: string[]
+}
+
+/**
+ * Union of all valid resource metadata types.
+ * Uses the `type` field as a discriminator.
+ */
+type ResourceMetadata =
+	| QtiResourceMetadata
+	| TextualResourceMetadata
+	| AudioResourceMetadata
+	| VideoResourceMetadata
+	| InteractiveResourceMetadata
+	| VisualResourceMetadata
+	| CourseMaterialResourceMetadata
+	| AssessmentBankResourceMetadata
+	| BaseResourceMetadata // Fallback for unknown types
+
+/**
+ * A digital learning resource (content, activity, or material).
+ *
+ * Resources represent external content that can be assigned to
+ * students through courses and classes.
+ */
+interface Resource extends Base {
+	/** Resource title */
+	title: string
+	/** Roles this resource is intended for */
+	roles?: ('primary' | 'secondary')[]
+	/** Importance level of this resource */
+	importance?: 'primary' | 'secondary'
+	/** Vendor's identifier for this resource */
+	vendorResourceId: string
+	/** Vendor identifier */
+	vendorId?: string
+	/** Application identifier */
+	applicationId?: string
+	/** Content-specific metadata */
+	metadata?: ResourceMetadata | null
+}
+
+/**
+ * A resource linked to a course component.
+ *
+ * Component resources map digital content to specific parts
+ * of a course structure.
+ */
+interface ComponentResource extends Base {
+	/** Resource title */
+	title: string
+	/** Course component this resource belongs to */
+	courseComponent: Ref
+	/** The resource being linked */
+	resource: Ref
+	/** Display order within the component */
+	sortOrder?: number
+	/** Type of lesson (proprietary extension) */
+	lessonType?: LessonType
+}
+
+/**
+ * OneRoster Rostering Types
+ *
+ * Types for rostering entities: users, orgs, courses, classes, enrollments, terms.
+ */
+
+
+
+/**
+ * An organization such as a school, district, or department.
+ *
+ * Organizations form a hierarchy with parent/child relationships.
+ * Schools are a specific type of organization.
+ */
+interface Organization extends Base {
+	/** Display name of the organization */
+	name: string
+	/** Type of organization (school, district, department, etc.) */
+	type: OrganizationType
+	/** External identifier (e.g., state school ID) */
+	identifier?: string
+	/** Reference to parent organization */
+	parent?: RefWithHref | null
+	/** References to child organizations */
+	children?: RefWithHref[] | null
+}
+
+/**
+ * An external user identifier from another system.
+ */
+interface UserId {
+	/** Type of identifier (e.g., "SIS", "LDAP") */
+	type: string
+	/** The identifier value */
+	identifier: string
+}
+
+/**
+ * A role assignment for a user at a specific organization.
+ */
+interface UserRole {
+	/** Whether this is the user's primary or secondary role */
+	roleType: 'primary' | 'secondary'
+	/** The role type (student, teacher, administrator, etc.) */
+	role: OneRosterUserRole
+	/** The organization where this role applies */
+	org: RefWithHref
+	/** Associated user profile identifier */
+	userProfile?: string
+	/** Role-specific metadata */
+	metadata?: Record<string, unknown> | null
+	/** When this role assignment begins */
+	beginDate?: string | null
+	/** When this role assignment ends */
+	endDate?: string | null
+}
+
+/** @internal */
+interface UserProfileCredential {
+	id: string
+	type: string
+	username: string
+	password?: string | null
+}
+
+/** @internal */
+interface UserProfileApp {
+	sourcedId: string
+	name: string
+	description?: string | null
+	domain: string[]
+	metadata?: Record<string, unknown> | null
+}
+
+/** @internal */
+interface UserProfile {
+	profileId: string
+	profileType: string
+	vendorId: string
+	applicationId: string
+	description?: string | null
+	app: UserProfileApp
+	credentials: UserProfileCredential[]
+}
+
+/**
+ * A user in the OneRoster system.
+ *
+ * Users can be students, teachers, parents, administrators, or other roles.
+ * A user may have multiple roles at different organizations.
+ */
+interface User extends Base {
+	/** Master identifier for cross-system user matching */
+	userMasterIdentifier?: string | null
+	/** Login username */
+	username?: string | null
+	/** External identifiers from other systems */
+	userIds?: UserId[]
+	/** Whether the user account is enabled */
+	enabledUser: boolean
+	/** User's first name */
+	givenName: string
+	/** User's last name */
+	familyName: string
+	/** User's middle name */
+	middleName?: string | null
+	/** External identifier */
+	identifier?: string | null
+	/** User's email address */
+	email?: string
+	/** Role assignments at organizations */
+	roles: UserRole[]
+	/** References to related users (e.g., parents for students) */
+	agents?: RefWithHref[]
+	/** Application-specific profiles */
+	userProfiles?: UserProfile[]
+	/** User's primary organization */
+	primaryOrg?: RefWithHref & { name?: string | null }
+	/** Preferred first name */
+	preferredFirstName?: string | null
+	/** Preferred middle name */
+	preferredMiddleName?: string | null
+	/** Preferred last name */
+	preferredLastName?: string | null
+	/** User's pronouns */
+	pronouns?: string | null
+	/** Grade levels associated with the user */
+	grades?: TimebackGrade[]
+	/** Password (write-only, not returned in responses) */
+	password?: string | null
+	/** SMS phone number */
+	sms?: string | null
+	/** Phone number */
+	phone?: string | null
+	/** Demographic information */
+	demographics?: Demographics | null
+}
+
+/**
+ * Demographic information for a user.
+ *
+ * Contains sensitive PII data including birth date, race, and ethnicity.
+ */
+interface Demographics extends Base {
+	/** Birth date in YYYY-MM-DD format */
+	birthDate?: string | null
+	/** Biological sex */
+	sex?: 'male' | 'female' | 'other' | 'unspecified' | null
+	americanIndianOrAlaskaNative?: string | null
+	asian?: string | null
+	blackOrAfricanAmerican?: string | null
+	nativeHawaiianOrOtherPacificIslander?: string | null
+	white?: string | null
+	demographicRaceTwoOrMoreRaces?: string | null
+	hispanicOrLatinoEthnicity?: string | null
+	countryOfBirthCode?: string | null
+	stateOfBirthAbbreviation?: string | null
+	cityOfBirth?: string | null
+	publicSchoolResidenceStatus?: string | null
+}
+
+/**
+ * Daily learning goals for a course or enrollment.
+ */
+interface CourseGoals {
+	/** Target XP to earn per day */
+	dailyXp?: number
+	/** Target lessons to complete per day */
+	dailyLessons?: number
+	/** Target active learning minutes per day */
+	dailyActiveMinutes?: number
+	/** Target accuracy percentage */
+	dailyAccuracy?: number
+	/** Target mastered units per day */
+	dailyMasteredUnits?: number
+}
+
+/**
+ * Aggregate metrics for a course.
+ */
+interface CourseMetrics {
+	/** Total XP available in the course */
+	totalXp?: number
+	/** Total number of lessons/activities */
+	totalLessons?: number
+	/** Total grade levels covered */
+	totalGrades?: number
+	/** Course classification type */
+	courseType?: 'base' | 'hole-filling' | 'optional' | 'Base' | 'Hole-Filling' | 'Optional'
+	/** Whether this is supplemental content */
+	isSupplemental?: boolean
+}
+
+/**
+ * Extended metadata for courses.
+ */
+interface CourseMetadata extends Record<string, unknown> {
+	/** Course classification (base, hole-filling, optional) */
+	courseType?: 'base' | 'hole-filling' | 'optional'
+	/** Whether this is supplemental content */
+	isSupplemental?: boolean
+	/** Whether this is a custom course for a specific student */
+	isCustom?: boolean
+	/** Publication status of the course */
+	publishStatus?: 'draft' | 'testing' | 'published' | 'deactivated'
+	/** Contact email for course issues */
+	contactEmail?: string
+	/** Primary application identifier */
+	primaryApp?: string
+	/** Daily learning goals */
+	goals?: CourseGoals
+	/** Aggregate metrics */
+	metrics?: CourseMetrics
+}
+
+/**
+ * A course in the curriculum.
+ *
+ * Courses define the content to be taught and can have multiple classes
+ * (sections) associated with them.
+ */
+interface Course extends Omit<Base, 'metadata'> {
+	/** Course-specific metadata */
+	metadata?: CourseMetadata | null
+	/** Course title */
+	title: string
+	/** Course code (e.g., "MATH101") */
+	courseCode?: string
+	/** Grade levels for this course */
+	grades?: TimebackGrade[]
+	/** Subject areas */
+	subjects?: TimebackSubject[]
+	/** Subject codes */
+	subjectCodes?: string[]
+	/** Organization offering this course */
+	org: Ref
+	/** Course level (e.g., "AP", "Honors") */
+	level?: string
+	/** Grading scheme identifier */
+	gradingScheme?: string
+	/** Associated academic session */
+	academicSession?: Ref
+	/** School year reference */
+	schoolYear?: RefWithHref
+	/** Learning resources for this course */
+	resources?: RefWithHref[]
+}
+
+/**
+ * A single item in a QTI-derived course structure.
+ *
+ * Represents metadata about a lesson/skill from QTI test content.
+ */
+interface CourseStructureItem {
+	/** URL to the QTI content */
+	url: string
+	/** Skill code identifier */
+	skillCode: string
+	/** Lesson code identifier */
+	lessonCode: string
+	/** Title of the lesson/skill */
+	title: string
+	/** Title of the containing unit */
+	'unit-title': string
+	/** Status of the content */
+	status: string
+	/** Experience points value */
+	xp: number
+	/** Optional stimulus content */
+	stimulus?: {
+		title: string
+		identifier: string
+	}
+	/** Optional video content */
+	video?: {
+		url: string
+		title: string
+	}
+}
+
+/**
+ * A component or module within a course.
+ */
+interface CourseComponent extends Base {
+	/** Display title */
+	title: string
+	/** Parent course reference */
+	course: Ref
+	/** Nested course component reference */
+	courseComponent?: Ref | null
+	/** Parent component reference */
+	parent?: Ref | null
+	/** Display order */
+	sortOrder?: number
+	/** Prerequisite component IDs */
+	prerequisites?: string[]
+	/** Whether all or any prerequisites are required */
+	prerequisiteCriteria?: 'ALL' | 'ANY'
+	/** Date when component becomes available */
+	unlockDate?: string
+}
+
+/**
+ * A class (section) where students and teachers meet.
+ *
+ * Classes are instances of courses for specific terms and locations.
+ */
+interface Class extends Base {
+	/** Class title */
+	title: string
+	/** Class code/section identifier */
+	classCode?: string | null
+	/** Type of class */
+	classType?: 'homeroom' | 'scheduled'
+	/** Physical location */
+	location?: string | null
+	/** Grade levels */
+	grades?: TimebackGrade[]
+	/** Subject areas */
+	subjects?: TimebackSubject[]
+	/** Subject codes */
+	subjectCodes?: string[]
+	/** Period/time slot identifiers */
+	periods?: string[]
+	/** Associated terms */
+	terms?: RefWithHref[]
+	/** Course this class is a section of */
+	course?: RefWithHref | null
+	/** School where this class is held */
+	school?: RefWithHref | null
+	/** Learning resources for this class */
+	resources?: RefWithHref[]
+}
+
+/**
+ * Goals for an individual enrollment.
+ */
+interface EnrollmentGoals {
+	dailyXp?: number
+	dailyLessons?: number
+	dailyActiveMinutes?: number
+	dailyAccuracy?: number
+	dailyMasteredUnits?: number
+}
+
+/**
+ * Metrics for an enrollment.
+ */
+interface EnrollmentMetrics {
+	totalXp?: number
+	totalLessons?: number
+	totalGrades?: number
+	courseType?: string
+	isSupplemental?: boolean
+}
+
+/**
+ * Extended metadata for enrollments.
+ */
+interface EnrollmentMetadata extends Record<string, unknown> {
+	/** Individual learning goals */
+	goals?: EnrollmentGoals
+	/** Progress metrics */
+	metrics?: EnrollmentMetrics
+}
+
+/**
+ * An enrollment linking a user to a class.
+ *
+ * Enrollments define the relationship between users and classes,
+ * including their role (student, teacher) and the time period.
+ */
+interface Enrollment extends Omit<Base, 'metadata'> {
+	/** Enrollment-specific metadata with goals and metrics */
+	metadata?: EnrollmentMetadata | null
+	/** The enrolled user */
+	user: RefWithHref & { name?: string }
+	/** The class the user is enrolled in */
+	class: RefWithHref & { name?: string }
+	/** The school */
+	school: RefWithHref & { name?: string }
+	/** The course */
+	course: RefWithHref & { name?: string }
+	/** Role in this enrollment (student, teacher, etc.) */
+	role: OneRosterUserRole
+	/** Whether this is the user's primary class ("true"/"false") */
+	primary?: string | null
+	/** Start date of enrollment */
+	beginDate?: string | null
+	/** End date of enrollment */
+	endDate?: string | null
+}
+
+/**
+ * An academic session such as a term, semester, or school year.
+ *
+ * Academic sessions define time periods for scheduling and can be
+ * nested (e.g., terms within a school year).
+ */
+interface AcademicSession extends Base {
+	/** Session title (e.g., "Fall 2024") */
+	title: string
+	/** Start date in YYYY-MM-DD format */
+	startDate: string
+	/** End date in YYYY-MM-DD format */
+	endDate: string
+	/** Type of session */
+	type: 'gradingPeriod' | 'semester' | 'schoolYear' | 'term'
+	/** Parent session reference */
+	parent?: RefWithHref | null
+	/** School year as a number (e.g., 2024) */
+	schoolYear: number
+	/** Organization this session belongs to */
+	org: RefWithHref
+	/** Child sessions */
+	children?: RefWithHref[] | null
+}
+
+/**
+ * A term within an academic year.
+ * Alias for AcademicSession with type 'term'.
+ */
+type Term = AcademicSession
+
+/**
+ * A grading period within a term or semester.
+ * Alias for AcademicSession with type 'gradingPeriod'.
+ */
+type GradingPeriod = AcademicSession
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// AGENT/CREDENTIAL TYPES
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Response from creating user credentials.
+ */
+interface CredentialCreateResponse {
+	/** The user profile ID */
+	userProfileId: string
+	/** The created credential ID */
+	credentialId: string
+	/** Status message */
+	message: string
+}
+
+/**
+ * Response from decrypting user credentials.
+ */
+interface DecryptedCredential {
+	/** The decrypted password */
+	password: string
+}
+
+type input<T> = T extends {
+    _zod: {
+        input: any;
+    };
+} ? T["_zod"]["input"] : unknown;
+
+/**
+ * OneRoster Schemas
+ *
+ * Zod schemas for OneRoster inputs used across CLI and SDK clients.
+ */
+
+
+
+/**
+ * Input for assigning a role to a user.
+ */
+declare const OneRosterUserRoleInput = z
+	.object({
+		roleType: z.enum(['primary', 'secondary']),
+		role: OneRosterUserRole,
+		org: Ref,
+		userProfile: z.string().optional(),
+		metadata: Metadata,
+		beginDate: OneRosterDateString.optional(),
+		endDate: OneRosterDateString.optional(),
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// USERS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster user.
+ *
+ * Enforces required fields while allowing additional fields via passthrough.
+ */
+declare const OneRosterUserCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
+		status: Status.optional(),
+		enabledUser: z.boolean(),
+		givenName: NonEmptyString.describe('givenName must be a non-empty string'),
+		familyName: NonEmptyString.describe('familyName must be a non-empty string'),
+		middleName: NonEmptyString.optional(),
+		username: NonEmptyString.optional(),
+		email: z.email().optional(),
+		roles: z.array(OneRosterUserRoleInput).min(1, 'roles must include at least one role'),
+		userIds: z
+			.array(
+				z
+					.object({
+						type: NonEmptyString,
+						identifier: NonEmptyString,
+					})
+					.strict(),
+			)
+			.optional(),
+		agents: z.array(Ref).optional(),
+		grades: z.array(TimebackGrade).optional(),
+		identifier: NonEmptyString.optional(),
+		sms: NonEmptyString.optional(),
+		phone: NonEmptyString.optional(),
+		pronouns: NonEmptyString.optional(),
+		password: NonEmptyString.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COURSES
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster course.
+ *
+ * Enforces required fields while allowing additional fields.
+ */
+declare const OneRosterCourseCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string').optional(),
+		status: Status.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		org: Ref,
+		courseCode: NonEmptyString.optional(),
+		subjects: z.array(TimebackSubject).optional(),
+		grades: z.array(TimebackGrade).optional(),
+		level: NonEmptyString.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// CLASSES
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster class.
+ *
+ * Enforces required fields while allowing additional fields.
+ */
+declare const OneRosterClassCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string').optional(),
+		status: Status.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		terms: z.array(Ref).min(1, 'terms must have at least one item'),
+		course: Ref,
+		org: Ref,
+		classCode: NonEmptyString.optional(),
+		classType: z.enum(['homeroom', 'scheduled']).optional(),
+		location: NonEmptyString.optional(),
+		grades: z.array(TimebackGrade).optional(),
+		subjects: z.array(TimebackSubject).optional(),
+		subjectCodes: z.array(NonEmptyString).optional(),
+		periods: z.array(NonEmptyString).optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+declare const OneRosterEnrollmentCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string').optional(),
+		status: Status.optional(),
+		user: Ref,
+		class: Ref,
+		school: Ref.optional(),
+		role: OneRosterUserRole,
+		primary: StringBoolean.optional(),
+		beginDate: OneRosterDateString.optional(),
+		endDate: OneRosterDateString.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// CATEGORIES (GRADEBOOK)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster category.
+ *
+ * Enforces title and status while allowing additional fields.
+ */
+declare const OneRosterCategoryCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		status: Status,
+		weight: z.number().nullable().optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// LINE ITEMS (GRADEBOOK)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster line item.
+ *
+ * Enforces required fields: title, class, school, category, assignDate, dueDate, status.
+ */
+declare const OneRosterLineItemCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		class: Ref,
+		school: Ref,
+		category: Ref,
+		assignDate: OneRosterDateString,
+		dueDate: OneRosterDateString,
+		status: Status,
+		description: z.string().optional(),
+		resultValueMin: z.number().nullable().optional(),
+		resultValueMax: z.number().nullable().optional(),
+		scoreScale: Ref.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// RESULTS (GRADEBOOK)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster result (grade).
+ *
+ * Enforces required fields: lineItem, student, scoreDate, scoreStatus, status.
+ */
+declare const OneRosterResultCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		lineItem: Ref,
+		student: Ref,
+		class: Ref.optional(),
+		scoreDate: OneRosterDateString,
+		scoreStatus: z.enum([
+			'exempt',
+			'fully graded',
+			'not submitted',
+			'partially graded',
+			'submitted',
+		]),
+		score: z.number().nullable().optional(),
+		textScore: z.string().nullable().optional(),
+		status: Status,
+		comment: z.string().nullable().optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// SCORE SCALES (GRADEBOOK)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster score scale.
+ *
+ * Enforces title while allowing additional fields.
+ */
+declare const OneRosterScoreScaleCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		status: Status.optional(),
+		type: z.string().optional(),
+		class: Ref.optional(),
+		course: Ref.nullable().optional(),
+		scoreScaleValue: z
+			.array(
+				z
+					.object({
+						itemValueLHS: NonEmptyString,
+						itemValueRHS: NonEmptyString,
+						value: z.string().optional(),
+						description: z.string().optional(),
+					})
+					.strict(),
+			)
+			.optional(),
+		minScore: z.number().optional(),
+		maxScore: z.number().optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ASSESSMENT LINE ITEMS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster assessment line item.
+ * Matches Timeback server `AssessmentLineItemSchema` (beyond-timeback-api-2).
+ */
+declare const OneRosterAssessmentLineItemCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		status: Status.optional(),
+		dateLastModified: IsoDateTimeString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		description: z.string().nullable().optional(),
+		class: Ref.nullable().optional(),
+		parentAssessmentLineItem: Ref.nullable().optional(),
+		scoreScale: Ref.nullable().optional(),
+		resultValueMin: z.number().nullable().optional(),
+		resultValueMax: z.number().nullable().optional(),
+		// Proprietary extensions
+		component: Ref.nullable().optional(),
+		componentResource: Ref.nullable().optional(),
+		learningObjectiveSet: z
+			.array(
+				z.object({
+					source: z.string(),
+					learningObjectiveIds: z.array(z.string()),
+				}),
+			)
+			.optional()
+			.nullable(),
+		course: Ref.nullable().optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+/**
+ * Input for creating a OneRoster assessment result.
+ * Matches Timeback server `AssessmentResultSchema` (beyond-timeback-api-2).
+ */
+declare const OneRosterAssessmentResultCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		status: Status.optional(),
+		dateLastModified: IsoDateTimeString.optional(),
+		metadata: Metadata,
+		assessmentLineItem: Ref,
+		student: Ref,
+		score: z.number().nullable().optional(),
+		textScore: z.string().nullable().optional(),
+		scoreDate: z.string().datetime(),
+		scoreScale: Ref.nullable().optional(),
+		scorePercentile: z.number().nullable().optional(),
+		scoreStatus: z.enum([
+			'exempt',
+			'fully graded',
+			'not submitted',
+			'partially graded',
+			'submitted',
+		]),
+		comment: z.string().nullable().optional(),
+		learningObjectiveSet: LearningObjectiveScoreSetSchema.nullable().optional(),
+		inProgress: z.string().nullable().optional(),
+		incomplete: z.string().nullable().optional(),
+		late: z.string().nullable().optional(),
+		missing: z.string().nullable().optional(),
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ORGANIZATIONS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster organization.
+ *
+ * Enforces name and type while allowing additional fields.
+ */
+declare const OneRosterOrgCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		status: Status.optional(),
+		name: NonEmptyString.describe('name must be a non-empty string'),
+		type: OrganizationType,
+		identifier: NonEmptyString.optional(),
+		parent: Ref.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+/**
+ * Input for creating a OneRoster school (org with type='school').
+ *
+ * Enforces name and optionally validates type.
+ */
+declare const OneRosterSchoolCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		status: Status.optional(),
+		name: NonEmptyString.describe('name must be a non-empty string'),
+		type: z.literal('school').optional(),
+		identifier: NonEmptyString.optional(),
+		parent: Ref.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ACADEMIC SESSIONS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster academic session.
+ *
+ * Enforces required fields: sourcedId, status, title, startDate, endDate, type, schoolYear, org.
+ */
+declare const OneRosterAcademicSessionCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
+		status: Status,
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		startDate: OneRosterDateString,
+		endDate: OneRosterDateString,
+		type: z.enum(['gradingPeriod', 'semester', 'schoolYear', 'term']),
+		schoolYear: NonEmptyString.describe('schoolYear must be a non-empty string'),
+		org: Ref,
+		parent: Ref.optional(),
+		children: z.array(Ref).optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COMPONENT RESOURCES
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster component resource.
+ *
+ * Enforces required fields while allowing additional fields.
+ */
+declare const OneRosterComponentResourceCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		courseComponent: Ref,
+		resource: Ref,
+		status: Status,
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// COURSE COMPONENTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating a OneRoster course component.
+ *
+ * Enforces title, course, and status while allowing additional fields.
+ */
+declare const OneRosterCourseComponentCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		course: Ref,
+		status: Status,
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// ENROLL INPUT (CONVENIENCE)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for enrolling a user in a class (convenience method).
+ *
+ * Enforces sourcedId and role while allowing additional fields.
+ */
+declare const OneRosterEnrollInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
+		role: z.enum(['student', 'teacher']),
+		primary: StringBoolean.optional(),
+		beginDate: OneRosterDateString.optional(),
+		endDate: OneRosterDateString.optional(),
+		metadata: Metadata,
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// AGENT INPUT
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for adding an agent (parent/guardian) relationship.
+ *
+ * Enforces agentSourcedId.
+ */
+declare const OneRosterAgentInput = z
+	.object({
+		agentSourcedId: NonEmptyString.describe('agentSourcedId must be a non-empty string'),
+	})
+	.strict()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// DEMOGRAPHICS INPUT
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating/updating demographics.
+ *
+ * Enforces sourcedId while allowing additional fields.
+ */
+declare const OneRosterDemographicsCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.describe('sourcedId must be a non-empty string'),
+	})
+	.loose()
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// RESOURCE INPUT
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Input for creating/updating resources.
+ *
+ * Enforces title and vendorResourceId while allowing additional fields.
+ */
+declare const OneRosterResourceCreateInput = z
+	.object({
+		sourcedId: NonEmptyString.optional(),
+		title: NonEmptyString.describe('title must be a non-empty string'),
+		vendorResourceId: NonEmptyString.describe('vendorResourceId must be a non-empty string'),
+		roles: z.array(z.enum(['primary', 'secondary'])).optional(),
+		importance: z.enum(['primary', 'secondary']).optional(),
+		vendorId: z.string().optional(),
+		applicationId: z.string().optional(),
+		status: Status.optional(),
+		metadata: ResourceMetadataSchema.nullable().optional(),
+	})
+	.strict()
+
+/**
+ * Input for creating a course structure from QTI tests.
+ *
+ * Enforces course required fields and courseStructure shape.
+ */
+declare const OneRosterCourseStructureInput = z
+	.object({
+		course: z
+			.object({
+				sourcedId: NonEmptyString.describe(
+					'course.sourcedId must be a non-empty string',
+				).optional(),
+				title: NonEmptyString.describe('course.title must be a non-empty string'),
+				org: Ref,
+				status: Status,
+				metadata: Metadata,
+			})
+			.strict(),
+		courseStructure: z.record(z.string(), CourseStructureItem),
+	})
+	.strict()
+
+/**
+ * Input array for bulk result creation.
+ */
+declare const OneRosterBulkResultsInput = z
+	.array(OneRosterBulkResultItem)
+	.min(1, 'results must have at least one item')
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// TYPE EXPORTS (REQUEST INPUTS)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+type OrgCreateInput = input<typeof OneRosterOrgCreateInput>
+type SchoolCreateInput = input<typeof OneRosterSchoolCreateInput>
+type UserRoleInput = input<typeof OneRosterUserRoleInput>
+type UserCreateInput = input<typeof OneRosterUserCreateInput>
+type DemographicsCreateInput = input<typeof OneRosterDemographicsCreateInput>
+type CourseCreateInput = input<typeof OneRosterCourseCreateInput>
+type CourseStructureInput = input<typeof OneRosterCourseStructureInput>
+type CourseComponentCreateInput = input<typeof OneRosterCourseComponentCreateInput>
+type ClassCreateInput = input<typeof OneRosterClassCreateInput>
+type EnrollmentCreateInput = input<typeof OneRosterEnrollmentCreateInput>
+type EnrollInput = input<typeof OneRosterEnrollInput>
+type AcademicSessionCreateInput = input<typeof OneRosterAcademicSessionCreateInput>
+type AgentInput = input<typeof OneRosterAgentInput>
+type CategoryCreateInput = input<typeof OneRosterCategoryCreateInput>
+type LineItemCreateInput = input<typeof OneRosterLineItemCreateInput>
+type ResultCreateInput = input<typeof OneRosterResultCreateInput>
+type ComponentResourceCreateInput = input<typeof OneRosterComponentResourceCreateInput>
+type ResourceCreateInput = input<typeof OneRosterResourceCreateInput>
+type ScoreScaleCreateInput = input<typeof OneRosterScoreScaleCreateInput>
+type AssessmentLineItemCreateInput = input<typeof OneRosterAssessmentLineItemCreateInput>
+type AssessmentResultCreateInput = input<typeof OneRosterAssessmentResultCreateInput>
+type BulkResultsInput = input<typeof OneRosterBulkResultsInput>
+
+export type { AcademicSession, AcademicSessionCreateInput, AcademicSessionFilterFields, AgentInput, AssessmentBankResourceMetadata, AssessmentLineItem, AssessmentLineItemCreateInput, AssessmentLineItemFilterFields, AssessmentResult, AssessmentResultCreateInput, AssessmentResultFilterFields, AudioResourceMetadata, Base, BaseFilterFields, BaseResourceMetadata, BulkResultsInput, Category, CategoryCreateInput, CategoryFilterFields, Class, ClassCreateInput, ClassFilterFields, ComponentResource, ComponentResourceCreateInput, ComponentResourceFilterFields, Course, CourseComponent, CourseComponentCreateInput, CourseComponentFilterFields, CourseCreateInput, CourseFilterFields, CourseGoals, CourseMaterialResourceMetadata, CourseMetadata, CourseMetrics, CourseStructureInput, CourseStructureItem, CreateResponse, CredentialCreateResponse, DecryptedCredential, Demographics, DemographicsCreateInput, DemographicsFilterFields, EnrollInput, Enrollment, EnrollmentCreateInput, EnrollmentFilterFields, EnrollmentGoals, EnrollmentMetadata, EnrollmentMetrics, GradingPeriod, IMSErrorResponse, InteractiveResourceMetadata, LearningObjectiveResult, LearningObjectiveSet, LearningObjectiveSetItem, LessonType, LineItem, LineItemCreateInput, LineItemFilterFields, OneRosterUserRole, OrgCreateInput, Organization, OrganizationFilterFields, OrganizationType, QtiResourceMetadata, Ref, RefWithHref, RefWithType, Resource, ResourceCreateInput, ResourceFilterFields, ResourceMetadata, ResourceType, Result, ResultCreateInput, ResultFilterFields, SchoolCreateInput, ScoreScale, ScoreScaleCreateInput, ScoreScaleFilterFields, ScoreScaleValue, ScoreStatus, Term, TextualResourceMetadata, TimebackGrade, TimebackSubject, User, UserCreateInput, UserFilterFields, UserId, UserProfile, UserProfileApp, UserProfileCredential, UserRole, UserRoleInput, VideoResourceMetadata, VisualResourceMetadata };