@instructure/athena-api-client 3.12.12 → 3.13.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 CHANGED
@@ -68,6 +68,7 @@ All URIs are relative to *http://localhost:3000*
68
68
  *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
69
69
  *AdminApi* | [**adminListQuizSessions**](docs/AdminApi.md#adminlistquizsessions) | **GET** /api/v1/admin/quiz-sessions | List recent quiz sessions across all account users
70
70
  *AdminApi* | [**adminListStudyObjectives**](docs/AdminApi.md#adminliststudyobjectives) | **GET** /api/v1/admin/study-objectives | List study objectives across all account users
71
+ *AdminApi* | [**adminListStudyObjectivesByUser**](docs/AdminApi.md#adminliststudyobjectivesbyuser) | **GET** /api/v1/admin/study-objectives/by-user | Per-user study-objective counts across all account users
71
72
  *AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account
72
73
  *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
73
74
  *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat
@@ -176,6 +177,7 @@ All URIs are relative to *http://localhost:3000*
176
177
  - [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md)
177
178
  - [AdminPaginatedChats](docs/AdminPaginatedChats.md)
178
179
  - [AdminPaginatedQuizSessions](docs/AdminPaginatedQuizSessions.md)
180
+ - [AdminPaginatedStudyObjectiveUserCounts](docs/AdminPaginatedStudyObjectiveUserCounts.md)
179
181
  - [AdminPaginatedStudyObjectives](docs/AdminPaginatedStudyObjectives.md)
180
182
  - [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md)
181
183
  - [AdminQuizSessionListItem](docs/AdminQuizSessionListItem.md)
@@ -183,7 +185,9 @@ All URIs are relative to *http://localhost:3000*
183
185
  - [AdminStreak](docs/AdminStreak.md)
184
186
  - [AdminStudyObjectiveCanvasTypeCount](docs/AdminStudyObjectiveCanvasTypeCount.md)
185
187
  - [AdminStudyObjectiveListItem](docs/AdminStudyObjectiveListItem.md)
188
+ - [AdminStudyObjectiveOriginCounts](docs/AdminStudyObjectiveOriginCounts.md)
186
189
  - [AdminStudyObjectiveSummary](docs/AdminStudyObjectiveSummary.md)
190
+ - [AdminStudyObjectiveUserCounts](docs/AdminStudyObjectiveUserCounts.md)
187
191
  - [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md)
188
192
  - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
189
193
  - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.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, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
13
+ import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
14
14
  export interface AdminGetChatRequest {
15
15
  xUserId: string;
16
16
  chatId: string;
@@ -66,6 +66,17 @@ export interface AdminListStudyObjectivesRequest {
66
66
  archived?: AdminListStudyObjectivesArchivedEnum;
67
67
  courseId?: string;
68
68
  hasQuiz?: boolean;
69
+ accountUserId?: string;
70
+ userId?: string;
71
+ }
72
+ export interface AdminListStudyObjectivesByUserRequest {
73
+ xUserId: string;
74
+ limit?: number;
75
+ cursor?: string;
76
+ origin?: AdminListStudyObjectivesByUserOriginEnum;
77
+ archived?: AdminListStudyObjectivesByUserArchivedEnum;
78
+ courseId?: string;
79
+ hasQuiz?: boolean;
69
80
  }
70
81
  export interface AdminListTaxonomyEnrollmentsRequest {
71
82
  xUserId: string;
@@ -185,6 +196,16 @@ export declare class AdminApi extends runtime.BaseAPI {
185
196
  * List study objectives across all account users
186
197
  */
187
198
  adminListStudyObjectives(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectives>;
199
+ /**
200
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
201
+ * Per-user study-objective counts across all account users
202
+ */
203
+ adminListStudyObjectivesByUserRaw(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedStudyObjectiveUserCounts>>;
204
+ /**
205
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
206
+ * Per-user study-objective counts across all account users
207
+ */
208
+ adminListStudyObjectivesByUser(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectiveUserCounts>;
188
209
  /**
189
210
  * List all taxonomy enrollments across the account
190
211
  */
@@ -253,3 +274,21 @@ export declare const AdminListStudyObjectivesArchivedEnum: {
253
274
  readonly All: "all";
254
275
  };
255
276
  export type AdminListStudyObjectivesArchivedEnum = typeof AdminListStudyObjectivesArchivedEnum[keyof typeof AdminListStudyObjectivesArchivedEnum];
277
+ /**
278
+ * @export
279
+ */
280
+ export declare const AdminListStudyObjectivesByUserOriginEnum: {
281
+ readonly Custom: "custom";
282
+ readonly Canvas: "canvas";
283
+ readonly Syllabus: "syllabus";
284
+ };
285
+ export type AdminListStudyObjectivesByUserOriginEnum = typeof AdminListStudyObjectivesByUserOriginEnum[keyof typeof AdminListStudyObjectivesByUserOriginEnum];
286
+ /**
287
+ * @export
288
+ */
289
+ export declare const AdminListStudyObjectivesByUserArchivedEnum: {
290
+ readonly Active: "active";
291
+ readonly Archived: "archived";
292
+ readonly All: "all";
293
+ };
294
+ export type AdminListStudyObjectivesByUserArchivedEnum = typeof AdminListStudyObjectivesByUserArchivedEnum[keyof typeof AdminListStudyObjectivesByUserArchivedEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.AdminListStudyObjectivesArchivedEnum = exports.AdminListStudyObjectivesOriginEnum = exports.AdminListQuizSessionsStatusEnum = exports.AdminListQuizSessionsModeEnum = exports.AdminApi = void 0;
25
+ exports.AdminListStudyObjectivesByUserArchivedEnum = exports.AdminListStudyObjectivesByUserOriginEnum = exports.AdminListStudyObjectivesArchivedEnum = exports.AdminListStudyObjectivesOriginEnum = exports.AdminListQuizSessionsStatusEnum = exports.AdminListQuizSessionsModeEnum = exports.AdminApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const index_1 = require("../models/index");
28
28
  /**
@@ -475,6 +475,12 @@ class AdminApi extends runtime.BaseAPI {
475
475
  if (requestParameters['hasQuiz'] != null) {
476
476
  queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
477
477
  }
478
+ if (requestParameters['accountUserId'] != null) {
479
+ queryParameters['accountUserId'] = requestParameters['accountUserId'];
480
+ }
481
+ if (requestParameters['userId'] != null) {
482
+ queryParameters['userId'] = requestParameters['userId'];
483
+ }
478
484
  const headerParameters = {};
479
485
  if (requestParameters['xUserId'] != null) {
480
486
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -502,6 +508,61 @@ class AdminApi extends runtime.BaseAPI {
502
508
  return yield response.value();
503
509
  });
504
510
  }
511
+ /**
512
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
513
+ * Per-user study-objective counts across all account users
514
+ */
515
+ adminListStudyObjectivesByUserRaw(requestParameters, initOverrides) {
516
+ return __awaiter(this, void 0, void 0, function* () {
517
+ if (requestParameters['xUserId'] == null) {
518
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListStudyObjectivesByUser().');
519
+ }
520
+ const queryParameters = {};
521
+ if (requestParameters['limit'] != null) {
522
+ queryParameters['limit'] = requestParameters['limit'];
523
+ }
524
+ if (requestParameters['cursor'] != null) {
525
+ queryParameters['cursor'] = requestParameters['cursor'];
526
+ }
527
+ if (requestParameters['origin'] != null) {
528
+ queryParameters['origin'] = requestParameters['origin'];
529
+ }
530
+ if (requestParameters['archived'] != null) {
531
+ queryParameters['archived'] = requestParameters['archived'];
532
+ }
533
+ if (requestParameters['courseId'] != null) {
534
+ queryParameters['courseId'] = requestParameters['courseId'];
535
+ }
536
+ if (requestParameters['hasQuiz'] != null) {
537
+ queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
538
+ }
539
+ const headerParameters = {};
540
+ if (requestParameters['xUserId'] != null) {
541
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
542
+ }
543
+ if (this.configuration && this.configuration.apiKey) {
544
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
545
+ }
546
+ let urlPath = `/api/v1/admin/study-objectives/by-user`;
547
+ const response = yield this.request({
548
+ path: urlPath,
549
+ method: 'GET',
550
+ headers: headerParameters,
551
+ query: queryParameters,
552
+ }, initOverrides);
553
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminPaginatedStudyObjectiveUserCountsFromJSON)(jsonValue));
554
+ });
555
+ }
556
+ /**
557
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
558
+ * Per-user study-objective counts across all account users
559
+ */
560
+ adminListStudyObjectivesByUser(requestParameters, initOverrides) {
561
+ return __awaiter(this, void 0, void 0, function* () {
562
+ const response = yield this.adminListStudyObjectivesByUserRaw(requestParameters, initOverrides);
563
+ return yield response.value();
564
+ });
565
+ }
505
566
  /**
506
567
  * List all taxonomy enrollments across the account
507
568
  */
@@ -697,3 +758,19 @@ exports.AdminListStudyObjectivesArchivedEnum = {
697
758
  Archived: 'archived',
698
759
  All: 'all'
699
760
  };
761
+ /**
762
+ * @export
763
+ */
764
+ exports.AdminListStudyObjectivesByUserOriginEnum = {
765
+ Custom: 'custom',
766
+ Canvas: 'canvas',
767
+ Syllabus: 'syllabus'
768
+ };
769
+ /**
770
+ * @export
771
+ */
772
+ exports.AdminListStudyObjectivesByUserArchivedEnum = {
773
+ Active: 'active',
774
+ Archived: 'archived',
775
+ All: 'all'
776
+ };
@@ -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, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
13
+ import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
14
14
  export interface AdminGetChatRequest {
15
15
  xUserId: string;
16
16
  chatId: string;
@@ -66,6 +66,17 @@ export interface AdminListStudyObjectivesRequest {
66
66
  archived?: AdminListStudyObjectivesArchivedEnum;
67
67
  courseId?: string;
68
68
  hasQuiz?: boolean;
69
+ accountUserId?: string;
70
+ userId?: string;
71
+ }
72
+ export interface AdminListStudyObjectivesByUserRequest {
73
+ xUserId: string;
74
+ limit?: number;
75
+ cursor?: string;
76
+ origin?: AdminListStudyObjectivesByUserOriginEnum;
77
+ archived?: AdminListStudyObjectivesByUserArchivedEnum;
78
+ courseId?: string;
79
+ hasQuiz?: boolean;
69
80
  }
70
81
  export interface AdminListTaxonomyEnrollmentsRequest {
71
82
  xUserId: string;
@@ -185,6 +196,16 @@ export declare class AdminApi extends runtime.BaseAPI {
185
196
  * List study objectives across all account users
186
197
  */
187
198
  adminListStudyObjectives(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectives>;
199
+ /**
200
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
201
+ * Per-user study-objective counts across all account users
202
+ */
203
+ adminListStudyObjectivesByUserRaw(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedStudyObjectiveUserCounts>>;
204
+ /**
205
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
206
+ * Per-user study-objective counts across all account users
207
+ */
208
+ adminListStudyObjectivesByUser(requestParameters: AdminListStudyObjectivesByUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectiveUserCounts>;
188
209
  /**
189
210
  * List all taxonomy enrollments across the account
190
211
  */
@@ -253,3 +274,21 @@ export declare const AdminListStudyObjectivesArchivedEnum: {
253
274
  readonly All: "all";
254
275
  };
255
276
  export type AdminListStudyObjectivesArchivedEnum = typeof AdminListStudyObjectivesArchivedEnum[keyof typeof AdminListStudyObjectivesArchivedEnum];
277
+ /**
278
+ * @export
279
+ */
280
+ export declare const AdminListStudyObjectivesByUserOriginEnum: {
281
+ readonly Custom: "custom";
282
+ readonly Canvas: "canvas";
283
+ readonly Syllabus: "syllabus";
284
+ };
285
+ export type AdminListStudyObjectivesByUserOriginEnum = typeof AdminListStudyObjectivesByUserOriginEnum[keyof typeof AdminListStudyObjectivesByUserOriginEnum];
286
+ /**
287
+ * @export
288
+ */
289
+ export declare const AdminListStudyObjectivesByUserArchivedEnum: {
290
+ readonly Active: "active";
291
+ readonly Archived: "archived";
292
+ readonly All: "all";
293
+ };
294
+ export type AdminListStudyObjectivesByUserArchivedEnum = typeof AdminListStudyObjectivesByUserArchivedEnum[keyof typeof AdminListStudyObjectivesByUserArchivedEnum];
@@ -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, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, QuizSessionSummaryFromJSON, } from '../models/index';
24
+ import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, QuizSessionSummaryFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -472,6 +472,12 @@ export class AdminApi extends runtime.BaseAPI {
472
472
  if (requestParameters['hasQuiz'] != null) {
473
473
  queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
474
474
  }
475
+ if (requestParameters['accountUserId'] != null) {
476
+ queryParameters['accountUserId'] = requestParameters['accountUserId'];
477
+ }
478
+ if (requestParameters['userId'] != null) {
479
+ queryParameters['userId'] = requestParameters['userId'];
480
+ }
475
481
  const headerParameters = {};
476
482
  if (requestParameters['xUserId'] != null) {
477
483
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -499,6 +505,61 @@ export class AdminApi extends runtime.BaseAPI {
499
505
  return yield response.value();
500
506
  });
501
507
  }
508
+ /**
509
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
510
+ * Per-user study-objective counts across all account users
511
+ */
512
+ adminListStudyObjectivesByUserRaw(requestParameters, initOverrides) {
513
+ return __awaiter(this, void 0, void 0, function* () {
514
+ if (requestParameters['xUserId'] == null) {
515
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListStudyObjectivesByUser().');
516
+ }
517
+ const queryParameters = {};
518
+ if (requestParameters['limit'] != null) {
519
+ queryParameters['limit'] = requestParameters['limit'];
520
+ }
521
+ if (requestParameters['cursor'] != null) {
522
+ queryParameters['cursor'] = requestParameters['cursor'];
523
+ }
524
+ if (requestParameters['origin'] != null) {
525
+ queryParameters['origin'] = requestParameters['origin'];
526
+ }
527
+ if (requestParameters['archived'] != null) {
528
+ queryParameters['archived'] = requestParameters['archived'];
529
+ }
530
+ if (requestParameters['courseId'] != null) {
531
+ queryParameters['courseId'] = requestParameters['courseId'];
532
+ }
533
+ if (requestParameters['hasQuiz'] != null) {
534
+ queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
535
+ }
536
+ const headerParameters = {};
537
+ if (requestParameters['xUserId'] != null) {
538
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
539
+ }
540
+ if (this.configuration && this.configuration.apiKey) {
541
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
542
+ }
543
+ let urlPath = `/api/v1/admin/study-objectives/by-user`;
544
+ const response = yield this.request({
545
+ path: urlPath,
546
+ method: 'GET',
547
+ headers: headerParameters,
548
+ query: queryParameters,
549
+ }, initOverrides);
550
+ return new runtime.JSONApiResponse(response, (jsonValue) => AdminPaginatedStudyObjectiveUserCountsFromJSON(jsonValue));
551
+ });
552
+ }
553
+ /**
554
+ * Returns one row per distinct user within the caller\'s account, each carrying that user\'s complete per-origin objective counts (custom, canvas, syllabus, total) computed in a single grouped scan. Honors the same origin, archive, course, and quiz filters as the list endpoint so a filtered breakdown stays consistent, and is cursor-paginated ordered by total descending. Lets a client render complete per-user totals without paginating through every objective. Intended for admin-style analytics views; 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.
555
+ * Per-user study-objective counts across all account users
556
+ */
557
+ adminListStudyObjectivesByUser(requestParameters, initOverrides) {
558
+ return __awaiter(this, void 0, void 0, function* () {
559
+ const response = yield this.adminListStudyObjectivesByUserRaw(requestParameters, initOverrides);
560
+ return yield response.value();
561
+ });
562
+ }
502
563
  /**
503
564
  * List all taxonomy enrollments across the account
504
565
  */
@@ -693,3 +754,19 @@ export const AdminListStudyObjectivesArchivedEnum = {
693
754
  Archived: 'archived',
694
755
  All: 'all'
695
756
  };
757
+ /**
758
+ * @export
759
+ */
760
+ export const AdminListStudyObjectivesByUserOriginEnum = {
761
+ Custom: 'custom',
762
+ Canvas: 'canvas',
763
+ Syllabus: 'syllabus'
764
+ };
765
+ /**
766
+ * @export
767
+ */
768
+ export const AdminListStudyObjectivesByUserArchivedEnum = {
769
+ Active: 'active',
770
+ Archived: 'archived',
771
+ All: 'all'
772
+ };
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AdminStudyObjectiveUserCounts } from './AdminStudyObjectiveUserCounts';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminPaginatedStudyObjectiveUserCounts
17
+ */
18
+ export interface AdminPaginatedStudyObjectiveUserCounts {
19
+ /**
20
+ * One row per distinct user, with that user's per-origin counts
21
+ * @type {Array<AdminStudyObjectiveUserCounts>}
22
+ * @memberof AdminPaginatedStudyObjectiveUserCounts
23
+ */
24
+ data: Array<AdminStudyObjectiveUserCounts>;
25
+ /**
26
+ * Opaque cursor for fetching the next page. Null when there are no more results.
27
+ * @type {string}
28
+ * @memberof AdminPaginatedStudyObjectiveUserCounts
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the AdminPaginatedStudyObjectiveUserCounts interface.
34
+ */
35
+ export declare function instanceOfAdminPaginatedStudyObjectiveUserCounts(value: object): value is AdminPaginatedStudyObjectiveUserCounts;
36
+ export declare function AdminPaginatedStudyObjectiveUserCountsFromJSON(json: any): AdminPaginatedStudyObjectiveUserCounts;
37
+ export declare function AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedStudyObjectiveUserCounts;
38
+ export declare function AdminPaginatedStudyObjectiveUserCountsToJSON(json: any): AdminPaginatedStudyObjectiveUserCounts;
39
+ export declare function AdminPaginatedStudyObjectiveUserCountsToJSONTyped(value?: AdminPaginatedStudyObjectiveUserCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
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
+ import { AdminStudyObjectiveUserCountsFromJSON, AdminStudyObjectiveUserCountsToJSON, } from './AdminStudyObjectiveUserCounts';
15
+ /**
16
+ * Check if a given object implements the AdminPaginatedStudyObjectiveUserCounts interface.
17
+ */
18
+ export function instanceOfAdminPaginatedStudyObjectiveUserCounts(value) {
19
+ if (!('data' in value) || value['data'] === undefined)
20
+ return false;
21
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function AdminPaginatedStudyObjectiveUserCountsFromJSON(json) {
26
+ return AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json, false);
27
+ }
28
+ export function AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'data': (json['data'].map(AdminStudyObjectiveUserCountsFromJSON)),
34
+ 'nextCursor': json['nextCursor'],
35
+ };
36
+ }
37
+ export function AdminPaginatedStudyObjectiveUserCountsToJSON(json) {
38
+ return AdminPaginatedStudyObjectiveUserCountsToJSONTyped(json, false);
39
+ }
40
+ export function AdminPaginatedStudyObjectiveUserCountsToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'data': (value['data'].map(AdminStudyObjectiveUserCountsToJSON)),
46
+ 'nextCursor': value['nextCursor'],
47
+ };
48
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminStudyObjectiveOriginCounts
16
+ */
17
+ export interface AdminStudyObjectiveOriginCounts {
18
+ /**
19
+ * User-created objectives with no Canvas link
20
+ * @type {number}
21
+ * @memberof AdminStudyObjectiveOriginCounts
22
+ */
23
+ custom: number;
24
+ /**
25
+ * Objectives linked to a mirrored Canvas object
26
+ * @type {number}
27
+ * @memberof AdminStudyObjectiveOriginCounts
28
+ */
29
+ canvas: number;
30
+ /**
31
+ * Objectives derived from syllabus analysis
32
+ * @type {number}
33
+ * @memberof AdminStudyObjectiveOriginCounts
34
+ */
35
+ syllabus: number;
36
+ /**
37
+ * All of the user's objectives in the filtered set
38
+ * @type {number}
39
+ * @memberof AdminStudyObjectiveOriginCounts
40
+ */
41
+ total: number;
42
+ }
43
+ /**
44
+ * Check if a given object implements the AdminStudyObjectiveOriginCounts interface.
45
+ */
46
+ export declare function instanceOfAdminStudyObjectiveOriginCounts(value: object): value is AdminStudyObjectiveOriginCounts;
47
+ export declare function AdminStudyObjectiveOriginCountsFromJSON(json: any): AdminStudyObjectiveOriginCounts;
48
+ export declare function AdminStudyObjectiveOriginCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveOriginCounts;
49
+ export declare function AdminStudyObjectiveOriginCountsToJSON(json: any): AdminStudyObjectiveOriginCounts;
50
+ export declare function AdminStudyObjectiveOriginCountsToJSONTyped(value?: AdminStudyObjectiveOriginCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
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 AdminStudyObjectiveOriginCounts interface.
16
+ */
17
+ export function instanceOfAdminStudyObjectiveOriginCounts(value) {
18
+ if (!('custom' in value) || value['custom'] === undefined)
19
+ return false;
20
+ if (!('canvas' in value) || value['canvas'] === undefined)
21
+ return false;
22
+ if (!('syllabus' in value) || value['syllabus'] === undefined)
23
+ return false;
24
+ if (!('total' in value) || value['total'] === undefined)
25
+ return false;
26
+ return true;
27
+ }
28
+ export function AdminStudyObjectiveOriginCountsFromJSON(json) {
29
+ return AdminStudyObjectiveOriginCountsFromJSONTyped(json, false);
30
+ }
31
+ export function AdminStudyObjectiveOriginCountsFromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'custom': json['custom'],
37
+ 'canvas': json['canvas'],
38
+ 'syllabus': json['syllabus'],
39
+ 'total': json['total'],
40
+ };
41
+ }
42
+ export function AdminStudyObjectiveOriginCountsToJSON(json) {
43
+ return AdminStudyObjectiveOriginCountsToJSONTyped(json, false);
44
+ }
45
+ export function AdminStudyObjectiveOriginCountsToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'custom': value['custom'],
51
+ 'canvas': value['canvas'],
52
+ 'syllabus': value['syllabus'],
53
+ 'total': value['total'],
54
+ };
55
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AdminStudyObjectiveOriginCounts } from './AdminStudyObjectiveOriginCounts';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminStudyObjectiveUserCounts
17
+ */
18
+ export interface AdminStudyObjectiveUserCounts {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminStudyObjectiveUserCounts
23
+ */
24
+ accountUserId: string;
25
+ /**
26
+ * External identifier of the user who owns the objectives
27
+ * @type {string}
28
+ * @memberof AdminStudyObjectiveUserCounts
29
+ */
30
+ userId: string | null;
31
+ /**
32
+ * Per-origin objective counts for this user
33
+ * @type {AdminStudyObjectiveOriginCounts}
34
+ * @memberof AdminStudyObjectiveUserCounts
35
+ */
36
+ counts: AdminStudyObjectiveOriginCounts;
37
+ /**
38
+ * When the user's most recent objective in the set was created
39
+ * @type {Date}
40
+ * @memberof AdminStudyObjectiveUserCounts
41
+ */
42
+ lastObjectiveCreatedAt: Date;
43
+ }
44
+ /**
45
+ * Check if a given object implements the AdminStudyObjectiveUserCounts interface.
46
+ */
47
+ export declare function instanceOfAdminStudyObjectiveUserCounts(value: object): value is AdminStudyObjectiveUserCounts;
48
+ export declare function AdminStudyObjectiveUserCountsFromJSON(json: any): AdminStudyObjectiveUserCounts;
49
+ export declare function AdminStudyObjectiveUserCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveUserCounts;
50
+ export declare function AdminStudyObjectiveUserCountsToJSON(json: any): AdminStudyObjectiveUserCounts;
51
+ export declare function AdminStudyObjectiveUserCountsToJSONTyped(value?: AdminStudyObjectiveUserCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
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
+ import { AdminStudyObjectiveOriginCountsFromJSON, AdminStudyObjectiveOriginCountsToJSON, } from './AdminStudyObjectiveOriginCounts';
15
+ /**
16
+ * Check if a given object implements the AdminStudyObjectiveUserCounts interface.
17
+ */
18
+ export function instanceOfAdminStudyObjectiveUserCounts(value) {
19
+ if (!('accountUserId' in value) || value['accountUserId'] === undefined)
20
+ return false;
21
+ if (!('userId' in value) || value['userId'] === undefined)
22
+ return false;
23
+ if (!('counts' in value) || value['counts'] === undefined)
24
+ return false;
25
+ if (!('lastObjectiveCreatedAt' in value) || value['lastObjectiveCreatedAt'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ export function AdminStudyObjectiveUserCountsFromJSON(json) {
30
+ return AdminStudyObjectiveUserCountsFromJSONTyped(json, false);
31
+ }
32
+ export function AdminStudyObjectiveUserCountsFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'accountUserId': json['accountUserId'],
38
+ 'userId': json['userId'],
39
+ 'counts': AdminStudyObjectiveOriginCountsFromJSON(json['counts']),
40
+ 'lastObjectiveCreatedAt': (new Date(json['lastObjectiveCreatedAt'])),
41
+ };
42
+ }
43
+ export function AdminStudyObjectiveUserCountsToJSON(json) {
44
+ return AdminStudyObjectiveUserCountsToJSONTyped(json, false);
45
+ }
46
+ export function AdminStudyObjectiveUserCountsToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'accountUserId': value['accountUserId'],
52
+ 'userId': value['userId'],
53
+ 'counts': AdminStudyObjectiveOriginCountsToJSON(value['counts']),
54
+ 'lastObjectiveCreatedAt': value['lastObjectiveCreatedAt'].toISOString(),
55
+ };
56
+ }
@@ -7,6 +7,7 @@ export * from './AdminCohortStats';
7
7
  export * from './AdminPaginatedActiveStreaks';
8
8
  export * from './AdminPaginatedChats';
9
9
  export * from './AdminPaginatedQuizSessions';
10
+ export * from './AdminPaginatedStudyObjectiveUserCounts';
10
11
  export * from './AdminPaginatedStudyObjectives';
11
12
  export * from './AdminPaginatedTaxonomyEnrollments';
12
13
  export * from './AdminQuizSessionListItem';
@@ -14,7 +15,9 @@ export * from './AdminQuizSessionScore';
14
15
  export * from './AdminStreak';
15
16
  export * from './AdminStudyObjectiveCanvasTypeCount';
16
17
  export * from './AdminStudyObjectiveListItem';
18
+ export * from './AdminStudyObjectiveOriginCounts';
17
19
  export * from './AdminStudyObjectiveSummary';
20
+ export * from './AdminStudyObjectiveUserCounts';
18
21
  export * from './AdminTaxonomyEnrollment';
19
22
  export * from './AdminTaxonomyEnrollmentTaxonomy';
20
23
  export * from './AdminTriggerAnalysisResponse';
@@ -9,6 +9,7 @@ export * from './AdminCohortStats';
9
9
  export * from './AdminPaginatedActiveStreaks';
10
10
  export * from './AdminPaginatedChats';
11
11
  export * from './AdminPaginatedQuizSessions';
12
+ export * from './AdminPaginatedStudyObjectiveUserCounts';
12
13
  export * from './AdminPaginatedStudyObjectives';
13
14
  export * from './AdminPaginatedTaxonomyEnrollments';
14
15
  export * from './AdminQuizSessionListItem';
@@ -16,7 +17,9 @@ export * from './AdminQuizSessionScore';
16
17
  export * from './AdminStreak';
17
18
  export * from './AdminStudyObjectiveCanvasTypeCount';
18
19
  export * from './AdminStudyObjectiveListItem';
20
+ export * from './AdminStudyObjectiveOriginCounts';
19
21
  export * from './AdminStudyObjectiveSummary';
22
+ export * from './AdminStudyObjectiveUserCounts';
20
23
  export * from './AdminTaxonomyEnrollment';
21
24
  export * from './AdminTaxonomyEnrollmentTaxonomy';
22
25
  export * from './AdminTriggerAnalysisResponse';
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AdminStudyObjectiveUserCounts } from './AdminStudyObjectiveUserCounts';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminPaginatedStudyObjectiveUserCounts
17
+ */
18
+ export interface AdminPaginatedStudyObjectiveUserCounts {
19
+ /**
20
+ * One row per distinct user, with that user's per-origin counts
21
+ * @type {Array<AdminStudyObjectiveUserCounts>}
22
+ * @memberof AdminPaginatedStudyObjectiveUserCounts
23
+ */
24
+ data: Array<AdminStudyObjectiveUserCounts>;
25
+ /**
26
+ * Opaque cursor for fetching the next page. Null when there are no more results.
27
+ * @type {string}
28
+ * @memberof AdminPaginatedStudyObjectiveUserCounts
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the AdminPaginatedStudyObjectiveUserCounts interface.
34
+ */
35
+ export declare function instanceOfAdminPaginatedStudyObjectiveUserCounts(value: object): value is AdminPaginatedStudyObjectiveUserCounts;
36
+ export declare function AdminPaginatedStudyObjectiveUserCountsFromJSON(json: any): AdminPaginatedStudyObjectiveUserCounts;
37
+ export declare function AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedStudyObjectiveUserCounts;
38
+ export declare function AdminPaginatedStudyObjectiveUserCountsToJSON(json: any): AdminPaginatedStudyObjectiveUserCounts;
39
+ export declare function AdminPaginatedStudyObjectiveUserCountsToJSONTyped(value?: AdminPaginatedStudyObjectiveUserCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
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.instanceOfAdminPaginatedStudyObjectiveUserCounts = instanceOfAdminPaginatedStudyObjectiveUserCounts;
17
+ exports.AdminPaginatedStudyObjectiveUserCountsFromJSON = AdminPaginatedStudyObjectiveUserCountsFromJSON;
18
+ exports.AdminPaginatedStudyObjectiveUserCountsFromJSONTyped = AdminPaginatedStudyObjectiveUserCountsFromJSONTyped;
19
+ exports.AdminPaginatedStudyObjectiveUserCountsToJSON = AdminPaginatedStudyObjectiveUserCountsToJSON;
20
+ exports.AdminPaginatedStudyObjectiveUserCountsToJSONTyped = AdminPaginatedStudyObjectiveUserCountsToJSONTyped;
21
+ const AdminStudyObjectiveUserCounts_1 = require("./AdminStudyObjectiveUserCounts");
22
+ /**
23
+ * Check if a given object implements the AdminPaginatedStudyObjectiveUserCounts interface.
24
+ */
25
+ function instanceOfAdminPaginatedStudyObjectiveUserCounts(value) {
26
+ if (!('data' in value) || value['data'] === undefined)
27
+ return false;
28
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function AdminPaginatedStudyObjectiveUserCountsFromJSON(json) {
33
+ return AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json, false);
34
+ }
35
+ function AdminPaginatedStudyObjectiveUserCountsFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'data': (json['data'].map(AdminStudyObjectiveUserCounts_1.AdminStudyObjectiveUserCountsFromJSON)),
41
+ 'nextCursor': json['nextCursor'],
42
+ };
43
+ }
44
+ function AdminPaginatedStudyObjectiveUserCountsToJSON(json) {
45
+ return AdminPaginatedStudyObjectiveUserCountsToJSONTyped(json, false);
46
+ }
47
+ function AdminPaginatedStudyObjectiveUserCountsToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(AdminStudyObjectiveUserCounts_1.AdminStudyObjectiveUserCountsToJSON)),
53
+ 'nextCursor': value['nextCursor'],
54
+ };
55
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminStudyObjectiveOriginCounts
16
+ */
17
+ export interface AdminStudyObjectiveOriginCounts {
18
+ /**
19
+ * User-created objectives with no Canvas link
20
+ * @type {number}
21
+ * @memberof AdminStudyObjectiveOriginCounts
22
+ */
23
+ custom: number;
24
+ /**
25
+ * Objectives linked to a mirrored Canvas object
26
+ * @type {number}
27
+ * @memberof AdminStudyObjectiveOriginCounts
28
+ */
29
+ canvas: number;
30
+ /**
31
+ * Objectives derived from syllabus analysis
32
+ * @type {number}
33
+ * @memberof AdminStudyObjectiveOriginCounts
34
+ */
35
+ syllabus: number;
36
+ /**
37
+ * All of the user's objectives in the filtered set
38
+ * @type {number}
39
+ * @memberof AdminStudyObjectiveOriginCounts
40
+ */
41
+ total: number;
42
+ }
43
+ /**
44
+ * Check if a given object implements the AdminStudyObjectiveOriginCounts interface.
45
+ */
46
+ export declare function instanceOfAdminStudyObjectiveOriginCounts(value: object): value is AdminStudyObjectiveOriginCounts;
47
+ export declare function AdminStudyObjectiveOriginCountsFromJSON(json: any): AdminStudyObjectiveOriginCounts;
48
+ export declare function AdminStudyObjectiveOriginCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveOriginCounts;
49
+ export declare function AdminStudyObjectiveOriginCountsToJSON(json: any): AdminStudyObjectiveOriginCounts;
50
+ export declare function AdminStudyObjectiveOriginCountsToJSONTyped(value?: AdminStudyObjectiveOriginCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,62 @@
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.instanceOfAdminStudyObjectiveOriginCounts = instanceOfAdminStudyObjectiveOriginCounts;
17
+ exports.AdminStudyObjectiveOriginCountsFromJSON = AdminStudyObjectiveOriginCountsFromJSON;
18
+ exports.AdminStudyObjectiveOriginCountsFromJSONTyped = AdminStudyObjectiveOriginCountsFromJSONTyped;
19
+ exports.AdminStudyObjectiveOriginCountsToJSON = AdminStudyObjectiveOriginCountsToJSON;
20
+ exports.AdminStudyObjectiveOriginCountsToJSONTyped = AdminStudyObjectiveOriginCountsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminStudyObjectiveOriginCounts interface.
23
+ */
24
+ function instanceOfAdminStudyObjectiveOriginCounts(value) {
25
+ if (!('custom' in value) || value['custom'] === undefined)
26
+ return false;
27
+ if (!('canvas' in value) || value['canvas'] === undefined)
28
+ return false;
29
+ if (!('syllabus' in value) || value['syllabus'] === undefined)
30
+ return false;
31
+ if (!('total' in value) || value['total'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function AdminStudyObjectiveOriginCountsFromJSON(json) {
36
+ return AdminStudyObjectiveOriginCountsFromJSONTyped(json, false);
37
+ }
38
+ function AdminStudyObjectiveOriginCountsFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'custom': json['custom'],
44
+ 'canvas': json['canvas'],
45
+ 'syllabus': json['syllabus'],
46
+ 'total': json['total'],
47
+ };
48
+ }
49
+ function AdminStudyObjectiveOriginCountsToJSON(json) {
50
+ return AdminStudyObjectiveOriginCountsToJSONTyped(json, false);
51
+ }
52
+ function AdminStudyObjectiveOriginCountsToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'custom': value['custom'],
58
+ 'canvas': value['canvas'],
59
+ 'syllabus': value['syllabus'],
60
+ 'total': value['total'],
61
+ };
62
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AdminStudyObjectiveOriginCounts } from './AdminStudyObjectiveOriginCounts';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminStudyObjectiveUserCounts
17
+ */
18
+ export interface AdminStudyObjectiveUserCounts {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminStudyObjectiveUserCounts
23
+ */
24
+ accountUserId: string;
25
+ /**
26
+ * External identifier of the user who owns the objectives
27
+ * @type {string}
28
+ * @memberof AdminStudyObjectiveUserCounts
29
+ */
30
+ userId: string | null;
31
+ /**
32
+ * Per-origin objective counts for this user
33
+ * @type {AdminStudyObjectiveOriginCounts}
34
+ * @memberof AdminStudyObjectiveUserCounts
35
+ */
36
+ counts: AdminStudyObjectiveOriginCounts;
37
+ /**
38
+ * When the user's most recent objective in the set was created
39
+ * @type {Date}
40
+ * @memberof AdminStudyObjectiveUserCounts
41
+ */
42
+ lastObjectiveCreatedAt: Date;
43
+ }
44
+ /**
45
+ * Check if a given object implements the AdminStudyObjectiveUserCounts interface.
46
+ */
47
+ export declare function instanceOfAdminStudyObjectiveUserCounts(value: object): value is AdminStudyObjectiveUserCounts;
48
+ export declare function AdminStudyObjectiveUserCountsFromJSON(json: any): AdminStudyObjectiveUserCounts;
49
+ export declare function AdminStudyObjectiveUserCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveUserCounts;
50
+ export declare function AdminStudyObjectiveUserCountsToJSON(json: any): AdminStudyObjectiveUserCounts;
51
+ export declare function AdminStudyObjectiveUserCountsToJSONTyped(value?: AdminStudyObjectiveUserCounts | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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.instanceOfAdminStudyObjectiveUserCounts = instanceOfAdminStudyObjectiveUserCounts;
17
+ exports.AdminStudyObjectiveUserCountsFromJSON = AdminStudyObjectiveUserCountsFromJSON;
18
+ exports.AdminStudyObjectiveUserCountsFromJSONTyped = AdminStudyObjectiveUserCountsFromJSONTyped;
19
+ exports.AdminStudyObjectiveUserCountsToJSON = AdminStudyObjectiveUserCountsToJSON;
20
+ exports.AdminStudyObjectiveUserCountsToJSONTyped = AdminStudyObjectiveUserCountsToJSONTyped;
21
+ const AdminStudyObjectiveOriginCounts_1 = require("./AdminStudyObjectiveOriginCounts");
22
+ /**
23
+ * Check if a given object implements the AdminStudyObjectiveUserCounts interface.
24
+ */
25
+ function instanceOfAdminStudyObjectiveUserCounts(value) {
26
+ if (!('accountUserId' in value) || value['accountUserId'] === undefined)
27
+ return false;
28
+ if (!('userId' in value) || value['userId'] === undefined)
29
+ return false;
30
+ if (!('counts' in value) || value['counts'] === undefined)
31
+ return false;
32
+ if (!('lastObjectiveCreatedAt' in value) || value['lastObjectiveCreatedAt'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ function AdminStudyObjectiveUserCountsFromJSON(json) {
37
+ return AdminStudyObjectiveUserCountsFromJSONTyped(json, false);
38
+ }
39
+ function AdminStudyObjectiveUserCountsFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'accountUserId': json['accountUserId'],
45
+ 'userId': json['userId'],
46
+ 'counts': (0, AdminStudyObjectiveOriginCounts_1.AdminStudyObjectiveOriginCountsFromJSON)(json['counts']),
47
+ 'lastObjectiveCreatedAt': (new Date(json['lastObjectiveCreatedAt'])),
48
+ };
49
+ }
50
+ function AdminStudyObjectiveUserCountsToJSON(json) {
51
+ return AdminStudyObjectiveUserCountsToJSONTyped(json, false);
52
+ }
53
+ function AdminStudyObjectiveUserCountsToJSONTyped(value, ignoreDiscriminator = false) {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'accountUserId': value['accountUserId'],
59
+ 'userId': value['userId'],
60
+ 'counts': (0, AdminStudyObjectiveOriginCounts_1.AdminStudyObjectiveOriginCountsToJSON)(value['counts']),
61
+ 'lastObjectiveCreatedAt': value['lastObjectiveCreatedAt'].toISOString(),
62
+ };
63
+ }
@@ -7,6 +7,7 @@ export * from './AdminCohortStats';
7
7
  export * from './AdminPaginatedActiveStreaks';
8
8
  export * from './AdminPaginatedChats';
9
9
  export * from './AdminPaginatedQuizSessions';
10
+ export * from './AdminPaginatedStudyObjectiveUserCounts';
10
11
  export * from './AdminPaginatedStudyObjectives';
11
12
  export * from './AdminPaginatedTaxonomyEnrollments';
12
13
  export * from './AdminQuizSessionListItem';
@@ -14,7 +15,9 @@ export * from './AdminQuizSessionScore';
14
15
  export * from './AdminStreak';
15
16
  export * from './AdminStudyObjectiveCanvasTypeCount';
16
17
  export * from './AdminStudyObjectiveListItem';
18
+ export * from './AdminStudyObjectiveOriginCounts';
17
19
  export * from './AdminStudyObjectiveSummary';
20
+ export * from './AdminStudyObjectiveUserCounts';
18
21
  export * from './AdminTaxonomyEnrollment';
19
22
  export * from './AdminTaxonomyEnrollmentTaxonomy';
20
23
  export * from './AdminTriggerAnalysisResponse';
@@ -25,6 +25,7 @@ __exportStar(require("./AdminCohortStats"), exports);
25
25
  __exportStar(require("./AdminPaginatedActiveStreaks"), exports);
26
26
  __exportStar(require("./AdminPaginatedChats"), exports);
27
27
  __exportStar(require("./AdminPaginatedQuizSessions"), exports);
28
+ __exportStar(require("./AdminPaginatedStudyObjectiveUserCounts"), exports);
28
29
  __exportStar(require("./AdminPaginatedStudyObjectives"), exports);
29
30
  __exportStar(require("./AdminPaginatedTaxonomyEnrollments"), exports);
30
31
  __exportStar(require("./AdminQuizSessionListItem"), exports);
@@ -32,7 +33,9 @@ __exportStar(require("./AdminQuizSessionScore"), exports);
32
33
  __exportStar(require("./AdminStreak"), exports);
33
34
  __exportStar(require("./AdminStudyObjectiveCanvasTypeCount"), exports);
34
35
  __exportStar(require("./AdminStudyObjectiveListItem"), exports);
36
+ __exportStar(require("./AdminStudyObjectiveOriginCounts"), exports);
35
37
  __exportStar(require("./AdminStudyObjectiveSummary"), exports);
38
+ __exportStar(require("./AdminStudyObjectiveUserCounts"), exports);
36
39
  __exportStar(require("./AdminTaxonomyEnrollment"), exports);
37
40
  __exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
38
41
  __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.12.12",
4
+ "version": "3.13.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {