@instructure/athena-api-client 3.47.0 → 4.0.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 +9 -6
- package/dist/apis/AdminApi.d.ts +53 -37
- package/dist/apis/AdminApi.js +75 -32
- package/dist/apis/ConceptDiagramsApi.d.ts +15 -1
- package/dist/apis/ConceptDiagramsApi.js +41 -0
- package/dist/apis/ConceptImagesApi.d.ts +15 -1
- package/dist/apis/ConceptImagesApi.js +41 -0
- package/dist/esm/apis/AdminApi.d.ts +53 -37
- package/dist/esm/apis/AdminApi.js +76 -33
- package/dist/esm/apis/ConceptDiagramsApi.d.ts +15 -1
- package/dist/esm/apis/ConceptDiagramsApi.js +42 -1
- package/dist/esm/apis/ConceptImagesApi.d.ts +15 -1
- package/dist/esm/apis/ConceptImagesApi.js +42 -1
- package/dist/esm/models/AdminConceptDiagram.d.ts +19 -1
- package/dist/esm/models/AdminConceptDiagram.js +12 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +19 -1
- package/dist/esm/models/AdminConceptDiagramDetail.js +12 -0
- package/dist/esm/models/AdminConceptImage.d.ts +19 -1
- package/dist/esm/models/AdminConceptImage.js +12 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +19 -1
- package/dist/esm/models/AdminConceptImageDetail.js +12 -0
- package/dist/esm/models/AdminConceptMediaJob.d.ts +157 -0
- package/dist/esm/models/AdminConceptMediaJob.js +139 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +19 -1
- package/dist/esm/models/AdminShownConceptDiagram.js +12 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +19 -1
- package/dist/esm/models/AdminShownConceptImage.js +12 -0
- package/dist/esm/models/ConceptMediaFlagResult.d.ts +32 -0
- package/dist/esm/models/ConceptMediaFlagResult.js +43 -0
- package/dist/esm/models/index.d.ts +2 -2
- package/dist/esm/models/index.js +2 -2
- package/dist/models/AdminConceptDiagram.d.ts +19 -1
- package/dist/models/AdminConceptDiagram.js +12 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +19 -1
- package/dist/models/AdminConceptDiagramDetail.js +12 -0
- package/dist/models/AdminConceptImage.d.ts +19 -1
- package/dist/models/AdminConceptImage.js +12 -0
- package/dist/models/AdminConceptImageDetail.d.ts +19 -1
- package/dist/models/AdminConceptImageDetail.js +12 -0
- package/dist/models/AdminConceptMediaJob.d.ts +157 -0
- package/dist/models/AdminConceptMediaJob.js +147 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +19 -1
- package/dist/models/AdminShownConceptDiagram.js +12 -0
- package/dist/models/AdminShownConceptImage.d.ts +19 -1
- package/dist/models/AdminShownConceptImage.js +12 -0
- package/dist/models/ConceptMediaFlagResult.d.ts +32 -0
- package/dist/models/ConceptMediaFlagResult.js +50 -0
- package/dist/models/index.d.ts +2 -2
- package/dist/models/index.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -59,14 +59,15 @@ All URIs are relative to *http://localhost:3000*
|
|
|
59
59
|
*AccountsApi* | [**updateAccount**](docs/AccountsApi.md#updateaccount) | **PATCH** /api/v1/accounts/{id} | Update an account
|
|
60
60
|
*AdminApi* | [**adminDeleteConceptDiagram**](docs/AdminApi.md#admindeleteconceptdiagram) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/delete | Soft-delete a concept diagram
|
|
61
61
|
*AdminApi* | [**adminDeleteConceptImage**](docs/AdminApi.md#admindeleteconceptimage) | **POST** /api/v1/admin/concept-images/{imageId}/delete | Soft-delete a concept image
|
|
62
|
-
*AdminApi* | [**adminGenerateConceptDiagram**](docs/AdminApi.md#admingenerateconceptdiagramoperation) | **POST** /api/v1/admin/concept-diagrams |
|
|
63
|
-
*AdminApi* | [**adminGenerateConceptImage**](docs/AdminApi.md#admingenerateconceptimageoperation) | **POST** /api/v1/admin/concept-images |
|
|
62
|
+
*AdminApi* | [**adminGenerateConceptDiagram**](docs/AdminApi.md#admingenerateconceptdiagramoperation) | **POST** /api/v1/admin/concept-diagrams | Enqueue a hidden draft diagram for a concept
|
|
63
|
+
*AdminApi* | [**adminGenerateConceptImage**](docs/AdminApi.md#admingenerateconceptimageoperation) | **POST** /api/v1/admin/concept-images | Enqueue a hidden draft image for a concept
|
|
64
64
|
*AdminApi* | [**adminGetChat**](docs/AdminApi.md#admingetchat) | **GET** /api/v1/admin/chats/{chatId} | Get any chat by ID within the account
|
|
65
65
|
*AdminApi* | [**adminGetChatAnalysis**](docs/AdminApi.md#admingetchatanalysis) | **GET** /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account
|
|
66
66
|
*AdminApi* | [**adminGetChatCanvasUsage**](docs/AdminApi.md#admingetchatcanvasusage) | **GET** /api/v1/admin/chats/{chatId}/canvas-usage | Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
|
|
67
67
|
*AdminApi* | [**adminGetCohortStats**](docs/AdminApi.md#admingetcohortstats) | **GET** /api/v1/admin/cohort-stats | Get cohort statistics for users created within a date range
|
|
68
68
|
*AdminApi* | [**adminGetConceptDiagram**](docs/AdminApi.md#admingetconceptdiagram) | **GET** /api/v1/admin/concept-diagrams/{diagramId} | Get a library concept diagram in any state
|
|
69
69
|
*AdminApi* | [**adminGetConceptImage**](docs/AdminApi.md#admingetconceptimage) | **GET** /api/v1/admin/concept-images/{imageId} | Get a library concept image in any state
|
|
70
|
+
*AdminApi* | [**adminGetConceptMediaJob**](docs/AdminApi.md#admingetconceptmediajob) | **GET** /api/v1/admin/concept-media-jobs/{jobId} | Get an admin concept media generation job
|
|
70
71
|
*AdminApi* | [**adminGetQuizSessionSummary**](docs/AdminApi.md#admingetquizsessionsummary) | **GET** /api/v1/admin/quiz-sessions/{sessionId}/summary | Get quiz session summary for any session within the account
|
|
71
72
|
*AdminApi* | [**adminGetStudyObjectiveSummary**](docs/AdminApi.md#admingetstudyobjectivesummary) | **GET** /api/v1/admin/study-objectives/summary | Aggregate study-objective statistics across all account users
|
|
72
73
|
*AdminApi* | [**adminGetUserChats**](docs/AdminApi.md#admingetuserchats) | **GET** /api/v1/admin/users/{externalId}/chats | Get chats with stats for a user
|
|
@@ -86,8 +87,8 @@ All URIs are relative to *http://localhost:3000*
|
|
|
86
87
|
*AdminApi* | [**adminListStudyObjectivesByUser**](docs/AdminApi.md#adminliststudyobjectivesbyuser) | **GET** /api/v1/admin/study-objectives/by-user | Per-user study-objective counts across all account users
|
|
87
88
|
*AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account
|
|
88
89
|
*AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
|
|
89
|
-
*AdminApi* | [**adminRegenerateConceptDiagram**](docs/AdminApi.md#adminregenerateconceptdiagramoperation) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/regenerate |
|
|
90
|
-
*AdminApi* | [**adminRegenerateConceptImage**](docs/AdminApi.md#adminregenerateconceptimageoperation) | **POST** /api/v1/admin/concept-images/{imageId}/regenerate |
|
|
90
|
+
*AdminApi* | [**adminRegenerateConceptDiagram**](docs/AdminApi.md#adminregenerateconceptdiagramoperation) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/regenerate | Enqueue a hidden revision of a concept diagram
|
|
91
|
+
*AdminApi* | [**adminRegenerateConceptImage**](docs/AdminApi.md#adminregenerateconceptimageoperation) | **POST** /api/v1/admin/concept-images/{imageId}/regenerate | Enqueue a hidden revision of a concept image
|
|
91
92
|
*AdminApi* | [**adminResetUserLearningData**](docs/AdminApi.md#adminresetuserlearningdata) | **POST** /api/v1/admin/users/{externalId}/reset-learning-data | Reset a user\'s Athena learning data to a blank slate
|
|
92
93
|
*AdminApi* | [**adminRestoreConceptDiagram**](docs/AdminApi.md#adminrestoreconceptdiagram) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/restore | Restore a soft-deleted concept diagram
|
|
93
94
|
*AdminApi* | [**adminRestoreConceptImage**](docs/AdminApi.md#adminrestoreconceptimage) | **POST** /api/v1/admin/concept-images/{imageId}/restore | Restore a soft-deleted concept image
|
|
@@ -107,8 +108,10 @@ All URIs are relative to *http://localhost:3000*
|
|
|
107
108
|
*ChatsApi* | [**resumeChatStream**](docs/ChatsApi.md#resumechatstream) | **GET** /api/v1/chat/{chatId}/stream | Resume a chat stream
|
|
108
109
|
*ChatsApi* | [**sendChatMessage**](docs/ChatsApi.md#sendchatmessage) | **POST** /api/v1/chat | Send a message to a chat
|
|
109
110
|
*ChatsApi* | [**updateChat**](docs/ChatsApi.md#updatechatoperation) | **PATCH** /api/v1/chats/{chatId} | Update a chat
|
|
111
|
+
*ConceptDiagramsApi* | [**flagConceptDiagram**](docs/ConceptDiagramsApi.md#flagconceptdiagram) | **POST** /api/v1/concept-diagrams/{diagramId}/flag | Flag a concept diagram so learners stop being shown it
|
|
110
112
|
*ConceptDiagramsApi* | [**getMyConceptDiagram**](docs/ConceptDiagramsApi.md#getmyconceptdiagram) | **GET** /api/v1/concept-diagrams/{diagramId} | Get a concept diagram the user authored
|
|
111
113
|
*ConceptDiagramsApi* | [**listMyConceptDiagrams**](docs/ConceptDiagramsApi.md#listmyconceptdiagrams) | **GET** /api/v1/concept-diagrams | List the concept diagrams the user authored
|
|
114
|
+
*ConceptImagesApi* | [**flagConceptImage**](docs/ConceptImagesApi.md#flagconceptimage) | **POST** /api/v1/concept-images/{imageId}/flag | Flag a concept image so learners stop being shown it
|
|
112
115
|
*ConceptImagesApi* | [**listMyConceptImages**](docs/ConceptImagesApi.md#listmyconceptimages) | **GET** /api/v1/concept-images | List the concept images the user generated
|
|
113
116
|
*DailyQuizApi* | [**createDailyQuiz**](docs/DailyQuizApi.md#createdailyquiz) | **POST** /api/v1/daily-quiz | Get or create today\'s daily quiz
|
|
114
117
|
*DailyQuizApi* | [**getDailyQuiz**](docs/DailyQuizApi.md#getdailyquiz) | **GET** /api/v1/daily-quiz | Get today\'s daily quiz
|
|
@@ -242,14 +245,13 @@ All URIs are relative to *http://localhost:3000*
|
|
|
242
245
|
- [AdminConceptMediaActor](docs/AdminConceptMediaActor.md)
|
|
243
246
|
- [AdminConceptMediaConcept](docs/AdminConceptMediaConcept.md)
|
|
244
247
|
- [AdminConceptMediaHistoryEntry](docs/AdminConceptMediaHistoryEntry.md)
|
|
248
|
+
- [AdminConceptMediaJob](docs/AdminConceptMediaJob.md)
|
|
245
249
|
- [AdminConceptMediaRevision](docs/AdminConceptMediaRevision.md)
|
|
246
250
|
- [AdminConceptSearchResult](docs/AdminConceptSearchResult.md)
|
|
247
251
|
- [AdminExchangeChat](docs/AdminExchangeChat.md)
|
|
248
252
|
- [AdminExchangeMessage](docs/AdminExchangeMessage.md)
|
|
249
253
|
- [AdminGenerateConceptDiagramRequest](docs/AdminGenerateConceptDiagramRequest.md)
|
|
250
254
|
- [AdminGenerateConceptImageRequest](docs/AdminGenerateConceptImageRequest.md)
|
|
251
|
-
- [AdminGeneratedConceptDiagram](docs/AdminGeneratedConceptDiagram.md)
|
|
252
|
-
- [AdminGeneratedConceptImage](docs/AdminGeneratedConceptImage.md)
|
|
253
255
|
- [AdminLastExchange](docs/AdminLastExchange.md)
|
|
254
256
|
- [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md)
|
|
255
257
|
- [AdminPaginatedChats](docs/AdminPaginatedChats.md)
|
|
@@ -314,6 +316,7 @@ All URIs are relative to *http://localhost:3000*
|
|
|
314
316
|
- [ConceptDiagramDetail](docs/ConceptDiagramDetail.md)
|
|
315
317
|
- [ConceptDiagramGalleryItem](docs/ConceptDiagramGalleryItem.md)
|
|
316
318
|
- [ConceptImageGalleryItem](docs/ConceptImageGalleryItem.md)
|
|
319
|
+
- [ConceptMediaFlagResult](docs/ConceptMediaFlagResult.md)
|
|
317
320
|
- [CreateAccountRequest](docs/CreateAccountRequest.md)
|
|
318
321
|
- [CreateChatRequest](docs/CreateChatRequest.md)
|
|
319
322
|
- [CreateFeatureDto](docs/CreateFeatureDto.md)
|
package/dist/apis/AdminApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest,
|
|
13
|
+
import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptMediaJob, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
|
|
14
14
|
export interface AdminDeleteConceptDiagramRequest {
|
|
15
15
|
xUserId: string;
|
|
16
16
|
diagramId: string;
|
|
@@ -52,6 +52,10 @@ export interface AdminGetConceptImageRequest {
|
|
|
52
52
|
xUserId: string;
|
|
53
53
|
imageId: string;
|
|
54
54
|
}
|
|
55
|
+
export interface AdminGetConceptMediaJobRequest {
|
|
56
|
+
xUserId: string;
|
|
57
|
+
jobId: string;
|
|
58
|
+
}
|
|
55
59
|
export interface AdminGetQuizSessionSummaryRequest {
|
|
56
60
|
xUserId: string;
|
|
57
61
|
sessionId: string;
|
|
@@ -239,25 +243,25 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
239
243
|
*/
|
|
240
244
|
adminDeleteConceptImage(requestParameters: AdminDeleteConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
241
245
|
/**
|
|
242
|
-
*
|
|
243
|
-
*
|
|
246
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
|
|
247
|
+
* Enqueue a hidden draft diagram for a concept
|
|
244
248
|
*/
|
|
245
|
-
adminGenerateConceptDiagramRaw(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
249
|
+
adminGenerateConceptDiagramRaw(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
|
|
246
250
|
/**
|
|
247
|
-
*
|
|
248
|
-
*
|
|
251
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
|
|
252
|
+
* Enqueue a hidden draft diagram for a concept
|
|
249
253
|
*/
|
|
250
|
-
adminGenerateConceptDiagram(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
254
|
+
adminGenerateConceptDiagram(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
|
|
251
255
|
/**
|
|
252
|
-
*
|
|
253
|
-
*
|
|
256
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
|
|
257
|
+
* Enqueue a hidden draft image for a concept
|
|
254
258
|
*/
|
|
255
|
-
adminGenerateConceptImageRaw(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
259
|
+
adminGenerateConceptImageRaw(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
|
|
256
260
|
/**
|
|
257
|
-
*
|
|
258
|
-
*
|
|
261
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
|
|
262
|
+
* Enqueue a hidden draft image for a concept
|
|
259
263
|
*/
|
|
260
|
-
adminGenerateConceptImage(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
264
|
+
adminGenerateConceptImage(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
|
|
261
265
|
/**
|
|
262
266
|
* Get any chat by ID within the account
|
|
263
267
|
*/
|
|
@@ -310,6 +314,16 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
310
314
|
* Get a library concept image in any state
|
|
311
315
|
*/
|
|
312
316
|
adminGetConceptImage(requestParameters: AdminGetConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
317
|
+
/**
|
|
318
|
+
* Poll after a generate or regenerate (every few seconds) until status is succeeded or failed. On success, resultMediaId is the new hidden draft: open it with adminGetConceptImage or adminGetConceptDiagram per kind. On failure, errorCode and errorMessage say why. A job left pending or running past its deadline (the generation timeout plus a margin while running; 30 minutes while pending) is reported failed with errorCode timeout. Only jobs requested by account users in the caller\'s account are found.
|
|
319
|
+
* Get an admin concept media generation job
|
|
320
|
+
*/
|
|
321
|
+
adminGetConceptMediaJobRaw(requestParameters: AdminGetConceptMediaJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
|
|
322
|
+
/**
|
|
323
|
+
* Poll after a generate or regenerate (every few seconds) until status is succeeded or failed. On success, resultMediaId is the new hidden draft: open it with adminGetConceptImage or adminGetConceptDiagram per kind. On failure, errorCode and errorMessage say why. A job left pending or running past its deadline (the generation timeout plus a margin while running; 30 minutes while pending) is reported failed with errorCode timeout. Only jobs requested by account users in the caller\'s account are found.
|
|
324
|
+
* Get an admin concept media generation job
|
|
325
|
+
*/
|
|
326
|
+
adminGetConceptMediaJob(requestParameters: AdminGetConceptMediaJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
|
|
313
327
|
/**
|
|
314
328
|
* Returns the session summary (quiz details, questions, responses, score) for any quiz session belonging to a user within the caller\'s account. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Unlike the per-user `getQuizSessionSummary` endpoint, this endpoint does not gate on the `enhanced-quizzing` feature flag; an admin can read any historical session in their account regardless of whether the chat owner currently has the feature.
|
|
315
329
|
* Get quiz session summary for any session within the account
|
|
@@ -367,22 +381,22 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
367
381
|
*/
|
|
368
382
|
adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
|
|
369
383
|
/**
|
|
370
|
-
* Keeps the diagram out of every learner read. Idempotent: an already
|
|
384
|
+
* Keeps the diagram out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: a diagram an admin already hid keeps its original hide time and actor. A diagram hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
|
|
371
385
|
* Hide a concept diagram from learners
|
|
372
386
|
*/
|
|
373
387
|
adminHideConceptDiagramRaw(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
374
388
|
/**
|
|
375
|
-
* Keeps the diagram out of every learner read. Idempotent: an already
|
|
389
|
+
* Keeps the diagram out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: a diagram an admin already hid keeps its original hide time and actor. A diagram hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
|
|
376
390
|
* Hide a concept diagram from learners
|
|
377
391
|
*/
|
|
378
392
|
adminHideConceptDiagram(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
379
393
|
/**
|
|
380
|
-
* Keeps the image out of every learner read. Idempotent: an already
|
|
394
|
+
* Keeps the image out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: an image an admin already hid keeps its original hide time and actor. An image hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
|
|
381
395
|
* Hide a concept image from learners
|
|
382
396
|
*/
|
|
383
397
|
adminHideConceptImageRaw(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
384
398
|
/**
|
|
385
|
-
* Keeps the image out of every learner read. Idempotent: an already
|
|
399
|
+
* Keeps the image out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: an image an admin already hid keeps its original hide time and actor. An image hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
|
|
386
400
|
* Hide a concept image from learners
|
|
387
401
|
*/
|
|
388
402
|
adminHideConceptImage(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
@@ -489,25 +503,25 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
489
503
|
*/
|
|
490
504
|
adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminStreak>>;
|
|
491
505
|
/**
|
|
492
|
-
*
|
|
493
|
-
*
|
|
506
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new diagram is generated from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
|
|
507
|
+
* Enqueue a hidden revision of a concept diagram
|
|
494
508
|
*/
|
|
495
|
-
adminRegenerateConceptDiagramRaw(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
509
|
+
adminRegenerateConceptDiagramRaw(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
|
|
496
510
|
/**
|
|
497
|
-
*
|
|
498
|
-
*
|
|
511
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new diagram is generated from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
|
|
512
|
+
* Enqueue a hidden revision of a concept diagram
|
|
499
513
|
*/
|
|
500
|
-
adminRegenerateConceptDiagram(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
514
|
+
adminRegenerateConceptDiagram(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
|
|
501
515
|
/**
|
|
502
|
-
*
|
|
503
|
-
*
|
|
516
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new image is generated from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
|
|
517
|
+
* Enqueue a hidden revision of a concept image
|
|
504
518
|
*/
|
|
505
|
-
adminRegenerateConceptImageRaw(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
519
|
+
adminRegenerateConceptImageRaw(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
|
|
506
520
|
/**
|
|
507
|
-
*
|
|
508
|
-
*
|
|
521
|
+
* Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new image is generated from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
|
|
522
|
+
* Enqueue a hidden revision of a concept image
|
|
509
523
|
*/
|
|
510
|
-
adminRegenerateConceptImage(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
524
|
+
adminRegenerateConceptImage(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
|
|
511
525
|
/**
|
|
512
526
|
* Wipes all per-user learning data (chats, quizzes, flashcards, study objectives, concepts, streaks, files, etc.) for the target user while preserving their account-user and user records — and therefore their external identity and Canvas connection. Does not re-seed any demo data. Intended for single-account demo/test users: learning streaks are keyed on the user (not the account), so a user who belongs to multiple accounts has their streak cleared everywhere.
|
|
513
527
|
* Reset a user\'s Athena learning data to a blank slate
|
|
@@ -519,22 +533,22 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
519
533
|
*/
|
|
520
534
|
adminResetUserLearningData(requestParameters: AdminResetUserLearningDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminResetLearningDataResponse>;
|
|
521
535
|
/**
|
|
522
|
-
* Clears the deletion and leaves the diagram hidden for review; show it to serve it to learners again. A diagram that is not deleted is unchanged.
|
|
536
|
+
* Clears the deletion and any approval and leaves the diagram hidden for review (a diagram already hidden keeps its hide); show it to serve it to learners again. A diagram that is not deleted is unchanged.
|
|
523
537
|
* Restore a soft-deleted concept diagram
|
|
524
538
|
*/
|
|
525
539
|
adminRestoreConceptDiagramRaw(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
526
540
|
/**
|
|
527
|
-
* Clears the deletion and leaves the diagram hidden for review; show it to serve it to learners again. A diagram that is not deleted is unchanged.
|
|
541
|
+
* Clears the deletion and any approval and leaves the diagram hidden for review (a diagram already hidden keeps its hide); show it to serve it to learners again. A diagram that is not deleted is unchanged.
|
|
528
542
|
* Restore a soft-deleted concept diagram
|
|
529
543
|
*/
|
|
530
544
|
adminRestoreConceptDiagram(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
531
545
|
/**
|
|
532
|
-
* Clears the deletion and leaves the image hidden for review; show it to serve it to learners again.
|
|
546
|
+
* Clears the deletion and any approval and leaves the image hidden for review (an image already hidden keeps its hide); show it to serve it to learners again. An image that is not deleted is unchanged.
|
|
533
547
|
* Restore a soft-deleted concept image
|
|
534
548
|
*/
|
|
535
549
|
adminRestoreConceptImageRaw(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
536
550
|
/**
|
|
537
|
-
* Clears the deletion and leaves the image hidden for review; show it to serve it to learners again.
|
|
551
|
+
* Clears the deletion and any approval and leaves the image hidden for review (an image already hidden keeps its hide); show it to serve it to learners again. An image that is not deleted is unchanged.
|
|
538
552
|
* Restore a soft-deleted concept image
|
|
539
553
|
*/
|
|
540
554
|
adminRestoreConceptImage(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
@@ -549,22 +563,22 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
549
563
|
*/
|
|
550
564
|
adminSearchConcepts(requestParameters: AdminSearchConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminConceptSearchResult>>;
|
|
551
565
|
/**
|
|
552
|
-
* Clears the hide so learners can be served the diagram again. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
|
|
566
|
+
* Clears the hide so learners can be served the diagram again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved diagram. Showing a visible diagram approves it too. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
|
|
553
567
|
* Show a hidden concept diagram to learners
|
|
554
568
|
*/
|
|
555
569
|
adminShowConceptDiagramRaw(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptDiagram>>;
|
|
556
570
|
/**
|
|
557
|
-
* Clears the hide so learners can be served the diagram again. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
|
|
571
|
+
* Clears the hide so learners can be served the diagram again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved diagram. Showing a visible diagram approves it too. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
|
|
558
572
|
* Show a hidden concept diagram to learners
|
|
559
573
|
*/
|
|
560
574
|
adminShowConceptDiagram(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptDiagram>;
|
|
561
575
|
/**
|
|
562
|
-
* Clears the hide so learners can be served the image again. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
|
|
576
|
+
* Clears the hide so learners can be served the image again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved image. Showing a visible image approves it too. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
|
|
563
577
|
* Show a hidden concept image to learners
|
|
564
578
|
*/
|
|
565
579
|
adminShowConceptImageRaw(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptImage>>;
|
|
566
580
|
/**
|
|
567
|
-
* Clears the hide so learners can be served the image again. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
|
|
581
|
+
* Clears the hide so learners can be served the image again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved image. Showing a visible image approves it too. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
|
|
568
582
|
* Show a hidden concept image to learners
|
|
569
583
|
*/
|
|
570
584
|
adminShowConceptImage(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptImage>;
|
|
@@ -592,6 +606,7 @@ export declare const AdminListConceptDiagramsStateEnum: {
|
|
|
592
606
|
readonly NotDeleted: "not_deleted";
|
|
593
607
|
readonly Visible: "visible";
|
|
594
608
|
readonly Hidden: "hidden";
|
|
609
|
+
readonly Flagged: "flagged";
|
|
595
610
|
readonly Deleted: "deleted";
|
|
596
611
|
readonly All: "all";
|
|
597
612
|
};
|
|
@@ -611,6 +626,7 @@ export declare const AdminListConceptImagesStateEnum: {
|
|
|
611
626
|
readonly NotDeleted: "not_deleted";
|
|
612
627
|
readonly Visible: "visible";
|
|
613
628
|
readonly Hidden: "hidden";
|
|
629
|
+
readonly Flagged: "flagged";
|
|
614
630
|
readonly Deleted: "deleted";
|
|
615
631
|
readonly All: "all";
|
|
616
632
|
};
|