@instructure/athena-api-client 3.20.4 → 3.22.0

package/dist/esm/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/esm/apis/StudyPlansApi.js

@@ -0,0 +1,202 @@
+/* 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 { CreateStudyPlanDtoToJSON, StudyPlanFromJSON, StudyPlanActivityFromJSON, UpdateActivityCompletionDtoToJSON, } from '../models/index';
+/**
+ *
+ */
+export 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) => 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: CreateStudyPlanDtoToJSON(requestParameters['createStudyPlanDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => 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: UpdateActivityCompletionDtoToJSON(requestParameters['updateActivityCompletionDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => 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();
+        });
+    }
+}

package/dist/esm/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/esm/apis/index.js

@@ -22,6 +22,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/esm/models/CreateObjectiveResourceDto.d.ts

@@ -27,6 +27,12 @@ export interface CreateObjectiveResourceDto {
      * @memberof CreateObjectiveResourceDto
      */
     resourceType: CreateObjectiveResourceDtoResourceTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateObjectiveResourceDto
+     */
+    studyPlanActivityId?: string | null;
 }
 /**
  * @export
@@ -35,6 +41,7 @@ export declare const CreateObjectiveResourceDtoResourceTypeEnum: {
     readonly Chat: "chat";
     readonly Quiz: "quiz";
     readonly Flashcard: "flashcard";
+    readonly PlanActivity: "plan-activity";
 };
 export type CreateObjectiveResourceDtoResourceTypeEnum = typeof CreateObjectiveResourceDtoResourceTypeEnum[keyof typeof CreateObjectiveResourceDtoResourceTypeEnum];
 /**

package/dist/esm/models/CreateObjectiveResourceDto.js

@@ -17,7 +17,8 @@
 export const CreateObjectiveResourceDtoResourceTypeEnum = {
     Chat: 'chat',
     Quiz: 'quiz',
-    Flashcard: 'flashcard'
+    Flashcard: 'flashcard',
+    PlanActivity: 'plan-activity'
 };
 /**
  * Check if a given object implements the CreateObjectiveResourceDto interface.
@@ -39,6 +40,7 @@ export function CreateObjectiveResourceDtoFromJSONTyped(json, ignoreDiscriminato
     return {
         'chatId': json['chatId'],
         'resourceType': json['resourceType'],
+        'studyPlanActivityId': json['studyPlanActivityId'] == null ? undefined : json['studyPlanActivityId'],
     };
 }
 export function CreateObjectiveResourceDtoToJSON(json) {
@@ -51,5 +53,6 @@ export function CreateObjectiveResourceDtoToJSONTyped(value, ignoreDiscriminator
     return {
         'chatId': value['chatId'],
         'resourceType': value['resourceType'],
+        'studyPlanActivityId': value['studyPlanActivityId'],
     };
 }

package/dist/esm/models/CreateStudyPlanDto.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 { CreateStudyPlanDtoActivitiesInner } from './CreateStudyPlanDtoActivitiesInner';
+/**
+ *
+ * @export
+ * @interface CreateStudyPlanDto
+ */
+export interface CreateStudyPlanDto {
+    /**
+     *
+     * @type {Array<CreateStudyPlanDtoActivitiesInner>}
+     * @memberof CreateStudyPlanDto
+     */
+    activities: Array<CreateStudyPlanDtoActivitiesInner>;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDto
+     */
+    sourceToolCallId?: string | null;
+}
+/**
+ * Check if a given object implements the CreateStudyPlanDto interface.
+ */
+export declare function instanceOfCreateStudyPlanDto(value: object): value is CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoFromJSON(json: any): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoToJSON(json: any): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoToJSONTyped(value?: CreateStudyPlanDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyPlanDto.js

@@ -0,0 +1,46 @@
+/* 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 { CreateStudyPlanDtoActivitiesInnerFromJSON, CreateStudyPlanDtoActivitiesInnerToJSON, } from './CreateStudyPlanDtoActivitiesInner';
+/**
+ * Check if a given object implements the CreateStudyPlanDto interface.
+ */
+export function instanceOfCreateStudyPlanDto(value) {
+    if (!('activities' in value) || value['activities'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyPlanDtoFromJSON(json) {
+    return CreateStudyPlanDtoFromJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activities': (json['activities'].map(CreateStudyPlanDtoActivitiesInnerFromJSON)),
+        'sourceToolCallId': json['sourceToolCallId'] == null ? undefined : json['sourceToolCallId'],
+    };
+}
+export function CreateStudyPlanDtoToJSON(json) {
+    return CreateStudyPlanDtoToJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activities': (value['activities'].map(CreateStudyPlanDtoActivitiesInnerToJSON)),
+        'sourceToolCallId': value['sourceToolCallId'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 CreateStudyPlanDtoActivitiesInner
+ */
+export interface CreateStudyPlanDtoActivitiesInner {
+    /**
+     *
+     * @type {number}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    position: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    label?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    duration?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
+ */
+export declare function instanceOfCreateStudyPlanDtoActivitiesInner(value: object): value is CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerFromJSON(json: any): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerToJSON(json: any): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value?: CreateStudyPlanDtoActivitiesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyPlanDtoActivitiesInner.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
+ */
+export function instanceOfCreateStudyPlanDtoActivitiesInner(value) {
+    if (!('position' in value) || value['position'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyPlanDtoActivitiesInnerFromJSON(json) {
+    return CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'position': json['position'],
+        'label': json['label'] == null ? undefined : json['label'],
+        'duration': json['duration'] == null ? undefined : json['duration'],
+        'title': json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function CreateStudyPlanDtoActivitiesInnerToJSON(json) {
+    return CreateStudyPlanDtoActivitiesInnerToJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'position': value['position'],
+        'label': value['label'],
+        'duration': value['duration'],
+        'title': value['title'],
+        'description': value['description'],
+    };
+}

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

@@ -45,6 +45,12 @@ export interface ObjectiveResource {
      * @memberof ObjectiveResource
      */
     resourceType: ObjectiveResourceResourceTypeEnum;
+    /**
+     * The study plan activity this chat was started from, or null when it was not launched from one. Goes null if that plan is later replaced or deleted — the resource itself survives.
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    studyPlanActivityId: string | null;
     /**
      *
      * @type {Date}
@@ -59,6 +65,7 @@ export declare const ObjectiveResourceResourceTypeEnum: {
     readonly Chat: "chat";
     readonly Quiz: "quiz";
     readonly Flashcard: "flashcard";
+    readonly PlanActivity: "plan-activity";
 };
 export type ObjectiveResourceResourceTypeEnum = typeof ObjectiveResourceResourceTypeEnum[keyof typeof ObjectiveResourceResourceTypeEnum];
 /**

package/dist/esm/models/ObjectiveResource.js

@@ -17,7 +17,8 @@
 export const ObjectiveResourceResourceTypeEnum = {
     Chat: 'chat',
     Quiz: 'quiz',
-    Flashcard: 'flashcard'
+    Flashcard: 'flashcard',
+    PlanActivity: 'plan-activity'
 };
 /**
  * Check if a given object implements the ObjectiveResource interface.
@@ -33,6 +34,8 @@ export function instanceOfObjectiveResource(value) {
         return false;
     if (!('resourceType' in value) || value['resourceType'] === undefined)
         return false;
+    if (!('studyPlanActivityId' in value) || value['studyPlanActivityId'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -50,6 +53,7 @@ export function ObjectiveResourceFromJSONTyped(json, ignoreDiscriminator) {
         'accountUserId': json['accountUserId'],
         'chatId': json['chatId'],
         'resourceType': json['resourceType'],
+        'studyPlanActivityId': json['studyPlanActivityId'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -66,6 +70,7 @@ export function ObjectiveResourceToJSONTyped(value, ignoreDiscriminator = false)
         'accountUserId': value['accountUserId'],
         'chatId': value['chatId'],
         'resourceType': value['resourceType'],
+        'studyPlanActivityId': value['studyPlanActivityId'],
         'createdAt': value['createdAt'].toISOString(),
     };
 }