@instructure/athena-api-client 2.23.0 → 2.23.1
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
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import * as runtime from '../runtime';
|
|
24
|
+
import { CanvasKnowledgeAssessmentEntityFromJSON, CanvasTaxonomyEntityFromJSON, UserContextFromJSON, } from '../models/index';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class StudyPrepApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* 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.
|
|
31
|
+
* Assess user knowledge from Canvas course grades
|
|
32
|
+
*/
|
|
33
|
+
assessCanvasKnowledgeRaw(requestParameters, initOverrides) {
|
|
34
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
35
|
+
if (requestParameters['courseId'] == null) {
|
|
36
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling assessCanvasKnowledge().');
|
|
37
|
+
}
|
|
38
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
39
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling assessCanvasKnowledge().');
|
|
40
|
+
}
|
|
41
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
42
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
|
|
43
|
+
}
|
|
44
|
+
if (requestParameters['xUserId'] == null) {
|
|
45
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling assessCanvasKnowledge().');
|
|
46
|
+
}
|
|
47
|
+
const queryParameters = {};
|
|
48
|
+
if (requestParameters['courseId'] != null) {
|
|
49
|
+
queryParameters['courseId'] = requestParameters['courseId'];
|
|
50
|
+
}
|
|
51
|
+
if (requestParameters['slug'] != null) {
|
|
52
|
+
queryParameters['slug'] = requestParameters['slug'];
|
|
53
|
+
}
|
|
54
|
+
const headerParameters = {};
|
|
55
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
56
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
57
|
+
}
|
|
58
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
59
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
60
|
+
}
|
|
61
|
+
if (requestParameters['xUserId'] != null) {
|
|
62
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
63
|
+
}
|
|
64
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
65
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
66
|
+
}
|
|
67
|
+
let urlPath = `/api/v1/study-prep/knowledge-assessment`;
|
|
68
|
+
const response = yield this.request({
|
|
69
|
+
path: urlPath,
|
|
70
|
+
method: 'POST',
|
|
71
|
+
headers: headerParameters,
|
|
72
|
+
query: queryParameters,
|
|
73
|
+
}, initOverrides);
|
|
74
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CanvasKnowledgeAssessmentEntityFromJSON(jsonValue));
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* 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.
|
|
79
|
+
* Assess user knowledge from Canvas course grades
|
|
80
|
+
*/
|
|
81
|
+
assessCanvasKnowledge(requestParameters, initOverrides) {
|
|
82
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
83
|
+
const response = yield this.assessCanvasKnowledgeRaw(requestParameters, initOverrides);
|
|
84
|
+
return yield response.value();
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* 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.
|
|
89
|
+
* Generate a taxonomy from a Canvas course
|
|
90
|
+
*/
|
|
91
|
+
generateCanvasTaxonomyRaw(requestParameters, initOverrides) {
|
|
92
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
93
|
+
if (requestParameters['courseId'] == null) {
|
|
94
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling generateCanvasTaxonomy().');
|
|
95
|
+
}
|
|
96
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
97
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling generateCanvasTaxonomy().');
|
|
98
|
+
}
|
|
99
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
100
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
|
|
101
|
+
}
|
|
102
|
+
if (requestParameters['xUserId'] == null) {
|
|
103
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling generateCanvasTaxonomy().');
|
|
104
|
+
}
|
|
105
|
+
const queryParameters = {};
|
|
106
|
+
if (requestParameters['courseId'] != null) {
|
|
107
|
+
queryParameters['courseId'] = requestParameters['courseId'];
|
|
108
|
+
}
|
|
109
|
+
const headerParameters = {};
|
|
110
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
111
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
112
|
+
}
|
|
113
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
114
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
115
|
+
}
|
|
116
|
+
if (requestParameters['xUserId'] != null) {
|
|
117
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
118
|
+
}
|
|
119
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
120
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
121
|
+
}
|
|
122
|
+
let urlPath = `/api/v1/study-prep/taxonomies`;
|
|
123
|
+
const response = yield this.request({
|
|
124
|
+
path: urlPath,
|
|
125
|
+
method: 'POST',
|
|
126
|
+
headers: headerParameters,
|
|
127
|
+
query: queryParameters,
|
|
128
|
+
}, initOverrides);
|
|
129
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CanvasTaxonomyEntityFromJSON(jsonValue));
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* 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.
|
|
134
|
+
* Generate a taxonomy from a Canvas course
|
|
135
|
+
*/
|
|
136
|
+
generateCanvasTaxonomy(requestParameters, initOverrides) {
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
const response = yield this.generateCanvasTaxonomyRaw(requestParameters, initOverrides);
|
|
139
|
+
return yield response.value();
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* 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.
|
|
144
|
+
* Sync user profile from Canvas
|
|
145
|
+
*/
|
|
146
|
+
syncCanvasUserProfileRaw(requestParameters, initOverrides) {
|
|
147
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
148
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
149
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling syncCanvasUserProfile().');
|
|
150
|
+
}
|
|
151
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
152
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
|
|
153
|
+
}
|
|
154
|
+
if (requestParameters['xUserId'] == null) {
|
|
155
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling syncCanvasUserProfile().');
|
|
156
|
+
}
|
|
157
|
+
const queryParameters = {};
|
|
158
|
+
const headerParameters = {};
|
|
159
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
160
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
161
|
+
}
|
|
162
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
163
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
164
|
+
}
|
|
165
|
+
if (requestParameters['xUserId'] != null) {
|
|
166
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
167
|
+
}
|
|
168
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
169
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
170
|
+
}
|
|
171
|
+
let urlPath = `/api/v1/study-prep/user-profile`;
|
|
172
|
+
const response = yield this.request({
|
|
173
|
+
path: urlPath,
|
|
174
|
+
method: 'POST',
|
|
175
|
+
headers: headerParameters,
|
|
176
|
+
query: queryParameters,
|
|
177
|
+
}, initOverrides);
|
|
178
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => UserContextFromJSON(jsonValue));
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* 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.
|
|
183
|
+
* Sync user profile from Canvas
|
|
184
|
+
*/
|
|
185
|
+
syncCanvasUserProfile(requestParameters, initOverrides) {
|
|
186
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
187
|
+
const response = yield this.syncCanvasUserProfileRaw(requestParameters, initOverrides);
|
|
188
|
+
return yield response.value();
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
}
|
|
@@ -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,66 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import * as runtime from '../runtime';
|
|
24
|
+
import { DeleteCurrentUserResponseFromJSON, } from '../models/index';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class UsersApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
31
|
+
* Delete the current user
|
|
32
|
+
*/
|
|
33
|
+
deleteCurrentUserRaw(requestParameters, initOverrides) {
|
|
34
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
35
|
+
if (requestParameters['xUserId'] == null) {
|
|
36
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteCurrentUser().');
|
|
37
|
+
}
|
|
38
|
+
const queryParameters = {};
|
|
39
|
+
const headerParameters = {};
|
|
40
|
+
if (requestParameters['xUserId'] != null) {
|
|
41
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
42
|
+
}
|
|
43
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
44
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
45
|
+
}
|
|
46
|
+
let urlPath = `/api/v1/users/me`;
|
|
47
|
+
const response = yield this.request({
|
|
48
|
+
path: urlPath,
|
|
49
|
+
method: 'DELETE',
|
|
50
|
+
headers: headerParameters,
|
|
51
|
+
query: queryParameters,
|
|
52
|
+
}, initOverrides);
|
|
53
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DeleteCurrentUserResponseFromJSON(jsonValue));
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
|
|
58
|
+
* Delete the current user
|
|
59
|
+
*/
|
|
60
|
+
deleteCurrentUser(requestParameters, initOverrides) {
|
|
61
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
+
const response = yield this.deleteCurrentUserRaw(requestParameters, initOverrides);
|
|
63
|
+
return yield response.value();
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
}
|
package/dist/esm/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/esm/apis/index.js
CHANGED
|
@@ -18,9 +18,11 @@ export * from './PlansApi';
|
|
|
18
18
|
export * from './QuizSessionsApi';
|
|
19
19
|
export * from './QuizzesApi';
|
|
20
20
|
export * from './ServiceTokensApi';
|
|
21
|
+
export * from './StudyPrepApi';
|
|
21
22
|
export * from './TagsApi';
|
|
22
23
|
export * from './TaxonomiesApi';
|
|
23
24
|
export * from './TaxonomyEnrollmentsApi';
|
|
24
25
|
export * from './UserConceptsApi';
|
|
25
26
|
export * from './UserContextApi';
|
|
27
|
+
export * from './UsersApi';
|
|
26
28
|
export * from './VotesApi';
|
|
@@ -0,0 +1,45 @@
|
|
|
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 type { ConceptAssessmentEntity } from './ConceptAssessmentEntity';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CanvasKnowledgeAssessmentEntity
|
|
17
|
+
*/
|
|
18
|
+
export interface CanvasKnowledgeAssessmentEntity {
|
|
19
|
+
/**
|
|
20
|
+
* Taxonomy UUID the assessment is scoped to
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof CanvasKnowledgeAssessmentEntity
|
|
23
|
+
*/
|
|
24
|
+
taxonomyId: string;
|
|
25
|
+
/**
|
|
26
|
+
* Number of concepts that received an estimate
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof CanvasKnowledgeAssessmentEntity
|
|
29
|
+
*/
|
|
30
|
+
assessed: number;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {Array<ConceptAssessmentEntity>}
|
|
34
|
+
* @memberof CanvasKnowledgeAssessmentEntity
|
|
35
|
+
*/
|
|
36
|
+
concepts: Array<ConceptAssessmentEntity>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
|
|
40
|
+
*/
|
|
41
|
+
export declare function instanceOfCanvasKnowledgeAssessmentEntity(value: object): value is CanvasKnowledgeAssessmentEntity;
|
|
42
|
+
export declare function CanvasKnowledgeAssessmentEntityFromJSON(json: any): CanvasKnowledgeAssessmentEntity;
|
|
43
|
+
export declare function CanvasKnowledgeAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasKnowledgeAssessmentEntity;
|
|
44
|
+
export declare function CanvasKnowledgeAssessmentEntityToJSON(json: any): CanvasKnowledgeAssessmentEntity;
|
|
45
|
+
export declare function CanvasKnowledgeAssessmentEntityToJSONTyped(value?: CanvasKnowledgeAssessmentEntity | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { ConceptAssessmentEntityFromJSON, ConceptAssessmentEntityToJSON, } from './ConceptAssessmentEntity';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfCanvasKnowledgeAssessmentEntity(value) {
|
|
19
|
+
if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('assessed' in value) || value['assessed'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('concepts' in value) || value['concepts'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function CanvasKnowledgeAssessmentEntityFromJSON(json) {
|
|
28
|
+
return CanvasKnowledgeAssessmentEntityFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function CanvasKnowledgeAssessmentEntityFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'taxonomyId': json['taxonomyId'],
|
|
36
|
+
'assessed': json['assessed'],
|
|
37
|
+
'concepts': (json['concepts'].map(ConceptAssessmentEntityFromJSON)),
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export function CanvasKnowledgeAssessmentEntityToJSON(json) {
|
|
41
|
+
return CanvasKnowledgeAssessmentEntityToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function CanvasKnowledgeAssessmentEntityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'taxonomyId': value['taxonomyId'],
|
|
49
|
+
'assessed': value['assessed'],
|
|
50
|
+
'concepts': (value['concepts'].map(ConceptAssessmentEntityToJSON)),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CanvasTaxonomyEntity
|
|
16
|
+
*/
|
|
17
|
+
export interface CanvasTaxonomyEntity {
|
|
18
|
+
/**
|
|
19
|
+
* Taxonomy UUID
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CanvasTaxonomyEntity
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* URL slug (e.g. canvas-12345)
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof CanvasTaxonomyEntity
|
|
28
|
+
*/
|
|
29
|
+
slug: string;
|
|
30
|
+
/**
|
|
31
|
+
* Canvas course ID associated with this taxonomy
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof CanvasTaxonomyEntity
|
|
34
|
+
*/
|
|
35
|
+
courseId: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Canvas course name
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof CanvasTaxonomyEntity
|
|
40
|
+
*/
|
|
41
|
+
name: string;
|
|
42
|
+
/**
|
|
43
|
+
* Current generation status. Poll GET /api/v1/taxonomies/by-slug/{slug} until "active".
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof CanvasTaxonomyEntity
|
|
46
|
+
*/
|
|
47
|
+
status: CanvasTaxonomyEntityStatusEnum;
|
|
48
|
+
/**
|
|
49
|
+
* True if this call created a new taxonomy record; false if one already existed
|
|
50
|
+
* @type {boolean}
|
|
51
|
+
* @memberof CanvasTaxonomyEntity
|
|
52
|
+
*/
|
|
53
|
+
created: boolean;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @export
|
|
57
|
+
*/
|
|
58
|
+
export declare const CanvasTaxonomyEntityStatusEnum: {
|
|
59
|
+
readonly Pending: "pending";
|
|
60
|
+
readonly Active: "active";
|
|
61
|
+
readonly Failed: "failed";
|
|
62
|
+
};
|
|
63
|
+
export type CanvasTaxonomyEntityStatusEnum = typeof CanvasTaxonomyEntityStatusEnum[keyof typeof CanvasTaxonomyEntityStatusEnum];
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the CanvasTaxonomyEntity interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfCanvasTaxonomyEntity(value: object): value is CanvasTaxonomyEntity;
|
|
68
|
+
export declare function CanvasTaxonomyEntityFromJSON(json: any): CanvasTaxonomyEntity;
|
|
69
|
+
export declare function CanvasTaxonomyEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasTaxonomyEntity;
|
|
70
|
+
export declare function CanvasTaxonomyEntityToJSON(json: any): CanvasTaxonomyEntity;
|
|
71
|
+
export declare function CanvasTaxonomyEntityToJSONTyped(value?: CanvasTaxonomyEntity | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const CanvasTaxonomyEntityStatusEnum = {
|
|
18
|
+
Pending: 'pending',
|
|
19
|
+
Active: 'active',
|
|
20
|
+
Failed: 'failed'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the CanvasTaxonomyEntity interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfCanvasTaxonomyEntity(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('slug' in value) || value['slug'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('created' in value) || value['created'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
return true;
|
|
39
|
+
}
|
|
40
|
+
export function CanvasTaxonomyEntityFromJSON(json) {
|
|
41
|
+
return CanvasTaxonomyEntityFromJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function CanvasTaxonomyEntityFromJSONTyped(json, ignoreDiscriminator) {
|
|
44
|
+
if (json == null) {
|
|
45
|
+
return json;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'id': json['id'],
|
|
49
|
+
'slug': json['slug'],
|
|
50
|
+
'courseId': json['courseId'],
|
|
51
|
+
'name': json['name'],
|
|
52
|
+
'status': json['status'],
|
|
53
|
+
'created': json['created'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
export function CanvasTaxonomyEntityToJSON(json) {
|
|
57
|
+
return CanvasTaxonomyEntityToJSONTyped(json, false);
|
|
58
|
+
}
|
|
59
|
+
export function CanvasTaxonomyEntityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
60
|
+
if (value == null) {
|
|
61
|
+
return value;
|
|
62
|
+
}
|
|
63
|
+
return {
|
|
64
|
+
'id': value['id'],
|
|
65
|
+
'slug': value['slug'],
|
|
66
|
+
'courseId': value['courseId'],
|
|
67
|
+
'name': value['name'],
|
|
68
|
+
'status': value['status'],
|
|
69
|
+
'created': value['created'],
|
|
70
|
+
};
|
|
71
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ConceptAssessmentEntity
|
|
16
|
+
*/
|
|
17
|
+
export interface ConceptAssessmentEntity {
|
|
18
|
+
/**
|
|
19
|
+
* Concept UUID
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ConceptAssessmentEntity
|
|
22
|
+
*/
|
|
23
|
+
conceptId: string;
|
|
24
|
+
/**
|
|
25
|
+
* Full concept name
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ConceptAssessmentEntity
|
|
28
|
+
*/
|
|
29
|
+
name: string;
|
|
30
|
+
/**
|
|
31
|
+
* Short label (≤ 64 chars)
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ConceptAssessmentEntity
|
|
34
|
+
*/
|
|
35
|
+
shortName: string;
|
|
36
|
+
/**
|
|
37
|
+
* Estimated competency (0–1)
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof ConceptAssessmentEntity
|
|
40
|
+
*/
|
|
41
|
+
strength: number;
|
|
42
|
+
/**
|
|
43
|
+
* Confidence in the estimate (0–1)
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof ConceptAssessmentEntity
|
|
46
|
+
*/
|
|
47
|
+
confidence: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the ConceptAssessmentEntity interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfConceptAssessmentEntity(value: object): value is ConceptAssessmentEntity;
|
|
53
|
+
export declare function ConceptAssessmentEntityFromJSON(json: any): ConceptAssessmentEntity;
|
|
54
|
+
export declare function ConceptAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptAssessmentEntity;
|
|
55
|
+
export declare function ConceptAssessmentEntityToJSON(json: any): ConceptAssessmentEntity;
|
|
56
|
+
export declare function ConceptAssessmentEntityToJSONTyped(value?: ConceptAssessmentEntity | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the ConceptAssessmentEntity interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfConceptAssessmentEntity(value) {
|
|
18
|
+
if (!('conceptId' in value) || value['conceptId'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('shortName' in value) || value['shortName'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('strength' in value) || value['strength'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('confidence' in value) || value['confidence'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
export function ConceptAssessmentEntityFromJSON(json) {
|
|
31
|
+
return ConceptAssessmentEntityFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function ConceptAssessmentEntityFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'conceptId': json['conceptId'],
|
|
39
|
+
'name': json['name'],
|
|
40
|
+
'shortName': json['shortName'],
|
|
41
|
+
'strength': json['strength'],
|
|
42
|
+
'confidence': json['confidence'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
export function ConceptAssessmentEntityToJSON(json) {
|
|
46
|
+
return ConceptAssessmentEntityToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
export function ConceptAssessmentEntityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'conceptId': value['conceptId'],
|
|
54
|
+
'name': value['name'],
|
|
55
|
+
'shortName': value['shortName'],
|
|
56
|
+
'strength': value['strength'],
|
|
57
|
+
'confidence': value['confidence'],
|
|
58
|
+
};
|
|
59
|
+
}
|