@instructure/athena-api-client 3.46.1 → 3.47.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.
- package/README.md +37 -0
- package/dist/apis/AdminApi.d.ts +296 -1
- package/dist/apis/AdminApi.js +809 -20
- package/dist/esm/apis/AdminApi.d.ts +296 -1
- package/dist/esm/apis/AdminApi.js +809 -20
- package/dist/esm/models/AdminConceptDiagram.d.ts +165 -0
- package/dist/esm/models/AdminConceptDiagram.js +136 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +203 -0
- package/dist/esm/models/AdminConceptDiagramDetail.js +162 -0
- package/dist/esm/models/AdminConceptImage.d.ts +183 -0
- package/dist/esm/models/AdminConceptImage.js +148 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +221 -0
- package/dist/esm/models/AdminConceptImageDetail.js +174 -0
- package/dist/esm/models/AdminConceptMediaActor.d.ts +38 -0
- package/dist/esm/models/AdminConceptMediaActor.js +47 -0
- package/dist/esm/models/AdminConceptMediaConcept.d.ts +38 -0
- package/dist/esm/models/AdminConceptMediaConcept.js +47 -0
- package/dist/esm/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
- package/dist/esm/models/AdminConceptMediaHistoryEntry.js +87 -0
- package/dist/esm/models/AdminConceptMediaRevision.d.ts +67 -0
- package/dist/esm/models/AdminConceptMediaRevision.js +70 -0
- package/dist/esm/models/AdminConceptSearchResult.d.ts +56 -0
- package/dist/esm/models/AdminConceptSearchResult.js +59 -0
- package/dist/esm/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
- package/dist/esm/models/AdminGenerateConceptDiagramRequest.js +51 -0
- package/dist/esm/models/AdminGenerateConceptImageRequest.d.ts +50 -0
- package/dist/esm/models/AdminGenerateConceptImageRequest.js +49 -0
- package/dist/esm/models/AdminGeneratedConceptDiagram.d.ts +219 -0
- package/dist/esm/models/AdminGeneratedConceptDiagram.js +175 -0
- package/dist/esm/models/AdminGeneratedConceptImage.d.ts +237 -0
- package/dist/esm/models/AdminGeneratedConceptImage.js +187 -0
- package/dist/esm/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
- package/dist/esm/models/AdminPaginatedConceptDiagrams.js +48 -0
- package/dist/esm/models/AdminPaginatedConceptImages.d.ts +39 -0
- package/dist/esm/models/AdminPaginatedConceptImages.js +48 -0
- package/dist/esm/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
- package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js +47 -0
- package/dist/esm/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
- package/dist/esm/models/AdminRegenerateConceptImageRequest.js +45 -0
- package/dist/esm/models/AdminShowConceptMediaRequest.d.ts +32 -0
- package/dist/esm/models/AdminShowConceptMediaRequest.js +41 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +215 -0
- package/dist/esm/models/AdminShownConceptDiagram.js +170 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +233 -0
- package/dist/esm/models/AdminShownConceptImage.js +182 -0
- package/dist/esm/models/index.d.ts +20 -0
- package/dist/esm/models/index.js +20 -0
- package/dist/models/AdminConceptDiagram.d.ts +165 -0
- package/dist/models/AdminConceptDiagram.js +144 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +203 -0
- package/dist/models/AdminConceptDiagramDetail.js +170 -0
- package/dist/models/AdminConceptImage.d.ts +183 -0
- package/dist/models/AdminConceptImage.js +156 -0
- package/dist/models/AdminConceptImageDetail.d.ts +221 -0
- package/dist/models/AdminConceptImageDetail.js +182 -0
- package/dist/models/AdminConceptMediaActor.d.ts +38 -0
- package/dist/models/AdminConceptMediaActor.js +54 -0
- package/dist/models/AdminConceptMediaConcept.d.ts +38 -0
- package/dist/models/AdminConceptMediaConcept.js +54 -0
- package/dist/models/AdminConceptMediaHistoryEntry.d.ts +92 -0
- package/dist/models/AdminConceptMediaHistoryEntry.js +95 -0
- package/dist/models/AdminConceptMediaRevision.d.ts +67 -0
- package/dist/models/AdminConceptMediaRevision.js +78 -0
- package/dist/models/AdminConceptSearchResult.d.ts +56 -0
- package/dist/models/AdminConceptSearchResult.js +66 -0
- package/dist/models/AdminGenerateConceptDiagramRequest.d.ts +56 -0
- package/dist/models/AdminGenerateConceptDiagramRequest.js +58 -0
- package/dist/models/AdminGenerateConceptImageRequest.d.ts +50 -0
- package/dist/models/AdminGenerateConceptImageRequest.js +56 -0
- package/dist/models/AdminGeneratedConceptDiagram.d.ts +219 -0
- package/dist/models/AdminGeneratedConceptDiagram.js +183 -0
- package/dist/models/AdminGeneratedConceptImage.d.ts +237 -0
- package/dist/models/AdminGeneratedConceptImage.js +195 -0
- package/dist/models/AdminPaginatedConceptDiagrams.d.ts +39 -0
- package/dist/models/AdminPaginatedConceptDiagrams.js +55 -0
- package/dist/models/AdminPaginatedConceptImages.d.ts +39 -0
- package/dist/models/AdminPaginatedConceptImages.js +55 -0
- package/dist/models/AdminRegenerateConceptDiagramRequest.d.ts +44 -0
- package/dist/models/AdminRegenerateConceptDiagramRequest.js +54 -0
- package/dist/models/AdminRegenerateConceptImageRequest.d.ts +38 -0
- package/dist/models/AdminRegenerateConceptImageRequest.js +52 -0
- package/dist/models/AdminShowConceptMediaRequest.d.ts +32 -0
- package/dist/models/AdminShowConceptMediaRequest.js +48 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +215 -0
- package/dist/models/AdminShownConceptDiagram.js +178 -0
- package/dist/models/AdminShownConceptImage.d.ts +233 -0
- package/dist/models/AdminShownConceptImage.js +190 -0
- package/dist/models/index.d.ts +20 -0
- package/dist/models/index.js +20 -0
- 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, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminGeneratedConceptDiagram, AdminGeneratedConceptImage, 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,14 @@ 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
|
+
}
|
|
31
55
|
export interface AdminGetQuizSessionSummaryRequest {
|
|
32
56
|
xUserId: string;
|
|
33
57
|
sessionId: string;
|
|
@@ -51,6 +75,14 @@ export interface AdminGetUsersActivityTotalsRequest {
|
|
|
51
75
|
xUserId: string;
|
|
52
76
|
adminUsersActivityTotalsRequest: AdminUsersActivityTotalsRequest;
|
|
53
77
|
}
|
|
78
|
+
export interface AdminHideConceptDiagramRequest {
|
|
79
|
+
xUserId: string;
|
|
80
|
+
diagramId: string;
|
|
81
|
+
}
|
|
82
|
+
export interface AdminHideConceptImageRequest {
|
|
83
|
+
xUserId: string;
|
|
84
|
+
imageId: string;
|
|
85
|
+
}
|
|
54
86
|
export interface AdminListActiveStreaksRequest {
|
|
55
87
|
xUserId: string;
|
|
56
88
|
limit?: number;
|
|
@@ -63,6 +95,28 @@ export interface AdminListChatsRequest {
|
|
|
63
95
|
chatType?: string;
|
|
64
96
|
forReview?: boolean;
|
|
65
97
|
}
|
|
98
|
+
export interface AdminListConceptDiagramsRequest {
|
|
99
|
+
xUserId: string;
|
|
100
|
+
limit?: number;
|
|
101
|
+
cursor?: string;
|
|
102
|
+
conceptId?: string;
|
|
103
|
+
conceptQuery?: string;
|
|
104
|
+
creatorAccountUserId?: string;
|
|
105
|
+
creatorUserId?: string;
|
|
106
|
+
state?: AdminListConceptDiagramsStateEnum;
|
|
107
|
+
origin?: AdminListConceptDiagramsOriginEnum;
|
|
108
|
+
}
|
|
109
|
+
export interface AdminListConceptImagesRequest {
|
|
110
|
+
xUserId: string;
|
|
111
|
+
limit?: number;
|
|
112
|
+
cursor?: string;
|
|
113
|
+
conceptId?: string;
|
|
114
|
+
conceptQuery?: string;
|
|
115
|
+
creatorAccountUserId?: string;
|
|
116
|
+
creatorUserId?: string;
|
|
117
|
+
state?: AdminListConceptImagesStateEnum;
|
|
118
|
+
origin?: AdminListConceptImagesOriginEnum;
|
|
119
|
+
}
|
|
66
120
|
export interface AdminListLastExchangesRequest {
|
|
67
121
|
xUserId: string;
|
|
68
122
|
since: Date;
|
|
@@ -114,10 +168,43 @@ export interface AdminListTopStreaksRequest {
|
|
|
114
168
|
xUserId: string;
|
|
115
169
|
limit?: number;
|
|
116
170
|
}
|
|
171
|
+
export interface AdminRegenerateConceptDiagramOperationRequest {
|
|
172
|
+
xUserId: string;
|
|
173
|
+
diagramId: string;
|
|
174
|
+
adminRegenerateConceptDiagramRequest: AdminRegenerateConceptDiagramRequest;
|
|
175
|
+
}
|
|
176
|
+
export interface AdminRegenerateConceptImageOperationRequest {
|
|
177
|
+
xUserId: string;
|
|
178
|
+
imageId: string;
|
|
179
|
+
adminRegenerateConceptImageRequest: AdminRegenerateConceptImageRequest;
|
|
180
|
+
}
|
|
117
181
|
export interface AdminResetUserLearningDataRequest {
|
|
118
182
|
xUserId: string;
|
|
119
183
|
externalId: string;
|
|
120
184
|
}
|
|
185
|
+
export interface AdminRestoreConceptDiagramRequest {
|
|
186
|
+
xUserId: string;
|
|
187
|
+
diagramId: string;
|
|
188
|
+
}
|
|
189
|
+
export interface AdminRestoreConceptImageRequest {
|
|
190
|
+
xUserId: string;
|
|
191
|
+
imageId: string;
|
|
192
|
+
}
|
|
193
|
+
export interface AdminSearchConceptsRequest {
|
|
194
|
+
xUserId: string;
|
|
195
|
+
query?: string;
|
|
196
|
+
limit?: number;
|
|
197
|
+
}
|
|
198
|
+
export interface AdminShowConceptDiagramRequest {
|
|
199
|
+
xUserId: string;
|
|
200
|
+
diagramId: string;
|
|
201
|
+
adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
|
|
202
|
+
}
|
|
203
|
+
export interface AdminShowConceptImageRequest {
|
|
204
|
+
xUserId: string;
|
|
205
|
+
imageId: string;
|
|
206
|
+
adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
|
|
207
|
+
}
|
|
121
208
|
export interface AdminTriggerChatAnalysisRequest {
|
|
122
209
|
xUserId: string;
|
|
123
210
|
chatId: string;
|
|
@@ -131,6 +218,46 @@ export interface AdminUpdateChatOperationRequest {
|
|
|
131
218
|
*
|
|
132
219
|
*/
|
|
133
220
|
export declare class AdminApi extends runtime.BaseAPI {
|
|
221
|
+
/**
|
|
222
|
+
* 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.
|
|
223
|
+
* Soft-delete a concept diagram
|
|
224
|
+
*/
|
|
225
|
+
adminDeleteConceptDiagramRaw(requestParameters: AdminDeleteConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
226
|
+
/**
|
|
227
|
+
* 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.
|
|
228
|
+
* Soft-delete a concept diagram
|
|
229
|
+
*/
|
|
230
|
+
adminDeleteConceptDiagram(requestParameters: AdminDeleteConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
231
|
+
/**
|
|
232
|
+
* 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).
|
|
233
|
+
* Soft-delete a concept image
|
|
234
|
+
*/
|
|
235
|
+
adminDeleteConceptImageRaw(requestParameters: AdminDeleteConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
236
|
+
/**
|
|
237
|
+
* 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).
|
|
238
|
+
* Soft-delete a concept image
|
|
239
|
+
*/
|
|
240
|
+
adminDeleteConceptImage(requestParameters: AdminDeleteConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
241
|
+
/**
|
|
242
|
+
* Generates a new diagram filed under exactly one concept: conceptId as-is, or conceptName resolved first (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 response says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat. It is 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), not the learner limit.
|
|
243
|
+
* Generate a hidden draft diagram for a concept
|
|
244
|
+
*/
|
|
245
|
+
adminGenerateConceptDiagramRaw(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminGeneratedConceptDiagram>>;
|
|
246
|
+
/**
|
|
247
|
+
* Generates a new diagram filed under exactly one concept: conceptId as-is, or conceptName resolved first (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 response says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat. It is 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), not the learner limit.
|
|
248
|
+
* Generate a hidden draft diagram for a concept
|
|
249
|
+
*/
|
|
250
|
+
adminGenerateConceptDiagram(requestParameters: AdminGenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminGeneratedConceptDiagram>;
|
|
251
|
+
/**
|
|
252
|
+
* Generates a new image filed under exactly one concept: conceptId as-is, or conceptName resolved first (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 response says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat. It is 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), not the learner limit.
|
|
253
|
+
* Generate a hidden draft image for a concept
|
|
254
|
+
*/
|
|
255
|
+
adminGenerateConceptImageRaw(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminGeneratedConceptImage>>;
|
|
256
|
+
/**
|
|
257
|
+
* Generates a new image filed under exactly one concept: conceptId as-is, or conceptName resolved first (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 response says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat. It is 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), not the learner limit.
|
|
258
|
+
* Generate a hidden draft image for a concept
|
|
259
|
+
*/
|
|
260
|
+
adminGenerateConceptImage(requestParameters: AdminGenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminGeneratedConceptImage>;
|
|
134
261
|
/**
|
|
135
262
|
* Get any chat by ID within the account
|
|
136
263
|
*/
|
|
@@ -163,6 +290,26 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
163
290
|
* Get cohort statistics for users created within a date range
|
|
164
291
|
*/
|
|
165
292
|
adminGetCohortStats(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminCohortStats>;
|
|
293
|
+
/**
|
|
294
|
+
* One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
|
|
295
|
+
* Get a library concept diagram in any state
|
|
296
|
+
*/
|
|
297
|
+
adminGetConceptDiagramRaw(requestParameters: AdminGetConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
298
|
+
/**
|
|
299
|
+
* One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
|
|
300
|
+
* Get a library concept diagram in any state
|
|
301
|
+
*/
|
|
302
|
+
adminGetConceptDiagram(requestParameters: AdminGetConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
303
|
+
/**
|
|
304
|
+
* One image, hidden or deleted included, with its prompt (and the editable prompt without the style preamble) and its revision lineage.
|
|
305
|
+
* Get a library concept image in any state
|
|
306
|
+
*/
|
|
307
|
+
adminGetConceptImageRaw(requestParameters: AdminGetConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
308
|
+
/**
|
|
309
|
+
* One image, hidden or deleted included, with its prompt (and the editable prompt without the style preamble) and its revision lineage.
|
|
310
|
+
* Get a library concept image in any state
|
|
311
|
+
*/
|
|
312
|
+
adminGetConceptImage(requestParameters: AdminGetConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
166
313
|
/**
|
|
167
314
|
* 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
315
|
* Get quiz session summary for any session within the account
|
|
@@ -219,6 +366,26 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
219
366
|
* Get lifetime activity totals for a batch of users
|
|
220
367
|
*/
|
|
221
368
|
adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
|
|
369
|
+
/**
|
|
370
|
+
* 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.
|
|
371
|
+
* Hide a concept diagram from learners
|
|
372
|
+
*/
|
|
373
|
+
adminHideConceptDiagramRaw(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
374
|
+
/**
|
|
375
|
+
* 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.
|
|
376
|
+
* Hide a concept diagram from learners
|
|
377
|
+
*/
|
|
378
|
+
adminHideConceptDiagram(requestParameters: AdminHideConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
379
|
+
/**
|
|
380
|
+
* 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).
|
|
381
|
+
* Hide a concept image from learners
|
|
382
|
+
*/
|
|
383
|
+
adminHideConceptImageRaw(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
384
|
+
/**
|
|
385
|
+
* 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).
|
|
386
|
+
* Hide a concept image from learners
|
|
387
|
+
*/
|
|
388
|
+
adminHideConceptImage(requestParameters: AdminHideConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
222
389
|
/**
|
|
223
390
|
* List all active streaks (currentDays > 0) across the account, paginated
|
|
224
391
|
*/
|
|
@@ -235,6 +402,26 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
235
402
|
* List recent chats across all account users
|
|
236
403
|
*/
|
|
237
404
|
adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
|
|
405
|
+
/**
|
|
406
|
+
* 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.
|
|
407
|
+
* List library concept diagrams in any state
|
|
408
|
+
*/
|
|
409
|
+
adminListConceptDiagramsRaw(requestParameters: AdminListConceptDiagramsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedConceptDiagrams>>;
|
|
410
|
+
/**
|
|
411
|
+
* 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.
|
|
412
|
+
* List library concept diagrams in any state
|
|
413
|
+
*/
|
|
414
|
+
adminListConceptDiagrams(requestParameters: AdminListConceptDiagramsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedConceptDiagrams>;
|
|
415
|
+
/**
|
|
416
|
+
* 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.
|
|
417
|
+
* List library concept images in any state
|
|
418
|
+
*/
|
|
419
|
+
adminListConceptImagesRaw(requestParameters: AdminListConceptImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedConceptImages>>;
|
|
420
|
+
/**
|
|
421
|
+
* 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.
|
|
422
|
+
* List library concept images in any state
|
|
423
|
+
*/
|
|
424
|
+
adminListConceptImages(requestParameters: AdminListConceptImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedConceptImages>;
|
|
238
425
|
/**
|
|
239
426
|
* 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
427
|
* List the final user message and assistant reply for low-engagement new users
|
|
@@ -301,6 +488,26 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
301
488
|
* List top N streaks across the account
|
|
302
489
|
*/
|
|
303
490
|
adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminStreak>>;
|
|
491
|
+
/**
|
|
492
|
+
* Generates a new diagram 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).
|
|
493
|
+
* Generate a hidden revision of a concept diagram
|
|
494
|
+
*/
|
|
495
|
+
adminRegenerateConceptDiagramRaw(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
496
|
+
/**
|
|
497
|
+
* Generates a new diagram 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).
|
|
498
|
+
* Generate a hidden revision of a concept diagram
|
|
499
|
+
*/
|
|
500
|
+
adminRegenerateConceptDiagram(requestParameters: AdminRegenerateConceptDiagramOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
501
|
+
/**
|
|
502
|
+
* Generates a new image 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).
|
|
503
|
+
* Generate a hidden revision of a concept image
|
|
504
|
+
*/
|
|
505
|
+
adminRegenerateConceptImageRaw(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
506
|
+
/**
|
|
507
|
+
* Generates a new image 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).
|
|
508
|
+
* Generate a hidden revision of a concept image
|
|
509
|
+
*/
|
|
510
|
+
adminRegenerateConceptImage(requestParameters: AdminRegenerateConceptImageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
304
511
|
/**
|
|
305
512
|
* 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
513
|
* Reset a user\'s Athena learning data to a blank slate
|
|
@@ -311,6 +518,56 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
311
518
|
* Reset a user\'s Athena learning data to a blank slate
|
|
312
519
|
*/
|
|
313
520
|
adminResetUserLearningData(requestParameters: AdminResetUserLearningDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminResetLearningDataResponse>;
|
|
521
|
+
/**
|
|
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.
|
|
523
|
+
* Restore a soft-deleted concept diagram
|
|
524
|
+
*/
|
|
525
|
+
adminRestoreConceptDiagramRaw(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptDiagramDetail>>;
|
|
526
|
+
/**
|
|
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.
|
|
528
|
+
* Restore a soft-deleted concept diagram
|
|
529
|
+
*/
|
|
530
|
+
adminRestoreConceptDiagram(requestParameters: AdminRestoreConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptDiagramDetail>;
|
|
531
|
+
/**
|
|
532
|
+
* 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.
|
|
533
|
+
* Restore a soft-deleted concept image
|
|
534
|
+
*/
|
|
535
|
+
adminRestoreConceptImageRaw(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptImageDetail>>;
|
|
536
|
+
/**
|
|
537
|
+
* 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.
|
|
538
|
+
* Restore a soft-deleted concept image
|
|
539
|
+
*/
|
|
540
|
+
adminRestoreConceptImage(requestParameters: AdminRestoreConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptImageDetail>;
|
|
541
|
+
/**
|
|
542
|
+
* 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.
|
|
543
|
+
* Search the global concepts by name
|
|
544
|
+
*/
|
|
545
|
+
adminSearchConceptsRaw(requestParameters: AdminSearchConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminConceptSearchResult>>>;
|
|
546
|
+
/**
|
|
547
|
+
* 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.
|
|
548
|
+
* Search the global concepts by name
|
|
549
|
+
*/
|
|
550
|
+
adminSearchConcepts(requestParameters: AdminSearchConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminConceptSearchResult>>;
|
|
551
|
+
/**
|
|
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.
|
|
553
|
+
* Show a hidden concept diagram to learners
|
|
554
|
+
*/
|
|
555
|
+
adminShowConceptDiagramRaw(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptDiagram>>;
|
|
556
|
+
/**
|
|
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.
|
|
558
|
+
* Show a hidden concept diagram to learners
|
|
559
|
+
*/
|
|
560
|
+
adminShowConceptDiagram(requestParameters: AdminShowConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptDiagram>;
|
|
561
|
+
/**
|
|
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).
|
|
563
|
+
* Show a hidden concept image to learners
|
|
564
|
+
*/
|
|
565
|
+
adminShowConceptImageRaw(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminShownConceptImage>>;
|
|
566
|
+
/**
|
|
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).
|
|
568
|
+
* Show a hidden concept image to learners
|
|
569
|
+
*/
|
|
570
|
+
adminShowConceptImage(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptImage>;
|
|
314
571
|
/**
|
|
315
572
|
* Trigger re-analysis for a chat
|
|
316
573
|
*/
|
|
@@ -328,6 +585,44 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
328
585
|
*/
|
|
329
586
|
adminUpdateChat(requestParameters: AdminUpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChat>;
|
|
330
587
|
}
|
|
588
|
+
/**
|
|
589
|
+
* @export
|
|
590
|
+
*/
|
|
591
|
+
export declare const AdminListConceptDiagramsStateEnum: {
|
|
592
|
+
readonly NotDeleted: "not_deleted";
|
|
593
|
+
readonly Visible: "visible";
|
|
594
|
+
readonly Hidden: "hidden";
|
|
595
|
+
readonly Deleted: "deleted";
|
|
596
|
+
readonly All: "all";
|
|
597
|
+
};
|
|
598
|
+
export type AdminListConceptDiagramsStateEnum = typeof AdminListConceptDiagramsStateEnum[keyof typeof AdminListConceptDiagramsStateEnum];
|
|
599
|
+
/**
|
|
600
|
+
* @export
|
|
601
|
+
*/
|
|
602
|
+
export declare const AdminListConceptDiagramsOriginEnum: {
|
|
603
|
+
readonly Chat: "chat";
|
|
604
|
+
readonly Admin: "admin";
|
|
605
|
+
};
|
|
606
|
+
export type AdminListConceptDiagramsOriginEnum = typeof AdminListConceptDiagramsOriginEnum[keyof typeof AdminListConceptDiagramsOriginEnum];
|
|
607
|
+
/**
|
|
608
|
+
* @export
|
|
609
|
+
*/
|
|
610
|
+
export declare const AdminListConceptImagesStateEnum: {
|
|
611
|
+
readonly NotDeleted: "not_deleted";
|
|
612
|
+
readonly Visible: "visible";
|
|
613
|
+
readonly Hidden: "hidden";
|
|
614
|
+
readonly Deleted: "deleted";
|
|
615
|
+
readonly All: "all";
|
|
616
|
+
};
|
|
617
|
+
export type AdminListConceptImagesStateEnum = typeof AdminListConceptImagesStateEnum[keyof typeof AdminListConceptImagesStateEnum];
|
|
618
|
+
/**
|
|
619
|
+
* @export
|
|
620
|
+
*/
|
|
621
|
+
export declare const AdminListConceptImagesOriginEnum: {
|
|
622
|
+
readonly Chat: "chat";
|
|
623
|
+
readonly Admin: "admin";
|
|
624
|
+
};
|
|
625
|
+
export type AdminListConceptImagesOriginEnum = typeof AdminListConceptImagesOriginEnum[keyof typeof AdminListConceptImagesOriginEnum];
|
|
331
626
|
/**
|
|
332
627
|
* @export
|
|
333
628
|
*/
|