@instructure/athena-api-client 3.20.4 → 3.22.0

package/README.md

@@ -93,6 +93,7 @@ All URIs are relative to *http://localhost:3000*
 *FeaturesApi* | [**deleteFeature**](docs/FeaturesApi.md#deletefeature) | **DELETE** /api/v1/features/{id} | Delete a feature
 *FeaturesApi* | [**getFeature**](docs/FeaturesApi.md#getfeature) | **GET** /api/v1/features/{id} | Get feature by ID
 *FeaturesApi* | [**listFeatures**](docs/FeaturesApi.md#listfeatures) | **GET** /api/v1/features | List all features
+*FeaturesApi* | [**listMyFeatures**](docs/FeaturesApi.md#listmyfeatures) | **GET** /api/v1/me/features | List the calling user\'s enabled features
 *FeaturesApi* | [**updateFeature**](docs/FeaturesApi.md#updatefeature) | **PATCH** /api/v1/features/{id} | Update a feature
 *FilesApi* | [**getFileUploadUrls**](docs/FilesApi.md#getfileuploadurls) | **POST** /api/v1/files/upload-url | Get presigned upload URLs
 *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint
@@ -139,6 +140,10 @@ All URIs are relative to *http://localhost:3000*
 *StudyObjectivesApi* | [**listStudyObjectiveQuizzes**](docs/StudyObjectivesApi.md#liststudyobjectivequizzes) | **GET** /api/v1/study-objectives/{studyObjectiveId}/quizzes | List quizzes and flashcards for a study objective
 *StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course
 *StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective
+*StudyPlansApi* | [**deleteStudyPlan**](docs/StudyPlansApi.md#deletestudyplan) | **DELETE** /api/v1/study-plans/{planId} | Delete a study plan
+*StudyPlansApi* | [**getStudyObjectiveStudyPlan**](docs/StudyPlansApi.md#getstudyobjectivestudyplan) | **GET** /api/v1/study-objectives/{studyObjectiveId}/study-plan | Get a study objective\'s plan
+*StudyPlansApi* | [**saveStudyObjectiveStudyPlan**](docs/StudyPlansApi.md#savestudyobjectivestudyplan) | **POST** /api/v1/study-objectives/{studyObjectiveId}/study-plan | Save (or replace) a study objective\'s plan
+*StudyPlansApi* | [**updateStudyPlanActivityCompletion**](docs/StudyPlansApi.md#updatestudyplanactivitycompletion) | **PATCH** /api/v1/study-plan-activities/{activityId} | Mark a plan activity complete or incomplete
 *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
@@ -226,6 +231,8 @@ All URIs are relative to *http://localhost:3000*
 - [CreateStudyObjectiveDto](docs/CreateStudyObjectiveDto.md)
 - [CreateStudyObjectiveDtoCanvasDocumentsInner](docs/CreateStudyObjectiveDtoCanvasDocumentsInner.md)
 - [CreateStudyObjectiveDtoCanvasObject](docs/CreateStudyObjectiveDtoCanvasObject.md)
+- [CreateStudyPlanDto](docs/CreateStudyPlanDto.md)
+- [CreateStudyPlanDtoActivitiesInner](docs/CreateStudyPlanDtoActivitiesInner.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
@@ -278,6 +285,8 @@ All URIs are relative to *http://localhost:3000*
 - [StudyObjectiveConceptAttachmentList](docs/StudyObjectiveConceptAttachmentList.md)
 - [StudyObjectiveConceptSummary](docs/StudyObjectiveConceptSummary.md)
 - [StudyObjectiveFileAttachment](docs/StudyObjectiveFileAttachment.md)
+- [StudyPlan](docs/StudyPlan.md)
+- [StudyPlanActivity](docs/StudyPlanActivity.md)
 - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
 - [SyllabusAnalysisObjective](docs/SyllabusAnalysisObjective.md)
 - [SyllabusAnalysisStatus](docs/SyllabusAnalysisStatus.md)
@@ -297,6 +306,7 @@ All URIs are relative to *http://localhost:3000*
 - [TriggerSyllabusAnalysisRequest](docs/TriggerSyllabusAnalysisRequest.md)
 - [TriggerSyllabusAnalysisRequestFile](docs/TriggerSyllabusAnalysisRequestFile.md)
 - [UpdateAccountDto](docs/UpdateAccountDto.md)
+- [UpdateActivityCompletionDto](docs/UpdateActivityCompletionDto.md)
 - [UpdateChatRequest](docs/UpdateChatRequest.md)
 - [UpdateFeatureDto](docs/UpdateFeatureDto.md)
 - [UpdatePlanDto](docs/UpdatePlanDto.md)
@@ -315,6 +325,7 @@ All URIs are relative to *http://localhost:3000*
 - [UserConcept](docs/UserConcept.md)
 - [UserConceptConcept](docs/UserConceptConcept.md)
 - [UserContext](docs/UserContext.md)
+- [UserFeatures](docs/UserFeatures.md)
 - [UserFile](docs/UserFile.md)
 - [UserFileAssociation](docs/UserFileAssociation.md)
 - [UserFileUploadUrlFile](docs/UserFileUploadUrlFile.md)

package/dist/apis/FeaturesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateFeatureDto, FeatureEntity, UpdateFeatureDto } from '../models/index';
+import type { CreateFeatureDto, FeatureEntity, UpdateFeatureDto, UserFeatures } from '../models/index';
 export interface CreateFeatureRequest {
     createFeatureDto: CreateFeatureDto;
 }
@@ -20,6 +20,9 @@ export interface DeleteFeatureRequest {
 export interface GetFeatureRequest {
     id: string;
 }
+export interface ListMyFeaturesRequest {
+    xUserId: string;
+}
 export interface UpdateFeatureRequest {
     id: string;
     updateFeatureDto: UpdateFeatureDto;
@@ -60,6 +63,16 @@ export declare class FeaturesApi extends runtime.BaseAPI {
      * List all features
      */
     listFeatures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FeatureEntity>>;
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeaturesRaw(requestParameters: ListMyFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserFeatures>>;
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeatures(requestParameters: ListMyFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserFeatures>;
     /**
      * Update a feature
      */

package/dist/apis/FeaturesApi.js

@@ -157,6 +157,43 @@ class FeaturesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeaturesRaw(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 listMyFeatures().');
+            }
+            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/me/features`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserFeaturesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeatures(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listMyFeaturesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Update a feature
      */

package/dist/apis/StudyObjectivesApi.d.ts

@@ -64,12 +64,12 @@ export interface UpdateStudyObjectiveRequest {
  */
 export declare class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResourceRaw(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectiveResource>>;
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;

package/dist/apis/StudyObjectivesApi.js

@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
  */
 class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResourceRaw(requestParameters, initOverrides) {
@@ -66,7 +66,7 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters, initOverrides) {

package/dist/apis/StudyPlansApi.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index';
+export interface DeleteStudyPlanRequest {
+    xUserId: string;
+    planId: string;
+}
+export interface GetStudyObjectiveStudyPlanRequest {
+    xUserId: string;
+    studyObjectiveId: string;
+}
+export interface SaveStudyObjectiveStudyPlanRequest {
+    xUserId: string;
+    studyObjectiveId: string;
+    createStudyPlanDto: CreateStudyPlanDto;
+}
+export interface UpdateStudyPlanActivityCompletionRequest {
+    xUserId: string;
+    activityId: string;
+    updateActivityCompletionDto: UpdateActivityCompletionDto;
+}
+/**
+ *
+ */
+export declare class StudyPlansApi extends runtime.BaseAPI {
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlanRaw(requestParameters: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlan(requestParameters: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlanRaw(requestParameters: GetStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyPlan>>;
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlan(requestParameters: GetStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyPlan>;
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlanRaw(requestParameters: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyPlan>>;
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlan(requestParameters: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyPlan>;
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletionRaw(requestParameters: UpdateStudyPlanActivityCompletionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyPlanActivity>>;
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletion(requestParameters: UpdateStudyPlanActivityCompletionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyPlanActivity>;
+}

package/dist/apis/StudyPlansApi.js

@@ -0,0 +1,206 @@
+"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.StudyPlansApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class StudyPlansApi extends runtime.BaseAPI {
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlanRaw(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 deleteStudyPlan().');
+            }
+            if (requestParameters['planId'] == null) {
+                throw new runtime.RequiredError('planId', 'Required parameter "planId" was null or undefined when calling deleteStudyPlan().');
+            }
+            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/study-plans/{planId}`;
+            urlPath = urlPath.replace(`{${"planId"}}`, encodeURIComponent(String(requestParameters['planId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteStudyPlanRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlanRaw(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 getStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling getStudyObjectiveStudyPlan().');
+            }
+            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/study-objectives/{studyObjectiveId}/study-plan`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyPlanFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStudyObjectiveStudyPlanRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlanRaw(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 saveStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling saveStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['createStudyPlanDto'] == null) {
+                throw new runtime.RequiredError('createStudyPlanDto', 'Required parameter "createStudyPlanDto" was null or undefined when calling saveStudyObjectiveStudyPlan().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/study-objectives/{studyObjectiveId}/study-plan`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateStudyPlanDtoToJSON)(requestParameters['createStudyPlanDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyPlanFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.saveStudyObjectiveStudyPlanRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletionRaw(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 updateStudyPlanActivityCompletion().');
+            }
+            if (requestParameters['activityId'] == null) {
+                throw new runtime.RequiredError('activityId', 'Required parameter "activityId" was null or undefined when calling updateStudyPlanActivityCompletion().');
+            }
+            if (requestParameters['updateActivityCompletionDto'] == null) {
+                throw new runtime.RequiredError('updateActivityCompletionDto', 'Required parameter "updateActivityCompletionDto" was null or undefined when calling updateStudyPlanActivityCompletion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/study-plan-activities/{activityId}`;
+            urlPath = urlPath.replace(`{${"activityId"}}`, encodeURIComponent(String(requestParameters['activityId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateActivityCompletionDtoToJSON)(requestParameters['updateActivityCompletionDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyPlanActivityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateStudyPlanActivityCompletionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.StudyPlansApi = StudyPlansApi;

package/dist/apis/index.d.ts

@@ -20,6 +20,7 @@ export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
+export * from './StudyPlansApi';
 export * from './StudyPrepApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';

package/dist/apis/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);
+__exportStar(require("./StudyPlansApi"), exports);
 __exportStar(require("./StudyPrepApi"), exports);
 __exportStar(require("./SyllabusAnalysisApi"), exports);
 __exportStar(require("./TagsApi"), exports);

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateFeatureDto, FeatureEntity, UpdateFeatureDto } from '../models/index';
+import type { CreateFeatureDto, FeatureEntity, UpdateFeatureDto, UserFeatures } from '../models/index';
 export interface CreateFeatureRequest {
     createFeatureDto: CreateFeatureDto;
 }
@@ -20,6 +20,9 @@ export interface DeleteFeatureRequest {
 export interface GetFeatureRequest {
     id: string;
 }
+export interface ListMyFeaturesRequest {
+    xUserId: string;
+}
 export interface UpdateFeatureRequest {
     id: string;
     updateFeatureDto: UpdateFeatureDto;
@@ -60,6 +63,16 @@ export declare class FeaturesApi extends runtime.BaseAPI {
      * List all features
      */
     listFeatures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FeatureEntity>>;
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeaturesRaw(requestParameters: ListMyFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserFeatures>>;
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeatures(requestParameters: ListMyFeaturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserFeatures>;
     /**
      * Update a feature
      */

package/dist/esm/apis/FeaturesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateFeatureDtoToJSON, FeatureEntityFromJSON, UpdateFeatureDtoToJSON, } from '../models/index';
+import { CreateFeatureDtoToJSON, FeatureEntityFromJSON, UpdateFeatureDtoToJSON, UserFeaturesFromJSON, } from '../models/index';
 /**
  *
  */
@@ -154,6 +154,43 @@ export class FeaturesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeaturesRaw(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 listMyFeatures().');
+            }
+            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/me/features`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UserFeaturesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the names of every feature the authenticated user is entitled to, resolved across all of their accounts via plan rank and per-account overrides.
+     * List the calling user\'s enabled features
+     */
+    listMyFeatures(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listMyFeaturesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Update a feature
      */

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

@@ -64,12 +64,12 @@ export interface UpdateStudyObjectiveRequest {
  */
 export declare class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResourceRaw(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ObjectiveResource>>;
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;

package/dist/esm/apis/StudyObjectivesApi.js

@@ -27,7 +27,7 @@ import { CreateObjectiveResourceDtoToJSON, CreateStudyObjectiveDtoToJSON, Object
  */
 export class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResourceRaw(requestParameters, initOverrides) {
@@ -63,7 +63,7 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Records that a chat (regular chat, quiz, flashcard, or plan activity) is being used in service of a study objective. Pass `studyPlanActivityId` to record which study plan activity the chat was started from — required for `plan-activity` resources — which grounds the chat in that activity and marks it complete.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters, initOverrides) {