@instructure/athena-api-client 3.12.5 → 3.12.7

package/README.md

@@ -61,11 +61,13 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminGetChatAnalysis**](docs/AdminApi.md#admingetchatanalysis) | **GET** /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account
 *AdminApi* | [**adminGetCohortStats**](docs/AdminApi.md#admingetcohortstats) | **GET** /api/v1/admin/cohort-stats | Get cohort statistics for users created within a date range
 *AdminApi* | [**adminGetQuizSessionSummary**](docs/AdminApi.md#admingetquizsessionsummary) | **GET** /api/v1/admin/quiz-sessions/{sessionId}/summary | Get quiz session summary for any session within the account
+*AdminApi* | [**adminGetStudyObjectiveSummary**](docs/AdminApi.md#admingetstudyobjectivesummary) | **GET** /api/v1/admin/study-objectives/summary | Aggregate study-objective statistics across all account users
 *AdminApi* | [**adminGetUserChats**](docs/AdminApi.md#admingetuserchats) | **GET** /api/v1/admin/users/{externalId}/chats | Get chats with stats for a user
 *AdminApi* | [**adminGetUserEngagement**](docs/AdminApi.md#admingetuserengagement) | **GET** /api/v1/admin/users/{externalId}/engagement | Get engagement dates for a user
 *AdminApi* | [**adminListActiveStreaks**](docs/AdminApi.md#adminlistactivestreaks) | **GET** /api/v1/admin/streaks/active | List all active streaks (currentDays > 0) across the account, paginated
 *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
 *AdminApi* | [**adminListQuizSessions**](docs/AdminApi.md#adminlistquizsessions) | **GET** /api/v1/admin/quiz-sessions | List recent quiz sessions across all account users
+*AdminApi* | [**adminListStudyObjectives**](docs/AdminApi.md#adminliststudyobjectives) | **GET** /api/v1/admin/study-objectives | List study objectives across all account users
 *AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account
 *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
 *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat
@@ -174,10 +176,14 @@ All URIs are relative to *http://localhost:3000*
 - [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md)
 - [AdminPaginatedChats](docs/AdminPaginatedChats.md)
 - [AdminPaginatedQuizSessions](docs/AdminPaginatedQuizSessions.md)
+- [AdminPaginatedStudyObjectives](docs/AdminPaginatedStudyObjectives.md)
 - [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md)
 - [AdminQuizSessionListItem](docs/AdminQuizSessionListItem.md)
 - [AdminQuizSessionScore](docs/AdminQuizSessionScore.md)
 - [AdminStreak](docs/AdminStreak.md)
+- [AdminStudyObjectiveCanvasTypeCount](docs/AdminStudyObjectiveCanvasTypeCount.md)
+- [AdminStudyObjectiveListItem](docs/AdminStudyObjectiveListItem.md)
+- [AdminStudyObjectiveSummary](docs/AdminStudyObjectiveSummary.md)
 - [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md)
 - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
 - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -28,6 +28,9 @@ export interface AdminGetQuizSessionSummaryRequest {
     xUserId: string;
     sessionId: string;
 }
+export interface AdminGetStudyObjectiveSummaryRequest {
+    xUserId: string;
+}
 export interface AdminGetUserChatsRequest {
     xUserId: string;
     externalId: string;
@@ -55,6 +58,15 @@ export interface AdminListQuizSessionsRequest {
     mode?: AdminListQuizSessionsModeEnum;
     status?: AdminListQuizSessionsStatusEnum;
 }
+export interface AdminListStudyObjectivesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    origin?: AdminListStudyObjectivesOriginEnum;
+    archived?: AdminListStudyObjectivesArchivedEnum;
+    courseId?: string;
+    hasQuiz?: boolean;
+}
 export interface AdminListTaxonomyEnrollmentsRequest {
     xUserId: string;
     limit?: number;
@@ -111,6 +123,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get quiz session summary for any session within the account
      */
     adminGetQuizSessionSummary(requestParameters: AdminGetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSessionSummary>;
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummaryRaw(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminStudyObjectiveSummary>>;
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummary(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminStudyObjectiveSummary>;
     /**
      * Get chats with stats for a user
      */
@@ -153,6 +175,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List recent quiz sessions across all account users
      */
     adminListQuizSessions(requestParameters: AdminListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedQuizSessions>;
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectivesRaw(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedStudyObjectives>>;
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectives(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectives>;
     /**
      * List all taxonomy enrollments across the account
      */
@@ -203,3 +235,21 @@ export declare const AdminListQuizSessionsStatusEnum: {
     readonly Abandoned: "abandoned";
 };
 export type AdminListQuizSessionsStatusEnum = typeof AdminListQuizSessionsStatusEnum[keyof typeof AdminListQuizSessionsStatusEnum];
+/**
+ * @export
+ */
+export declare const AdminListStudyObjectivesOriginEnum: {
+    readonly Custom: "custom";
+    readonly Canvas: "canvas";
+    readonly Syllabus: "syllabus";
+};
+export type AdminListStudyObjectivesOriginEnum = typeof AdminListStudyObjectivesOriginEnum[keyof typeof AdminListStudyObjectivesOriginEnum];
+/**
+ * @export
+ */
+export declare const AdminListStudyObjectivesArchivedEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type AdminListStudyObjectivesArchivedEnum = typeof AdminListStudyObjectivesArchivedEnum[keyof typeof AdminListStudyObjectivesArchivedEnum];

package/dist/apis/AdminApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminListQuizSessionsStatusEnum = exports.AdminListQuizSessionsModeEnum = exports.AdminApi = void 0;
+exports.AdminListStudyObjectivesArchivedEnum = exports.AdminListStudyObjectivesOriginEnum = exports.AdminListQuizSessionsStatusEnum = exports.AdminListQuizSessionsModeEnum = exports.AdminApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -195,6 +195,43 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetStudyObjectiveSummary().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/study-objectives/summary`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminStudyObjectiveSummaryFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetStudyObjectiveSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Get chats with stats for a user
      */
@@ -410,6 +447,61 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectivesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListStudyObjectives().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['origin'] != null) {
+                queryParameters['origin'] = requestParameters['origin'];
+            }
+            if (requestParameters['archived'] != null) {
+                queryParameters['archived'] = requestParameters['archived'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['hasQuiz'] != null) {
+                queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/study-objectives`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminPaginatedStudyObjectivesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectives(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListStudyObjectivesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List all taxonomy enrollments across the account
      */
@@ -589,3 +681,19 @@ exports.AdminListQuizSessionsStatusEnum = {
     Completed: 'completed',
     Abandoned: 'abandoned'
 };
+/**
+ * @export
+ */
+exports.AdminListStudyObjectivesOriginEnum = {
+    Custom: 'custom',
+    Canvas: 'canvas',
+    Syllabus: 'syllabus'
+};
+/**
+ * @export
+ */
+exports.AdminListStudyObjectivesArchivedEnum = {
+    Active: 'active',
+    Archived: 'archived',
+    All: 'all'
+};

package/dist/esm/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -28,6 +28,9 @@ export interface AdminGetQuizSessionSummaryRequest {
     xUserId: string;
     sessionId: string;
 }
+export interface AdminGetStudyObjectiveSummaryRequest {
+    xUserId: string;
+}
 export interface AdminGetUserChatsRequest {
     xUserId: string;
     externalId: string;
@@ -55,6 +58,15 @@ export interface AdminListQuizSessionsRequest {
     mode?: AdminListQuizSessionsModeEnum;
     status?: AdminListQuizSessionsStatusEnum;
 }
+export interface AdminListStudyObjectivesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    origin?: AdminListStudyObjectivesOriginEnum;
+    archived?: AdminListStudyObjectivesArchivedEnum;
+    courseId?: string;
+    hasQuiz?: boolean;
+}
 export interface AdminListTaxonomyEnrollmentsRequest {
     xUserId: string;
     limit?: number;
@@ -111,6 +123,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get quiz session summary for any session within the account
      */
     adminGetQuizSessionSummary(requestParameters: AdminGetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSessionSummary>;
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummaryRaw(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminStudyObjectiveSummary>>;
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummary(requestParameters: AdminGetStudyObjectiveSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminStudyObjectiveSummary>;
     /**
      * Get chats with stats for a user
      */
@@ -153,6 +175,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List recent quiz sessions across all account users
      */
     adminListQuizSessions(requestParameters: AdminListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedQuizSessions>;
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectivesRaw(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedStudyObjectives>>;
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectives(requestParameters: AdminListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedStudyObjectives>;
     /**
      * List all taxonomy enrollments across the account
      */
@@ -203,3 +235,21 @@ export declare const AdminListQuizSessionsStatusEnum: {
     readonly Abandoned: "abandoned";
 };
 export type AdminListQuizSessionsStatusEnum = typeof AdminListQuizSessionsStatusEnum[keyof typeof AdminListQuizSessionsStatusEnum];
+/**
+ * @export
+ */
+export declare const AdminListStudyObjectivesOriginEnum: {
+    readonly Custom: "custom";
+    readonly Canvas: "canvas";
+    readonly Syllabus: "syllabus";
+};
+export type AdminListStudyObjectivesOriginEnum = typeof AdminListStudyObjectivesOriginEnum[keyof typeof AdminListStudyObjectivesOriginEnum];
+/**
+ * @export
+ */
+export declare const AdminListStudyObjectivesArchivedEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type AdminListStudyObjectivesArchivedEnum = typeof AdminListStudyObjectivesArchivedEnum[keyof typeof AdminListStudyObjectivesArchivedEnum];

package/dist/esm/apis/AdminApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminStreakFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -192,6 +192,43 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetStudyObjectiveSummary().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/study-objectives/summary`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminStudyObjectiveSummaryFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns counts of study objectives within the caller\'s account, broken down by origin (custom user-created, Canvas-sourced, syllabus-derived) and archive state, plus how many users created a custom objective and a breakdown of Canvas-sourced objectives by Canvas object type. 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.
+     * Aggregate study-objective statistics across all account users
+     */
+    adminGetStudyObjectiveSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetStudyObjectiveSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Get chats with stats for a user
      */
@@ -407,6 +444,61 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectivesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminListStudyObjectives().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['origin'] != null) {
+                queryParameters['origin'] = requestParameters['origin'];
+            }
+            if (requestParameters['archived'] != null) {
+                queryParameters['archived'] = requestParameters['archived'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['hasQuiz'] != null) {
+                queryParameters['hasQuiz'] = requestParameters['hasQuiz'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/study-objectives`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminPaginatedStudyObjectivesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of study objectives belonging to users within the caller\'s account, ordered by creation date (newest first), with the owning user\'s external id, derived origin, linked Canvas object metadata, and resource/quiz engagement counts. Filter by origin to isolate custom (workaround) objectives, or pass a courseId to inspect everything generated for a course. Intended for admin-style 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.
+     * List study objectives across all account users
+     */
+    adminListStudyObjectives(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListStudyObjectivesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List all taxonomy enrollments across the account
      */
@@ -585,3 +677,19 @@ export const AdminListQuizSessionsStatusEnum = {
     Completed: 'completed',
     Abandoned: 'abandoned'
 };
+/**
+ * @export
+ */
+export const AdminListStudyObjectivesOriginEnum = {
+    Custom: 'custom',
+    Canvas: 'canvas',
+    Syllabus: 'syllabus'
+};
+/**
+ * @export
+ */
+export const AdminListStudyObjectivesArchivedEnum = {
+    Active: 'active',
+    Archived: 'archived',
+    All: 'all'
+};

package/dist/esm/models/AdminPaginatedStudyObjectives.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AdminStudyObjectiveListItem } from './AdminStudyObjectiveListItem';
+/**
+ *
+ * @export
+ * @interface AdminPaginatedStudyObjectives
+ */
+export interface AdminPaginatedStudyObjectives {
+    /**
+     * Array of study objective objects
+     * @type {Array<AdminStudyObjectiveListItem>}
+     * @memberof AdminPaginatedStudyObjectives
+     */
+    data: Array<AdminStudyObjectiveListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof AdminPaginatedStudyObjectives
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the AdminPaginatedStudyObjectives interface.
+ */
+export declare function instanceOfAdminPaginatedStudyObjectives(value: object): value is AdminPaginatedStudyObjectives;
+export declare function AdminPaginatedStudyObjectivesFromJSON(json: any): AdminPaginatedStudyObjectives;
+export declare function AdminPaginatedStudyObjectivesFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedStudyObjectives;
+export declare function AdminPaginatedStudyObjectivesToJSON(json: any): AdminPaginatedStudyObjectives;
+export declare function AdminPaginatedStudyObjectivesToJSONTyped(value?: AdminPaginatedStudyObjectives | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminPaginatedStudyObjectives.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AdminStudyObjectiveListItemFromJSON, AdminStudyObjectiveListItemToJSON, } from './AdminStudyObjectiveListItem';
+/**
+ * Check if a given object implements the AdminPaginatedStudyObjectives interface.
+ */
+export function instanceOfAdminPaginatedStudyObjectives(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function AdminPaginatedStudyObjectivesFromJSON(json) {
+    return AdminPaginatedStudyObjectivesFromJSONTyped(json, false);
+}
+export function AdminPaginatedStudyObjectivesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminStudyObjectiveListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function AdminPaginatedStudyObjectivesToJSON(json) {
+    return AdminPaginatedStudyObjectivesToJSONTyped(json, false);
+}
+export function AdminPaginatedStudyObjectivesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminStudyObjectiveListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/esm/models/AdminStudyObjectiveCanvasTypeCount.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AdminStudyObjectiveCanvasTypeCount
+ */
+export interface AdminStudyObjectiveCanvasTypeCount {
+    /**
+     * Canvas object type the objectives derive from (e.g. assignment, quiz, page)
+     * @type {string}
+     * @memberof AdminStudyObjectiveCanvasTypeCount
+     */
+    objectType: string;
+    /**
+     * Number of Canvas-sourced objectives of this type
+     * @type {number}
+     * @memberof AdminStudyObjectiveCanvasTypeCount
+     */
+    count: number;
+}
+/**
+ * Check if a given object implements the AdminStudyObjectiveCanvasTypeCount interface.
+ */
+export declare function instanceOfAdminStudyObjectiveCanvasTypeCount(value: object): value is AdminStudyObjectiveCanvasTypeCount;
+export declare function AdminStudyObjectiveCanvasTypeCountFromJSON(json: any): AdminStudyObjectiveCanvasTypeCount;
+export declare function AdminStudyObjectiveCanvasTypeCountFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveCanvasTypeCount;
+export declare function AdminStudyObjectiveCanvasTypeCountToJSON(json: any): AdminStudyObjectiveCanvasTypeCount;
+export declare function AdminStudyObjectiveCanvasTypeCountToJSONTyped(value?: AdminStudyObjectiveCanvasTypeCount | null, ignoreDiscriminator?: boolean): any;