@instructure/athena-api-client 3.46.2 → 4.0.0

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 (94) hide show
  1. package/README.md +37 -0
  2. package/dist/apis/AdminApi.d.ts +310 -1
  3. package/dist/apis/AdminApi.js +850 -20
  4. package/dist/esm/apis/AdminApi.d.ts +310 -1
  5. package/dist/esm/apis/AdminApi.js +850 -20
  6. package/dist/esm/models/AdminConceptDiagram.d.ts +165 -0
  7. package/dist/esm/models/AdminConceptDiagram.js +136 -0
  8. package/dist/esm/models/AdminConceptDiagramDetail.d.ts +203 -0
  9. package/dist/esm/models/AdminConceptDiagramDetail.js +162 -0
  10. package/dist/esm/models/AdminConceptImage.d.ts +183 -0
  11. package/dist/esm/models/AdminConceptImage.js +148 -0
  12. package/dist/esm/models/AdminConceptImageDetail.d.ts +221 -0
  13. package/dist/esm/models/AdminConceptImageDetail.js +174 -0
  14. package/dist/esm/models/AdminConceptMediaActor.d.ts +38 -0
  15. package/dist/esm/models/AdminConceptMediaActor.js +47 -0
  16. package/dist/esm/models/AdminConceptMediaConcept.d.ts +38 -0
  17. package/dist/esm/models/AdminConceptMediaConcept.js +47 -0
  18. package/dist/esm/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
  19. package/dist/esm/models/AdminConceptMediaHistoryEntry.js +87 -0
  20. package/dist/esm/models/AdminConceptMediaJob.d.ts +157 -0
  21. package/dist/esm/models/AdminConceptMediaJob.js +139 -0
  22. package/dist/esm/models/AdminConceptMediaRevision.d.ts +67 -0
  23. package/dist/esm/models/AdminConceptMediaRevision.js +70 -0
  24. package/dist/esm/models/AdminConceptSearchResult.d.ts +56 -0
  25. package/dist/esm/models/AdminConceptSearchResult.js +59 -0
  26. package/dist/esm/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  27. package/dist/esm/models/AdminGenerateConceptDiagramRequest.js +51 -0
  28. package/dist/esm/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  29. package/dist/esm/models/AdminGenerateConceptImageRequest.js +49 -0
  30. package/dist/esm/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  31. package/dist/esm/models/AdminGeneratedConceptDiagram.js +175 -0
  32. package/dist/esm/models/AdminGeneratedConceptImage.d.ts +237 -0
  33. package/dist/esm/models/AdminGeneratedConceptImage.js +187 -0
  34. package/dist/esm/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  35. package/dist/esm/models/AdminPaginatedConceptDiagrams.js +48 -0
  36. package/dist/esm/models/AdminPaginatedConceptImages.d.ts +39 -0
  37. package/dist/esm/models/AdminPaginatedConceptImages.js +48 -0
  38. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  39. package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js +47 -0
  40. package/dist/esm/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  41. package/dist/esm/models/AdminRegenerateConceptImageRequest.js +45 -0
  42. package/dist/esm/models/AdminShowConceptMediaRequest.d.ts +32 -0
  43. package/dist/esm/models/AdminShowConceptMediaRequest.js +41 -0
  44. package/dist/esm/models/AdminShownConceptDiagram.d.ts +215 -0
  45. package/dist/esm/models/AdminShownConceptDiagram.js +170 -0
  46. package/dist/esm/models/AdminShownConceptImage.d.ts +233 -0
  47. package/dist/esm/models/AdminShownConceptImage.js +182 -0
  48. package/dist/esm/models/index.d.ts +19 -0
  49. package/dist/esm/models/index.js +19 -0
  50. package/dist/models/AdminConceptDiagram.d.ts +165 -0
  51. package/dist/models/AdminConceptDiagram.js +144 -0
  52. package/dist/models/AdminConceptDiagramDetail.d.ts +203 -0
  53. package/dist/models/AdminConceptDiagramDetail.js +170 -0
  54. package/dist/models/AdminConceptImage.d.ts +183 -0
  55. package/dist/models/AdminConceptImage.js +156 -0
  56. package/dist/models/AdminConceptImageDetail.d.ts +221 -0
  57. package/dist/models/AdminConceptImageDetail.js +182 -0
  58. package/dist/models/AdminConceptMediaActor.d.ts +38 -0
  59. package/dist/models/AdminConceptMediaActor.js +54 -0
  60. package/dist/models/AdminConceptMediaConcept.d.ts +38 -0
  61. package/dist/models/AdminConceptMediaConcept.js +54 -0
  62. package/dist/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
  63. package/dist/models/AdminConceptMediaHistoryEntry.js +95 -0
  64. package/dist/models/AdminConceptMediaJob.d.ts +157 -0
  65. package/dist/models/AdminConceptMediaJob.js +147 -0
  66. package/dist/models/AdminConceptMediaRevision.d.ts +67 -0
  67. package/dist/models/AdminConceptMediaRevision.js +78 -0
  68. package/dist/models/AdminConceptSearchResult.d.ts +56 -0
  69. package/dist/models/AdminConceptSearchResult.js +66 -0
  70. package/dist/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
  71. package/dist/models/AdminGenerateConceptDiagramRequest.js +58 -0
  72. package/dist/models/AdminGenerateConceptImageRequest.d.ts +50 -0
  73. package/dist/models/AdminGenerateConceptImageRequest.js +56 -0
  74. package/dist/models/AdminGeneratedConceptDiagram.d.ts +219 -0
  75. package/dist/models/AdminGeneratedConceptDiagram.js +183 -0
  76. package/dist/models/AdminGeneratedConceptImage.d.ts +237 -0
  77. package/dist/models/AdminGeneratedConceptImage.js +195 -0
  78. package/dist/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
  79. package/dist/models/AdminPaginatedConceptDiagrams.js +55 -0
  80. package/dist/models/AdminPaginatedConceptImages.d.ts +39 -0
  81. package/dist/models/AdminPaginatedConceptImages.js +55 -0
  82. package/dist/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
  83. package/dist/models/AdminRegenerateConceptDiagramRequest.js +54 -0
  84. package/dist/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
  85. package/dist/models/AdminRegenerateConceptImageRequest.js +52 -0
  86. package/dist/models/AdminShowConceptMediaRequest.d.ts +32 -0
  87. package/dist/models/AdminShowConceptMediaRequest.js +48 -0
  88. package/dist/models/AdminShownConceptDiagram.d.ts +215 -0
  89. package/dist/models/AdminShownConceptDiagram.js +178 -0
  90. package/dist/models/AdminShownConceptImage.d.ts +233 -0
  91. package/dist/models/AdminShownConceptImage.js +190 -0
  92. package/dist/models/index.d.ts +19 -0
  93. package/dist/models/index.js +19 -0
  94. package/package.json +1 -1
@@ -10,7 +10,23 @@
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, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
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
+ export interface AdminDeleteConceptDiagramRequest {
15
+ xUserId: string;
16
+ diagramId: string;
17
+ }
18
+ export interface AdminDeleteConceptImageRequest {
19
+ xUserId: string;
20
+ imageId: string;
21
+ }
22
+ export interface AdminGenerateConceptDiagramOperationRequest {
23
+ xUserId: string;
24
+ adminGenerateConceptDiagramRequest: AdminGenerateConceptDiagramRequest;
25
+ }
26
+ export interface AdminGenerateConceptImageOperationRequest {
27
+ xUserId: string;
28
+ adminGenerateConceptImageRequest: AdminGenerateConceptImageRequest;
29
+ }
14
30
  export interface AdminGetChatRequest {
15
31
  xUserId: string;
16
32
  chatId: string;
@@ -28,6 +44,18 @@ export interface AdminGetCohortStatsRequest {
28
44
  since: Date;
29
45
  until: Date;
30
46
  }
47
+ export interface AdminGetConceptDiagramRequest {
48
+ xUserId: string;
49
+ diagramId: string;
50
+ }
51
+ export interface AdminGetConceptImageRequest {
52
+ xUserId: string;
53
+ imageId: string;
54
+ }
55
+ export interface AdminGetConceptMediaJobRequest {
56
+ xUserId: string;
57
+ jobId: string;
58
+ }
31
59
  export interface AdminGetQuizSessionSummaryRequest {
32
60
  xUserId: string;
33
61
  sessionId: string;
@@ -51,6 +79,14 @@ export interface AdminGetUsersActivityTotalsRequest {
51
79
  xUserId: string;
52
80
  adminUsersActivityTotalsRequest: AdminUsersActivityTotalsRequest;
53
81
  }
82
+ export interface AdminHideConceptDiagramRequest {
83
+ xUserId: string;
84
+ diagramId: string;
85
+ }
86
+ export interface AdminHideConceptImageRequest {
87
+ xUserId: string;
88
+ imageId: string;
89
+ }
54
90
  export interface AdminListActiveStreaksRequest {
55
91
  xUserId: string;
56
92
  limit?: number;
@@ -63,6 +99,28 @@ export interface AdminListChatsRequest {
63
99
  chatType?: string;
64
100
  forReview?: boolean;
65
101
  }
102
+ export interface AdminListConceptDiagramsRequest {
103
+ xUserId: string;
104
+ limit?: number;
105
+ cursor?: string;
106
+ conceptId?: string;
107
+ conceptQuery?: string;
108
+ creatorAccountUserId?: string;
109
+ creatorUserId?: string;
110
+ state?: AdminListConceptDiagramsStateEnum;
111
+ origin?: AdminListConceptDiagramsOriginEnum;
112
+ }
113
+ export interface AdminListConceptImagesRequest {
114
+ xUserId: string;
115
+ limit?: number;
116
+ cursor?: string;
117
+ conceptId?: string;
118
+ conceptQuery?: string;
119
+ creatorAccountUserId?: string;
120
+ creatorUserId?: string;
121
+ state?: AdminListConceptImagesStateEnum;
122
+ origin?: AdminListConceptImagesOriginEnum;
123
+ }
66
124
  export interface AdminListLastExchangesRequest {
67
125
  xUserId: string;
68
126
  since: Date;
@@ -114,10 +172,43 @@ export interface AdminListTopStreaksRequest {
114
172
  xUserId: string;
115
173
  limit?: number;
116
174
  }
175
+ export interface AdminRegenerateConceptDiagramOperationRequest {
176
+ xUserId: string;
177
+ diagramId: string;
178
+ adminRegenerateConceptDiagramRequest: AdminRegenerateConceptDiagramRequest;
179
+ }
180
+ export interface AdminRegenerateConceptImageOperationRequest {
181
+ xUserId: string;
182
+ imageId: string;
183
+ adminRegenerateConceptImageRequest: AdminRegenerateConceptImageRequest;
184
+ }
117
185
  export interface AdminResetUserLearningDataRequest {
118
186
  xUserId: string;
119
187
  externalId: string;
120
188
  }
189
+ export interface AdminRestoreConceptDiagramRequest {
190
+ xUserId: string;
191
+ diagramId: string;
192
+ }
193
+ export interface AdminRestoreConceptImageRequest {
194
+ xUserId: string;
195
+ imageId: string;
196
+ }
197
+ export interface AdminSearchConceptsRequest {
198
+ xUserId: string;
199
+ query?: string;
200
+ limit?: number;
201
+ }
202
+ export interface AdminShowConceptDiagramRequest {
203
+ xUserId: string;
204
+ diagramId: string;
205
+ adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
206
+ }
207
+ export interface AdminShowConceptImageRequest {
208
+ xUserId: string;
209
+ imageId: string;
210
+ adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
211
+ }
121
212
  export interface AdminTriggerChatAnalysisRequest {
122
213
  xUserId: string;
123
214
  chatId: string;
@@ -131,6 +222,46 @@ export interface AdminUpdateChatOperationRequest {
131
222
  *
132
223
  */
133
224
  export declare class AdminApi extends runtime.BaseAPI {
225
+ /**
226
+ * Removes the diagram from every learner read and from the default admin list. The row is kept. Idempotent. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
227
+ * Soft-delete a concept diagram
228
+ */
229
+ adminDeleteConceptDiagramRaw(requestParameters: AdminDeleteConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
230
+ /**
231
+ * Removes the diagram from every learner read and from the default admin list. The row is kept. Idempotent. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
232
+ * Soft-delete a concept diagram
233
+ */
234
+ adminDeleteConceptDiagram(requestParameters: AdminDeleteConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
235
+ /**
236
+ * Removes the image from every learner read and from the default admin list. The row and its stored image bytes are kept. Idempotent. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
237
+ * Soft-delete a concept image
238
+ */
239
+ adminDeleteConceptImageRaw(requestParameters: AdminDeleteConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
240
+ /**
241
+ * Removes the image from every learner read and from the default admin list. The row and its stored image bytes are kept. Idempotent. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
242
+ * Soft-delete a concept image
243
+ */
244
+ adminDeleteConceptImage(requestParameters: AdminDeleteConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
245
+ /**
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
248
+ */
249
+ adminGenerateConceptDiagramRaw(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
250
+ /**
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
253
+ */
254
+ adminGenerateConceptDiagram(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
255
+ /**
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
258
+ */
259
+ adminGenerateConceptImageRaw(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
260
+ /**
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
263
+ */
264
+ adminGenerateConceptImage(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
134
265
  /**
135
266
  * Get any chat by ID within the account
136
267
  */
@@ -163,6 +294,36 @@ export declare class AdminApi extends runtime.BaseAPI {
163
294
  * Get cohort statistics for users created within a date range
164
295
  */
165
296
  adminGetCohortStats(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminCohortStats>;
297
+ /**
298
+ * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
299
+ * Get a library concept diagram in any state
300
+ */
301
+ adminGetConceptDiagramRaw(requestParameters: AdminGetConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
302
+ /**
303
+ * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
304
+ * Get a library concept diagram in any state
305
+ */
306
+ adminGetConceptDiagram(requestParameters: AdminGetConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
307
+ /**
308
+ * One image, hidden or deleted included, with its prompt (and the editable prompt without the style preamble) and its revision lineage.
309
+ * Get a library concept image in any state
310
+ */
311
+ adminGetConceptImageRaw(requestParameters: AdminGetConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
312
+ /**
313
+ * One image, hidden or deleted included, with its prompt (and the editable prompt without the style preamble) and its revision lineage.
314
+ * Get a library concept image in any state
315
+ */
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>;
166
327
  /**
167
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.
168
329
  * Get quiz session summary for any session within the account
@@ -219,6 +380,26 @@ export declare class AdminApi extends runtime.BaseAPI {
219
380
  * Get lifetime activity totals for a batch of users
220
381
  */
221
382
  adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
383
+ /**
384
+ * Keeps the diagram out of every learner read. Idempotent: an already hidden diagram keeps its original hide time and actor. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
385
+ * Hide a concept diagram from learners
386
+ */
387
+ adminHideConceptDiagramRaw(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
388
+ /**
389
+ * Keeps the diagram out of every learner read. Idempotent: an already hidden diagram keeps its original hide time and actor. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
390
+ * Hide a concept diagram from learners
391
+ */
392
+ adminHideConceptDiagram(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
393
+ /**
394
+ * Keeps the image out of every learner read. Idempotent: an already hidden image keeps its original hide time and actor. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
395
+ * Hide a concept image from learners
396
+ */
397
+ adminHideConceptImageRaw(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
398
+ /**
399
+ * Keeps the image out of every learner read. Idempotent: an already hidden image keeps its original hide time and actor. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
400
+ * Hide a concept image from learners
401
+ */
402
+ adminHideConceptImage(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
222
403
  /**
223
404
  * List all active streaks (currentDays > 0) across the account, paginated
224
405
  */
@@ -235,6 +416,26 @@ export declare class AdminApi extends runtime.BaseAPI {
235
416
  * List recent chats across all account users
236
417
  */
237
418
  adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
419
+ /**
420
+ * Every persisted concept diagram, newest first, filtered by concept, creator, origin, and state. Deleted diagrams are left out unless state is deleted or all. Omits the HTML document; fetch one diagram to get it.
421
+ * List library concept diagrams in any state
422
+ */
423
+ adminListConceptDiagramsRaw(requestParameters: AdminListConceptDiagramsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedConceptDiagrams>>;
424
+ /**
425
+ * Every persisted concept diagram, newest first, filtered by concept, creator, origin, and state. Deleted diagrams are left out unless state is deleted or all. Omits the HTML document; fetch one diagram to get it.
426
+ * List library concept diagrams in any state
427
+ */
428
+ adminListConceptDiagrams(requestParameters: AdminListConceptDiagramsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedConceptDiagrams>;
429
+ /**
430
+ * Every persisted concept image, newest first, filtered by concept, creator, origin, and state. Deleted images are left out unless state is deleted or all. Each item carries a freshly signed read URL.
431
+ * List library concept images in any state
432
+ */
433
+ adminListConceptImagesRaw(requestParameters: AdminListConceptImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedConceptImages>>;
434
+ /**
435
+ * Every persisted concept image, newest first, filtered by concept, creator, origin, and state. Deleted images are left out unless state is deleted or all. Each item carries a freshly signed read URL.
436
+ * List library concept images in any state
437
+ */
438
+ adminListConceptImages(requestParameters: AdminListConceptImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedConceptImages>;
238
439
  /**
239
440
  * For account users created within [since, until) who sent at most `maxUserMessages` learner-authored messages and whose last such message is at least `inactiveDays` old, returns that last message together with the first assistant reply that followed it in the same chat. Client-fired synthetic turns (learning-session kickoffs, daily-quiz starts) are ignored when counting and selecting messages. Users with no learner-authored messages are omitted. Ordered by most recent last message first.
240
441
  * List the final user message and assistant reply for low-engagement new users
@@ -301,6 +502,26 @@ export declare class AdminApi extends runtime.BaseAPI {
301
502
  * List top N streaks across the account
302
503
  */
303
504
  adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminStreak>>;
505
+ /**
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
508
+ */
509
+ adminRegenerateConceptDiagramRaw(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
510
+ /**
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
513
+ */
514
+ adminRegenerateConceptDiagram(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
515
+ /**
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
518
+ */
519
+ adminRegenerateConceptImageRaw(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaJob>>;
520
+ /**
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
523
+ */
524
+ adminRegenerateConceptImage(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaJob>;
304
525
  /**
305
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.
306
527
  * Reset a user\'s Athena learning data to a blank slate
@@ -311,6 +532,56 @@ export declare class AdminApi extends runtime.BaseAPI {
311
532
  * Reset a user\'s Athena learning data to a blank slate
312
533
  */
313
534
  adminResetUserLearningData(requestParameters: AdminResetUserLearningDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminResetLearningDataResponse>;
535
+ /**
536
+ * 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.
537
+ * Restore a soft-deleted concept diagram
538
+ */
539
+ adminRestoreConceptDiagramRaw(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
540
+ /**
541
+ * 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.
542
+ * Restore a soft-deleted concept diagram
543
+ */
544
+ adminRestoreConceptDiagram(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
545
+ /**
546
+ * Clears the deletion and leaves the image hidden for review; show it to serve it to learners again. A image that is not deleted is unchanged.
547
+ * Restore a soft-deleted concept image
548
+ */
549
+ adminRestoreConceptImageRaw(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
550
+ /**
551
+ * Clears the deletion and leaves the image hidden for review; show it to serve it to learners again. A image that is not deleted is unchanged.
552
+ * Restore a soft-deleted concept image
553
+ */
554
+ adminRestoreConceptImage(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
555
+ /**
556
+ * Concepts whose name contains the query (case-insensitive), exact and prefix matches first, each with its count of non-deleted library images and diagrams. For picking the concept an admin-generated image or diagram is filed under. Without a query, concepts by name.
557
+ * Search the global concepts by name
558
+ */
559
+ adminSearchConceptsRaw(requestParameters: AdminSearchConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminConceptSearchResult>>>;
560
+ /**
561
+ * Concepts whose name contains the query (case-insensitive), exact and prefix matches first, each with its count of non-deleted library images and diagrams. For picking the concept an admin-generated image or diagram is filed under. Without a query, concepts by name.
562
+ * Search the global concepts by name
563
+ */
564
+ adminSearchConcepts(requestParameters: AdminSearchConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminConceptSearchResult>>;
565
+ /**
566
+ * 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.
567
+ * Show a hidden concept diagram to learners
568
+ */
569
+ adminShowConceptDiagramRaw(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptDiagram>>;
570
+ /**
571
+ * 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.
572
+ * Show a hidden concept diagram to learners
573
+ */
574
+ adminShowConceptDiagram(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptDiagram>;
575
+ /**
576
+ * 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).
577
+ * Show a hidden concept image to learners
578
+ */
579
+ adminShowConceptImageRaw(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptImage>>;
580
+ /**
581
+ * 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).
582
+ * Show a hidden concept image to learners
583
+ */
584
+ adminShowConceptImage(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptImage>;
314
585
  /**
315
586
  * Trigger re-analysis for a chat
316
587
  */
@@ -328,6 +599,44 @@ export declare class AdminApi extends runtime.BaseAPI {
328
599
  */
329
600
  adminUpdateChat(requestParameters: AdminUpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChat>;
330
601
  }
602
+ /**
603
+ * @export
604
+ */
605
+ export declare const AdminListConceptDiagramsStateEnum: {
606
+ readonly NotDeleted: "not_deleted";
607
+ readonly Visible: "visible";
608
+ readonly Hidden: "hidden";
609
+ readonly Deleted: "deleted";
610
+ readonly All: "all";
611
+ };
612
+ export type AdminListConceptDiagramsStateEnum = typeof AdminListConceptDiagramsStateEnum[keyof typeof AdminListConceptDiagramsStateEnum];
613
+ /**
614
+ * @export
615
+ */
616
+ export declare const AdminListConceptDiagramsOriginEnum: {
617
+ readonly Chat: "chat";
618
+ readonly Admin: "admin";
619
+ };
620
+ export type AdminListConceptDiagramsOriginEnum = typeof AdminListConceptDiagramsOriginEnum[keyof typeof AdminListConceptDiagramsOriginEnum];
621
+ /**
622
+ * @export
623
+ */
624
+ export declare const AdminListConceptImagesStateEnum: {
625
+ readonly NotDeleted: "not_deleted";
626
+ readonly Visible: "visible";
627
+ readonly Hidden: "hidden";
628
+ readonly Deleted: "deleted";
629
+ readonly All: "all";
630
+ };
631
+ export type AdminListConceptImagesStateEnum = typeof AdminListConceptImagesStateEnum[keyof typeof AdminListConceptImagesStateEnum];
632
+ /**
633
+ * @export
634
+ */
635
+ export declare const AdminListConceptImagesOriginEnum: {
636
+ readonly Chat: "chat";
637
+ readonly Admin: "admin";
638
+ };
639
+ export type AdminListConceptImagesOriginEnum = typeof AdminListConceptImagesOriginEnum[keyof typeof AdminListConceptImagesOriginEnum];
331
640
  /**
332
641
  * @export
333
642
  */