/** * 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 { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index'; export interface AdminGetChatRequest { xUserId: string; chatId: string; } export interface AdminGetChatAnalysisRequest { xUserId: string; chatId: string; } export interface AdminGetCohortStatsRequest { xUserId: string; since: Date; until: Date; } export interface AdminGetQuizSessionSummaryRequest { xUserId: string; sessionId: string; } export interface AdminGetStudyObjectiveSummaryRequest { xUserId: string; } export interface AdminGetUserChatsRequest { xUserId: string; externalId: string; } export interface AdminGetUserEngagementRequest { xUserId: string; externalId: string; } export interface AdminListActiveStreaksRequest { xUserId: string; limit?: number; cursor?: string; } export interface AdminListChatsRequest { xUserId: string; limit?: number; cursor?: string; chatType?: string; forReview?: boolean; } export interface AdminListQuizSessionsRequest { xUserId: string; limit?: number; cursor?: string; mode?: AdminListQuizSessionsModeEnum; status?: AdminListQuizSessionsStatusEnum; } export interface AdminListStudyObjectivesRequest { xUserId: string; limit?: number; cursor?: string; origin?: AdminListStudyObjectivesOriginEnum; archived?: AdminListStudyObjectivesArchivedEnum; courseId?: string; hasQuiz?: boolean; accountUserId?: string; userId?: string; } export interface AdminListStudyObjectivesByUserRequest { xUserId: string; limit?: number; cursor?: string; origin?: AdminListStudyObjectivesByUserOriginEnum; archived?: AdminListStudyObjectivesByUserArchivedEnum; courseId?: string; hasQuiz?: boolean; } export interface AdminListTaxonomyEnrollmentsRequest { xUserId: string; limit?: number; cursor?: string; } export interface AdminListTopStreaksRequest { xUserId: string; limit?: number; } export interface AdminResetUserLearningDataRequest { xUserId: string; externalId: string; } export interface AdminTriggerChatAnalysisRequest { xUserId: string; chatId: string; } export interface AdminUpdateChatOperationRequest { xUserId: string; chatId: string; adminUpdateChatRequest: AdminUpdateChatRequest; } /** * */ export declare class AdminApi extends runtime.BaseAPI { /** * Get any chat by ID within the account */ adminGetChatRaw(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get any chat by ID within the account */ adminGetChat(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get chat analysis for any chat within the account */ adminGetChatAnalysisRaw(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get chat analysis for any chat within the account */ adminGetChatAnalysis(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get cohort statistics for users created within a date range */ adminGetCohortStatsRaw(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get cohort statistics for users created within a date range */ adminGetCohortStats(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the session summary (quiz details, questions, responses, score) for any quiz session belonging to a user within the caller\'s account. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Unlike the per-user `getQuizSessionSummary` endpoint, this endpoint does not gate on the `enhanced-quizzing` feature flag; an admin can read any historical session in their account regardless of whether the chat owner currently has the feature. * Get quiz session summary for any session within the account */ adminGetQuizSessionSummaryRaw(requestParameters: AdminGetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the session summary (quiz details, questions, responses, score) for any quiz session belonging to a user within the caller\'s account. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Unlike the per-user `getQuizSessionSummary` endpoint, this endpoint does not gate on the `enhanced-quizzing` feature flag; an admin can read any historical session in their account regardless of whether the chat owner currently has the feature. * Get quiz session summary for any session within the account */ adminGetQuizSessionSummary(requestParameters: AdminGetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. Intended for admin-style analytics views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * Aggregate study-objective statistics across all account users */ adminGetStudyObjectiveSummaryRaw(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. Intended for admin-style analytics views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * Aggregate study-objective statistics across all account users */ adminGetStudyObjectiveSummary(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get chats with stats for a user */ adminGetUserChatsRaw(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get chats with stats for a user */ adminGetUserChats(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get engagement dates for a user */ adminGetUserEngagementRaw(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get engagement dates for a user */ adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * List all active streaks (currentDays > 0) across the account, paginated */ adminListActiveStreaksRaw(requestParameters: AdminListActiveStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List all active streaks (currentDays > 0) across the account, paginated */ adminListActiveStreaks(requestParameters: AdminListActiveStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * List recent chats across all account users */ adminListChatsRaw(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List recent chats across all account users */ adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a paginated list of quiz sessions belonging to users within the caller\'s account, ordered by start date (newest first), with embedded quiz info, the owning user\'s external id, and a score summary (including the number of questions answered). Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Questions and responses are not included; fetch them per session via the summary endpoint. Like the summary endpoint, this is not gated on the `enhanced-quizzing` feature flag. * List recent quiz sessions across all account users */ adminListQuizSessionsRaw(requestParameters: AdminListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a paginated list of quiz sessions belonging to users within the caller\'s account, ordered by start date (newest first), with embedded quiz info, the owning user\'s external id, and a score summary (including the number of questions answered). Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Questions and responses are not included; fetch them per session via the summary endpoint. Like the summary endpoint, this is not gated on the `enhanced-quizzing` feature flag. * List recent quiz sessions across all account users */ adminListQuizSessions(requestParameters: AdminListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * List study objectives across all account users */ adminListStudyObjectivesRaw(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * List study objectives across all account users */ adminListStudyObjectives(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * Per-user study-objective counts across all account users */ adminListStudyObjectivesByUserRaw(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. * Per-user study-objective counts across all account users */ adminListStudyObjectivesByUser(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * List all taxonomy enrollments across the account */ adminListTaxonomyEnrollmentsRaw(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List all taxonomy enrollments across the account */ adminListTaxonomyEnrollments(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * List top N streaks across the account */ adminListTopStreaksRaw(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * List top N streaks across the account */ adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Wipes all per-user learning data (chats, quizzes, flashcards, study objectives, concepts, streaks, files, etc.) for the target user while preserving their account-user and user records — and therefore their external identity and Canvas connection. Does not re-seed any demo data. Intended for single-account demo/test users: learning streaks are keyed on the user (not the account), so a user who belongs to multiple accounts has their streak cleared everywhere. * Reset a user\'s Athena learning data to a blank slate */ adminResetUserLearningDataRaw(requestParameters: AdminResetUserLearningDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Wipes all per-user learning data (chats, quizzes, flashcards, study objectives, concepts, streaks, files, etc.) for the target user while preserving their account-user and user records — and therefore their external identity and Canvas connection. Does not re-seed any demo data. Intended for single-account demo/test users: learning streaks are keyed on the user (not the account), so a user who belongs to multiple accounts has their streak cleared everywhere. * Reset a user\'s Athena learning data to a blank slate */ adminResetUserLearningData(requestParameters: AdminResetUserLearningDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Trigger re-analysis for a chat */ adminTriggerChatAnalysisRaw(requestParameters: AdminTriggerChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Trigger re-analysis for a chat */ adminTriggerChatAnalysis(requestParameters: AdminTriggerChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update a chat (admin) */ adminUpdateChatRaw(requestParameters: AdminUpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a chat (admin) */ adminUpdateChat(requestParameters: AdminUpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const AdminListQuizSessionsModeEnum: { readonly Quiz: "quiz"; readonly Flashcards: "flashcards"; }; export type AdminListQuizSessionsModeEnum = typeof AdminListQuizSessionsModeEnum[keyof typeof AdminListQuizSessionsModeEnum]; /** * @export */ export declare const AdminListQuizSessionsStatusEnum: { readonly Active: "active"; readonly Completed: "completed"; readonly Abandoned: "abandoned"; }; export type AdminListQuizSessionsStatusEnum = typeof AdminListQuizSessionsStatusEnum[keyof typeof AdminListQuizSessionsStatusEnum]; /** * @export */ export declare const AdminListStudyObjectivesOriginEnum: { readonly Custom: "custom"; readonly Canvas: "canvas"; readonly Syllabus: "syllabus"; }; export type AdminListStudyObjectivesOriginEnum = typeof AdminListStudyObjectivesOriginEnum[keyof typeof AdminListStudyObjectivesOriginEnum]; /** * @export */ export declare const AdminListStudyObjectivesArchivedEnum: { readonly Active: "active"; readonly Archived: "archived"; readonly All: "all"; }; export type AdminListStudyObjectivesArchivedEnum = typeof AdminListStudyObjectivesArchivedEnum[keyof typeof AdminListStudyObjectivesArchivedEnum]; /** * @export */ export declare const AdminListStudyObjectivesByUserOriginEnum: { readonly Custom: "custom"; readonly Canvas: "canvas"; readonly Syllabus: "syllabus"; }; export type AdminListStudyObjectivesByUserOriginEnum = typeof AdminListStudyObjectivesByUserOriginEnum[keyof typeof AdminListStudyObjectivesByUserOriginEnum]; /** * @export */ export declare const AdminListStudyObjectivesByUserArchivedEnum: { readonly Active: "active"; readonly Archived: "archived"; readonly All: "all"; }; export type AdminListStudyObjectivesByUserArchivedEnum = typeof AdminListStudyObjectivesByUserArchivedEnum[keyof typeof AdminListStudyObjectivesByUserArchivedEnum];