@timeback/oneroster 0.1.9-beta.20260310173551 → 0.2.0

package/dist/resources/assessment/line-items.d.ts

@@ -13,9 +13,9 @@ import type { AssessmentLineItem, AssessmentLineItemsCallable, OneRosterTranspor
  * ```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 }
  * })
  * ```
  */

package/dist/resources/base.d.ts

@@ -39,7 +39,7 @@ export declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>
      * 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
@@ -52,14 +52,14 @@ export declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>
     /**
      * 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
@@ -75,7 +75,7 @@ export declare abstract class BaseResource<T extends Base, F = T, I = Partial<T>
      * 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)
      *
@@ -274,21 +274,21 @@ export declare abstract class ReadOnlyResource<T extends Base, F = T, P extends
     /**
      * List the first page of resources.
      *
-     * @param params - Optional filtering, sorting, and pagination parameters
+     * @param params - Optional `where` clause, sorting, and pagination parameters
      * @returns Promise resolving to the first page (data + pagination metadata)
      */
     list(params?: P): Promise<PageResult<T>>;
     /**
      * 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
      */
     first(params?: P): Promise<T | undefined>;
@@ -298,7 +298,7 @@ export declare abstract class ReadOnlyResource<T extends Base, F = T, P extends
      * 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)
      */

package/dist/resources/rostering/academic-sessions.d.ts

@@ -48,25 +48,25 @@ export 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[]>;
     /**
      * 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, 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>;

package/dist/resources/rostering/classes.d.ts

@@ -52,13 +52,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>;
@@ -79,13 +79,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>;
@@ -122,25 +122,25 @@ export 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>;
@@ -158,13 +158,13 @@ export 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>;
@@ -189,25 +189,25 @@ export 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>;
@@ -250,25 +250,25 @@ export 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>;

package/dist/resources/rostering/courses.d.ts

@@ -35,37 +35,37 @@ export 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[]>;
     /**
      * 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, 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>;

package/dist/resources/rostering/schools.d.ts

@@ -22,37 +22,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>;
@@ -96,85 +96,85 @@ export 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[]>;
     /**
      * 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, 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>;
@@ -199,13 +199,13 @@ export 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>;

package/dist/resources/rostering/users.d.ts

@@ -44,25 +44,25 @@ export 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[]>;
     /**
      * 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, ClassFilterFields>;
@@ -148,13 +148,13 @@ export 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[]>;
     /**
      * 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, ClassFilterFields>;
@@ -186,13 +186,13 @@ export 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[]>;
     /**
      * 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, ClassFilterFields>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@timeback/oneroster",
-	"version": "0.1.9-beta.20260310173551",
+	"version": "0.2.0",
 	"type": "module",
 	"exports": {
 		".": {