@instructure/athena-api-client 3.3.0 → 3.4.0

package/README.md

@@ -134,6 +134,8 @@ All URIs are relative to *http://localhost:3000*
 *StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades
 *StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course
 *StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas
+*SyllabusAnalysisApi* | [**getSyllabusAnalysisStatus**](docs/SyllabusAnalysisApi.md#getsyllabusanalysisstatus) | **GET** /api/v1/syllabus-analysis | Get syllabus analysis status
+*SyllabusAnalysisApi* | [**triggerSyllabusAnalysis**](docs/SyllabusAnalysisApi.md#triggersyllabusanalysisoperation) | **POST** /api/v1/syllabus-analysis | Trigger syllabus analysis
 *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
 *TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree
 *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
@@ -253,6 +255,9 @@ All URIs are relative to *http://localhost:3000*
 - [StudyObjectiveConceptSummary](docs/StudyObjectiveConceptSummary.md)
 - [StudyObjectiveFileAttachment](docs/StudyObjectiveFileAttachment.md)
 - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
+- [SyllabusAnalysisObjective](docs/SyllabusAnalysisObjective.md)
+- [SyllabusAnalysisStatus](docs/SyllabusAnalysisStatus.md)
+- [SyllabusAnalysisStatusView](docs/SyllabusAnalysisStatusView.md)
 - [Tag](docs/Tag.md)
 - [TaxonomyDetail](docs/TaxonomyDetail.md)
 - [TaxonomyEnrollment](docs/TaxonomyEnrollment.md)
@@ -268,6 +273,8 @@ All URIs are relative to *http://localhost:3000*
 - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.md)
 - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.md)
 - [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md)
+- [TriggerSyllabusAnalysisRequest](docs/TriggerSyllabusAnalysisRequest.md)
+- [TriggerSyllabusAnalysisRequestFile](docs/TriggerSyllabusAnalysisRequestFile.md)
 - [UpdateAccountDto](docs/UpdateAccountDto.md)
 - [UpdateChatRequest](docs/UpdateChatRequest.md)
 - [UpdateFeatureDto](docs/UpdateFeatureDto.md)

package/dist/apis/SyllabusAnalysisApi.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { SyllabusAnalysisStatus, SyllabusAnalysisStatusView, TriggerSyllabusAnalysisRequest } from '../models/index';
+export interface GetSyllabusAnalysisStatusRequest {
+    courseId: string;
+    canvasDomain: string;
+    xUserId: string;
+}
+export interface TriggerSyllabusAnalysisOperationRequest {
+    xUserId: string;
+    triggerSyllabusAnalysisRequest: TriggerSyllabusAnalysisRequest;
+    xCanvasToken?: string;
+}
+/**
+ *
+ */
+export declare class SyllabusAnalysisApi extends runtime.BaseAPI {
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatusRaw(requestParameters: GetSyllabusAnalysisStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyllabusAnalysisStatusView>>;
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatus(requestParameters: GetSyllabusAnalysisStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyllabusAnalysisStatusView>;
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysisRaw(requestParameters: TriggerSyllabusAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyllabusAnalysisStatus>>;
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysis(requestParameters: TriggerSyllabusAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyllabusAnalysisStatus>;
+}

package/dist/apis/SyllabusAnalysisApi.js

@@ -0,0 +1,127 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyllabusAnalysisApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class SyllabusAnalysisApi extends runtime.BaseAPI {
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            if (requestParameters['canvasDomain'] == null) {
+                throw new runtime.RequiredError('canvasDomain', 'Required parameter "canvasDomain" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['canvasDomain'] != null) {
+                queryParameters['canvasDomain'] = requestParameters['canvasDomain'];
+            }
+            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/syllabus-analysis`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SyllabusAnalysisStatusViewFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSyllabusAnalysisStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysisRaw(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 triggerSyllabusAnalysis().');
+            }
+            if (requestParameters['triggerSyllabusAnalysisRequest'] == null) {
+                throw new runtime.RequiredError('triggerSyllabusAnalysisRequest', 'Required parameter "triggerSyllabusAnalysisRequest" was null or undefined when calling triggerSyllabusAnalysis().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            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/syllabus-analysis`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.TriggerSyllabusAnalysisRequestToJSON)(requestParameters['triggerSyllabusAnalysisRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SyllabusAnalysisStatusFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysis(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.triggerSyllabusAnalysisRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.SyllabusAnalysisApi = SyllabusAnalysisApi;

package/dist/apis/index.d.ts

@@ -21,6 +21,7 @@ export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPrepApi';
+export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

package/dist/apis/index.js

@@ -39,6 +39,7 @@ __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);
 __exportStar(require("./StudyPrepApi"), exports);
+__exportStar(require("./SyllabusAnalysisApi"), exports);
 __exportStar(require("./TagsApi"), exports);
 __exportStar(require("./TaxonomiesApi"), exports);
 __exportStar(require("./TaxonomyEnrollmentsApi"), exports);

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

@@ -0,0 +1,48 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { SyllabusAnalysisStatus, SyllabusAnalysisStatusView, TriggerSyllabusAnalysisRequest } from '../models/index';
+export interface GetSyllabusAnalysisStatusRequest {
+    courseId: string;
+    canvasDomain: string;
+    xUserId: string;
+}
+export interface TriggerSyllabusAnalysisOperationRequest {
+    xUserId: string;
+    triggerSyllabusAnalysisRequest: TriggerSyllabusAnalysisRequest;
+    xCanvasToken?: string;
+}
+/**
+ *
+ */
+export declare class SyllabusAnalysisApi extends runtime.BaseAPI {
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatusRaw(requestParameters: GetSyllabusAnalysisStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyllabusAnalysisStatusView>>;
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatus(requestParameters: GetSyllabusAnalysisStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyllabusAnalysisStatusView>;
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysisRaw(requestParameters: TriggerSyllabusAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyllabusAnalysisStatus>>;
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysis(requestParameters: TriggerSyllabusAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyllabusAnalysisStatus>;
+}

package/dist/esm/apis/SyllabusAnalysisApi.js

@@ -0,0 +1,123 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { SyllabusAnalysisStatusFromJSON, SyllabusAnalysisStatusViewFromJSON, TriggerSyllabusAnalysisRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class SyllabusAnalysisApi extends runtime.BaseAPI {
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            if (requestParameters['canvasDomain'] == null) {
+                throw new runtime.RequiredError('canvasDomain', 'Required parameter "canvasDomain" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getSyllabusAnalysisStatus().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['canvasDomain'] != null) {
+                queryParameters['canvasDomain'] = requestParameters['canvasDomain'];
+            }
+            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/syllabus-analysis`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SyllabusAnalysisStatusViewFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the syllabus-analysis lifecycle status for a student+course so the consuming app can show \'analyzed / found N / none / not yet\'. Returns `not_yet` (never a 404) when no analysis has run.
+     * Get syllabus analysis status
+     */
+    getSyllabusAnalysisStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSyllabusAnalysisStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysisRaw(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 triggerSyllabusAnalysis().');
+            }
+            if (requestParameters['triggerSyllabusAnalysisRequest'] == null) {
+                throw new runtime.RequiredError('triggerSyllabusAnalysisRequest', 'Required parameter "triggerSyllabusAnalysisRequest" was null or undefined when calling triggerSyllabusAnalysis().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            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/syllabus-analysis`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: TriggerSyllabusAnalysisRequestToJSON(requestParameters['triggerSyllabusAnalysisRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SyllabusAnalysisStatusFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Begins LLM-driven extraction of graded assessments (exams) from a course syllabus and returns a 202 status snapshot; analysis runs in the background. Idempotent per student+course: an unchanged, already-analyzed syllabus is a no-op that returns the previously derived objectives. The Canvas API token is read from the `X-Canvas-Token` header (used downstream to resolve any referenced file content); `canvasDomain` is part of the request body.
+     * Trigger syllabus analysis
+     */
+    triggerSyllabusAnalysis(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.triggerSyllabusAnalysisRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -21,6 +21,7 @@ export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPrepApi';
+export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

package/dist/esm/apis/index.js

@@ -23,6 +23,7 @@ export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPrepApi';
+export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

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

@@ -35,6 +35,12 @@ export interface StudyObjective {
      * @memberof StudyObjective
      */
     courseId: string;
+    /**
+     * Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    source: StudyObjectiveSourceEnum;
     /**
      *
      * @type {string}
@@ -78,6 +84,14 @@ export interface StudyObjective {
      */
     updatedAt: Date;
 }
+/**
+ * @export
+ */
+export declare const StudyObjectiveSourceEnum: {
+    readonly User: "user";
+    readonly Syllabus: "syllabus";
+};
+export type StudyObjectiveSourceEnum = typeof StudyObjectiveSourceEnum[keyof typeof StudyObjectiveSourceEnum];
 /**
  * Check if a given object implements the StudyObjective interface.
  */

package/dist/esm/models/StudyObjective.js

@@ -13,6 +13,13 @@
  */
 import { StudyObjectiveFileAttachmentFromJSON, StudyObjectiveFileAttachmentToJSON, } from './StudyObjectiveFileAttachment';
 import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSON, } from './StudyObjectiveCanvasDocument';
+/**
+ * @export
+ */
+export const StudyObjectiveSourceEnum = {
+    User: 'user',
+    Syllabus: 'syllabus'
+};
 /**
  * Check if a given object implements the StudyObjective interface.
  */
@@ -23,6 +30,8 @@ export function instanceOfStudyObjective(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('notes' in value) || value['notes'] === undefined)
@@ -50,6 +59,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
         'courseId': json['courseId'],
+        'source': json['source'],
         'title': json['title'],
         'notes': json['notes'],
         'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
@@ -70,6 +80,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'accountUserId': value['accountUserId'],
         'courseId': value['courseId'],
+        'source': value['source'],
         'title': value['title'],
         'notes': value['notes'],
         'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),

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

@@ -0,0 +1,64 @@
+/**
+ * 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 SyllabusAnalysisObjective
+ */
+export interface SyllabusAnalysisObjective {
+    /**
+     *
+     * @type {string}
+     * @memberof SyllabusAnalysisObjective
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SyllabusAnalysisObjective
+     */
+    courseId: string;
+    /**
+     * Origin of the objective. Always 'syllabus' for analysis results.
+     * @type {string}
+     * @memberof SyllabusAnalysisObjective
+     */
+    source: SyllabusAnalysisObjectiveSourceEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SyllabusAnalysisObjective
+     */
+    title: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof SyllabusAnalysisObjective
+     */
+    dueAt: Date | null;
+}
+/**
+ * @export
+ */
+export declare const SyllabusAnalysisObjectiveSourceEnum: {
+    readonly User: "user";
+    readonly Syllabus: "syllabus";
+};
+export type SyllabusAnalysisObjectiveSourceEnum = typeof SyllabusAnalysisObjectiveSourceEnum[keyof typeof SyllabusAnalysisObjectiveSourceEnum];
+/**
+ * Check if a given object implements the SyllabusAnalysisObjective interface.
+ */
+export declare function instanceOfSyllabusAnalysisObjective(value: object): value is SyllabusAnalysisObjective;
+export declare function SyllabusAnalysisObjectiveFromJSON(json: any): SyllabusAnalysisObjective;
+export declare function SyllabusAnalysisObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyllabusAnalysisObjective;
+export declare function SyllabusAnalysisObjectiveToJSON(json: any): SyllabusAnalysisObjective;
+export declare function SyllabusAnalysisObjectiveToJSONTyped(value?: SyllabusAnalysisObjective | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SyllabusAnalysisObjective.js

@@ -0,0 +1,66 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const SyllabusAnalysisObjectiveSourceEnum = {
+    User: 'user',
+    Syllabus: 'syllabus'
+};
+/**
+ * Check if a given object implements the SyllabusAnalysisObjective interface.
+ */
+export function instanceOfSyllabusAnalysisObjective(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('dueAt' in value) || value['dueAt'] === undefined)
+        return false;
+    return true;
+}
+export function SyllabusAnalysisObjectiveFromJSON(json) {
+    return SyllabusAnalysisObjectiveFromJSONTyped(json, false);
+}
+export function SyllabusAnalysisObjectiveFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseId': json['courseId'],
+        'source': json['source'],
+        'title': json['title'],
+        'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
+    };
+}
+export function SyllabusAnalysisObjectiveToJSON(json) {
+    return SyllabusAnalysisObjectiveToJSONTyped(json, false);
+}
+export function SyllabusAnalysisObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'courseId': value['courseId'],
+        'source': value['source'],
+        'title': value['title'],
+        'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+    };
+}