@instructure/athena-api-client 3.0.3 → 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.
Files changed (134) hide show
  1. package/README.md +39 -0
  2. package/dist/apis/ChatsApi.d.ts +2 -0
  3. package/dist/apis/ChatsApi.js +6 -0
  4. package/dist/apis/DailyQuizApi.d.ts +1 -0
  5. package/dist/apis/DailyQuizApi.js +3 -0
  6. package/dist/apis/MessagesApi.d.ts +1 -0
  7. package/dist/apis/MessagesApi.js +3 -0
  8. package/dist/apis/PracticeQuizzesApi.d.ts +1 -0
  9. package/dist/apis/PracticeQuizzesApi.js +3 -0
  10. package/dist/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  11. package/dist/apis/StudyObjectiveConceptsApi.js +133 -0
  12. package/dist/apis/StudyObjectivesApi.d.ts +127 -0
  13. package/dist/apis/StudyObjectivesApi.js +378 -0
  14. package/dist/apis/UserFilesApi.d.ts +90 -0
  15. package/dist/apis/UserFilesApi.js +246 -0
  16. package/dist/apis/index.d.ts +3 -0
  17. package/dist/apis/index.js +3 -0
  18. package/dist/esm/apis/ChatsApi.d.ts +2 -0
  19. package/dist/esm/apis/ChatsApi.js +6 -0
  20. package/dist/esm/apis/DailyQuizApi.d.ts +1 -0
  21. package/dist/esm/apis/DailyQuizApi.js +3 -0
  22. package/dist/esm/apis/MessagesApi.d.ts +1 -0
  23. package/dist/esm/apis/MessagesApi.js +3 -0
  24. package/dist/esm/apis/PracticeQuizzesApi.d.ts +1 -0
  25. package/dist/esm/apis/PracticeQuizzesApi.js +3 -0
  26. package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  27. package/dist/esm/apis/StudyObjectiveConceptsApi.js +129 -0
  28. package/dist/esm/apis/StudyObjectivesApi.d.ts +127 -0
  29. package/dist/esm/apis/StudyObjectivesApi.js +374 -0
  30. package/dist/esm/apis/UserFilesApi.d.ts +90 -0
  31. package/dist/esm/apis/UserFilesApi.js +242 -0
  32. package/dist/esm/apis/index.d.ts +3 -0
  33. package/dist/esm/apis/index.js +3 -0
  34. package/dist/esm/models/AssociateUserFileRequest.d.ts +48 -0
  35. package/dist/esm/models/AssociateUserFileRequest.js +56 -0
  36. package/dist/esm/models/CreateObjectiveResourceDto.d.ts +47 -0
  37. package/dist/esm/models/CreateObjectiveResourceDto.js +55 -0
  38. package/dist/esm/models/CreateStudyObjectiveDto.d.ts +57 -0
  39. package/dist/esm/models/CreateStudyObjectiveDto.js +54 -0
  40. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  41. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +55 -0
  42. package/dist/esm/models/ObjectiveResource.d.ts +71 -0
  43. package/dist/esm/models/ObjectiveResource.js +71 -0
  44. package/dist/esm/models/PaginatedObjectiveResources.d.ts +39 -0
  45. package/dist/esm/models/PaginatedObjectiveResources.js +48 -0
  46. package/dist/esm/models/PaginatedStudyObjectives.d.ts +39 -0
  47. package/dist/esm/models/PaginatedStudyObjectives.js +48 -0
  48. package/dist/esm/models/StudyObjective.d.ts +88 -0
  49. package/dist/esm/models/StudyObjective.js +81 -0
  50. package/dist/esm/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  51. package/dist/esm/models/StudyObjectiveCanvasDocument.js +55 -0
  52. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  53. package/dist/esm/models/StudyObjectiveConceptAttachment.js +77 -0
  54. package/dist/esm/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  55. package/dist/esm/models/StudyObjectiveConceptAttachmentList.js +44 -0
  56. package/dist/esm/models/StudyObjectiveConceptSummary.d.ts +56 -0
  57. package/dist/esm/models/StudyObjectiveConceptSummary.js +59 -0
  58. package/dist/esm/models/StudyObjectiveFileAttachment.d.ts +56 -0
  59. package/dist/esm/models/StudyObjectiveFileAttachment.js +59 -0
  60. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  61. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +58 -0
  62. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  63. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +48 -0
  64. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  65. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +43 -0
  66. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  67. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.js +44 -0
  68. package/dist/esm/models/UpdateStudyObjectiveDto.d.ts +51 -0
  69. package/dist/esm/models/UpdateStudyObjectiveDto.js +48 -0
  70. package/dist/esm/models/UserFile.d.ts +75 -0
  71. package/dist/esm/models/UserFile.js +72 -0
  72. package/dist/esm/models/UserFileAssociation.d.ts +60 -0
  73. package/dist/esm/models/UserFileAssociation.js +64 -0
  74. package/dist/esm/models/UserFileUploadUrlFile.d.ts +56 -0
  75. package/dist/esm/models/UserFileUploadUrlFile.js +59 -0
  76. package/dist/esm/models/UserFileUploadUrlRequest.d.ts +33 -0
  77. package/dist/esm/models/UserFileUploadUrlRequest.js +44 -0
  78. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  79. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.js +58 -0
  80. package/dist/esm/models/UserFileUploadUrlResponse.d.ts +33 -0
  81. package/dist/esm/models/UserFileUploadUrlResponse.js +44 -0
  82. package/dist/esm/models/index.d.ts +24 -0
  83. package/dist/esm/models/index.js +24 -0
  84. package/dist/models/AssociateUserFileRequest.d.ts +48 -0
  85. package/dist/models/AssociateUserFileRequest.js +64 -0
  86. package/dist/models/CreateObjectiveResourceDto.d.ts +47 -0
  87. package/dist/models/CreateObjectiveResourceDto.js +63 -0
  88. package/dist/models/CreateStudyObjectiveDto.d.ts +57 -0
  89. package/dist/models/CreateStudyObjectiveDto.js +61 -0
  90. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  91. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +62 -0
  92. package/dist/models/ObjectiveResource.d.ts +71 -0
  93. package/dist/models/ObjectiveResource.js +79 -0
  94. package/dist/models/PaginatedObjectiveResources.d.ts +39 -0
  95. package/dist/models/PaginatedObjectiveResources.js +55 -0
  96. package/dist/models/PaginatedStudyObjectives.d.ts +39 -0
  97. package/dist/models/PaginatedStudyObjectives.js +55 -0
  98. package/dist/models/StudyObjective.d.ts +88 -0
  99. package/dist/models/StudyObjective.js +88 -0
  100. package/dist/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  101. package/dist/models/StudyObjectiveCanvasDocument.js +62 -0
  102. package/dist/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  103. package/dist/models/StudyObjectiveConceptAttachment.js +85 -0
  104. package/dist/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  105. package/dist/models/StudyObjectiveConceptAttachmentList.js +51 -0
  106. package/dist/models/StudyObjectiveConceptSummary.d.ts +56 -0
  107. package/dist/models/StudyObjectiveConceptSummary.js +66 -0
  108. package/dist/models/StudyObjectiveFileAttachment.d.ts +56 -0
  109. package/dist/models/StudyObjectiveFileAttachment.js +66 -0
  110. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  111. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +66 -0
  112. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  113. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +55 -0
  114. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  115. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +50 -0
  116. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  117. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.js +51 -0
  118. package/dist/models/UpdateStudyObjectiveDto.d.ts +51 -0
  119. package/dist/models/UpdateStudyObjectiveDto.js +55 -0
  120. package/dist/models/UserFile.d.ts +75 -0
  121. package/dist/models/UserFile.js +79 -0
  122. package/dist/models/UserFileAssociation.d.ts +60 -0
  123. package/dist/models/UserFileAssociation.js +72 -0
  124. package/dist/models/UserFileUploadUrlFile.d.ts +56 -0
  125. package/dist/models/UserFileUploadUrlFile.js +66 -0
  126. package/dist/models/UserFileUploadUrlRequest.d.ts +33 -0
  127. package/dist/models/UserFileUploadUrlRequest.js +51 -0
  128. package/dist/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  129. package/dist/models/UserFileUploadUrlRequestFilesInner.js +66 -0
  130. package/dist/models/UserFileUploadUrlResponse.d.ts +33 -0
  131. package/dist/models/UserFileUploadUrlResponse.js +51 -0
  132. package/dist/models/index.d.ts +24 -0
  133. package/dist/models/index.js +24 -0
  134. package/package.json +1 -1
package/README.md CHANGED
@@ -120,6 +120,16 @@ All URIs are relative to *http://localhost:3000*
120
120
  *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
121
121
  *ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
122
122
  *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
123
+ *StudyObjectiveConceptsApi* | [**listStudyObjectiveConcepts**](docs/StudyObjectiveConceptsApi.md#liststudyobjectiveconcepts) | **GET** /api/v1/study-objective-concepts | List study-objective concept attachments
124
+ *StudyObjectiveConceptsApi* | [**triggerStudyObjectiveConceptExtraction**](docs/StudyObjectiveConceptsApi.md#triggerstudyobjectiveconceptextractionoperation) | **POST** /api/v1/study-objective-concepts/extract | Trigger study-objective concept extraction
125
+ *StudyObjectivesApi* | [**createObjectiveResource**](docs/StudyObjectivesApi.md#createobjectiveresource) | **POST** /api/v1/study-objectives/{studyObjectiveId}/resources | Attach a chat resource to a study objective
126
+ *StudyObjectivesApi* | [**createStudyObjective**](docs/StudyObjectivesApi.md#createstudyobjective) | **POST** /api/v1/study-objectives | Create a study objective
127
+ *StudyObjectivesApi* | [**deleteObjectiveResource**](docs/StudyObjectivesApi.md#deleteobjectiveresource) | **DELETE** /api/v1/study-objectives/{studyObjectiveId}/resources/{resourceId} | Detach a resource from a study objective
128
+ *StudyObjectivesApi* | [**deleteStudyObjective**](docs/StudyObjectivesApi.md#deletestudyobjective) | **DELETE** /api/v1/study-objectives/{studyObjectiveId} | Delete a study objective
129
+ *StudyObjectivesApi* | [**getStudyObjective**](docs/StudyObjectivesApi.md#getstudyobjective) | **GET** /api/v1/study-objectives/{studyObjectiveId} | Get a study objective by ID
130
+ *StudyObjectivesApi* | [**listObjectiveResources**](docs/StudyObjectivesApi.md#listobjectiveresources) | **GET** /api/v1/study-objectives/{studyObjectiveId}/resources | List resources attached to a study objective
131
+ *StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course
132
+ *StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective
123
133
  *StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades
124
134
  *StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course
125
135
  *StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas
@@ -136,6 +146,11 @@ All URIs are relative to *http://localhost:3000*
136
146
  *UserConceptsApi* | [**upsertUserConceptByName**](docs/UserConceptsApi.md#upsertuserconceptbynameoperation) | **POST** /api/v1/user-concepts | Upsert user concept by name
137
147
  *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context
138
148
  *UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context
149
+ *UserFilesApi* | [**createUserFileAssociation**](docs/UserFilesApi.md#createuserfileassociation) | **POST** /api/v1/user-files/{userFileId}/associations | Attach a user file to a parent resource
150
+ *UserFilesApi* | [**deleteUserFile**](docs/UserFilesApi.md#deleteuserfile) | **DELETE** /api/v1/user-files/{userFileId} | Hard delete a user file
151
+ *UserFilesApi* | [**deleteUserFileAssociation**](docs/UserFilesApi.md#deleteuserfileassociation) | **DELETE** /api/v1/user-files/{userFileId}/associations/{associationId} | Detach a user file from a parent resource
152
+ *UserFilesApi* | [**getUserFile**](docs/UserFilesApi.md#getuserfile) | **GET** /api/v1/user-files/{userFileId} | Get a user file by id
153
+ *UserFilesApi* | [**getUserFileUploadUrls**](docs/UserFilesApi.md#getuserfileuploadurls) | **POST** /api/v1/user-files/upload-url | Get presigned upload URLs for user files
139
154
  *UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deletecurrentuser) | **DELETE** /api/v1/users/me | Delete the current user
140
155
  *VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat
141
156
  *VotesApi* | [**upsertChatVote**](docs/VotesApi.md#upsertchatvote) | **PATCH** /api/v1/chats/{chatId}/votes | Create or update a vote
@@ -158,6 +173,7 @@ All URIs are relative to *http://localhost:3000*
158
173
  - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
159
174
  - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
160
175
  - [AdminUserEngagement](docs/AdminUserEngagement.md)
176
+ - [AssociateUserFileRequest](docs/AssociateUserFileRequest.md)
161
177
  - [CanvasDomainMatch](docs/CanvasDomainMatch.md)
162
178
  - [CanvasDomainSearchDto](docs/CanvasDomainSearchDto.md)
163
179
  - [CanvasDomainSearchResponse](docs/CanvasDomainSearchResponse.md)
@@ -179,8 +195,11 @@ All URIs are relative to *http://localhost:3000*
179
195
  - [CreateMessagesRequest](docs/CreateMessagesRequest.md)
180
196
  - [CreateMessagesRequestMessagesInner](docs/CreateMessagesRequestMessagesInner.md)
181
197
  - [CreateMessagesResponse](docs/CreateMessagesResponse.md)
198
+ - [CreateObjectiveResourceDto](docs/CreateObjectiveResourceDto.md)
182
199
  - [CreatePlanDto](docs/CreatePlanDto.md)
183
200
  - [CreatePracticeQuizRequest](docs/CreatePracticeQuizRequest.md)
201
+ - [CreateStudyObjectiveDto](docs/CreateStudyObjectiveDto.md)
202
+ - [CreateStudyObjectiveDtoCanvasDocumentsInner](docs/CreateStudyObjectiveDtoCanvasDocumentsInner.md)
184
203
  - [CreateTokenRequest](docs/CreateTokenRequest.md)
185
204
  - [CreateTokenResponse](docs/CreateTokenResponse.md)
186
205
  - [DailyQuizStatus](docs/DailyQuizStatus.md)
@@ -198,11 +217,14 @@ All URIs are relative to *http://localhost:3000*
198
217
  - [MessageAttachment](docs/MessageAttachment.md)
199
218
  - [MessageCountResponse](docs/MessageCountResponse.md)
200
219
  - [MessagePartsInner](docs/MessagePartsInner.md)
220
+ - [ObjectiveResource](docs/ObjectiveResource.md)
201
221
  - [PaginatedChats](docs/PaginatedChats.md)
202
222
  - [PaginatedLearningMoments](docs/PaginatedLearningMoments.md)
203
223
  - [PaginatedMessages](docs/PaginatedMessages.md)
224
+ - [PaginatedObjectiveResources](docs/PaginatedObjectiveResources.md)
204
225
  - [PaginatedQuizSessions](docs/PaginatedQuizSessions.md)
205
226
  - [PaginatedQuizzes](docs/PaginatedQuizzes.md)
227
+ - [PaginatedStudyObjectives](docs/PaginatedStudyObjectives.md)
206
228
  - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
207
229
  - [PaginatedUserConcepts](docs/PaginatedUserConcepts.md)
208
230
  - [Plan](docs/Plan.md)
@@ -221,6 +243,12 @@ All URIs are relative to *http://localhost:3000*
221
243
  - [Score](docs/Score.md)
222
244
  - [ScoreByTypeValue](docs/ScoreByTypeValue.md)
223
245
  - [ServiceToken](docs/ServiceToken.md)
246
+ - [StudyObjective](docs/StudyObjective.md)
247
+ - [StudyObjectiveCanvasDocument](docs/StudyObjectiveCanvasDocument.md)
248
+ - [StudyObjectiveConceptAttachment](docs/StudyObjectiveConceptAttachment.md)
249
+ - [StudyObjectiveConceptAttachmentList](docs/StudyObjectiveConceptAttachmentList.md)
250
+ - [StudyObjectiveConceptSummary](docs/StudyObjectiveConceptSummary.md)
251
+ - [StudyObjectiveFileAttachment](docs/StudyObjectiveFileAttachment.md)
224
252
  - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
225
253
  - [Tag](docs/Tag.md)
226
254
  - [TaxonomyDetail](docs/TaxonomyDetail.md)
@@ -231,11 +259,16 @@ All URIs are relative to *http://localhost:3000*
231
259
  - [TaxonomyProgress](docs/TaxonomyProgress.md)
232
260
  - [TaxonomyProgressNode](docs/TaxonomyProgressNode.md)
233
261
  - [TaxonomySummary](docs/TaxonomySummary.md)
262
+ - [TriggerStudyObjectiveConceptExtractionItemStatus](docs/TriggerStudyObjectiveConceptExtractionItemStatus.md)
263
+ - [TriggerStudyObjectiveConceptExtractionRequest](docs/TriggerStudyObjectiveConceptExtractionRequest.md)
264
+ - [TriggerStudyObjectiveConceptExtractionRequestItemsInner](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInner.md)
265
+ - [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md)
234
266
  - [UpdateAccountDto](docs/UpdateAccountDto.md)
235
267
  - [UpdateChatRequest](docs/UpdateChatRequest.md)
236
268
  - [UpdateFeatureDto](docs/UpdateFeatureDto.md)
237
269
  - [UpdatePlanDto](docs/UpdatePlanDto.md)
238
270
  - [UpdateQuizSessionRequest](docs/UpdateQuizSessionRequest.md)
271
+ - [UpdateStudyObjectiveDto](docs/UpdateStudyObjectiveDto.md)
239
272
  - [UpdateTokenRequest](docs/UpdateTokenRequest.md)
240
273
  - [UpdateTokenResponse](docs/UpdateTokenResponse.md)
241
274
  - [UploadUrlFile](docs/UploadUrlFile.md)
@@ -249,6 +282,12 @@ All URIs are relative to *http://localhost:3000*
249
282
  - [UserConcept](docs/UserConcept.md)
250
283
  - [UserConceptConcept](docs/UserConceptConcept.md)
251
284
  - [UserContext](docs/UserContext.md)
285
+ - [UserFile](docs/UserFile.md)
286
+ - [UserFileAssociation](docs/UserFileAssociation.md)
287
+ - [UserFileUploadUrlFile](docs/UserFileUploadUrlFile.md)
288
+ - [UserFileUploadUrlRequest](docs/UserFileUploadUrlRequest.md)
289
+ - [UserFileUploadUrlRequestFilesInner](docs/UserFileUploadUrlRequestFilesInner.md)
290
+ - [UserFileUploadUrlResponse](docs/UserFileUploadUrlResponse.md)
252
291
  - [Vote](docs/Vote.md)
253
292
  - [VotesResponse](docs/VotesResponse.md)
254
293
 
@@ -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;
@@ -44,6 +44,9 @@ class ChatsApi 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
  }
@@ -307,6 +310,9 @@ class ChatsApi extends runtime.BaseAPI {
307
310
  const queryParameters = {};
308
311
  const headerParameters = {};
309
312
  headerParameters['Content-Type'] = 'application/json';
313
+ if (requestParameters['xAthenaClient'] != null) {
314
+ headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
315
+ }
310
316
  if (requestParameters['xCanvasDomain'] != null) {
311
317
  headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
312
318
  }
@@ -13,6 +13,7 @@ import * as runtime from '../runtime';
13
13
  import type { DailyQuizStatus } from '../models/index';
14
14
  export interface CreateDailyQuizRequest {
15
15
  xUserId: string;
16
+ xAthenaClient?: string;
16
17
  }
17
18
  export interface GetDailyQuizRequest {
18
19
  xUserId: string;
@@ -40,6 +40,9 @@ class DailyQuizApi extends runtime.BaseAPI {
40
40
  }
41
41
  const queryParameters = {};
42
42
  const headerParameters = {};
43
+ if (requestParameters['xAthenaClient'] != null) {
44
+ headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
45
+ }
43
46
  if (requestParameters['xUserId'] != null) {
44
47
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
45
48
  }
@@ -15,6 +15,7 @@ export interface CreateChatMessagesRequest {
15
15
  chatId: string;
16
16
  xUserId: string;
17
17
  createMessagesRequest: CreateMessagesRequest;
18
+ xAthenaClient?: string;
18
19
  }
19
20
  export interface DeleteMessagesRequest {
20
21
  chatId: string;
@@ -47,6 +47,9 @@ class MessagesApi extends runtime.BaseAPI {
47
47
  const queryParameters = {};
48
48
  const headerParameters = {};
49
49
  headerParameters['Content-Type'] = 'application/json';
50
+ if (requestParameters['xAthenaClient'] != null) {
51
+ headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
52
+ }
50
53
  if (requestParameters['xUserId'] != null) {
51
54
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
52
55
  }
@@ -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;
@@ -44,6 +44,9 @@ class PracticeQuizzesApi 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
  }
@@ -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,133 @@
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.StudyObjectiveConceptsApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
28
+ /**
29
+ *
30
+ */
31
+ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
32
+ /**
33
+ * 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.
34
+ * List study-objective concept attachments
35
+ */
36
+ listStudyObjectiveConceptsRaw(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 listStudyObjectiveConcepts().');
40
+ }
41
+ const queryParameters = {};
42
+ if (requestParameters['canvasCourseId'] != null) {
43
+ queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
44
+ }
45
+ if (requestParameters['canvasObjectIds'] != null) {
46
+ queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
47
+ }
48
+ if (requestParameters['studyObjectiveIds'] != null) {
49
+ queryParameters['studyObjectiveIds'] = requestParameters['studyObjectiveIds'];
50
+ }
51
+ const headerParameters = {};
52
+ if (requestParameters['xUserId'] != null) {
53
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
54
+ }
55
+ if (this.configuration && this.configuration.apiKey) {
56
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
57
+ }
58
+ let urlPath = `/api/v1/study-objective-concepts`;
59
+ const response = yield this.request({
60
+ path: urlPath,
61
+ method: 'GET',
62
+ headers: headerParameters,
63
+ query: queryParameters,
64
+ }, initOverrides);
65
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyObjectiveConceptAttachmentListFromJSON)(jsonValue));
66
+ });
67
+ }
68
+ /**
69
+ * 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.
70
+ * List study-objective concept attachments
71
+ */
72
+ listStudyObjectiveConcepts(requestParameters, initOverrides) {
73
+ return __awaiter(this, void 0, void 0, function* () {
74
+ const response = yield this.listStudyObjectiveConceptsRaw(requestParameters, initOverrides);
75
+ return yield response.value();
76
+ });
77
+ }
78
+ /**
79
+ * 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.
80
+ * Trigger study-objective concept extraction
81
+ */
82
+ triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function* () {
84
+ if (requestParameters['xCanvasDomain'] == null) {
85
+ throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
86
+ }
87
+ if (requestParameters['xCanvasToken'] == null) {
88
+ throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
89
+ }
90
+ if (requestParameters['xUserId'] == null) {
91
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
92
+ }
93
+ if (requestParameters['triggerStudyObjectiveConceptExtractionRequest'] == null) {
94
+ throw new runtime.RequiredError('triggerStudyObjectiveConceptExtractionRequest', 'Required parameter "triggerStudyObjectiveConceptExtractionRequest" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
95
+ }
96
+ const queryParameters = {};
97
+ const headerParameters = {};
98
+ headerParameters['Content-Type'] = 'application/json';
99
+ if (requestParameters['xCanvasDomain'] != null) {
100
+ headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
101
+ }
102
+ if (requestParameters['xCanvasToken'] != null) {
103
+ headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
104
+ }
105
+ if (requestParameters['xUserId'] != null) {
106
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
107
+ }
108
+ if (this.configuration && this.configuration.apiKey) {
109
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
110
+ }
111
+ let urlPath = `/api/v1/study-objective-concepts/extract`;
112
+ const response = yield this.request({
113
+ path: urlPath,
114
+ method: 'POST',
115
+ headers: headerParameters,
116
+ query: queryParameters,
117
+ body: (0, index_1.TriggerStudyObjectiveConceptExtractionRequestToJSON)(requestParameters['triggerStudyObjectiveConceptExtractionRequest']),
118
+ }, initOverrides);
119
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TriggerStudyObjectiveConceptExtractionResponseFromJSON)(jsonValue));
120
+ });
121
+ }
122
+ /**
123
+ * 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.
124
+ * Trigger study-objective concept extraction
125
+ */
126
+ triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
127
+ return __awaiter(this, void 0, void 0, function* () {
128
+ const response = yield this.triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides);
129
+ return yield response.value();
130
+ });
131
+ }
132
+ }
133
+ exports.StudyObjectiveConceptsApi = StudyObjectiveConceptsApi;
@@ -0,0 +1,127 @@
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 { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
14
+ export interface CreateObjectiveResourceRequest {
15
+ xUserId: string;
16
+ studyObjectiveId: string;
17
+ createObjectiveResourceDto: CreateObjectiveResourceDto;
18
+ }
19
+ export interface CreateStudyObjectiveRequest {
20
+ xUserId: string;
21
+ createStudyObjectiveDto: CreateStudyObjectiveDto;
22
+ }
23
+ export interface DeleteObjectiveResourceRequest {
24
+ xUserId: string;
25
+ studyObjectiveId: string;
26
+ resourceId: string;
27
+ }
28
+ export interface DeleteStudyObjectiveRequest {
29
+ xUserId: string;
30
+ studyObjectiveId: string;
31
+ }
32
+ export interface GetStudyObjectiveRequest {
33
+ xUserId: string;
34
+ studyObjectiveId: string;
35
+ }
36
+ export interface ListObjectiveResourcesRequest {
37
+ xUserId: string;
38
+ studyObjectiveId: string;
39
+ limit?: number;
40
+ cursor?: string;
41
+ }
42
+ export interface ListStudyObjectivesRequest {
43
+ xUserId: string;
44
+ courseId: string;
45
+ limit?: number;
46
+ cursor?: string;
47
+ }
48
+ export interface UpdateStudyObjectiveRequest {
49
+ xUserId: string;
50
+ studyObjectiveId: string;
51
+ updateStudyObjectiveDto: UpdateStudyObjectiveDto;
52
+ }
53
+ /**
54
+ *
55
+ */
56
+ export declare class StudyObjectivesApi extends runtime.BaseAPI {
57
+ /**
58
+ * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
59
+ * Attach a chat resource to a study objective
60
+ */
61
+ createObjectiveResourceRaw(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectiveResource>>;
62
+ /**
63
+ * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
64
+ * Attach a chat resource to a study objective
65
+ */
66
+ createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;
67
+ /**
68
+ * Create a study objective
69
+ */
70
+ createStudyObjectiveRaw(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
71
+ /**
72
+ * Create a study objective
73
+ */
74
+ createStudyObjective(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
75
+ /**
76
+ * Detach a resource from a study objective
77
+ */
78
+ deleteObjectiveResourceRaw(requestParameters: DeleteObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
79
+ /**
80
+ * Detach a resource from a study objective
81
+ */
82
+ deleteObjectiveResource(requestParameters: DeleteObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
83
+ /**
84
+ * Deletes a study objective. Cascade-deletes any objective resources attached to it.
85
+ * Delete a study objective
86
+ */
87
+ deleteStudyObjectiveRaw(requestParameters: DeleteStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
88
+ /**
89
+ * Deletes a study objective. Cascade-deletes any objective resources attached to it.
90
+ * Delete a study objective
91
+ */
92
+ deleteStudyObjective(requestParameters: DeleteStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
93
+ /**
94
+ * Get a study objective by ID
95
+ */
96
+ getStudyObjectiveRaw(requestParameters: GetStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
97
+ /**
98
+ * Get a study objective by ID
99
+ */
100
+ getStudyObjective(requestParameters: GetStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
101
+ /**
102
+ * List resources attached to a study objective
103
+ */
104
+ listObjectiveResourcesRaw(requestParameters: ListObjectiveResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedObjectiveResources>>;
105
+ /**
106
+ * List resources attached to a study objective
107
+ */
108
+ listObjectiveResources(requestParameters: ListObjectiveResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedObjectiveResources>;
109
+ /**
110
+ * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
111
+ * List study objectives for a course
112
+ */
113
+ listStudyObjectivesRaw(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedStudyObjectives>>;
114
+ /**
115
+ * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
116
+ * List study objectives for a course
117
+ */
118
+ listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
119
+ /**
120
+ * Update a study objective
121
+ */
122
+ updateStudyObjectiveRaw(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
123
+ /**
124
+ * Update a study objective
125
+ */
126
+ updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
127
+ }