@instructure/athena-api-client 3.0.2 → 3.0.4
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 +39 -0
- package/dist/apis/ChatsApi.d.ts +2 -0
- package/dist/apis/ChatsApi.js +6 -0
- package/dist/apis/DailyQuizApi.d.ts +1 -0
- package/dist/apis/DailyQuizApi.js +3 -0
- package/dist/apis/MessagesApi.d.ts +1 -0
- package/dist/apis/MessagesApi.js +3 -0
- package/dist/apis/PracticeQuizzesApi.d.ts +1 -0
- package/dist/apis/PracticeQuizzesApi.js +3 -0
- package/dist/apis/StudyObjectiveConceptsApi.d.ts +50 -0
- package/dist/apis/StudyObjectiveConceptsApi.js +133 -0
- package/dist/apis/StudyObjectivesApi.d.ts +127 -0
- package/dist/apis/StudyObjectivesApi.js +378 -0
- package/dist/apis/UserFilesApi.d.ts +90 -0
- package/dist/apis/UserFilesApi.js +246 -0
- package/dist/apis/index.d.ts +3 -0
- package/dist/apis/index.js +3 -0
- package/dist/esm/apis/ChatsApi.d.ts +2 -0
- package/dist/esm/apis/ChatsApi.js +6 -0
- package/dist/esm/apis/DailyQuizApi.d.ts +1 -0
- package/dist/esm/apis/DailyQuizApi.js +3 -0
- package/dist/esm/apis/MessagesApi.d.ts +1 -0
- package/dist/esm/apis/MessagesApi.js +3 -0
- package/dist/esm/apis/PracticeQuizzesApi.d.ts +1 -0
- package/dist/esm/apis/PracticeQuizzesApi.js +3 -0
- package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +50 -0
- package/dist/esm/apis/StudyObjectiveConceptsApi.js +129 -0
- package/dist/esm/apis/StudyObjectivesApi.d.ts +127 -0
- package/dist/esm/apis/StudyObjectivesApi.js +374 -0
- package/dist/esm/apis/UserFilesApi.d.ts +90 -0
- package/dist/esm/apis/UserFilesApi.js +242 -0
- package/dist/esm/apis/index.d.ts +3 -0
- package/dist/esm/apis/index.js +3 -0
- package/dist/esm/models/AssociateUserFileRequest.d.ts +48 -0
- package/dist/esm/models/AssociateUserFileRequest.js +56 -0
- package/dist/esm/models/CreateObjectiveResourceDto.d.ts +47 -0
- package/dist/esm/models/CreateObjectiveResourceDto.js +55 -0
- package/dist/esm/models/CreateStudyObjectiveDto.d.ts +57 -0
- package/dist/esm/models/CreateStudyObjectiveDto.js +54 -0
- package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
- package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +55 -0
- package/dist/esm/models/ObjectiveResource.d.ts +71 -0
- package/dist/esm/models/ObjectiveResource.js +71 -0
- package/dist/esm/models/PaginatedObjectiveResources.d.ts +39 -0
- package/dist/esm/models/PaginatedObjectiveResources.js +48 -0
- package/dist/esm/models/PaginatedStudyObjectives.d.ts +39 -0
- package/dist/esm/models/PaginatedStudyObjectives.js +48 -0
- package/dist/esm/models/StudyObjective.d.ts +88 -0
- package/dist/esm/models/StudyObjective.js +81 -0
- package/dist/esm/models/StudyObjectiveCanvasDocument.d.ts +50 -0
- package/dist/esm/models/StudyObjectiveCanvasDocument.js +55 -0
- package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +76 -0
- package/dist/esm/models/StudyObjectiveConceptAttachment.js +77 -0
- package/dist/esm/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
- package/dist/esm/models/StudyObjectiveConceptAttachmentList.js +44 -0
- package/dist/esm/models/StudyObjectiveConceptSummary.d.ts +56 -0
- package/dist/esm/models/StudyObjectiveConceptSummary.js +59 -0
- package/dist/esm/models/StudyObjectiveFileAttachment.d.ts +56 -0
- package/dist/esm/models/StudyObjectiveFileAttachment.js +59 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +58 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +48 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +43 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.js +44 -0
- package/dist/esm/models/UpdateStudyObjectiveDto.d.ts +51 -0
- package/dist/esm/models/UpdateStudyObjectiveDto.js +48 -0
- package/dist/esm/models/UserFile.d.ts +75 -0
- package/dist/esm/models/UserFile.js +72 -0
- package/dist/esm/models/UserFileAssociation.d.ts +60 -0
- package/dist/esm/models/UserFileAssociation.js +64 -0
- package/dist/esm/models/UserFileUploadUrlFile.d.ts +56 -0
- package/dist/esm/models/UserFileUploadUrlFile.js +59 -0
- package/dist/esm/models/UserFileUploadUrlRequest.d.ts +33 -0
- package/dist/esm/models/UserFileUploadUrlRequest.js +44 -0
- package/dist/esm/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
- package/dist/esm/models/UserFileUploadUrlRequestFilesInner.js +58 -0
- package/dist/esm/models/UserFileUploadUrlResponse.d.ts +33 -0
- package/dist/esm/models/UserFileUploadUrlResponse.js +44 -0
- package/dist/esm/models/index.d.ts +24 -0
- package/dist/esm/models/index.js +24 -0
- package/dist/models/AssociateUserFileRequest.d.ts +48 -0
- package/dist/models/AssociateUserFileRequest.js +64 -0
- package/dist/models/CreateObjectiveResourceDto.d.ts +47 -0
- package/dist/models/CreateObjectiveResourceDto.js +63 -0
- package/dist/models/CreateStudyObjectiveDto.d.ts +57 -0
- package/dist/models/CreateStudyObjectiveDto.js +61 -0
- package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
- package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +62 -0
- package/dist/models/ObjectiveResource.d.ts +71 -0
- package/dist/models/ObjectiveResource.js +79 -0
- package/dist/models/PaginatedObjectiveResources.d.ts +39 -0
- package/dist/models/PaginatedObjectiveResources.js +55 -0
- package/dist/models/PaginatedStudyObjectives.d.ts +39 -0
- package/dist/models/PaginatedStudyObjectives.js +55 -0
- package/dist/models/StudyObjective.d.ts +88 -0
- package/dist/models/StudyObjective.js +88 -0
- package/dist/models/StudyObjectiveCanvasDocument.d.ts +50 -0
- package/dist/models/StudyObjectiveCanvasDocument.js +62 -0
- package/dist/models/StudyObjectiveConceptAttachment.d.ts +76 -0
- package/dist/models/StudyObjectiveConceptAttachment.js +85 -0
- package/dist/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
- package/dist/models/StudyObjectiveConceptAttachmentList.js +51 -0
- package/dist/models/StudyObjectiveConceptSummary.d.ts +56 -0
- package/dist/models/StudyObjectiveConceptSummary.js +66 -0
- package/dist/models/StudyObjectiveFileAttachment.d.ts +56 -0
- package/dist/models/StudyObjectiveFileAttachment.js +66 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +66 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +55 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +50 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
- package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.js +51 -0
- package/dist/models/UpdateStudyObjectiveDto.d.ts +51 -0
- package/dist/models/UpdateStudyObjectiveDto.js +55 -0
- package/dist/models/UserFile.d.ts +75 -0
- package/dist/models/UserFile.js +79 -0
- package/dist/models/UserFileAssociation.d.ts +60 -0
- package/dist/models/UserFileAssociation.js +72 -0
- package/dist/models/UserFileUploadUrlFile.d.ts +56 -0
- package/dist/models/UserFileUploadUrlFile.js +66 -0
- package/dist/models/UserFileUploadUrlRequest.d.ts +33 -0
- package/dist/models/UserFileUploadUrlRequest.js +51 -0
- package/dist/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
- package/dist/models/UserFileUploadUrlRequestFilesInner.js +66 -0
- package/dist/models/UserFileUploadUrlResponse.d.ts +33 -0
- package/dist/models/UserFileUploadUrlResponse.js +51 -0
- package/dist/models/index.d.ts +24 -0
- package/dist/models/index.js +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,246 @@
|
|
|
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.UserFilesApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class UserFilesApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Idempotent. Returns the existing association if (userFileId, kind, kindId) already exists.
|
|
34
|
+
* Attach a user file to a parent resource
|
|
35
|
+
*/
|
|
36
|
+
createUserFileAssociationRaw(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 createUserFileAssociation().');
|
|
40
|
+
}
|
|
41
|
+
if (requestParameters['userFileId'] == null) {
|
|
42
|
+
throw new runtime.RequiredError('userFileId', 'Required parameter "userFileId" was null or undefined when calling createUserFileAssociation().');
|
|
43
|
+
}
|
|
44
|
+
if (requestParameters['associateUserFileRequest'] == null) {
|
|
45
|
+
throw new runtime.RequiredError('associateUserFileRequest', 'Required parameter "associateUserFileRequest" was null or undefined when calling createUserFileAssociation().');
|
|
46
|
+
}
|
|
47
|
+
const queryParameters = {};
|
|
48
|
+
const headerParameters = {};
|
|
49
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
50
|
+
if (requestParameters['xUserId'] != null) {
|
|
51
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
52
|
+
}
|
|
53
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
54
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
55
|
+
}
|
|
56
|
+
let urlPath = `/api/v1/user-files/{userFileId}/associations`;
|
|
57
|
+
urlPath = urlPath.replace(`{${"userFileId"}}`, encodeURIComponent(String(requestParameters['userFileId'])));
|
|
58
|
+
const response = yield this.request({
|
|
59
|
+
path: urlPath,
|
|
60
|
+
method: 'POST',
|
|
61
|
+
headers: headerParameters,
|
|
62
|
+
query: queryParameters,
|
|
63
|
+
body: (0, index_1.AssociateUserFileRequestToJSON)(requestParameters['associateUserFileRequest']),
|
|
64
|
+
}, initOverrides);
|
|
65
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserFileAssociationFromJSON)(jsonValue));
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Idempotent. Returns the existing association if (userFileId, kind, kindId) already exists.
|
|
70
|
+
* Attach a user file to a parent resource
|
|
71
|
+
*/
|
|
72
|
+
createUserFileAssociation(requestParameters, initOverrides) {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
const response = yield this.createUserFileAssociationRaw(requestParameters, initOverrides);
|
|
75
|
+
return yield response.value();
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Synchronously removes the S3 object and the user_files row (cascade clears remaining associations).
|
|
80
|
+
* Hard delete a user file
|
|
81
|
+
*/
|
|
82
|
+
deleteUserFileRaw(requestParameters, initOverrides) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
84
|
+
if (requestParameters['xUserId'] == null) {
|
|
85
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteUserFile().');
|
|
86
|
+
}
|
|
87
|
+
if (requestParameters['userFileId'] == null) {
|
|
88
|
+
throw new runtime.RequiredError('userFileId', 'Required parameter "userFileId" was null or undefined when calling deleteUserFile().');
|
|
89
|
+
}
|
|
90
|
+
const queryParameters = {};
|
|
91
|
+
const headerParameters = {};
|
|
92
|
+
if (requestParameters['xUserId'] != null) {
|
|
93
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
94
|
+
}
|
|
95
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
96
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
97
|
+
}
|
|
98
|
+
let urlPath = `/api/v1/user-files/{userFileId}`;
|
|
99
|
+
urlPath = urlPath.replace(`{${"userFileId"}}`, encodeURIComponent(String(requestParameters['userFileId'])));
|
|
100
|
+
const response = yield this.request({
|
|
101
|
+
path: urlPath,
|
|
102
|
+
method: 'DELETE',
|
|
103
|
+
headers: headerParameters,
|
|
104
|
+
query: queryParameters,
|
|
105
|
+
}, initOverrides);
|
|
106
|
+
return new runtime.VoidApiResponse(response);
|
|
107
|
+
});
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Synchronously removes the S3 object and the user_files row (cascade clears remaining associations).
|
|
111
|
+
* Hard delete a user file
|
|
112
|
+
*/
|
|
113
|
+
deleteUserFile(requestParameters, initOverrides) {
|
|
114
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
115
|
+
yield this.deleteUserFileRaw(requestParameters, initOverrides);
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* The file row and S3 object remain.
|
|
120
|
+
* Detach a user file from a parent resource
|
|
121
|
+
*/
|
|
122
|
+
deleteUserFileAssociationRaw(requestParameters, initOverrides) {
|
|
123
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
124
|
+
if (requestParameters['xUserId'] == null) {
|
|
125
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteUserFileAssociation().');
|
|
126
|
+
}
|
|
127
|
+
if (requestParameters['userFileId'] == null) {
|
|
128
|
+
throw new runtime.RequiredError('userFileId', 'Required parameter "userFileId" was null or undefined when calling deleteUserFileAssociation().');
|
|
129
|
+
}
|
|
130
|
+
if (requestParameters['associationId'] == null) {
|
|
131
|
+
throw new runtime.RequiredError('associationId', 'Required parameter "associationId" was null or undefined when calling deleteUserFileAssociation().');
|
|
132
|
+
}
|
|
133
|
+
const queryParameters = {};
|
|
134
|
+
const headerParameters = {};
|
|
135
|
+
if (requestParameters['xUserId'] != null) {
|
|
136
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
137
|
+
}
|
|
138
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
139
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
140
|
+
}
|
|
141
|
+
let urlPath = `/api/v1/user-files/{userFileId}/associations/{associationId}`;
|
|
142
|
+
urlPath = urlPath.replace(`{${"userFileId"}}`, encodeURIComponent(String(requestParameters['userFileId'])));
|
|
143
|
+
urlPath = urlPath.replace(`{${"associationId"}}`, encodeURIComponent(String(requestParameters['associationId'])));
|
|
144
|
+
const response = yield this.request({
|
|
145
|
+
path: urlPath,
|
|
146
|
+
method: 'DELETE',
|
|
147
|
+
headers: headerParameters,
|
|
148
|
+
query: queryParameters,
|
|
149
|
+
}, initOverrides);
|
|
150
|
+
return new runtime.VoidApiResponse(response);
|
|
151
|
+
});
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* The file row and S3 object remain.
|
|
155
|
+
* Detach a user file from a parent resource
|
|
156
|
+
*/
|
|
157
|
+
deleteUserFileAssociation(requestParameters, initOverrides) {
|
|
158
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
159
|
+
yield this.deleteUserFileAssociationRaw(requestParameters, initOverrides);
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Returns the file row with a freshly-signed previewUrl and the full association list.
|
|
164
|
+
* Get a user file by id
|
|
165
|
+
*/
|
|
166
|
+
getUserFileRaw(requestParameters, initOverrides) {
|
|
167
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
168
|
+
if (requestParameters['xUserId'] == null) {
|
|
169
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getUserFile().');
|
|
170
|
+
}
|
|
171
|
+
if (requestParameters['userFileId'] == null) {
|
|
172
|
+
throw new runtime.RequiredError('userFileId', 'Required parameter "userFileId" was null or undefined when calling getUserFile().');
|
|
173
|
+
}
|
|
174
|
+
const queryParameters = {};
|
|
175
|
+
const headerParameters = {};
|
|
176
|
+
if (requestParameters['xUserId'] != null) {
|
|
177
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
178
|
+
}
|
|
179
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
180
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
181
|
+
}
|
|
182
|
+
let urlPath = `/api/v1/user-files/{userFileId}`;
|
|
183
|
+
urlPath = urlPath.replace(`{${"userFileId"}}`, encodeURIComponent(String(requestParameters['userFileId'])));
|
|
184
|
+
const response = yield this.request({
|
|
185
|
+
path: urlPath,
|
|
186
|
+
method: 'GET',
|
|
187
|
+
headers: headerParameters,
|
|
188
|
+
query: queryParameters,
|
|
189
|
+
}, initOverrides);
|
|
190
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserFileFromJSON)(jsonValue));
|
|
191
|
+
});
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Returns the file row with a freshly-signed previewUrl and the full association list.
|
|
195
|
+
* Get a user file by id
|
|
196
|
+
*/
|
|
197
|
+
getUserFile(requestParameters, initOverrides) {
|
|
198
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
199
|
+
const response = yield this.getUserFileRaw(requestParameters, initOverrides);
|
|
200
|
+
return yield response.value();
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Mints signed S3 PUT/GET/DELETE URLs and creates user_files rows owned by the caller. The returned userFileId is the durable handle clients pass to POST /api/v1/user-files/:userFileId/associations to attach the file to a parent resource.
|
|
205
|
+
* Get presigned upload URLs for user files
|
|
206
|
+
*/
|
|
207
|
+
getUserFileUploadUrlsRaw(requestParameters, initOverrides) {
|
|
208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
209
|
+
if (requestParameters['xUserId'] == null) {
|
|
210
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getUserFileUploadUrls().');
|
|
211
|
+
}
|
|
212
|
+
if (requestParameters['userFileUploadUrlRequest'] == null) {
|
|
213
|
+
throw new runtime.RequiredError('userFileUploadUrlRequest', 'Required parameter "userFileUploadUrlRequest" was null or undefined when calling getUserFileUploadUrls().');
|
|
214
|
+
}
|
|
215
|
+
const queryParameters = {};
|
|
216
|
+
const headerParameters = {};
|
|
217
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
218
|
+
if (requestParameters['xUserId'] != null) {
|
|
219
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
220
|
+
}
|
|
221
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
222
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
223
|
+
}
|
|
224
|
+
let urlPath = `/api/v1/user-files/upload-url`;
|
|
225
|
+
const response = yield this.request({
|
|
226
|
+
path: urlPath,
|
|
227
|
+
method: 'POST',
|
|
228
|
+
headers: headerParameters,
|
|
229
|
+
query: queryParameters,
|
|
230
|
+
body: (0, index_1.UserFileUploadUrlRequestToJSON)(requestParameters['userFileUploadUrlRequest']),
|
|
231
|
+
}, initOverrides);
|
|
232
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserFileUploadUrlResponseFromJSON)(jsonValue));
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Mints signed S3 PUT/GET/DELETE URLs and creates user_files rows owned by the caller. The returned userFileId is the durable handle clients pass to POST /api/v1/user-files/:userFileId/associations to attach the file to a parent resource.
|
|
237
|
+
* Get presigned upload URLs for user files
|
|
238
|
+
*/
|
|
239
|
+
getUserFileUploadUrls(requestParameters, initOverrides) {
|
|
240
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
241
|
+
const response = yield this.getUserFileUploadUrlsRaw(requestParameters, initOverrides);
|
|
242
|
+
return yield response.value();
|
|
243
|
+
});
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
exports.UserFilesApi = UserFilesApi;
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -18,11 +18,14 @@ export * from './PracticeQuizzesApi';
|
|
|
18
18
|
export * from './QuizSessionsApi';
|
|
19
19
|
export * from './QuizzesApi';
|
|
20
20
|
export * from './ServiceTokensApi';
|
|
21
|
+
export * from './StudyObjectiveConceptsApi';
|
|
22
|
+
export * from './StudyObjectivesApi';
|
|
21
23
|
export * from './StudyPrepApi';
|
|
22
24
|
export * from './TagsApi';
|
|
23
25
|
export * from './TaxonomiesApi';
|
|
24
26
|
export * from './TaxonomyEnrollmentsApi';
|
|
25
27
|
export * from './UserConceptsApi';
|
|
26
28
|
export * from './UserContextApi';
|
|
29
|
+
export * from './UserFilesApi';
|
|
27
30
|
export * from './UsersApi';
|
|
28
31
|
export * from './VotesApi';
|
package/dist/apis/index.js
CHANGED
|
@@ -36,11 +36,14 @@ __exportStar(require("./PracticeQuizzesApi"), exports);
|
|
|
36
36
|
__exportStar(require("./QuizSessionsApi"), exports);
|
|
37
37
|
__exportStar(require("./QuizzesApi"), exports);
|
|
38
38
|
__exportStar(require("./ServiceTokensApi"), exports);
|
|
39
|
+
__exportStar(require("./StudyObjectiveConceptsApi"), exports);
|
|
40
|
+
__exportStar(require("./StudyObjectivesApi"), exports);
|
|
39
41
|
__exportStar(require("./StudyPrepApi"), exports);
|
|
40
42
|
__exportStar(require("./TagsApi"), exports);
|
|
41
43
|
__exportStar(require("./TaxonomiesApi"), exports);
|
|
42
44
|
__exportStar(require("./TaxonomyEnrollmentsApi"), exports);
|
|
43
45
|
__exportStar(require("./UserConceptsApi"), exports);
|
|
44
46
|
__exportStar(require("./UserContextApi"), exports);
|
|
47
|
+
__exportStar(require("./UserFilesApi"), exports);
|
|
45
48
|
__exportStar(require("./UsersApi"), exports);
|
|
46
49
|
__exportStar(require("./VotesApi"), exports);
|
|
@@ -14,6 +14,7 @@ import type { Chat, ChatRequest, CreateChatRequest, PaginatedChats, UpdateChatRe
|
|
|
14
14
|
export interface CreateChatOperationRequest {
|
|
15
15
|
xUserId: string;
|
|
16
16
|
createChatRequest: CreateChatRequest;
|
|
17
|
+
xAthenaClient?: string;
|
|
17
18
|
}
|
|
18
19
|
export interface DeleteChatRequest {
|
|
19
20
|
chatId: string;
|
|
@@ -40,6 +41,7 @@ export interface ResumeChatStreamRequest {
|
|
|
40
41
|
export interface SendChatMessageRequest {
|
|
41
42
|
xUserId: string;
|
|
42
43
|
chatRequest: ChatRequest;
|
|
44
|
+
xAthenaClient?: string;
|
|
43
45
|
xCanvasDomain?: string;
|
|
44
46
|
xCanvasToken?: string;
|
|
45
47
|
xUserTimezone?: string;
|
|
@@ -41,6 +41,9 @@ export class ChatsApi extends runtime.BaseAPI {
|
|
|
41
41
|
const queryParameters = {};
|
|
42
42
|
const headerParameters = {};
|
|
43
43
|
headerParameters['Content-Type'] = 'application/json';
|
|
44
|
+
if (requestParameters['xAthenaClient'] != null) {
|
|
45
|
+
headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
|
|
46
|
+
}
|
|
44
47
|
if (requestParameters['xUserId'] != null) {
|
|
45
48
|
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
46
49
|
}
|
|
@@ -304,6 +307,9 @@ export class ChatsApi extends runtime.BaseAPI {
|
|
|
304
307
|
const queryParameters = {};
|
|
305
308
|
const headerParameters = {};
|
|
306
309
|
headerParameters['Content-Type'] = 'application/json';
|
|
310
|
+
if (requestParameters['xAthenaClient'] != null) {
|
|
311
|
+
headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
|
|
312
|
+
}
|
|
307
313
|
if (requestParameters['xCanvasDomain'] != null) {
|
|
308
314
|
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
309
315
|
}
|
|
@@ -37,6 +37,9 @@ export class DailyQuizApi extends runtime.BaseAPI {
|
|
|
37
37
|
}
|
|
38
38
|
const queryParameters = {};
|
|
39
39
|
const headerParameters = {};
|
|
40
|
+
if (requestParameters['xAthenaClient'] != null) {
|
|
41
|
+
headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
|
|
42
|
+
}
|
|
40
43
|
if (requestParameters['xUserId'] != null) {
|
|
41
44
|
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
42
45
|
}
|
|
@@ -44,6 +44,9 @@ export class MessagesApi extends runtime.BaseAPI {
|
|
|
44
44
|
const queryParameters = {};
|
|
45
45
|
const headerParameters = {};
|
|
46
46
|
headerParameters['Content-Type'] = 'application/json';
|
|
47
|
+
if (requestParameters['xAthenaClient'] != null) {
|
|
48
|
+
headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
|
|
49
|
+
}
|
|
47
50
|
if (requestParameters['xUserId'] != null) {
|
|
48
51
|
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
49
52
|
}
|
|
@@ -14,6 +14,7 @@ import type { CreatePracticeQuizRequest, PracticeQuiz, PracticeQuizStatusList }
|
|
|
14
14
|
export interface CreatePracticeQuizOperationRequest {
|
|
15
15
|
xUserId: string;
|
|
16
16
|
createPracticeQuizRequest: CreatePracticeQuizRequest;
|
|
17
|
+
xAthenaClient?: string;
|
|
17
18
|
}
|
|
18
19
|
export interface ListPracticeQuizzesRequest {
|
|
19
20
|
canvasCourseId: string;
|
|
@@ -41,6 +41,9 @@ export class PracticeQuizzesApi extends runtime.BaseAPI {
|
|
|
41
41
|
const queryParameters = {};
|
|
42
42
|
const headerParameters = {};
|
|
43
43
|
headerParameters['Content-Type'] = 'application/json';
|
|
44
|
+
if (requestParameters['xAthenaClient'] != null) {
|
|
45
|
+
headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
|
|
46
|
+
}
|
|
44
47
|
if (requestParameters['xUserId'] != null) {
|
|
45
48
|
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
46
49
|
}
|
|
@@ -0,0 +1,50 @@
|
|
|
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 { StudyObjectiveConceptAttachmentList, TriggerStudyObjectiveConceptExtractionRequest, TriggerStudyObjectiveConceptExtractionResponse } from '../models/index';
|
|
14
|
+
export interface ListStudyObjectiveConceptsRequest {
|
|
15
|
+
xUserId: string;
|
|
16
|
+
canvasCourseId?: string;
|
|
17
|
+
canvasObjectIds?: Array<string>;
|
|
18
|
+
studyObjectiveIds?: Array<string>;
|
|
19
|
+
}
|
|
20
|
+
export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
|
|
21
|
+
xCanvasDomain: string;
|
|
22
|
+
xCanvasToken: string;
|
|
23
|
+
xUserId: string;
|
|
24
|
+
triggerStudyObjectiveConceptExtractionRequest: TriggerStudyObjectiveConceptExtractionRequest;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
|
|
30
|
+
/**
|
|
31
|
+
* Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
|
|
32
|
+
* List study-objective concept attachments
|
|
33
|
+
*/
|
|
34
|
+
listStudyObjectiveConceptsRaw(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjectiveConceptAttachmentList>>;
|
|
35
|
+
/**
|
|
36
|
+
* Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
|
|
37
|
+
* List study-objective concept attachments
|
|
38
|
+
*/
|
|
39
|
+
listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
|
|
40
|
+
/**
|
|
41
|
+
* Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers — they are NEVER accepted in the body to keep the tenant identifier authoritative.
|
|
42
|
+
* Trigger study-objective concept extraction
|
|
43
|
+
*/
|
|
44
|
+
triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
|
|
45
|
+
/**
|
|
46
|
+
* Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers — they are NEVER accepted in the body to keep the tenant identifier authoritative.
|
|
47
|
+
* Trigger study-objective concept extraction
|
|
48
|
+
*/
|
|
49
|
+
triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
|
|
50
|
+
}
|
|
@@ -0,0 +1,129 @@
|
|
|
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 { StudyObjectiveConceptAttachmentListFromJSON, TriggerStudyObjectiveConceptExtractionRequestToJSON, TriggerStudyObjectiveConceptExtractionResponseFromJSON, } from '../models/index';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
|
|
31
|
+
* List study-objective concept attachments
|
|
32
|
+
*/
|
|
33
|
+
listStudyObjectiveConceptsRaw(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 listStudyObjectiveConcepts().');
|
|
37
|
+
}
|
|
38
|
+
const queryParameters = {};
|
|
39
|
+
if (requestParameters['canvasCourseId'] != null) {
|
|
40
|
+
queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
|
|
41
|
+
}
|
|
42
|
+
if (requestParameters['canvasObjectIds'] != null) {
|
|
43
|
+
queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
|
|
44
|
+
}
|
|
45
|
+
if (requestParameters['studyObjectiveIds'] != null) {
|
|
46
|
+
queryParameters['studyObjectiveIds'] = requestParameters['studyObjectiveIds'];
|
|
47
|
+
}
|
|
48
|
+
const headerParameters = {};
|
|
49
|
+
if (requestParameters['xUserId'] != null) {
|
|
50
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
51
|
+
}
|
|
52
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
53
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
54
|
+
}
|
|
55
|
+
let urlPath = `/api/v1/study-objective-concepts`;
|
|
56
|
+
const response = yield this.request({
|
|
57
|
+
path: urlPath,
|
|
58
|
+
method: 'GET',
|
|
59
|
+
headers: headerParameters,
|
|
60
|
+
query: queryParameters,
|
|
61
|
+
}, initOverrides);
|
|
62
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => StudyObjectiveConceptAttachmentListFromJSON(jsonValue));
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
|
|
67
|
+
* List study-objective concept attachments
|
|
68
|
+
*/
|
|
69
|
+
listStudyObjectiveConcepts(requestParameters, initOverrides) {
|
|
70
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
71
|
+
const response = yield this.listStudyObjectiveConceptsRaw(requestParameters, initOverrides);
|
|
72
|
+
return yield response.value();
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers — they are NEVER accepted in the body to keep the tenant identifier authoritative.
|
|
77
|
+
* Trigger study-objective concept extraction
|
|
78
|
+
*/
|
|
79
|
+
triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
|
|
80
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
81
|
+
if (requestParameters['xCanvasDomain'] == null) {
|
|
82
|
+
throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
|
|
83
|
+
}
|
|
84
|
+
if (requestParameters['xCanvasToken'] == null) {
|
|
85
|
+
throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
|
|
86
|
+
}
|
|
87
|
+
if (requestParameters['xUserId'] == null) {
|
|
88
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
|
|
89
|
+
}
|
|
90
|
+
if (requestParameters['triggerStudyObjectiveConceptExtractionRequest'] == null) {
|
|
91
|
+
throw new runtime.RequiredError('triggerStudyObjectiveConceptExtractionRequest', 'Required parameter "triggerStudyObjectiveConceptExtractionRequest" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
|
|
92
|
+
}
|
|
93
|
+
const queryParameters = {};
|
|
94
|
+
const headerParameters = {};
|
|
95
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
96
|
+
if (requestParameters['xCanvasDomain'] != null) {
|
|
97
|
+
headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
|
|
98
|
+
}
|
|
99
|
+
if (requestParameters['xCanvasToken'] != null) {
|
|
100
|
+
headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
|
|
101
|
+
}
|
|
102
|
+
if (requestParameters['xUserId'] != null) {
|
|
103
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
104
|
+
}
|
|
105
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
106
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
107
|
+
}
|
|
108
|
+
let urlPath = `/api/v1/study-objective-concepts/extract`;
|
|
109
|
+
const response = yield this.request({
|
|
110
|
+
path: urlPath,
|
|
111
|
+
method: 'POST',
|
|
112
|
+
headers: headerParameters,
|
|
113
|
+
query: queryParameters,
|
|
114
|
+
body: TriggerStudyObjectiveConceptExtractionRequestToJSON(requestParameters['triggerStudyObjectiveConceptExtractionRequest']),
|
|
115
|
+
}, initOverrides);
|
|
116
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => TriggerStudyObjectiveConceptExtractionResponseFromJSON(jsonValue));
|
|
117
|
+
});
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers — they are NEVER accepted in the body to keep the tenant identifier authoritative.
|
|
121
|
+
* Trigger study-objective concept extraction
|
|
122
|
+
*/
|
|
123
|
+
triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
|
|
124
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
125
|
+
const response = yield this.triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides);
|
|
126
|
+
return yield response.value();
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
}
|