@instructure/athena-api-client 4.3.0 → 4.4.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 CHANGED
@@ -65,6 +65,7 @@ All URIs are relative to *http://localhost:3000*
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
+ *AdminApi* | [**adminGetConcept**](docs/AdminApi.md#admingetconcept) | **GET** /api/v1/admin/concepts/{id} | Get one concept with its media counts
68
69
  *AdminApi* | [**adminGetConceptDiagram**](docs/AdminApi.md#admingetconceptdiagram) | **GET** /api/v1/admin/concept-diagrams/{diagramId} | Get a library concept diagram in any state
69
70
  *AdminApi* | [**adminGetConceptImage**](docs/AdminApi.md#admingetconceptimage) | **GET** /api/v1/admin/concept-images/{imageId} | Get a library concept image in any state
70
71
  *AdminApi* | [**adminGetConceptMediaJob**](docs/AdminApi.md#admingetconceptmediajob) | **GET** /api/v1/admin/concept-media-jobs/{jobId} | Get an admin concept media generation job
@@ -86,6 +87,7 @@ All URIs are relative to *http://localhost:3000*
86
87
  *AdminApi* | [**adminListStudyObjectives**](docs/AdminApi.md#adminliststudyobjectives) | **GET** /api/v1/admin/study-objectives | List study objectives across all account users
87
88
  *AdminApi* | [**adminListStudyObjectivesByUser**](docs/AdminApi.md#adminliststudyobjectivesbyuser) | **GET** /api/v1/admin/study-objectives/by-user | Per-user study-objective counts across all account users
88
89
  *AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account
90
+ *AdminApi* | [**adminListTopConcepts**](docs/AdminApi.md#adminlisttopconcepts) | **GET** /api/v1/admin/concepts/top | List the concepts the most users have
89
91
  *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
90
92
  *AdminApi* | [**adminRegenerateConceptDiagram**](docs/AdminApi.md#adminregenerateconceptdiagramoperation) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/regenerate | Enqueue a hidden revision of a concept diagram
91
93
  *AdminApi* | [**adminRegenerateConceptImage**](docs/AdminApi.md#adminregenerateconceptimageoperation) | **POST** /api/v1/admin/concept-images/{imageId}/regenerate | Enqueue a hidden revision of a concept image
@@ -295,6 +297,7 @@ All URIs are relative to *http://localhost:3000*
295
297
  - [AdminStudyObjectiveUserCounts](docs/AdminStudyObjectiveUserCounts.md)
296
298
  - [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md)
297
299
  - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
300
+ - [AdminTopConcept](docs/AdminTopConcept.md)
298
301
  - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
299
302
  - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
300
303
  - [AdminUserActivity](docs/AdminUserActivity.md)
@@ -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, AdminConceptMediaJob, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, 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, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
14
14
  export interface AdminDeleteConceptDiagramRequest {
15
15
  xUserId: string;
16
16
  diagramId: string;
@@ -44,6 +44,10 @@ export interface AdminGetCohortStatsRequest {
44
44
  since: Date;
45
45
  until: Date;
46
46
  }
47
+ export interface AdminGetConceptRequest {
48
+ xUserId: string;
49
+ id: string;
50
+ }
47
51
  export interface AdminGetConceptDiagramRequest {
48
52
  xUserId: string;
49
53
  diagramId: string;
@@ -168,6 +172,10 @@ export interface AdminListTaxonomyEnrollmentsRequest {
168
172
  limit?: number;
169
173
  cursor?: string;
170
174
  }
175
+ export interface AdminListTopConceptsRequest {
176
+ xUserId: string;
177
+ limit?: number;
178
+ }
171
179
  export interface AdminListTopStreaksRequest {
172
180
  xUserId: string;
173
181
  limit?: number;
@@ -304,6 +312,16 @@ export declare class AdminApi extends runtime.BaseAPI {
304
312
  * Get cohort statistics for users created within a date range
305
313
  */
306
314
  adminGetCohortStats(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminCohortStats>;
315
+ /**
316
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
317
+ * Get one concept with its media counts
318
+ */
319
+ adminGetConceptRaw(requestParameters: AdminGetConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptSearchResult>>;
320
+ /**
321
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
322
+ * Get one concept with its media counts
323
+ */
324
+ adminGetConcept(requestParameters: AdminGetConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptSearchResult>;
307
325
  /**
308
326
  * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
309
327
  * Get a library concept diagram in any state
@@ -504,6 +522,16 @@ export declare class AdminApi extends runtime.BaseAPI {
504
522
  * List all taxonomy enrollments across the account
505
523
  */
506
524
  adminListTaxonomyEnrollments(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedTaxonomyEnrollments>;
525
+ /**
526
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
527
+ * List the concepts the most users have
528
+ */
529
+ adminListTopConceptsRaw(requestParameters: AdminListTopConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminTopConcept>>>;
530
+ /**
531
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
532
+ * List the concepts the most users have
533
+ */
534
+ adminListTopConcepts(requestParameters: AdminListTopConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminTopConcept>>;
507
535
  /**
508
536
  * List top N streaks across the account
509
537
  */
@@ -359,6 +359,47 @@ class AdminApi extends runtime.BaseAPI {
359
359
  return yield response.value();
360
360
  });
361
361
  }
362
+ /**
363
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
364
+ * Get one concept with its media counts
365
+ */
366
+ adminGetConceptRaw(requestParameters, initOverrides) {
367
+ return __awaiter(this, void 0, void 0, function* () {
368
+ if (requestParameters['xUserId'] == null) {
369
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetConcept().');
370
+ }
371
+ if (requestParameters['id'] == null) {
372
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adminGetConcept().');
373
+ }
374
+ const queryParameters = {};
375
+ const headerParameters = {};
376
+ if (requestParameters['xUserId'] != null) {
377
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
378
+ }
379
+ if (this.configuration && this.configuration.apiKey) {
380
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
381
+ }
382
+ let urlPath = `/api/v1/admin/concepts/{id}`;
383
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
384
+ const response = yield this.request({
385
+ path: urlPath,
386
+ method: 'GET',
387
+ headers: headerParameters,
388
+ query: queryParameters,
389
+ }, initOverrides);
390
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminConceptSearchResultFromJSON)(jsonValue));
391
+ });
392
+ }
393
+ /**
394
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
395
+ * Get one concept with its media counts
396
+ */
397
+ adminGetConcept(requestParameters, initOverrides) {
398
+ return __awaiter(this, void 0, void 0, function* () {
399
+ const response = yield this.adminGetConceptRaw(requestParameters, initOverrides);
400
+ return yield response.value();
401
+ });
402
+ }
362
403
  /**
363
404
  * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
364
405
  * Get a library concept diagram in any state
@@ -1325,6 +1366,46 @@ class AdminApi extends runtime.BaseAPI {
1325
1366
  return yield response.value();
1326
1367
  });
1327
1368
  }
1369
+ /**
1370
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
1371
+ * List the concepts the most users have
1372
+ */
1373
+ adminListTopConceptsRaw(requestParameters, initOverrides) {
1374
+ return __awaiter(this, void 0, void 0, function* () {
1375
+ if (requestParameters['xUserId'] == null) {
1376
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListTopConcepts().');
1377
+ }
1378
+ const queryParameters = {};
1379
+ if (requestParameters['limit'] != null) {
1380
+ queryParameters['limit'] = requestParameters['limit'];
1381
+ }
1382
+ const headerParameters = {};
1383
+ if (requestParameters['xUserId'] != null) {
1384
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
1385
+ }
1386
+ if (this.configuration && this.configuration.apiKey) {
1387
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
1388
+ }
1389
+ let urlPath = `/api/v1/admin/concepts/top`;
1390
+ const response = yield this.request({
1391
+ path: urlPath,
1392
+ method: 'GET',
1393
+ headers: headerParameters,
1394
+ query: queryParameters,
1395
+ }, initOverrides);
1396
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AdminTopConceptFromJSON));
1397
+ });
1398
+ }
1399
+ /**
1400
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
1401
+ * List the concepts the most users have
1402
+ */
1403
+ adminListTopConcepts(requestParameters, initOverrides) {
1404
+ return __awaiter(this, void 0, void 0, function* () {
1405
+ const response = yield this.adminListTopConceptsRaw(requestParameters, initOverrides);
1406
+ return yield response.value();
1407
+ });
1408
+ }
1328
1409
  /**
1329
1410
  * List top N streaks across the account
1330
1411
  */
@@ -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, AdminConceptMediaJob, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, 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, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
14
14
  export interface AdminDeleteConceptDiagramRequest {
15
15
  xUserId: string;
16
16
  diagramId: string;
@@ -44,6 +44,10 @@ export interface AdminGetCohortStatsRequest {
44
44
  since: Date;
45
45
  until: Date;
46
46
  }
47
+ export interface AdminGetConceptRequest {
48
+ xUserId: string;
49
+ id: string;
50
+ }
47
51
  export interface AdminGetConceptDiagramRequest {
48
52
  xUserId: string;
49
53
  diagramId: string;
@@ -168,6 +172,10 @@ export interface AdminListTaxonomyEnrollmentsRequest {
168
172
  limit?: number;
169
173
  cursor?: string;
170
174
  }
175
+ export interface AdminListTopConceptsRequest {
176
+ xUserId: string;
177
+ limit?: number;
178
+ }
171
179
  export interface AdminListTopStreaksRequest {
172
180
  xUserId: string;
173
181
  limit?: number;
@@ -304,6 +312,16 @@ export declare class AdminApi extends runtime.BaseAPI {
304
312
  * Get cohort statistics for users created within a date range
305
313
  */
306
314
  adminGetCohortStats(requestParameters: AdminGetCohortStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminCohortStats>;
315
+ /**
316
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
317
+ * Get one concept with its media counts
318
+ */
319
+ adminGetConceptRaw(requestParameters: AdminGetConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptSearchResult>>;
320
+ /**
321
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
322
+ * Get one concept with its media counts
323
+ */
324
+ adminGetConcept(requestParameters: AdminGetConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptSearchResult>;
307
325
  /**
308
326
  * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
309
327
  * Get a library concept diagram in any state
@@ -504,6 +522,16 @@ export declare class AdminApi extends runtime.BaseAPI {
504
522
  * List all taxonomy enrollments across the account
505
523
  */
506
524
  adminListTaxonomyEnrollments(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedTaxonomyEnrollments>;
525
+ /**
526
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
527
+ * List the concepts the most users have
528
+ */
529
+ adminListTopConceptsRaw(requestParameters: AdminListTopConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminTopConcept>>>;
530
+ /**
531
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
532
+ * List the concepts the most users have
533
+ */
534
+ adminListTopConcepts(requestParameters: AdminListTopConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminTopConcept>>;
507
535
  /**
508
536
  * List top N streaks across the account
509
537
  */
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminConceptDiagramDetailFromJSON, AdminConceptImageDetailFromJSON, AdminConceptMediaJobFromJSON, AdminConceptSearchResultFromJSON, AdminGenerateConceptDiagramRequestToJSON, AdminGenerateConceptImageRequestToJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedConceptDiagramsFromJSON, AdminPaginatedConceptImagesFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminRegenerateConceptDiagramRequestToJSON, AdminRegenerateConceptImageRequestToJSON, AdminResetLearningDataResponseFromJSON, AdminReviseConceptDiagramRequestToJSON, AdminReviseConceptImageRequestToJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
24
+ import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminConceptDiagramDetailFromJSON, AdminConceptImageDetailFromJSON, AdminConceptMediaJobFromJSON, AdminConceptSearchResultFromJSON, AdminGenerateConceptDiagramRequestToJSON, AdminGenerateConceptImageRequestToJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedConceptDiagramsFromJSON, AdminPaginatedConceptImagesFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminRegenerateConceptDiagramRequestToJSON, AdminRegenerateConceptImageRequestToJSON, AdminResetLearningDataResponseFromJSON, AdminReviseConceptDiagramRequestToJSON, AdminReviseConceptImageRequestToJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTopConceptFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -356,6 +356,47 @@ export class AdminApi extends runtime.BaseAPI {
356
356
  return yield response.value();
357
357
  });
358
358
  }
359
+ /**
360
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
361
+ * Get one concept with its media counts
362
+ */
363
+ adminGetConceptRaw(requestParameters, initOverrides) {
364
+ return __awaiter(this, void 0, void 0, function* () {
365
+ if (requestParameters['xUserId'] == null) {
366
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetConcept().');
367
+ }
368
+ if (requestParameters['id'] == null) {
369
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adminGetConcept().');
370
+ }
371
+ const queryParameters = {};
372
+ const headerParameters = {};
373
+ if (requestParameters['xUserId'] != null) {
374
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
375
+ }
376
+ if (this.configuration && this.configuration.apiKey) {
377
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
378
+ }
379
+ let urlPath = `/api/v1/admin/concepts/{id}`;
380
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
381
+ const response = yield this.request({
382
+ path: urlPath,
383
+ method: 'GET',
384
+ headers: headerParameters,
385
+ query: queryParameters,
386
+ }, initOverrides);
387
+ return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptSearchResultFromJSON(jsonValue));
388
+ });
389
+ }
390
+ /**
391
+ * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
392
+ * Get one concept with its media counts
393
+ */
394
+ adminGetConcept(requestParameters, initOverrides) {
395
+ return __awaiter(this, void 0, void 0, function* () {
396
+ const response = yield this.adminGetConceptRaw(requestParameters, initOverrides);
397
+ return yield response.value();
398
+ });
399
+ }
359
400
  /**
360
401
  * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
361
402
  * Get a library concept diagram in any state
@@ -1322,6 +1363,46 @@ export class AdminApi extends runtime.BaseAPI {
1322
1363
  return yield response.value();
1323
1364
  });
1324
1365
  }
1366
+ /**
1367
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
1368
+ * List the concepts the most users have
1369
+ */
1370
+ adminListTopConceptsRaw(requestParameters, initOverrides) {
1371
+ return __awaiter(this, void 0, void 0, function* () {
1372
+ if (requestParameters['xUserId'] == null) {
1373
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListTopConcepts().');
1374
+ }
1375
+ const queryParameters = {};
1376
+ if (requestParameters['limit'] != null) {
1377
+ queryParameters['limit'] = requestParameters['limit'];
1378
+ }
1379
+ const headerParameters = {};
1380
+ if (requestParameters['xUserId'] != null) {
1381
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
1382
+ }
1383
+ if (this.configuration && this.configuration.apiKey) {
1384
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
1385
+ }
1386
+ let urlPath = `/api/v1/admin/concepts/top`;
1387
+ const response = yield this.request({
1388
+ path: urlPath,
1389
+ method: 'GET',
1390
+ headers: headerParameters,
1391
+ query: queryParameters,
1392
+ }, initOverrides);
1393
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AdminTopConceptFromJSON));
1394
+ });
1395
+ }
1396
+ /**
1397
+ * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
1398
+ * List the concepts the most users have
1399
+ */
1400
+ adminListTopConcepts(requestParameters, initOverrides) {
1401
+ return __awaiter(this, void 0, void 0, function* () {
1402
+ const response = yield this.adminListTopConceptsRaw(requestParameters, initOverrides);
1403
+ return yield response.value();
1404
+ });
1405
+ }
1325
1406
  /**
1326
1407
  * List top N streaks across the account
1327
1408
  */
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminTopConcept
16
+ */
17
+ export interface AdminTopConcept {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AdminTopConcept
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AdminTopConcept
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof AdminTopConcept
34
+ */
35
+ description: string;
36
+ /**
37
+ * Library images of this concept that are not deleted
38
+ * @type {number}
39
+ * @memberof AdminTopConcept
40
+ */
41
+ imageCount: number;
42
+ /**
43
+ * Library diagrams of this concept that are not deleted
44
+ * @type {number}
45
+ * @memberof AdminTopConcept
46
+ */
47
+ diagramCount: number;
48
+ /**
49
+ * Distinct users holding a user concept for this concept, across all their account users
50
+ * @type {number}
51
+ * @memberof AdminTopConcept
52
+ */
53
+ userCount: number;
54
+ }
55
+ /**
56
+ * Check if a given object implements the AdminTopConcept interface.
57
+ */
58
+ export declare function instanceOfAdminTopConcept(value: object): value is AdminTopConcept;
59
+ export declare function AdminTopConceptFromJSON(json: any): AdminTopConcept;
60
+ export declare function AdminTopConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTopConcept;
61
+ export declare function AdminTopConceptToJSON(json: any): AdminTopConcept;
62
+ export declare function AdminTopConceptToJSONTyped(value?: AdminTopConcept | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the AdminTopConcept interface.
16
+ */
17
+ export function instanceOfAdminTopConcept(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('description' in value) || value['description'] === undefined)
23
+ return false;
24
+ if (!('imageCount' in value) || value['imageCount'] === undefined)
25
+ return false;
26
+ if (!('diagramCount' in value) || value['diagramCount'] === undefined)
27
+ return false;
28
+ if (!('userCount' in value) || value['userCount'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function AdminTopConceptFromJSON(json) {
33
+ return AdminTopConceptFromJSONTyped(json, false);
34
+ }
35
+ export function AdminTopConceptFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'id': json['id'],
41
+ 'name': json['name'],
42
+ 'description': json['description'],
43
+ 'imageCount': json['imageCount'],
44
+ 'diagramCount': json['diagramCount'],
45
+ 'userCount': json['userCount'],
46
+ };
47
+ }
48
+ export function AdminTopConceptToJSON(json) {
49
+ return AdminTopConceptToJSONTyped(json, false);
50
+ }
51
+ export function AdminTopConceptToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'id': value['id'],
57
+ 'name': value['name'],
58
+ 'description': value['description'],
59
+ 'imageCount': value['imageCount'],
60
+ 'diagramCount': value['diagramCount'],
61
+ 'userCount': value['userCount'],
62
+ };
63
+ }
@@ -66,6 +66,7 @@ export * from './AdminStudyObjectiveSummary';
66
66
  export * from './AdminStudyObjectiveUserCounts';
67
67
  export * from './AdminTaxonomyEnrollment';
68
68
  export * from './AdminTaxonomyEnrollmentTaxonomy';
69
+ export * from './AdminTopConcept';
69
70
  export * from './AdminTriggerAnalysisResponse';
70
71
  export * from './AdminUpdateChatRequest';
71
72
  export * from './AdminUserActivity';
@@ -68,6 +68,7 @@ export * from './AdminStudyObjectiveSummary';
68
68
  export * from './AdminStudyObjectiveUserCounts';
69
69
  export * from './AdminTaxonomyEnrollment';
70
70
  export * from './AdminTaxonomyEnrollmentTaxonomy';
71
+ export * from './AdminTopConcept';
71
72
  export * from './AdminTriggerAnalysisResponse';
72
73
  export * from './AdminUpdateChatRequest';
73
74
  export * from './AdminUserActivity';
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminTopConcept
16
+ */
17
+ export interface AdminTopConcept {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof AdminTopConcept
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AdminTopConcept
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof AdminTopConcept
34
+ */
35
+ description: string;
36
+ /**
37
+ * Library images of this concept that are not deleted
38
+ * @type {number}
39
+ * @memberof AdminTopConcept
40
+ */
41
+ imageCount: number;
42
+ /**
43
+ * Library diagrams of this concept that are not deleted
44
+ * @type {number}
45
+ * @memberof AdminTopConcept
46
+ */
47
+ diagramCount: number;
48
+ /**
49
+ * Distinct users holding a user concept for this concept, across all their account users
50
+ * @type {number}
51
+ * @memberof AdminTopConcept
52
+ */
53
+ userCount: number;
54
+ }
55
+ /**
56
+ * Check if a given object implements the AdminTopConcept interface.
57
+ */
58
+ export declare function instanceOfAdminTopConcept(value: object): value is AdminTopConcept;
59
+ export declare function AdminTopConceptFromJSON(json: any): AdminTopConcept;
60
+ export declare function AdminTopConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTopConcept;
61
+ export declare function AdminTopConceptToJSON(json: any): AdminTopConcept;
62
+ export declare function AdminTopConceptToJSONTyped(value?: AdminTopConcept | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAdminTopConcept = instanceOfAdminTopConcept;
17
+ exports.AdminTopConceptFromJSON = AdminTopConceptFromJSON;
18
+ exports.AdminTopConceptFromJSONTyped = AdminTopConceptFromJSONTyped;
19
+ exports.AdminTopConceptToJSON = AdminTopConceptToJSON;
20
+ exports.AdminTopConceptToJSONTyped = AdminTopConceptToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminTopConcept interface.
23
+ */
24
+ function instanceOfAdminTopConcept(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('name' in value) || value['name'] === undefined)
28
+ return false;
29
+ if (!('description' in value) || value['description'] === undefined)
30
+ return false;
31
+ if (!('imageCount' in value) || value['imageCount'] === undefined)
32
+ return false;
33
+ if (!('diagramCount' in value) || value['diagramCount'] === undefined)
34
+ return false;
35
+ if (!('userCount' in value) || value['userCount'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function AdminTopConceptFromJSON(json) {
40
+ return AdminTopConceptFromJSONTyped(json, false);
41
+ }
42
+ function AdminTopConceptFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'id': json['id'],
48
+ 'name': json['name'],
49
+ 'description': json['description'],
50
+ 'imageCount': json['imageCount'],
51
+ 'diagramCount': json['diagramCount'],
52
+ 'userCount': json['userCount'],
53
+ };
54
+ }
55
+ function AdminTopConceptToJSON(json) {
56
+ return AdminTopConceptToJSONTyped(json, false);
57
+ }
58
+ function AdminTopConceptToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'id': value['id'],
64
+ 'name': value['name'],
65
+ 'description': value['description'],
66
+ 'imageCount': value['imageCount'],
67
+ 'diagramCount': value['diagramCount'],
68
+ 'userCount': value['userCount'],
69
+ };
70
+ }
@@ -66,6 +66,7 @@ export * from './AdminStudyObjectiveSummary';
66
66
  export * from './AdminStudyObjectiveUserCounts';
67
67
  export * from './AdminTaxonomyEnrollment';
68
68
  export * from './AdminTaxonomyEnrollmentTaxonomy';
69
+ export * from './AdminTopConcept';
69
70
  export * from './AdminTriggerAnalysisResponse';
70
71
  export * from './AdminUpdateChatRequest';
71
72
  export * from './AdminUserActivity';
@@ -84,6 +84,7 @@ __exportStar(require("./AdminStudyObjectiveSummary"), exports);
84
84
  __exportStar(require("./AdminStudyObjectiveUserCounts"), exports);
85
85
  __exportStar(require("./AdminTaxonomyEnrollment"), exports);
86
86
  __exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
87
+ __exportStar(require("./AdminTopConcept"), exports);
87
88
  __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
88
89
  __exportStar(require("./AdminUpdateChatRequest"), exports);
89
90
  __exportStar(require("./AdminUserActivity"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "4.3.0",
4
+ "version": "4.4.1",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {