@studyfetch/sdk 1.33.0 → 1.35.0

package/src/resources/v1/assignment-grader/assignment-grader.ts

@@ -0,0 +1,421 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as RubricTemplatesAPI from './rubric-templates';
+import {
+  RubricTemplateCreateParams,
+  RubricTemplateCreateResponse,
+  RubricTemplateGetByIDResponse,
+  RubricTemplateListResponse,
+  RubricTemplates,
+} from './rubric-templates';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class AssignmentGrader extends APIResource {
+  rubricTemplates: RubricTemplatesAPI.RubricTemplates = new RubricTemplatesAPI.RubricTemplates(this._client);
+
+  /**
+   * Grade a new assignment
+   *
+   * @example
+   * ```ts
+   * const assignmentGrader =
+   *   await client.v1.assignmentGrader.create({
+   *     title: 'title',
+   *   });
+   * ```
+   */
+  create(
+    body: AssignmentGraderCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AssignmentGraderCreateResponse> {
+    return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
+  }
+
+  /**
+   * Delete an assignment grader by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.assignmentGrader.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/assignment-grader/delete/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Generate educator report for an assignment
+   *
+   * @example
+   * ```ts
+   * await client.v1.assignmentGrader.generateReport(
+   *   'assignmentId',
+   * );
+   * ```
+   */
+  generateReport(assignmentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/assignment-grader/educator-report/${assignmentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get all assignment graders
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.assignmentGrader.getAll();
+   * ```
+   */
+  getAll(options?: RequestOptions): APIPromise<AssignmentGraderGetAllResponse> {
+    return this._client.get('/api/v1/assignment-grader/get', options);
+  }
+
+  /**
+   * Get an assignment grader by ID
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.assignmentGrader.getByID(
+   *   'id',
+   * );
+   * ```
+   */
+  getByID(id: string, options?: RequestOptions): APIPromise<AssignmentGraderGetByIDResponse> {
+    return this._client.get(path`/api/v1/assignment-grader/get/${id}`, options);
+  }
+}
+
+export interface AssignmentGraderCreateResponse {
+  gradedAssignment?: AssignmentGraderCreateResponse.GradedAssignment;
+
+  success?: boolean;
+}
+
+export namespace AssignmentGraderCreateResponse {
+  export interface GradedAssignment {
+    /**
+     * Version key
+     */
+    __v: number;
+
+    /**
+     * Assignment grader ID
+     */
+    _id: string;
+
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * Overall grade percentage
+     */
+    grade: number;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Grading results
+     */
+    rubric: unknown;
+
+    /**
+     * Assignment title
+     */
+    title: string;
+
+    /**
+     * Update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Assignment ID for grouping
+     */
+    assignmentId?: string;
+
+    /**
+     * Material ID
+     */
+    materialId?: string;
+
+    /**
+     * Rubric template ID
+     */
+    rubricTemplateId?: string;
+
+    /**
+     * Student identifier
+     */
+    studentIdentifier?: string;
+
+    /**
+     * Text that was graded
+     */
+    textToGrade?: string;
+
+    /**
+     * User ID
+     */
+    userId?: string;
+  }
+}
+
+export type AssignmentGraderGetAllResponse =
+  Array<AssignmentGraderGetAllResponse.AssignmentGraderGetAllResponseItem>;
+
+export namespace AssignmentGraderGetAllResponse {
+  export interface AssignmentGraderGetAllResponseItem {
+    /**
+     * Version key
+     */
+    __v: number;
+
+    /**
+     * Assignment grader ID
+     */
+    _id: string;
+
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * Overall grade percentage
+     */
+    grade: number;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Grading results
+     */
+    rubric: unknown;
+
+    /**
+     * Assignment title
+     */
+    title: string;
+
+    /**
+     * Update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Assignment ID for grouping
+     */
+    assignmentId?: string;
+
+    /**
+     * Material ID
+     */
+    materialId?: string;
+
+    /**
+     * Rubric template ID
+     */
+    rubricTemplateId?: string;
+
+    /**
+     * Student identifier
+     */
+    studentIdentifier?: string;
+
+    /**
+     * Text that was graded
+     */
+    textToGrade?: string;
+
+    /**
+     * User ID
+     */
+    userId?: string;
+  }
+}
+
+export interface AssignmentGraderGetByIDResponse {
+  /**
+   * Version key
+   */
+  __v: number;
+
+  /**
+   * Assignment grader ID
+   */
+  _id: string;
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Overall grade percentage
+   */
+  grade: number;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Grading results
+   */
+  rubric: unknown;
+
+  /**
+   * Assignment title
+   */
+  title: string;
+
+  /**
+   * Update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Assignment ID for grouping
+   */
+  assignmentId?: string;
+
+  /**
+   * Material ID
+   */
+  materialId?: string;
+
+  /**
+   * Rubric template ID
+   */
+  rubricTemplateId?: string;
+
+  /**
+   * Student identifier
+   */
+  studentIdentifier?: string;
+
+  /**
+   * Text that was graded
+   */
+  textToGrade?: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+}
+
+export interface AssignmentGraderCreateParams {
+  /**
+   * Title of the assignment
+   */
+  title: string;
+
+  /**
+   * Assignment ID for grouping submissions
+   */
+  assignmentId?: string;
+
+  /**
+   * Material ID to grade
+   */
+  materialId?: string;
+
+  /**
+   * AI model to use
+   */
+  model?: string;
+
+  /**
+   * Grading rubric
+   */
+  rubric?: AssignmentGraderCreateParams.Rubric;
+
+  /**
+   * Rubric template ID to use
+   */
+  rubricTemplateId?: string;
+
+  /**
+   * Student identifier (email or ID)
+   */
+  studentIdentifier?: string;
+
+  /**
+   * Text content to grade
+   */
+  textToGrade?: string;
+
+  /**
+   * User ID for tracking
+   */
+  userId?: string;
+}
+
+export namespace AssignmentGraderCreateParams {
+  /**
+   * Grading rubric
+   */
+  export interface Rubric {
+    /**
+     * Grading criteria
+     */
+    criteria: Array<Rubric.Criterion>;
+  }
+
+  export namespace Rubric {
+    export interface Criterion {
+      /**
+       * Points possible for this criterion
+       */
+      pointsPossible: number;
+
+      /**
+       * Title of the criterion
+       */
+      title: string;
+
+      /**
+       * Description of the criterion
+       */
+      description?: string;
+    }
+  }
+}
+
+AssignmentGrader.RubricTemplates = RubricTemplates;
+
+export declare namespace AssignmentGrader {
+  export {
+    type AssignmentGraderCreateResponse as AssignmentGraderCreateResponse,
+    type AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse,
+    type AssignmentGraderGetByIDResponse as AssignmentGraderGetByIDResponse,
+    type AssignmentGraderCreateParams as AssignmentGraderCreateParams,
+  };
+
+  export {
+    RubricTemplates as RubricTemplates,
+    type RubricTemplateCreateResponse as RubricTemplateCreateResponse,
+    type RubricTemplateListResponse as RubricTemplateListResponse,
+    type RubricTemplateGetByIDResponse as RubricTemplateGetByIDResponse,
+    type RubricTemplateCreateParams as RubricTemplateCreateParams,
+  };
+}

package/src/resources/v1/assignment-grader/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AssignmentGrader,
+  type AssignmentGraderCreateResponse,
+  type AssignmentGraderGetAllResponse,
+  type AssignmentGraderGetByIDResponse,
+  type AssignmentGraderCreateParams,
+} from './assignment-grader';
+export {
+  RubricTemplates,
+  type RubricTemplateCreateResponse,
+  type RubricTemplateListResponse,
+  type RubricTemplateGetByIDResponse,
+  type RubricTemplateCreateParams,
+} from './rubric-templates';