# athena-api-client@1.0.0 A TypeScript SDK client for the localhost API. ## Usage First, install the SDK from npm. ```bash npm install athena-api-client --save ``` Next, try it out. ```ts import { Configuration, AccountsApi, } from 'athena-api-client'; import type { CreateAccountOperationRequest } from 'athena-api-client'; async function example() { console.log("🚀 Testing athena-api-client SDK..."); const config = new Configuration({ // To configure API key authorization: AuthToken apiKey: "YOUR API KEY", }); const api = new AccountsApi(config); const body = { // CreateAccountRequest createAccountRequest: ..., } satisfies CreateAccountOperationRequest; try { const data = await api.createAccount(body); console.log(data); } catch (error) { console.error(error); } } // Run the test example().catch(console.error); ``` ## Documentation ### API Endpoints All URIs are relative to *http://localhost:3000* | Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- *AccountsApi* | [**createAccount**](docs/AccountsApi.md#createaccountoperation) | **POST** /api/v1/accounts | Create a new account *AccountsApi* | [**listAccounts**](docs/AccountsApi.md#listaccounts) | **GET** /api/v1/accounts | List all accounts *AccountsApi* | [**updateAccount**](docs/AccountsApi.md#updateaccount) | **PATCH** /api/v1/accounts/{id} | Update an account *AdminApi* | [**adminGetChat**](docs/AdminApi.md#admingetchat) | **GET** /api/v1/admin/chats/{chatId} | Get any chat by ID within the account *AdminApi* | [**adminGetChatAnalysis**](docs/AdminApi.md#admingetchatanalysis) | **GET** /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account *AdminApi* | [**adminGetCohortStats**](docs/AdminApi.md#admingetcohortstats) | **GET** /api/v1/admin/cohort-stats | Get cohort statistics for users created within a date range *AdminApi* | [**adminGetQuizSessionSummary**](docs/AdminApi.md#admingetquizsessionsummary) | **GET** /api/v1/admin/quiz-sessions/{sessionId}/summary | Get quiz session summary for any session within the account *AdminApi* | [**adminGetStudyObjectiveSummary**](docs/AdminApi.md#admingetstudyobjectivesummary) | **GET** /api/v1/admin/study-objectives/summary | Aggregate study-objective statistics across all account users *AdminApi* | [**adminGetUserChats**](docs/AdminApi.md#admingetuserchats) | **GET** /api/v1/admin/users/{externalId}/chats | Get chats with stats for a user *AdminApi* | [**adminGetUserEngagement**](docs/AdminApi.md#admingetuserengagement) | **GET** /api/v1/admin/users/{externalId}/engagement | Get engagement dates for a user *AdminApi* | [**adminListActiveStreaks**](docs/AdminApi.md#adminlistactivestreaks) | **GET** /api/v1/admin/streaks/active | List all active streaks (currentDays > 0) across the account, paginated *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users *AdminApi* | [**adminListQuizSessions**](docs/AdminApi.md#adminlistquizsessions) | **GET** /api/v1/admin/quiz-sessions | List recent quiz sessions across all account users *AdminApi* | [**adminListStudyObjectives**](docs/AdminApi.md#adminliststudyobjectives) | **GET** /api/v1/admin/study-objectives | List study objectives across all account users *AdminApi* | [**adminListStudyObjectivesByUser**](docs/AdminApi.md#adminliststudyobjectivesbyuser) | **GET** /api/v1/admin/study-objectives/by-user | Per-user study-objective counts across all account users *AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account *AdminApi* | [**adminResetUserLearningData**](docs/AdminApi.md#adminresetuserlearningdata) | **POST** /api/v1/admin/users/{externalId}/reset-learning-data | Reset a user\'s Athena learning data to a blank slate *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat *AdminApi* | [**adminUpdateChat**](docs/AdminApi.md#adminupdatechatoperation) | **PATCH** /api/v1/admin/chats/{chatId} | Update a chat (admin) *CanvasCourseAccessApi* | [**getCanvasCourseAccess**](docs/CanvasCourseAccessApi.md#getcanvascourseaccess) | **GET** /api/v1/canvas/course-access | Read the Canvas course-access map Athena is enforcing *CanvasDomainSearchApi* | [**searchCanvasDomain**](docs/CanvasDomainSearchApi.md#searchcanvasdomain) | **POST** /api/v1/canvas/domain-search | AI-ranked Canvas domain search *ChatAnalysisApi* | [**getChatAnalysis**](docs/ChatAnalysisApi.md#getchatanalysis) | **GET** /api/v1/chats/{chatId}/analysis | Get chat analysis *ChatsApi* | [**createChat**](docs/ChatsApi.md#createchatoperation) | **POST** /api/v1/chats | Create a chat *ChatsApi* | [**deleteChat**](docs/ChatsApi.md#deletechat) | **DELETE** /api/v1/chats/{chatId} | Delete a chat *ChatsApi* | [**getChat**](docs/ChatsApi.md#getchat) | **GET** /api/v1/chats/{chatId} | Get a chat *ChatsApi* | [**listChats**](docs/ChatsApi.md#listchats) | **GET** /api/v1/chats | List chats *ChatsApi* | [**markChatAsViewed**](docs/ChatsApi.md#markchatasviewed) | **PATCH** /api/v1/chats/{chatId}/viewed | Mark chat as viewed *ChatsApi* | [**resumeChatStream**](docs/ChatsApi.md#resumechatstream) | **GET** /api/v1/chat/{chatId}/stream | Resume a chat stream *ChatsApi* | [**sendChatMessage**](docs/ChatsApi.md#sendchatmessage) | **POST** /api/v1/chat | Send a message to a chat *ChatsApi* | [**updateChat**](docs/ChatsApi.md#updatechatoperation) | **PATCH** /api/v1/chats/{chatId} | Update a chat *DailyQuizApi* | [**createDailyQuiz**](docs/DailyQuizApi.md#createdailyquiz) | **POST** /api/v1/daily-quiz | Get or create today\'s daily quiz *DailyQuizApi* | [**getDailyQuiz**](docs/DailyQuizApi.md#getdailyquiz) | **GET** /api/v1/daily-quiz | Get today\'s daily quiz *FeatureOverridesApi* | [**deleteFeatureOverride**](docs/FeatureOverridesApi.md#deletefeatureoverride) | **DELETE** /api/v1/feature-overrides/{id} | Delete a feature override *FeatureOverridesApi* | [**listFeatureOverrides**](docs/FeatureOverridesApi.md#listfeatureoverrides) | **GET** /api/v1/feature-overrides | List feature overrides *FeatureOverridesApi* | [**upsertFeatureOverride**](docs/FeatureOverridesApi.md#upsertfeatureoverride) | **PUT** /api/v1/feature-overrides | Upsert a feature override for an account *FeaturesApi* | [**createFeature**](docs/FeaturesApi.md#createfeature) | **POST** /api/v1/features | Create a new feature *FeaturesApi* | [**deleteFeature**](docs/FeaturesApi.md#deletefeature) | **DELETE** /api/v1/features/{id} | Delete a feature *FeaturesApi* | [**getFeature**](docs/FeaturesApi.md#getfeature) | **GET** /api/v1/features/{id} | Get feature by ID *FeaturesApi* | [**listFeatures**](docs/FeaturesApi.md#listfeatures) | **GET** /api/v1/features | List all features *FeaturesApi* | [**listMyFeatures**](docs/FeaturesApi.md#listmyfeatures) | **GET** /api/v1/me/features | List the calling user\'s enabled features *FeaturesApi* | [**updateFeature**](docs/FeaturesApi.md#updatefeature) | **PATCH** /api/v1/features/{id} | Update a feature *FilesApi* | [**getFileUploadUrls**](docs/FilesApi.md#getfileuploadurls) | **POST** /api/v1/files/upload-url | Get presigned upload URLs *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint *LearningDaysApi* | [**getLearningDays**](docs/LearningDaysApi.md#getlearningdays) | **GET** /api/v1/learning-days | Get learning days in range *LearningMomentsApi* | [**getLearningMomentsCount**](docs/LearningMomentsApi.md#getlearningmomentscount) | **GET** /api/v1/learning-moments/count | Get learning moments count *LearningMomentsApi* | [**listLearningMoments**](docs/LearningMomentsApi.md#listlearningmoments) | **GET** /api/v1/learning-moments | List learning moments *LearningSessionEvaluationsApi* | [**listLearningSessionEvaluations**](docs/LearningSessionEvaluationsApi.md#listlearningsessionevaluations) | **GET** /api/v1/chats/{chatId}/learning-session-evaluations | List learning session evaluations for a chat *LearningSessionEvaluationsApi* | [**listLearningSessionEvaluationsForConcept**](docs/LearningSessionEvaluationsApi.md#listlearningsessionevaluationsforconcept) | **GET** /api/v1/user-concepts/{conceptId}/learning-session-evaluations | List learning session evaluations for a concept *LearningStreakApi* | [**getLearningStreak**](docs/LearningStreakApi.md#getlearningstreak) | **GET** /api/v1/learning-streak | Get learning streak *MessagesApi* | [**createChatMessages**](docs/MessagesApi.md#createchatmessages) | **POST** /api/v1/chats/{chatId}/messages | Save messages to a chat *MessagesApi* | [**deleteMessages**](docs/MessagesApi.md#deletemessages) | **DELETE** /api/v1/chats/{chatId}/messages | Delete messages from timestamp *MessagesApi* | [**getChatMessage**](docs/MessagesApi.md#getchatmessage) | **GET** /api/v1/chats/{chatId}/messages/{messageId} | Get a chat message *MessagesApi* | [**getChatMessages**](docs/MessagesApi.md#getchatmessages) | **GET** /api/v1/chats/{chatId}/messages | List chat messages *MessagesApi* | [**getMessageCount**](docs/MessagesApi.md#getmessagecount) | **GET** /api/v1/messages/count | Count user messages *PlansApi* | [**createPlan**](docs/PlansApi.md#createplan) | **POST** /api/v1/plans | Create a new plan *PlansApi* | [**deletePlan**](docs/PlansApi.md#deleteplan) | **DELETE** /api/v1/plans/{id} | Delete a plan *PlansApi* | [**getPlan**](docs/PlansApi.md#getplan) | **GET** /api/v1/plans/{id} | Get plan by ID *PlansApi* | [**listPlans**](docs/PlansApi.md#listplans) | **GET** /api/v1/plans | List all plans *PlansApi* | [**updatePlan**](docs/PlansApi.md#updateplan) | **PATCH** /api/v1/plans/{id} | Update a plan *PracticeQuizzesApi* | [**createPracticeQuiz**](docs/PracticeQuizzesApi.md#createpracticequizoperation) | **POST** /api/v1/practice-quizzes | Find or create a practice-quiz slot *PracticeQuizzesApi* | [**listPracticeQuizzes**](docs/PracticeQuizzesApi.md#listpracticequizzes) | **GET** /api/v1/practice-quizzes | List practice-quiz slots for a course *QuizSessionsApi* | [**createQuizSession**](docs/QuizSessionsApi.md#createquizsession) | **POST** /api/v1/quizzes/{quizId}/sessions | Create a quiz session *QuizSessionsApi* | [**getQuizSessionConceptSummary**](docs/QuizSessionsApi.md#getquizsessionconceptsummary) | **GET** /api/v1/quiz-sessions/{sessionId}/concept-summary | Get quiz session concept mastery summary *QuizSessionsApi* | [**getQuizSessionSummary**](docs/QuizSessionsApi.md#getquizsessionsummary) | **GET** /api/v1/quiz-sessions/{sessionId}/summary | Get quiz session summary *QuizSessionsApi* | [**listQuizSessions**](docs/QuizSessionsApi.md#listquizsessions) | **GET** /api/v1/quiz-sessions | List user quiz sessions *QuizSessionsApi* | [**recordQuizQuestionView**](docs/QuizSessionsApi.md#recordquizquestionviewoperation) | **POST** /api/v1/quiz-sessions/{sessionId}/views | Record a question view *QuizSessionsApi* | [**submitQuizResponse**](docs/QuizSessionsApi.md#submitquizresponseoperation) | **POST** /api/v1/quiz-sessions/{sessionId}/responses | Submit a quiz response *QuizSessionsApi* | [**updateQuizSession**](docs/QuizSessionsApi.md#updatequizsessionoperation) | **PATCH** /api/v1/quiz-sessions/{sessionId} | Update quiz session status *QuizzesApi* | [**getQuiz**](docs/QuizzesApi.md#getquiz) | **GET** /api/v1/quizzes/{quizId} | Get quiz with questions *QuizzesApi* | [**listQuizzes**](docs/QuizzesApi.md#listquizzes) | **GET** /api/v1/quizzes | List user quizzes *ServiceTokensApi* | [**createServiceToken**](docs/ServiceTokensApi.md#createservicetoken) | **POST** /api/v1/tokens | Create a new service token *ServiceTokensApi* | [**deleteServiceToken**](docs/ServiceTokensApi.md#deleteservicetoken) | **DELETE** /api/v1/tokens/{id} | Delete service token *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID *ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status *StudyObjectiveConceptsApi* | [**listStudyObjectiveConcepts**](docs/StudyObjectiveConceptsApi.md#liststudyobjectiveconcepts) | **GET** /api/v1/study-objective-concepts | List study-objective concept attachments *StudyObjectiveConceptsApi* | [**triggerStudyObjectiveConceptExtraction**](docs/StudyObjectiveConceptsApi.md#triggerstudyobjectiveconceptextractionoperation) | **POST** /api/v1/study-objective-concepts/extract | Trigger study-objective concept extraction *StudyObjectivesApi* | [**createObjectiveResource**](docs/StudyObjectivesApi.md#createobjectiveresource) | **POST** /api/v1/study-objectives/{studyObjectiveId}/resources | Attach a chat resource to a study objective *StudyObjectivesApi* | [**createStudyObjective**](docs/StudyObjectivesApi.md#createstudyobjective) | **POST** /api/v1/study-objectives | Create or upsert a study objective *StudyObjectivesApi* | [**deleteObjectiveResource**](docs/StudyObjectivesApi.md#deleteobjectiveresource) | **DELETE** /api/v1/study-objectives/{studyObjectiveId}/resources/{resourceId} | Detach a resource from a study objective *StudyObjectivesApi* | [**deleteStudyObjective**](docs/StudyObjectivesApi.md#deletestudyobjective) | **DELETE** /api/v1/study-objectives/{studyObjectiveId} | Delete a study objective *StudyObjectivesApi* | [**getStudyObjective**](docs/StudyObjectivesApi.md#getstudyobjective) | **GET** /api/v1/study-objectives/{studyObjectiveId} | Get a study objective by ID *StudyObjectivesApi* | [**listObjectiveResources**](docs/StudyObjectivesApi.md#listobjectiveresources) | **GET** /api/v1/study-objectives/{studyObjectiveId}/resources | List resources attached to a study objective *StudyObjectivesApi* | [**listStudyObjectiveQuizzes**](docs/StudyObjectivesApi.md#liststudyobjectivequizzes) | **GET** /api/v1/study-objectives/{studyObjectiveId}/quizzes | List quizzes and flashcards for a study objective *StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course or study space *StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective *StudyPlansApi* | [**deleteStudyPlan**](docs/StudyPlansApi.md#deletestudyplan) | **DELETE** /api/v1/study-plans/{planId} | Delete a study plan *StudyPlansApi* | [**getStudyObjectiveStudyPlan**](docs/StudyPlansApi.md#getstudyobjectivestudyplan) | **GET** /api/v1/study-objectives/{studyObjectiveId}/study-plan | Get a study objective\'s plan *StudyPlansApi* | [**saveStudyObjectiveStudyPlan**](docs/StudyPlansApi.md#savestudyobjectivestudyplan) | **POST** /api/v1/study-objectives/{studyObjectiveId}/study-plan | Save (or replace) a study objective\'s plan *StudyPlansApi* | [**updateStudyPlanActivityCompletion**](docs/StudyPlansApi.md#updatestudyplanactivitycompletion) | **PATCH** /api/v1/study-plan-activities/{activityId} | Mark a plan activity complete or incomplete *StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades *StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course *StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas *StudySpacesApi* | [**createStudySpace**](docs/StudySpacesApi.md#createstudyspace) | **POST** /api/v1/study-spaces | Create a study space the learner names *StudySpacesApi* | [**deleteStudySpace**](docs/StudySpacesApi.md#deletestudyspace) | **DELETE** /api/v1/study-spaces/{studySpaceId} | Delete a study space the learner created *StudySpacesApi* | [**listStudySpaces**](docs/StudySpacesApi.md#liststudyspaces) | **GET** /api/v1/study-spaces | List the authenticated user\'s study spaces *StudySpacesApi* | [**updateStudySpace**](docs/StudySpacesApi.md#updatestudyspace) | **PATCH** /api/v1/study-spaces/{studySpaceId} | Update a study space title *SyllabusAnalysisApi* | [**getSyllabusAnalysisStatus**](docs/SyllabusAnalysisApi.md#getsyllabusanalysisstatus) | **GET** /api/v1/syllabus-analysis | Get syllabus analysis status *SyllabusAnalysisApi* | [**triggerSyllabusAnalysis**](docs/SyllabusAnalysisApi.md#triggersyllabusanalysisoperation) | **POST** /api/v1/syllabus-analysis | Trigger syllabus analysis *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags *TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug *TaxonomiesApi* | [**getTaxonomyProgress**](docs/TaxonomiesApi.md#gettaxonomyprogress) | **GET** /api/v1/taxonomies/{id}/progress | Get progress and readiness for a taxonomy *TaxonomiesApi* | [**listTaxonomies**](docs/TaxonomiesApi.md#listtaxonomies) | **GET** /api/v1/taxonomies | List available taxonomies *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomy_enrollments/{id} | Enroll in a taxonomy *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomy_enrollments | List current user\'s active enrollments *TaxonomyEnrollmentsApi* | [**unenrollFromTaxonomy**](docs/TaxonomyEnrollmentsApi.md#unenrollfromtaxonomy) | **DELETE** /api/v1/taxonomy_enrollments/{id} | Unenroll from a taxonomy *UserConceptsApi* | [**ensureUserConceptTracked**](docs/UserConceptsApi.md#ensureuserconcepttracked) | **PUT** /api/v1/user-concepts/{conceptId} | Ensure a user concept is tracked by concept id *UserConceptsApi* | [**getUserConcept**](docs/UserConceptsApi.md#getuserconcept) | **GET** /api/v1/user-concepts/{conceptId} | Get a user concept by concept id *UserConceptsApi* | [**listUserConcepts**](docs/UserConceptsApi.md#listuserconcepts) | **GET** /api/v1/user-concepts | List user concepts *UserConceptsApi* | [**listUserConceptsByIds**](docs/UserConceptsApi.md#listuserconceptsbyids) | **GET** /api/v1/user-concepts/by-ids | Batch read user concepts by concept ids *UserConceptsApi* | [**upsertUserConceptByName**](docs/UserConceptsApi.md#upsertuserconceptbynameoperation) | **POST** /api/v1/user-concepts | Upsert user concept by name *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context *UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context *UserFilesApi* | [**createUserFileAssociation**](docs/UserFilesApi.md#createuserfileassociation) | **POST** /api/v1/user-files/{userFileId}/associations | Attach a user file to a parent resource *UserFilesApi* | [**deleteUserFile**](docs/UserFilesApi.md#deleteuserfile) | **DELETE** /api/v1/user-files/{userFileId} | Hard delete a user file *UserFilesApi* | [**deleteUserFileAssociation**](docs/UserFilesApi.md#deleteuserfileassociation) | **DELETE** /api/v1/user-files/{userFileId}/associations/{associationId} | Detach a user file from a parent resource *UserFilesApi* | [**getUserFile**](docs/UserFilesApi.md#getuserfile) | **GET** /api/v1/user-files/{userFileId} | Get a user file by id *UserFilesApi* | [**getUserFileUploadUrls**](docs/UserFilesApi.md#getuserfileuploadurls) | **POST** /api/v1/user-files/upload-url | Get presigned upload URLs for user files *UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deletecurrentuser) | **DELETE** /api/v1/users/me | Delete the current user *VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat *VotesApi* | [**upsertChatVote**](docs/VotesApi.md#upsertchatvote) | **PATCH** /api/v1/chats/{chatId}/votes | Create or update a vote ### Models - [Account](docs/Account.md) - [AdminActiveStreak](docs/AdminActiveStreak.md) - [AdminChat](docs/AdminChat.md) - [AdminChatAnalysis](docs/AdminChatAnalysis.md) - [AdminChatWithStats](docs/AdminChatWithStats.md) - [AdminCohortStats](docs/AdminCohortStats.md) - [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md) - [AdminPaginatedChats](docs/AdminPaginatedChats.md) - [AdminPaginatedQuizSessions](docs/AdminPaginatedQuizSessions.md) - [AdminPaginatedStudyObjectiveUserCounts](docs/AdminPaginatedStudyObjectiveUserCounts.md) - [AdminPaginatedStudyObjectives](docs/AdminPaginatedStudyObjectives.md) - [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md) - [AdminQuizSessionListItem](docs/AdminQuizSessionListItem.md) - [AdminQuizSessionScore](docs/AdminQuizSessionScore.md) - [AdminResetLearningDataResponse](docs/AdminResetLearningDataResponse.md) - [AdminStreak](docs/AdminStreak.md) - [AdminStudyObjectiveCanvasTypeCount](docs/AdminStudyObjectiveCanvasTypeCount.md) - [AdminStudyObjectiveListItem](docs/AdminStudyObjectiveListItem.md) - [AdminStudyObjectiveOriginCounts](docs/AdminStudyObjectiveOriginCounts.md) - [AdminStudyObjectiveSummary](docs/AdminStudyObjectiveSummary.md) - [AdminStudyObjectiveUserCounts](docs/AdminStudyObjectiveUserCounts.md) - [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md) - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md) - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md) - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md) - [AdminUserEngagement](docs/AdminUserEngagement.md) - [AssociateUserFileRequest](docs/AssociateUserFileRequest.md) - [CanvasCourseAccess](docs/CanvasCourseAccess.md) - [CanvasDomainMatch](docs/CanvasDomainMatch.md) - [CanvasDomainSearchDto](docs/CanvasDomainSearchDto.md) - [CanvasDomainSearchResponse](docs/CanvasDomainSearchResponse.md) - [CanvasKnowledgeAssessmentEntity](docs/CanvasKnowledgeAssessmentEntity.md) - [CanvasTaxonomyEntity](docs/CanvasTaxonomyEntity.md) - [Chat](docs/Chat.md) - [ChatAnalysis](docs/ChatAnalysis.md) - [ChatRequest](docs/ChatRequest.md) - [ChatRequestAttachmentsInner](docs/ChatRequestAttachmentsInner.md) - [ChatRequestExternalFileUrl](docs/ChatRequestExternalFileUrl.md) - [ChatRequestMessageMetadata](docs/ChatRequestMessageMetadata.md) - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md) - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md) - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md) - [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md) - [ConceptChange](docs/ConceptChange.md) - [CreateAccountRequest](docs/CreateAccountRequest.md) - [CreateChatRequest](docs/CreateChatRequest.md) - [CreateFeatureDto](docs/CreateFeatureDto.md) - [CreateMessagesRequest](docs/CreateMessagesRequest.md) - [CreateMessagesRequestMessagesInner](docs/CreateMessagesRequestMessagesInner.md) - [CreateMessagesResponse](docs/CreateMessagesResponse.md) - [CreateObjectiveResourceDto](docs/CreateObjectiveResourceDto.md) - [CreatePlanDto](docs/CreatePlanDto.md) - [CreatePracticeQuizRequest](docs/CreatePracticeQuizRequest.md) - [CreateStudyObjectiveDto](docs/CreateStudyObjectiveDto.md) - [CreateStudyObjectiveDtoCanvasDocumentsInner](docs/CreateStudyObjectiveDtoCanvasDocumentsInner.md) - [CreateStudyObjectiveDtoCanvasObject](docs/CreateStudyObjectiveDtoCanvasObject.md) - [CreateStudyPlanDto](docs/CreateStudyPlanDto.md) - [CreateStudyPlanDtoActivitiesInner](docs/CreateStudyPlanDtoActivitiesInner.md) - [CreateStudySpaceDto](docs/CreateStudySpaceDto.md) - [CreateTokenRequest](docs/CreateTokenRequest.md) - [CreateTokenResponse](docs/CreateTokenResponse.md) - [DailyQuizStatus](docs/DailyQuizStatus.md) - [DeleteCurrentUserResponse](docs/DeleteCurrentUserResponse.md) - [EnrollmentTaxonomy](docs/EnrollmentTaxonomy.md) - [FeatureEntity](docs/FeatureEntity.md) - [FeatureOverrideEntity](docs/FeatureOverrideEntity.md) - [HealthCheck](docs/HealthCheck.md) - [LearningDaysResponse](docs/LearningDaysResponse.md) - [LearningMoment](docs/LearningMoment.md) - [LearningMomentCount](docs/LearningMomentCount.md) - [LearningSessionEvaluation](docs/LearningSessionEvaluation.md) - [LearningStreakResponse](docs/LearningStreakResponse.md) - [Message](docs/Message.md) - [MessageAttachment](docs/MessageAttachment.md) - [MessageCountResponse](docs/MessageCountResponse.md) - [MessagePartsInner](docs/MessagePartsInner.md) - [ObjectiveResource](docs/ObjectiveResource.md) - [PaginatedChats](docs/PaginatedChats.md) - [PaginatedLearningMoments](docs/PaginatedLearningMoments.md) - [PaginatedMessages](docs/PaginatedMessages.md) - [PaginatedObjectiveResources](docs/PaginatedObjectiveResources.md) - [PaginatedQuizSessions](docs/PaginatedQuizSessions.md) - [PaginatedQuizzes](docs/PaginatedQuizzes.md) - [PaginatedStudyObjectives](docs/PaginatedStudyObjectives.md) - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md) - [PaginatedUserConcepts](docs/PaginatedUserConcepts.md) - [Plan](docs/Plan.md) - [PracticeQuiz](docs/PracticeQuiz.md) - [PracticeQuizStatus](docs/PracticeQuizStatus.md) - [PracticeQuizStatusList](docs/PracticeQuizStatusList.md) - [Quiz](docs/Quiz.md) - [QuizConceptSummary](docs/QuizConceptSummary.md) - [QuizListItem](docs/QuizListItem.md) - [QuizQuestion](docs/QuizQuestion.md) - [QuizQuestionView](docs/QuizQuestionView.md) - [QuizResponse](docs/QuizResponse.md) - [QuizSession](docs/QuizSession.md) - [QuizSessionListItem](docs/QuizSessionListItem.md) - [QuizSessionScore](docs/QuizSessionScore.md) - [QuizSessionSummary](docs/QuizSessionSummary.md) - [QuizWithQuestions](docs/QuizWithQuestions.md) - [RecordQuizQuestionViewRequest](docs/RecordQuizQuestionViewRequest.md) - [Score](docs/Score.md) - [ScoreByTypeValue](docs/ScoreByTypeValue.md) - [ServiceToken](docs/ServiceToken.md) - [StudyObjective](docs/StudyObjective.md) - [StudyObjectiveCanvasDocument](docs/StudyObjectiveCanvasDocument.md) - [StudyObjectiveConceptAttachment](docs/StudyObjectiveConceptAttachment.md) - [StudyObjectiveConceptAttachmentList](docs/StudyObjectiveConceptAttachmentList.md) - [StudyObjectiveConceptSummary](docs/StudyObjectiveConceptSummary.md) - [StudyObjectiveFileAttachment](docs/StudyObjectiveFileAttachment.md) - [StudyPlan](docs/StudyPlan.md) - [StudyPlanActivity](docs/StudyPlanActivity.md) - [StudySpace](docs/StudySpace.md) - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md) - [SyllabusAnalysisObjective](docs/SyllabusAnalysisObjective.md) - [SyllabusAnalysisStatus](docs/SyllabusAnalysisStatus.md) - [SyllabusAnalysisStatusView](docs/SyllabusAnalysisStatusView.md) - [Tag](docs/Tag.md) - [TaxonomyDetail](docs/TaxonomyDetail.md) - [TaxonomyEnrollment](docs/TaxonomyEnrollment.md) - [TaxonomyEnrollmentWithTaxonomy](docs/TaxonomyEnrollmentWithTaxonomy.md) - [TaxonomyNode](docs/TaxonomyNode.md) - [TaxonomyNodeConcept](docs/TaxonomyNodeConcept.md) - [TaxonomyProgress](docs/TaxonomyProgress.md) - [TaxonomyProgressNode](docs/TaxonomyProgressNode.md) - [TaxonomySummary](docs/TaxonomySummary.md) - [TriggerStudyObjectiveConceptExtractionItemStatus](docs/TriggerStudyObjectiveConceptExtractionItemStatus.md) - [TriggerStudyObjectiveConceptExtractionRequest](docs/TriggerStudyObjectiveConceptExtractionRequest.md) - [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md) - [TriggerSyllabusAnalysisRequest](docs/TriggerSyllabusAnalysisRequest.md) - [TriggerSyllabusAnalysisRequestFile](docs/TriggerSyllabusAnalysisRequestFile.md) - [UpdateAccountDto](docs/UpdateAccountDto.md) - [UpdateActivityCompletionDto](docs/UpdateActivityCompletionDto.md) - [UpdateChatRequest](docs/UpdateChatRequest.md) - [UpdateFeatureDto](docs/UpdateFeatureDto.md) - [UpdatePlanDto](docs/UpdatePlanDto.md) - [UpdateQuizSessionRequest](docs/UpdateQuizSessionRequest.md) - [UpdateStudyObjectiveDto](docs/UpdateStudyObjectiveDto.md) - [UpdateStudySpaceDto](docs/UpdateStudySpaceDto.md) - [UpdateTokenRequest](docs/UpdateTokenRequest.md) - [UpdateTokenResponse](docs/UpdateTokenResponse.md) - [UploadUrlFile](docs/UploadUrlFile.md) - [UploadUrlRequest](docs/UploadUrlRequest.md) - [UploadUrlRequestFilesInner](docs/UploadUrlRequestFilesInner.md) - [UploadUrlResponse](docs/UploadUrlResponse.md) - [UpsertOverrideDto](docs/UpsertOverrideDto.md) - [UpsertUserConceptByNameRequest](docs/UpsertUserConceptByNameRequest.md) - [UpsertUserContextRequest](docs/UpsertUserContextRequest.md) - [UpsertVoteRequest](docs/UpsertVoteRequest.md) - [UserConcept](docs/UserConcept.md) - [UserConceptConcept](docs/UserConceptConcept.md) - [UserContext](docs/UserContext.md) - [UserFeatures](docs/UserFeatures.md) - [UserFile](docs/UserFile.md) - [UserFileAssociation](docs/UserFileAssociation.md) - [UserFileUploadUrlFile](docs/UserFileUploadUrlFile.md) - [UserFileUploadUrlRequest](docs/UserFileUploadUrlRequest.md) - [UserFileUploadUrlRequestFilesInner](docs/UserFileUploadUrlRequestFilesInner.md) - [UserFileUploadUrlResponse](docs/UserFileUploadUrlResponse.md) - [Vote](docs/Vote.md) - [VotesResponse](docs/VotesResponse.md) ### Authorization Authentication schemes defined for the API: #### AuthToken - **Type**: API key - **API key parameter name**: `X-Auth-Token` - **Location**: HTTP header ## About This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/) and is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `1.0.0` - Package version: `1.0.0` - Generator version: `7.19.0` - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen` The generated npm module supports the following: - Environments * Node.js * Webpack * Browserify - Language levels * ES5 - you must have a Promises/A+ library installed * ES6 - Module systems * CommonJS * ES6 module system ## Development ### Building To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run: ```bash npm install npm run build ``` ### Publishing Once you've built the package, you can publish it to npm: ```bash npm publish ``` ## License []()