/** * Athena API * REST API for the Athena system * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { PaginatedQuizSessions, QuizConceptSummary, QuizQuestionView, QuizResponse, QuizSession, QuizSessionSummary, RecordQuizQuestionViewRequest, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index'; export interface CreateQuizSessionRequest { quizId: string; xUserId: string; } export interface GetQuizSessionConceptSummaryRequest { sessionId: string; xUserId: string; } export interface GetQuizSessionSummaryRequest { sessionId: string; xUserId: string; } export interface ListQuizSessionsRequest { xUserId: string; limit?: number; cursor?: string; mode?: ListQuizSessionsModeEnum; status?: ListQuizSessionsStatusEnum; } export interface RecordQuizQuestionViewOperationRequest { sessionId: string; xUserId: string; recordQuizQuestionViewRequest: RecordQuizQuestionViewRequest; } export interface SubmitQuizResponseOperationRequest { sessionId: string; xUserId: string; submitQuizResponseRequest: SubmitQuizResponseRequest; } export interface UpdateQuizSessionOperationRequest { sessionId: string; xUserId: string; updateQuizSessionRequest: UpdateQuizSessionRequest; } /** * */ export declare class QuizSessionsApi extends runtime.BaseAPI { /** * Creates a new session for taking a quiz. Only the quiz owner can create sessions. * Create a quiz session */ createQuizSessionRaw(requestParameters: CreateQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new session for taking a quiz. Only the quiz owner can create sessions. * Create a quiz session */ createQuizSession(requestParameters: CreateQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns each concept assessed during the session with its mastery strength and tier before and after the session. * Get quiz session concept mastery summary */ getQuizSessionConceptSummaryRaw(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns each concept assessed during the session with its mastery strength and tier before and after the session. * Get quiz session concept mastery summary */ getQuizSessionConceptSummary(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the session summary with quiz details, questions, responses, and score breakdown. * Get quiz session summary */ getQuizSessionSummaryRaw(requestParameters: GetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the session summary with quiz details, questions, responses, and score breakdown. * Get quiz session summary */ getQuizSessionSummary(requestParameters: GetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary. * List user quiz sessions */ listQuizSessionsRaw(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary. * List user quiz sessions */ listQuizSessions(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Increments the view count for a question within a quiz session. Records passive exposure (e.g. a flashcard the user saw or flipped) independently of whether they submitted an answer. The view count aggregates across all sessions of the question\'s quiz. * Record a question view */ recordQuizQuestionViewRaw(requestParameters: RecordQuizQuestionViewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Increments the view count for a question within a quiz session. Records passive exposure (e.g. a flashcard the user saw or flipped) independently of whether they submitted an answer. The view count aggregates across all sessions of the question\'s quiz. * Record a question view */ recordQuizQuestionView(requestParameters: RecordQuizQuestionViewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Submits an answer for a question within a quiz session. * Submit a quiz response */ submitQuizResponseRaw(requestParameters: SubmitQuizResponseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Submits an answer for a question within a quiz session. * Submit a quiz response */ submitQuizResponse(requestParameters: SubmitQuizResponseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates the status of a quiz session. Sets completedAt when status is \"completed\". * Update quiz session status */ updateQuizSessionRaw(requestParameters: UpdateQuizSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates the status of a quiz session. Sets completedAt when status is \"completed\". * Update quiz session status */ updateQuizSession(requestParameters: UpdateQuizSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListQuizSessionsModeEnum: { readonly Quiz: "quiz"; readonly Flashcards: "flashcards"; }; export type ListQuizSessionsModeEnum = typeof ListQuizSessionsModeEnum[keyof typeof ListQuizSessionsModeEnum]; /** * @export */ export declare const ListQuizSessionsStatusEnum: { readonly Active: "active"; readonly Completed: "completed"; readonly Abandoned: "abandoned"; }; export type ListQuizSessionsStatusEnum = typeof ListQuizSessionsStatusEnum[keyof typeof ListQuizSessionsStatusEnum];