/**
 * Callable Resource Types
 *
 * Types for callable resource patterns where
 * `resource(id)` returns a scoped resource and `resource.list()` etc.
 * access collection-level operations.
 */
import type { ListParams } from '@timeback/internal-client-infra';
import type { AssessmentLineItemCreateInput, ClassCreateInput, ComponentResourceCreateInput, CourseComponentCreateInput, CourseCreateInput, CourseStructureInput, LineItemCreateInput, ResourceCreateInput, SchoolCreateInput, UserCreateInput } from '@timeback/types/zod';
import type { Paginator } from '../lib';
import type { ScopedAssessmentLineItemResource } from '../resources/assessment/line-items';
import type { ScopedLineItemResource } from '../resources/gradebook/line-items';
import type { ScopedResourceResource } from '../resources/resources/resources';
import type { ScopedTermResource } from '../resources/rostering/academic-sessions';
import type { ScopedClassResource } from '../resources/rostering/classes';
import type { ScopedCourseResource } from '../resources/rostering/courses';
import type { ScopedSchoolResource } from '../resources/rostering/schools';
import type { ScopedStudentResource, ScopedTeacherResource, ScopedUserResource } from '../resources/rostering/users';
import type { AcademicSession, AcademicSessionFilterFields, AssessmentLineItem, AssessmentLineItemFilterFields, Base, Class, ClassFilterFields, ComponentResource, ComponentResourceFilterFields, Course, CourseComponent, CourseComponentFilterFields, CourseFilterFields, CreateResponse, LineItem, LineItemFilterFields, Organization, OrganizationFilterFields, Resource, ResourceFilterFields, User, UserFilterFields } from './index';
import type { ListParamsNoSearch, ListParamsWithSearch } from './list-params';
/**
 * Base interface for callable resources.
 * Resources that support scoping by ID implement this pattern.
 *
 * @template T - The entity type
 * @template F - Filter fields type
 * @template S - Scoped resource type returned when called with an ID
 * @template I - Input type for create/update (defaults to Partial<T>)
 */
export interface CallableResource<T extends Base, F, S, I = Partial<T>, P extends ListParams<F> = ListParams<F>, W = void> {
    /** Get a scoped resource for a specific entity */
    (id: string): S;
    /** List the first page of entities */
    list(params?: P): Promise<import('@timeback/internal-client-infra').PageResult<T>>;
    /** List all entities (fetches all pages) */
    listAll(params?: P): Promise<T[]>;
    /** Get the first matching entity, or undefined if none match */
    first(params?: P): Promise<T | undefined>;
    /** Stream entities with lazy pagination */
    stream(params?: P): Paginator<T, F>;
    /** Get a single entity by ID */
    get(id: string): Promise<T>;
    /** Check whether a single entity exists by ID */
    exists(id: string): Promise<boolean>;
    /** Create a new entity */
    create(data: I): Promise<CreateResponse>;
    /** Update an existing entity */
    update(id: string, data: Partial<I>): Promise<W>;
    /** Create or update an entity (falls back to create on 404) */
    upsert(id: string, data: Omit<I, 'sourcedId'>): Promise<W>;
    /** Delete an entity */
    delete(id: string): Promise<void>;
}
/**
 * Read-only callable resource (no create/update/delete).
 *
 * @template T - The entity type
 * @template F - Filter fields type
 * @template S - Scoped resource type returned when called with an ID
 */
export interface ReadOnlyCallableResource<T extends Base, F, S, P extends ListParams<F> = ListParams<F>> {
    /** Get a scoped resource for a specific entity */
    (id: string): S;
    /** List the first page of entities */
    list(params?: P): Promise<import('@timeback/internal-client-infra').PageResult<T>>;
    /** List all entities (fetches all pages) */
    listAll(params?: P): Promise<T[]>;
    /** Get the first matching entity, or undefined if none match */
    first(params?: P): Promise<T | undefined>;
    /** Stream entities with lazy pagination */
    stream(params?: P): Paginator<T, F>;
    /** Get a single entity by ID */
    get(id: string): Promise<T>;
    /** Check whether a single entity exists by ID */
    exists(id: string): Promise<boolean>;
}
/**
 * Callable courses resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const courses = await client.courses.list()
 * const course = await client.courses.get(id)
 *
 * // Scoped operations
 * const classes = await client.courses(courseId).classes()
 * ```
 */
export interface CoursesCallable extends CallableResource<Course, CourseFilterFields, ScopedCourseResource, CourseCreateInput, ListParamsWithSearch<CourseFilterFields>> {
    /** List all course components */
    components(params?: ListParamsNoSearch<CourseComponentFilterFields>): Promise<CourseComponent[]>;
    /** Stream course components with lazy pagination */
    streamComponents(params?: ListParamsNoSearch<CourseComponentFilterFields>): Paginator<CourseComponent, CourseComponentFilterFields>;
    /** Get a specific course component */
    getComponent(sourcedId: string): Promise<CourseComponent>;
    /** Create a new course component */
    createComponent(data: CourseComponentCreateInput): Promise<CreateResponse>;
    /** Update a course component */
    updateComponent(sourcedId: string, data: CourseComponentCreateInput): Promise<void>;
    /** Delete a course component */
    deleteComponent(sourcedId: string): Promise<void>;
    /** List all component resources */
    componentResources(params?: ListParamsNoSearch<ComponentResourceFilterFields>): Promise<ComponentResource[]>;
    /** Stream component resources with lazy pagination */
    streamComponentResources(params?: ListParamsNoSearch<ComponentResourceFilterFields>): Paginator<ComponentResource, ComponentResourceFilterFields>;
    /** Get a specific component resource */
    getComponentResource(sourcedId: string): Promise<ComponentResource>;
    /** Create a new component resource */
    createComponentResource(data: ComponentResourceCreateInput): Promise<CreateResponse>;
    /** Update a component resource */
    updateComponentResource(sourcedId: string, data: ComponentResourceCreateInput): Promise<void>;
    /** Delete a component resource */
    deleteComponentResource(sourcedId: string): Promise<void>;
    /** Create a course structure from QTI tests */
    createStructure(data: CourseStructureInput): Promise<CreateResponse>;
}
/**
 * Callable classes resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const classes = await client.classes.list()
 * const cls = await client.classes.get(id)
 *
 * // Scoped operations
 * const students = await client.classes(classId).students()
 * const lineItems = await client.classes(classId).lineItems()
 * ```
 */
export type ClassesCallable = CallableResource<Class, ClassFilterFields, ScopedClassResource, ClassCreateInput, ListParamsNoSearch<ClassFilterFields>>;
/**
 * Callable schools resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const schools = await client.schools.list()
 * const school = await client.schools.get(id)
 *
 * // Scoped operations
 * const classes = await client.schools(schoolId).classes()
 * const students = await client.schools(schoolId).students()
 * ```
 */
export type SchoolsCallable = CallableResource<Organization, OrganizationFilterFields, ScopedSchoolResource, SchoolCreateInput, ListParamsNoSearch<OrganizationFilterFields>>;
/**
 * Callable users resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const users = await client.users.list()
 * const user = await client.users.get(id)
 *
 * // Scoped operations
 * const resources = await client.users(userId).resources()
 * const classes = await client.users(userId).classes()
 * ```
 */
export type UsersCallable = CallableResource<User, UserFilterFields, ScopedUserResource, UserCreateInput, ListParamsWithSearch<UserFilterFields>>;
/**
 * Callable students resource (read-only).
 *
 * @example
 * ```typescript
 * // Collection operations
 * const students = await client.students.list()
 * const student = await client.students.get(id)
 *
 * // Scoped operations
 * const classes = await client.students(studentId).classes()
 * ```
 */
export type StudentsCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedStudentResource, ListParamsWithSearch<UserFilterFields>>;
/**
 * Callable teachers resource (read-only).
 *
 * @example
 * ```typescript
 * // Collection operations
 * const teachers = await client.teachers.list()
 * const teacher = await client.teachers.get(id)
 *
 * // Scoped operations
 * const classes = await client.teachers(teacherId).classes()
 * ```
 */
export type TeachersCallable = ReadOnlyCallableResource<User, UserFilterFields, ScopedTeacherResource, ListParamsNoSearch<UserFilterFields>>;
/**
 * Callable terms resource (read-only).
 *
 * @example
 * ```typescript
 * // Collection operations
 * const terms = await client.terms.list()
 * const term = await client.terms.get(id)
 *
 * // Scoped operations
 * const classes = await client.terms(termId).classes()
 * ```
 */
export type TermsCallable = ReadOnlyCallableResource<AcademicSession, AcademicSessionFilterFields, ScopedTermResource, ListParamsNoSearch<AcademicSessionFilterFields>>;
/**
 * Callable line items resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const lineItems = await client.lineItems.list()
 * const lineItem = await client.lineItems.get(id)
 *
 * // Scoped operations
 * const results = await client.lineItems(lineItemId).results()
 * ```
 */
export interface LineItemsCallable extends CallableResource<LineItem, LineItemFilterFields, ScopedLineItemResource, LineItemCreateInput, ListParamsNoSearch<LineItemFilterFields>, LineItem> {
}
/**
 * Callable assessment line items resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const lineItems = await client.assessmentLineItems.list()
 * const lineItem = await client.assessmentLineItems.get(id)
 *
 * // Partial update
 * await client.assessmentLineItems.patch(id, { score: 95 })
 * ```
 */
export interface AssessmentLineItemsCallable extends CallableResource<AssessmentLineItem, AssessmentLineItemFilterFields, ScopedAssessmentLineItemResource, AssessmentLineItemCreateInput, ListParamsNoSearch<AssessmentLineItemFilterFields>, AssessmentLineItem> {
    /** Partially update an assessment line item (only specified fields are changed) */
    patch(id: string, data: Partial<AssessmentLineItem>): Promise<void>;
}
/**
 * Callable resources resource.
 *
 * @example
 * ```typescript
 * // Collection operations
 * const resources = await client.resources.list()
 * const resource = await client.resources.get(id)
 *
 * // Nested resource queries (following convention)
 * const classResources = await client.classes(classId).resources()
 * const courseResources = await client.courses(courseId).resources()
 * const userResources = await client.users(userId).resources()
 *
 * // Export
 * await client.resources.export(resourceId)
 * ```
 */
export interface ResourcesCallable extends CallableResource<Resource, ResourceFilterFields, ScopedResourceResource, ResourceCreateInput, ListParamsNoSearch<ResourceFilterFields>> {
    /** Export a resource to Common Cartridge (.zip) as an ArrayBuffer */
    export(resourceId: string): Promise<ArrayBuffer>;
}
//# sourceMappingURL=callable.d.ts.map