@instructure/athena-api-client 2.23.0 → 2.23.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist/apis/StudyPrepApi.d.ts +66 -0
- package/dist/apis/StudyPrepApi.js +195 -0
- package/dist/apis/UsersApi.d.ts +31 -0
- package/dist/apis/UsersApi.js +70 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/StudyPrepApi.d.ts +66 -0
- package/dist/esm/apis/StudyPrepApi.js +191 -0
- package/dist/esm/apis/UsersApi.d.ts +31 -0
- package/dist/esm/apis/UsersApi.js +66 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/CanvasKnowledgeAssessmentEntity.d.ts +45 -0
- package/dist/esm/models/CanvasKnowledgeAssessmentEntity.js +52 -0
- package/dist/esm/models/CanvasTaxonomyEntity.d.ts +71 -0
- package/dist/esm/models/CanvasTaxonomyEntity.js +71 -0
- package/dist/esm/models/ConceptAssessmentEntity.d.ts +56 -0
- package/dist/esm/models/ConceptAssessmentEntity.js +59 -0
- package/dist/esm/models/DeleteCurrentUserResponse.d.ts +32 -0
- package/dist/esm/models/DeleteCurrentUserResponse.js +43 -0
- package/dist/esm/models/EnrollmentTaxonomy.d.ts +6 -0
- package/dist/esm/models/EnrollmentTaxonomy.js +4 -0
- package/dist/esm/models/TaxonomyDetail.d.ts +8 -0
- package/dist/esm/models/TaxonomyDetail.js +7 -1
- package/dist/esm/models/TaxonomySummary.d.ts +8 -0
- package/dist/esm/models/TaxonomySummary.js +7 -1
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/CanvasKnowledgeAssessmentEntity.d.ts +45 -0
- package/dist/models/CanvasKnowledgeAssessmentEntity.js +59 -0
- package/dist/models/CanvasTaxonomyEntity.d.ts +71 -0
- package/dist/models/CanvasTaxonomyEntity.js +79 -0
- package/dist/models/ConceptAssessmentEntity.d.ts +56 -0
- package/dist/models/ConceptAssessmentEntity.js +66 -0
- package/dist/models/DeleteCurrentUserResponse.d.ts +32 -0
- package/dist/models/DeleteCurrentUserResponse.js +50 -0
- package/dist/models/EnrollmentTaxonomy.d.ts +6 -0
- package/dist/models/EnrollmentTaxonomy.js +4 -0
- package/dist/models/TaxonomyDetail.d.ts +8 -0
- package/dist/models/TaxonomyDetail.js +7 -1
- package/dist/models/TaxonomySummary.d.ts +8 -0
- package/dist/models/TaxonomySummary.js +7 -1
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -116,6 +116,9 @@ All URIs are relative to *http://localhost:3000*
|
|
|
116
116
|
*ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
|
|
117
117
|
*ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
|
|
118
118
|
*ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
|
|
119
|
+
*StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades
|
|
120
|
+
*StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course
|
|
121
|
+
*StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas
|
|
119
122
|
*TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
|
|
120
123
|
*TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree
|
|
121
124
|
*TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
|
|
@@ -128,6 +131,7 @@ All URIs are relative to *http://localhost:3000*
|
|
|
128
131
|
*UserConceptsApi* | [**upsertUserConceptByName**](docs/UserConceptsApi.md#upsertuserconceptbynameoperation) | **POST** /api/v1/user-concepts | Upsert user concept by name
|
|
129
132
|
*UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context
|
|
130
133
|
*UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context
|
|
134
|
+
*UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deletecurrentuser) | **DELETE** /api/v1/users/me | Delete the current user
|
|
131
135
|
*VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat
|
|
132
136
|
*VotesApi* | [**upsertChatVote**](docs/VotesApi.md#upsertchatvote) | **PATCH** /api/v1/chats/{chatId}/votes | Create or update a vote
|
|
133
137
|
|
|
@@ -149,6 +153,8 @@ All URIs are relative to *http://localhost:3000*
|
|
|
149
153
|
- [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
|
|
150
154
|
- [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
|
|
151
155
|
- [AdminUserEngagement](docs/AdminUserEngagement.md)
|
|
156
|
+
- [CanvasKnowledgeAssessmentEntity](docs/CanvasKnowledgeAssessmentEntity.md)
|
|
157
|
+
- [CanvasTaxonomyEntity](docs/CanvasTaxonomyEntity.md)
|
|
152
158
|
- [Chat](docs/Chat.md)
|
|
153
159
|
- [ChatAnalysis](docs/ChatAnalysis.md)
|
|
154
160
|
- [ChatRequest](docs/ChatRequest.md)
|
|
@@ -158,6 +164,7 @@ All URIs are relative to *http://localhost:3000*
|
|
|
158
164
|
- [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
|
|
159
165
|
- [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
|
|
160
166
|
- [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
|
|
167
|
+
- [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md)
|
|
161
168
|
- [CreateAccountRequest](docs/CreateAccountRequest.md)
|
|
162
169
|
- [CreateChatRequest](docs/CreateChatRequest.md)
|
|
163
170
|
- [CreateFeatureDto](docs/CreateFeatureDto.md)
|
|
@@ -168,6 +175,7 @@ All URIs are relative to *http://localhost:3000*
|
|
|
168
175
|
- [CreateTokenRequest](docs/CreateTokenRequest.md)
|
|
169
176
|
- [CreateTokenResponse](docs/CreateTokenResponse.md)
|
|
170
177
|
- [DailyQuizStatus](docs/DailyQuizStatus.md)
|
|
178
|
+
- [DeleteCurrentUserResponse](docs/DeleteCurrentUserResponse.md)
|
|
171
179
|
- [EnrollmentTaxonomy](docs/EnrollmentTaxonomy.md)
|
|
172
180
|
- [FeatureEntity](docs/FeatureEntity.md)
|
|
173
181
|
- [FeatureOverrideEntity](docs/FeatureOverrideEntity.md)
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { CanvasKnowledgeAssessmentEntity, CanvasTaxonomyEntity, UserContext } from '../models/index';
|
|
14
|
+
export interface AssessCanvasKnowledgeRequest {
|
|
15
|
+
courseId: number;
|
|
16
|
+
xCanvasDomain: string;
|
|
17
|
+
xCanvasToken: string;
|
|
18
|
+
xUserId: string;
|
|
19
|
+
slug?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GenerateCanvasTaxonomyRequest {
|
|
22
|
+
courseId: number;
|
|
23
|
+
xCanvasDomain: string;
|
|
24
|
+
xCanvasToken: string;
|
|
25
|
+
xUserId: string;
|
|
26
|
+
}
|
|
27
|
+
export interface SyncCanvasUserProfileRequest {
|
|
28
|
+
xCanvasDomain: string;
|
|
29
|
+
xCanvasToken: string;
|
|
30
|
+
xUserId: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
export declare class StudyPrepApi extends runtime.BaseAPI {
|
|
36
|
+
/**
|
|
37
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
38
|
+
* Assess user knowledge from Canvas course grades
|
|
39
|
+
*/
|
|
40
|
+
assessCanvasKnowledgeRaw(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasKnowledgeAssessmentEntity>>;
|
|
41
|
+
/**
|
|
42
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
43
|
+
* Assess user knowledge from Canvas course grades
|
|
44
|
+
*/
|
|
45
|
+
assessCanvasKnowledge(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasKnowledgeAssessmentEntity>;
|
|
46
|
+
/**
|
|
47
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
48
|
+
* Generate a taxonomy from a Canvas course
|
|
49
|
+
*/
|
|
50
|
+
generateCanvasTaxonomyRaw(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasTaxonomyEntity>>;
|
|
51
|
+
/**
|
|
52
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
53
|
+
* Generate a taxonomy from a Canvas course
|
|
54
|
+
*/
|
|
55
|
+
generateCanvasTaxonomy(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasTaxonomyEntity>;
|
|
56
|
+
/**
|
|
57
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
58
|
+
* Sync user profile from Canvas
|
|
59
|
+
*/
|
|
60
|
+
syncCanvasUserProfileRaw(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContext>>;
|
|
61
|
+
/**
|
|
62
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
63
|
+
* Sync user profile from Canvas
|
|
64
|
+
*/
|
|
65
|
+
syncCanvasUserProfile(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContext>;
|
|
66
|
+
}
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.StudyPrepApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class StudyPrepApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
34
|
+
* Assess user knowledge from Canvas course grades
|
|
35
|
+
*/
|
|
36
|
+
assessCanvasKnowledgeRaw(requestParameters, initOverrides) {
|
|
37
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
+
if (requestParameters['courseId'] == null) {
|
|
39
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling assessCanvasKnowledge().');
|
|
40
|
+
}
|
|
41
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
42
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling assessCanvasKnowledge().');
|
|
43
|
+
}
|
|
44
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
45
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
|
|
46
|
+
}
|
|
47
|
+
if (requestParameters['xUserId'] == null) {
|
|
48
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling assessCanvasKnowledge().');
|
|
49
|
+
}
|
|
50
|
+
const queryParameters = {};
|
|
51
|
+
if (requestParameters['courseId'] != null) {
|
|
52
|
+
queryParameters['courseId'] = requestParameters['courseId'];
|
|
53
|
+
}
|
|
54
|
+
if (requestParameters['slug'] != null) {
|
|
55
|
+
queryParameters['slug'] = requestParameters['slug'];
|
|
56
|
+
}
|
|
57
|
+
const headerParameters = {};
|
|
58
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
59
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
60
|
+
}
|
|
61
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
62
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
63
|
+
}
|
|
64
|
+
if (requestParameters['xUserId'] != null) {
|
|
65
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
66
|
+
}
|
|
67
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
68
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
69
|
+
}
|
|
70
|
+
let urlPath = `/api/v1/study-prep/knowledge-assessment`;
|
|
71
|
+
const response = yield this.request({
|
|
72
|
+
path: urlPath,
|
|
73
|
+
method: 'POST',
|
|
74
|
+
headers: headerParameters,
|
|
75
|
+
query: queryParameters,
|
|
76
|
+
}, initOverrides);
|
|
77
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasKnowledgeAssessmentEntityFromJSON)(jsonValue));
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
82
|
+
* Assess user knowledge from Canvas course grades
|
|
83
|
+
*/
|
|
84
|
+
assessCanvasKnowledge(requestParameters, initOverrides) {
|
|
85
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
86
|
+
const response = yield this.assessCanvasKnowledgeRaw(requestParameters, initOverrides);
|
|
87
|
+
return yield response.value();
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
92
|
+
* Generate a taxonomy from a Canvas course
|
|
93
|
+
*/
|
|
94
|
+
generateCanvasTaxonomyRaw(requestParameters, initOverrides) {
|
|
95
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
96
|
+
if (requestParameters['courseId'] == null) {
|
|
97
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling generateCanvasTaxonomy().');
|
|
98
|
+
}
|
|
99
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
100
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling generateCanvasTaxonomy().');
|
|
101
|
+
}
|
|
102
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
103
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
|
|
104
|
+
}
|
|
105
|
+
if (requestParameters['xUserId'] == null) {
|
|
106
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling generateCanvasTaxonomy().');
|
|
107
|
+
}
|
|
108
|
+
const queryParameters = {};
|
|
109
|
+
if (requestParameters['courseId'] != null) {
|
|
110
|
+
queryParameters['courseId'] = requestParameters['courseId'];
|
|
111
|
+
}
|
|
112
|
+
const headerParameters = {};
|
|
113
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
114
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
115
|
+
}
|
|
116
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
117
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
118
|
+
}
|
|
119
|
+
if (requestParameters['xUserId'] != null) {
|
|
120
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
121
|
+
}
|
|
122
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
123
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
124
|
+
}
|
|
125
|
+
let urlPath = `/api/v1/study-prep/taxonomies`;
|
|
126
|
+
const response = yield this.request({
|
|
127
|
+
path: urlPath,
|
|
128
|
+
method: 'POST',
|
|
129
|
+
headers: headerParameters,
|
|
130
|
+
query: queryParameters,
|
|
131
|
+
}, initOverrides);
|
|
132
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasTaxonomyEntityFromJSON)(jsonValue));
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
137
|
+
* Generate a taxonomy from a Canvas course
|
|
138
|
+
*/
|
|
139
|
+
generateCanvasTaxonomy(requestParameters, initOverrides) {
|
|
140
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
141
|
+
const response = yield this.generateCanvasTaxonomyRaw(requestParameters, initOverrides);
|
|
142
|
+
return yield response.value();
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
147
|
+
* Sync user profile from Canvas
|
|
148
|
+
*/
|
|
149
|
+
syncCanvasUserProfileRaw(requestParameters, initOverrides) {
|
|
150
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
151
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
152
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling syncCanvasUserProfile().');
|
|
153
|
+
}
|
|
154
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
155
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
|
|
156
|
+
}
|
|
157
|
+
if (requestParameters['xUserId'] == null) {
|
|
158
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling syncCanvasUserProfile().');
|
|
159
|
+
}
|
|
160
|
+
const queryParameters = {};
|
|
161
|
+
const headerParameters = {};
|
|
162
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
163
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
164
|
+
}
|
|
165
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
166
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
167
|
+
}
|
|
168
|
+
if (requestParameters['xUserId'] != null) {
|
|
169
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
170
|
+
}
|
|
171
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
172
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
173
|
+
}
|
|
174
|
+
let urlPath = `/api/v1/study-prep/user-profile`;
|
|
175
|
+
const response = yield this.request({
|
|
176
|
+
path: urlPath,
|
|
177
|
+
method: 'POST',
|
|
178
|
+
headers: headerParameters,
|
|
179
|
+
query: queryParameters,
|
|
180
|
+
}, initOverrides);
|
|
181
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserContextFromJSON)(jsonValue));
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
186
|
+
* Sync user profile from Canvas
|
|
187
|
+
*/
|
|
188
|
+
syncCanvasUserProfile(requestParameters, initOverrides) {
|
|
189
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
190
|
+
const response = yield this.syncCanvasUserProfileRaw(requestParameters, initOverrides);
|
|
191
|
+
return yield response.value();
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
exports.StudyPrepApi = StudyPrepApi;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { DeleteCurrentUserResponse } from '../models/index';
|
|
14
|
+
export interface DeleteCurrentUserRequest {
|
|
15
|
+
xUserId: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
*/
|
|
20
|
+
export declare class UsersApi extends runtime.BaseAPI {
|
|
21
|
+
/**
|
|
22
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
23
|
+
* Delete the current user
|
|
24
|
+
*/
|
|
25
|
+
deleteCurrentUserRaw(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCurrentUserResponse>>;
|
|
26
|
+
/**
|
|
27
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
28
|
+
* Delete the current user
|
|
29
|
+
*/
|
|
30
|
+
deleteCurrentUser(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCurrentUserResponse>;
|
|
31
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.UsersApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class UsersApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
34
|
+
* Delete the current user
|
|
35
|
+
*/
|
|
36
|
+
deleteCurrentUserRaw(requestParameters, initOverrides) {
|
|
37
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
+
if (requestParameters['xUserId'] == null) {
|
|
39
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteCurrentUser().');
|
|
40
|
+
}
|
|
41
|
+
const queryParameters = {};
|
|
42
|
+
const headerParameters = {};
|
|
43
|
+
if (requestParameters['xUserId'] != null) {
|
|
44
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
45
|
+
}
|
|
46
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
47
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
48
|
+
}
|
|
49
|
+
let urlPath = `/api/v1/users/me`;
|
|
50
|
+
const response = yield this.request({
|
|
51
|
+
path: urlPath,
|
|
52
|
+
method: 'DELETE',
|
|
53
|
+
headers: headerParameters,
|
|
54
|
+
query: queryParameters,
|
|
55
|
+
}, initOverrides);
|
|
56
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeleteCurrentUserResponseFromJSON)(jsonValue));
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
61
|
+
* Delete the current user
|
|
62
|
+
*/
|
|
63
|
+
deleteCurrentUser(requestParameters, initOverrides) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
+
const response = yield this.deleteCurrentUserRaw(requestParameters, initOverrides);
|
|
66
|
+
return yield response.value();
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
exports.UsersApi = UsersApi;
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -16,9 +16,11 @@ export * from './PlansApi';
|
|
|
16
16
|
export * from './QuizSessionsApi';
|
|
17
17
|
export * from './QuizzesApi';
|
|
18
18
|
export * from './ServiceTokensApi';
|
|
19
|
+
export * from './StudyPrepApi';
|
|
19
20
|
export * from './TagsApi';
|
|
20
21
|
export * from './TaxonomiesApi';
|
|
21
22
|
export * from './TaxonomyEnrollmentsApi';
|
|
22
23
|
export * from './UserConceptsApi';
|
|
23
24
|
export * from './UserContextApi';
|
|
25
|
+
export * from './UsersApi';
|
|
24
26
|
export * from './VotesApi';
|
package/dist/apis/index.js
CHANGED
|
@@ -34,9 +34,11 @@ __exportStar(require("./PlansApi"), exports);
|
|
|
34
34
|
__exportStar(require("./QuizSessionsApi"), exports);
|
|
35
35
|
__exportStar(require("./QuizzesApi"), exports);
|
|
36
36
|
__exportStar(require("./ServiceTokensApi"), exports);
|
|
37
|
+
__exportStar(require("./StudyPrepApi"), exports);
|
|
37
38
|
__exportStar(require("./TagsApi"), exports);
|
|
38
39
|
__exportStar(require("./TaxonomiesApi"), exports);
|
|
39
40
|
__exportStar(require("./TaxonomyEnrollmentsApi"), exports);
|
|
40
41
|
__exportStar(require("./UserConceptsApi"), exports);
|
|
41
42
|
__exportStar(require("./UserContextApi"), exports);
|
|
43
|
+
__exportStar(require("./UsersApi"), exports);
|
|
42
44
|
__exportStar(require("./VotesApi"), exports);
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { CanvasKnowledgeAssessmentEntity, CanvasTaxonomyEntity, UserContext } from '../models/index';
|
|
14
|
+
export interface AssessCanvasKnowledgeRequest {
|
|
15
|
+
courseId: number;
|
|
16
|
+
xCanvasDomain: string;
|
|
17
|
+
xCanvasToken: string;
|
|
18
|
+
xUserId: string;
|
|
19
|
+
slug?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GenerateCanvasTaxonomyRequest {
|
|
22
|
+
courseId: number;
|
|
23
|
+
xCanvasDomain: string;
|
|
24
|
+
xCanvasToken: string;
|
|
25
|
+
xUserId: string;
|
|
26
|
+
}
|
|
27
|
+
export interface SyncCanvasUserProfileRequest {
|
|
28
|
+
xCanvasDomain: string;
|
|
29
|
+
xCanvasToken: string;
|
|
30
|
+
xUserId: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
export declare class StudyPrepApi extends runtime.BaseAPI {
|
|
36
|
+
/**
|
|
37
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
38
|
+
* Assess user knowledge from Canvas course grades
|
|
39
|
+
*/
|
|
40
|
+
assessCanvasKnowledgeRaw(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasKnowledgeAssessmentEntity>>;
|
|
41
|
+
/**
|
|
42
|
+
* Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
|
|
43
|
+
* Assess user knowledge from Canvas course grades
|
|
44
|
+
*/
|
|
45
|
+
assessCanvasKnowledge(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasKnowledgeAssessmentEntity>;
|
|
46
|
+
/**
|
|
47
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
48
|
+
* Generate a taxonomy from a Canvas course
|
|
49
|
+
*/
|
|
50
|
+
generateCanvasTaxonomyRaw(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasTaxonomyEntity>>;
|
|
51
|
+
/**
|
|
52
|
+
* Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
|
|
53
|
+
* Generate a taxonomy from a Canvas course
|
|
54
|
+
*/
|
|
55
|
+
generateCanvasTaxonomy(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasTaxonomyEntity>;
|
|
56
|
+
/**
|
|
57
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
58
|
+
* Sync user profile from Canvas
|
|
59
|
+
*/
|
|
60
|
+
syncCanvasUserProfileRaw(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContext>>;
|
|
61
|
+
/**
|
|
62
|
+
* Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
|
|
63
|
+
* Sync user profile from Canvas
|
|
64
|
+
*/
|
|
65
|
+
syncCanvasUserProfile(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContext>;
|
|
66
|
+
}
|