@timeback/oneroster 0.1.9-beta.20260309185602 → 0.2.0

package/dist/{chunk-ex772j6v.js → chunk-4fwv2yyb.js}

@@ -192,12 +192,14 @@ var LEARNWITHAI_QTI_URLS = {
 var PLATFORM_ENDPOINTS = {
   BEYOND_AI: {
     token: BEYONDAI_TOKEN_URLS,
+    tokenScope: undefined,
     api: BEYONDAI_API_URLS,
     caliper: BEYONDAI_CALIPER_URLS,
     qti: BEYONDAI_QTI_URLS
   },
   LEARNWITH_AI: {
     token: LEARNWITHAI_TOKEN_URLS,
+    tokenScope: "https://purl.imsglobal.org/spec/caliper/v1p2/scope/events.write",
     api: LEARNWITHAI_API_URLS,
     caliper: LEARNWITHAI_CALIPER_URLS,
     qti: LEARNWITHAI_QTI_URLS
@@ -581,7 +583,7 @@ class TokenManager {
         Authorization: `Basic ${credentials}`,
         "Content-Type": "application/x-www-form-urlencoded"
       },
-      body: "grant_type=client_credentials"
+      body: this.config.scope ? `grant_type=client_credentials&scope=${encodeURIComponent(this.config.scope)}` : "grant_type=client_credentials"
     });
     const duration = Math.round(performance.now() - start);
     if (!response.ok) {
@@ -645,7 +647,7 @@ var BEYONDAI_PATHS = {
 };
 var LEARNWITHAI_PATHS = {
   caliper: {
-    send: "/events/1.0/",
+    send: "/caliper/v1p2",
     validate: null,
     list: null,
     get: null,
@@ -660,7 +662,9 @@ var LEARNWITHAI_PATHS = {
   edubridge: null,
   powerpath: null,
   clr: null,
-  case: null
+  case: {
+    base: "/case/1.1"
+  }
 };
 var PLATFORM_PATHS = {
   BEYOND_AI: BEYONDAI_PATHS,
@@ -697,6 +701,7 @@ class TimebackProvider {
   timeout;
   endpoints;
   authUrl;
+  tokenScope;
   pathProfiles;
   tokenManagers = new Map;
   constructor(config) {
@@ -712,6 +717,7 @@ class TimebackProvider {
         throw new Error(`Unknown platform: ${platform}`);
       }
       this.authUrl = platformEndpoints.token[env];
+      this.tokenScope = platformEndpoints.tokenScope ?? undefined;
       this.pathProfiles = PLATFORM_PATHS[platform] ?? BEYONDAI_PATHS;
       this.endpoints = {
         oneroster: {
@@ -837,7 +843,8 @@ class TimebackProvider {
         credentials: {
           clientId: this.auth.clientId,
           clientSecret: this.auth.clientSecret
-        }
+        },
+        scope: this.tokenScope
       });
       this.tokenManagers.set(authUrl, manager);
     }
@@ -855,7 +862,8 @@ class TimebackProvider {
         credentials: {
           clientId: this.auth.clientId,
           clientSecret: this.auth.clientSecret
-        }
+        },
+        scope: this.tokenScope
       });
       this.tokenManagers.set(this.authUrl, manager);
     }
@@ -1531,7 +1539,7 @@ function issue(path, message) {
 function validateWithSchema(schema, data, context) {
   const result = schema.safeParse(data);
   if (result.success) {
-    return;
+    return result.data;
   }
   const issues = result.error.issues.map((errorIssue) => ({
     path: errorIssue.path.join(".") || "(root)",

package/dist/errors.js

@@ -5,7 +5,7 @@ import {
   NotFoundError,
   UnauthorizedError,
   ValidationError
-} from "./chunk-ex772j6v.js";
+} from "./chunk-4fwv2yyb.js";
 import"./chunk-6jf1natv.js";
 export {
   ValidationError,

package/dist/index.d.ts

@@ -1461,8 +1461,8 @@ declare const OneRosterLineItemCreateInput = z
 		class: Ref,
 		school: Ref,
 		category: Ref,
-		assignDate: IsoDateTimeString,
-		dueDate: IsoDateTimeString,
+		assignDate: OneRosterDateString,
+		dueDate: OneRosterDateString,
 		status: Status,
 		description: z.string().optional(),
 		resultValueMin: z.number().nullable().optional(),
@@ -1487,7 +1487,7 @@ declare const OneRosterResultCreateInput = z
 		lineItem: Ref,
 		student: Ref,
 		class: Ref.optional(),
-		scoreDate: IsoDateTimeString,
+		scoreDate: OneRosterDateString,
 		scoreStatus: z.enum([
 			'exempt',
 			'fully graded',
@@ -1587,7 +1587,7 @@ declare const OneRosterAssessmentResultCreateInput = z
 		student: Ref,
 		score: z.number().nullable().optional(),
 		textScore: z.string().nullable().optional(),
-		scoreDate: z.string().datetime(),
+		scoreDate: OneRosterDateString,
 		scoreScale: Ref.nullable().optional(),
 		scorePercentile: z.number().nullable().optional(),
 		scoreStatus: z.enum([
@@ -3637,7 +3637,7 @@ declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>, P ext
      * This returns a single page plus metadata (`hasMore`, `total`, `nextOffset`).
      * Use `stream()` for lazy iteration or `listAll()` to fetch everything.
      *
-     * @param params - Optional filtering, sorting, and pagination parameters
+     * @param params - Optional `where` clause, sorting, and pagination parameters
      * @returns Promise resolving to the first page of matching resources
      *
      * @example
@@ -3650,14 +3650,14 @@ declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>, P ext
     /**
      * List all resources, fetching all pages automatically.
      *
-     * @param params - Optional filtering, sorting, and pagination parameters
+     * @param params - Optional `where` clause, sorting, and pagination parameters
      * @returns Promise resolving to an array of all matching resources
      */
     listAll(params?: P): Promise<T[]>;
     /**
      * Get the first matching resource, or undefined if none match.
      *
-     * @param params - Optional filtering parameters
+     * @param params - Optional `where` clause parameters
      * @returns The first matching resource, or undefined
      *
      * @example
@@ -3673,7 +3673,7 @@ declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>, P ext
      * Use this for large datasets where you want to process items
      * one at a time without loading everything into memory.
      *
-     * @param params - Optional filtering, sorting, and pagination parameters
+     * @param params - Optional `where` clause, sorting, and pagination parameters
      * @returns Async iterable paginator for streaming results
      * @throws {InputValidationError} If params are invalid (e.g., negative limit)
      *
@@ -3900,25 +3900,25 @@ declare class ScopedTermResource {
     exists(): Promise<boolean>;
     /**
      * List classes in this term.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
     /**
      * List grading periods in this term.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to grading period array
      */
     gradingPeriods(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Promise<GradingPeriod[]>;
     /**
      * Stream grading periods with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming grading periods
      */
     streamGradingPeriods(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Paginator<GradingPeriod, AcademicSessionFilterFields>;
@@ -4005,13 +4005,13 @@ declare class ScopedClassStudentResource {
     constructor(transport: OneRosterTransportLike, classId: string, studentId: string);
     /**
      * List results for this student in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to result array
      */
     results(params?: ListParamsNoSearch<ResultFilterFields>): Promise<Result[]>;
     /**
      * Stream results with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming results
      */
     streamResults(params?: ListParamsNoSearch<ResultFilterFields>): Paginator<Result, ResultFilterFields>;
@@ -4032,13 +4032,13 @@ declare class ScopedClassLineItemResource {
     constructor(transport: OneRosterTransportLike, classId: string, lineItemId: string);
     /**
      * List results for this line item in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to result array
      */
     results(params?: ListParamsNoSearch<ResultFilterFields>): Promise<Result[]>;
     /**
      * Stream results with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming results
      */
     streamResults(params?: ListParamsNoSearch<ResultFilterFields>): Paginator<Result, ResultFilterFields>;
@@ -4075,25 +4075,25 @@ declare class ScopedClassResource {
     exists(): Promise<boolean>;
     /**
      * List students in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     students(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream students with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming students
      */
     streamStudents(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
     /**
      * List teachers in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     teachers(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream teachers with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming teachers
      */
     streamTeachers(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
@@ -4111,13 +4111,13 @@ declare class ScopedClassResource {
     enroll(input: EnrollInput): Promise<CreateResponse>;
     /**
      * List line items (assignments) in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to line item array
      */
     lineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Promise<LineItem[]>;
     /**
      * Stream line items with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming line items
      */
     streamLineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Paginator<LineItem, LineItemFilterFields>;
@@ -4142,25 +4142,25 @@ declare class ScopedClassResource {
     createLineItem(data: LineItemCreateInput): Promise<CreateResponse>;
     /**
      * List results in this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to result array
      */
     results(params?: ListParamsNoSearch<ResultFilterFields>): Promise<Result[]>;
     /**
      * Stream results with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming results
      */
     streamResults(params?: ListParamsNoSearch<ResultFilterFields>): Paginator<Result, ResultFilterFields>;
     /**
      * List resources for this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to resource array
      */
     resources(params?: ListParamsNoSearch<ResourceFilterFields>): Promise<Resource[]>;
     /**
      * Stream resources with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming resources
      */
     streamResources(params?: ListParamsNoSearch<ResourceFilterFields>): Paginator<Resource, ResourceFilterFields>;
@@ -4203,25 +4203,25 @@ declare class ScopedClassResource {
     academicSession(sessionId: string): ScopedClassAcademicSessionResource;
     /**
      * List score scales for this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to score scale array
      */
     scoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Promise<ScoreScale[]>;
     /**
      * Stream score scales with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming score scales
      */
     streamScoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Paginator<ScoreScale, ScoreScaleFilterFields>;
     /**
      * List categories for this class.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to category array
      */
     categories(params?: ListParamsNoSearch<CategoryFilterFields>): Promise<Category[]>;
     /**
      * Stream categories with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming categories
      */
     streamCategories(params?: ListParamsNoSearch<CategoryFilterFields>): Paginator<Category, CategoryFilterFields>;
@@ -4263,37 +4263,37 @@ declare class ScopedCourseResource {
     exists(): Promise<boolean>;
     /**
      * List classes for this course.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
     /**
      * List components for this course.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to component array
      */
     components(params?: ListParamsNoSearch<CourseComponentFilterFields>): Promise<CourseComponent[]>;
     /**
      * Stream components with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming components
      */
     streamComponents(params?: ListParamsNoSearch<CourseComponentFilterFields>): Paginator<CourseComponent, CourseComponentFilterFields>;
     /**
      * List resources for this course.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to resource array
      */
     resources(params?: ListParamsNoSearch<ResourceFilterFields>): Promise<Resource[]>;
     /**
      * Stream resources with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming resources
      */
     streamResources(params?: ListParamsNoSearch<ResourceFilterFields>): Paginator<Resource, ResourceFilterFields>;
@@ -4321,37 +4321,37 @@ declare class ScopedSchoolClassResource {
     constructor(transport: OneRosterTransportLike, schoolId: string, classId: string);
     /**
      * List enrollments for this class within this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to enrollment array
      */
     enrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Promise<Enrollment[]>;
     /**
      * Stream enrollments with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming enrollments
      */
     streamEnrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
     /**
      * List students in this class at this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     students(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream students with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming students
      */
     streamStudents(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
     /**
      * List teachers for this class at this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     teachers(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream teachers with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming teachers
      */
     streamTeachers(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
@@ -4395,85 +4395,85 @@ declare class ScopedSchoolResource {
     class(classId: string): ScopedSchoolClassResource;
     /**
      * List classes in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
     /**
      * List enrollments in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to enrollment array
      */
     enrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Promise<Enrollment[]>;
     /**
      * Stream enrollments with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming enrollments
      */
     streamEnrollments(params?: ListParamsNoSearch<EnrollmentFilterFields>): Paginator<Enrollment, EnrollmentFilterFields>;
     /**
      * List students in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     students(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream students with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming students
      */
     streamStudents(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
     /**
      * List teachers in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to user array
      */
     teachers(params?: ListParamsNoSearch<UserFilterFields>): Promise<User[]>;
     /**
      * Stream teachers with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming teachers
      */
     streamTeachers(params?: ListParamsNoSearch<UserFilterFields>): Paginator<User, UserFilterFields>;
     /**
      * List courses in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to course array
      */
     courses(params?: ListParamsNoSearch<CourseFilterFields>): Promise<Course[]>;
     /**
      * Stream courses with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming courses
      */
     streamCourses(params?: ListParamsNoSearch<CourseFilterFields>): Paginator<Course, CourseFilterFields>;
     /**
      * List terms/academic sessions for this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to academic session array
      */
     terms(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Promise<AcademicSession[]>;
     /**
      * Stream terms with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming academic sessions
      */
     streamTerms(params?: ListParamsNoSearch<AcademicSessionFilterFields>): Paginator<AcademicSession, AcademicSessionFilterFields>;
     /**
      * List line items (assignments) in this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to line item array
      */
     lineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Promise<LineItem[]>;
     /**
      * Stream line items with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming line items
      */
     streamLineItems(params?: ListParamsNoSearch<LineItemFilterFields>): Paginator<LineItem, LineItemFilterFields>;
@@ -4498,13 +4498,13 @@ declare class ScopedSchoolResource {
     createLineItem(data: LineItemCreateInput): Promise<CreateResponse>;
     /**
      * List score scales for this school.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to score scale array
      */
     scoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Promise<ScoreScale[]>;
     /**
      * Stream score scales with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming score scales
      */
     streamScoreScales(params?: ListParamsNoSearch<ScoreScaleFilterFields>): Paginator<ScoreScale, ScoreScaleFilterFields>;
@@ -4552,25 +4552,25 @@ declare class ScopedUserResource {
     demographics(): Promise<User>;
     /**
      * List resources for this user.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to resource array
      */
     resources(params?: ListParamsNoSearch<ResourceFilterFields>): Promise<Resource[]>;
     /**
      * Stream resources with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming resources
      */
     streamResources(params?: ListParamsNoSearch<ResourceFilterFields>): Paginator<Resource, ResourceFilterFields>;
     /**
      * List classes for this user.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
@@ -4650,13 +4650,13 @@ declare class ScopedStudentResource {
     exists(): Promise<boolean>;
     /**
      * List classes this student is enrolled in.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
@@ -4688,13 +4688,13 @@ declare class ScopedTeacherResource {
     exists(): Promise<boolean>;
     /**
      * List classes this teacher is assigned to.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Promise resolving to class array
      */
     classes(params?: ListParamsNoSearch<ClassFilterFields>): Promise<Class$1[]>;
     /**
      * Stream classes with lazy pagination.
-     * @param params - Optional filter and pagination parameters
+     * @param params - Optional `where` clause and pagination parameters
      * @returns Paginator for streaming classes
      */
     streamClasses(params?: ListParamsNoSearch<ClassFilterFields>): Paginator<Class$1, ClassFilterFields>;
@@ -5015,9 +5015,9 @@ type OneRosterClientInstance = InstanceType<typeof OneRosterClient>;
  * ```typescript
  * const lineItem = await client.assessmentLineItems(lineItemId).get()
  *
- * // To get results for an assessment line item, use assessmentResults with a filter:
+ * // To get results for an assessment line item, use assessmentResults with a where clause:
  * const results = await client.assessmentResults.list({
- *   filter: { lineItem: { sourcedId: lineItemId } }
+ *   where: { 'assessmentLineItem.sourcedId': lineItemId }
  * })
  * ```
  */