@instructure/athena-api-client 3.31.1 → 3.32.0

package/README.md

@@ -144,6 +144,7 @@ All URIs are relative to *http://localhost:3000*
 *StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course or study space
 *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* | [**getChatStudyPlanActivity**](docs/StudyPlansApi.md#getchatstudyplanactivity) | **GET** /api/v1/chats/{chatId}/study-plan-activity | Get the study plan activity a chat was launched from
 *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
@@ -232,6 +233,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
+- [ChatStudyPlanActivity](docs/ChatStudyPlanActivity.md)
 - [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md)
 - [ConceptChange](docs/ConceptChange.md)
 - [CreateAccountRequest](docs/CreateAccountRequest.md)

package/dist/apis/StudyObjectivesApi.d.ts

@@ -65,12 +65,12 @@ export interface UpdateStudyObjectiveRequest {
  */
 export declare class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters, initOverrides) {

package/dist/apis/StudyPlansApi.d.ts

@@ -10,11 +10,15 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index';
+import type { ChatStudyPlanActivity, CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index';
 export interface DeleteStudyPlanRequest {
     xUserId: string;
     planId: string;
 }
+export interface GetChatStudyPlanActivityRequest {
+    xUserId: string;
+    chatId: string;
+}
 export interface GetStudyObjectiveStudyPlanRequest {
     xUserId: string;
     studyObjectiveId: string;
@@ -43,6 +47,16 @@ export declare class StudyPlansApi extends runtime.BaseAPI {
      * Delete a study plan
      */
     deleteStudyPlan(requestParameters: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivityRaw(requestParameters: GetChatStudyPlanActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatStudyPlanActivity>>;
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivity(requestParameters: GetChatStudyPlanActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatStudyPlanActivity>;
     /**
      * 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

package/dist/apis/StudyPlansApi.js

@@ -69,6 +69,47 @@ class StudyPlansApi extends runtime.BaseAPI {
             yield this.deleteStudyPlanRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivityRaw(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 getChatStudyPlanActivity().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatStudyPlanActivity().');
+            }
+            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/chats/{chatId}/study-plan-activity`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ChatStudyPlanActivityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivity(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getChatStudyPlanActivityRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * 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

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

@@ -65,12 +65,12 @@ export interface UpdateStudyObjectiveRequest {
  */
 export declare class StudyObjectivesApi extends runtime.BaseAPI {
     /**
-     * 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * 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, 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.
+     * 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. Linking does not complete the activity: completion is set only through `PATCH /api/v1/study-plan-activities/{activityId}`.
      * Attach a chat resource to a study objective
      */
     createObjectiveResource(requestParameters, initOverrides) {

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

@@ -10,11 +10,15 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index';
+import type { ChatStudyPlanActivity, CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index';
 export interface DeleteStudyPlanRequest {
     xUserId: string;
     planId: string;
 }
+export interface GetChatStudyPlanActivityRequest {
+    xUserId: string;
+    chatId: string;
+}
 export interface GetStudyObjectiveStudyPlanRequest {
     xUserId: string;
     studyObjectiveId: string;
@@ -43,6 +47,16 @@ export declare class StudyPlansApi extends runtime.BaseAPI {
      * Delete a study plan
      */
     deleteStudyPlan(requestParameters: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivityRaw(requestParameters: GetChatStudyPlanActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatStudyPlanActivity>>;
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivity(requestParameters: GetChatStudyPlanActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatStudyPlanActivity>;
     /**
      * 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

package/dist/esm/apis/StudyPlansApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateStudyPlanDtoToJSON, StudyPlanFromJSON, StudyPlanActivityFromJSON, UpdateActivityCompletionDtoToJSON, } from '../models/index';
+import { ChatStudyPlanActivityFromJSON, CreateStudyPlanDtoToJSON, StudyPlanFromJSON, StudyPlanActivityFromJSON, UpdateActivityCompletionDtoToJSON, } from '../models/index';
 /**
  *
  */
@@ -66,6 +66,47 @@ export class StudyPlansApi extends runtime.BaseAPI {
             yield this.deleteStudyPlanRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivityRaw(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 getChatStudyPlanActivity().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatStudyPlanActivity().');
+            }
+            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/chats/{chatId}/study-plan-activity`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ChatStudyPlanActivityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Answers, for a chat opened cold from history, whether it was launched from a study plan activity and whether that activity is done. Returns the activity with its position in the plan (`ordinal` of `total`) and the plan\'s study objective. 404 when the chat carries no activity link — including a link severed by a later plan replacement — or when the plan is not the caller\'s.
+     * Get the study plan activity a chat was launched from
+     */
+    getChatStudyPlanActivity(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getChatStudyPlanActivityRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * 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

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { StudyPlanActivity } from './StudyPlanActivity';
+/**
+ *
+ * @export
+ * @interface ChatStudyPlanActivity
+ */
+export interface ChatStudyPlanActivity {
+    /**
+     * The activity itself. Its `chatId` is the activity's most recent linked chat — the resume target — which is not necessarily the chat this was looked up by.
+     * @type {StudyPlanActivity}
+     * @memberof ChatStudyPlanActivity
+     */
+    activity: StudyPlanActivity;
+    /**
+     * 1-based position of the activity among the plan's position-ordered activities.
+     * @type {number}
+     * @memberof ChatStudyPlanActivity
+     */
+    ordinal: number;
+    /**
+     * How many activities the plan contains.
+     * @type {number}
+     * @memberof ChatStudyPlanActivity
+     */
+    total: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatStudyPlanActivity
+     */
+    studyPlanId: string;
+    /**
+     * The study objective the plan belongs to.
+     * @type {string}
+     * @memberof ChatStudyPlanActivity
+     */
+    studyObjectiveId: string;
+}
+/**
+ * Check if a given object implements the ChatStudyPlanActivity interface.
+ */
+export declare function instanceOfChatStudyPlanActivity(value: object): value is ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityFromJSON(json: any): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityToJSON(json: any): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityToJSONTyped(value?: ChatStudyPlanActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatStudyPlanActivity.js

@@ -0,0 +1,60 @@
+/* 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 { StudyPlanActivityFromJSON, StudyPlanActivityToJSON, } from './StudyPlanActivity';
+/**
+ * Check if a given object implements the ChatStudyPlanActivity interface.
+ */
+export function instanceOfChatStudyPlanActivity(value) {
+    if (!('activity' in value) || value['activity'] === undefined)
+        return false;
+    if (!('ordinal' in value) || value['ordinal'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('studyPlanId' in value) || value['studyPlanId'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    return true;
+}
+export function ChatStudyPlanActivityFromJSON(json) {
+    return ChatStudyPlanActivityFromJSONTyped(json, false);
+}
+export function ChatStudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activity': StudyPlanActivityFromJSON(json['activity']),
+        'ordinal': json['ordinal'],
+        'total': json['total'],
+        'studyPlanId': json['studyPlanId'],
+        'studyObjectiveId': json['studyObjectiveId'],
+    };
+}
+export function ChatStudyPlanActivityToJSON(json) {
+    return ChatStudyPlanActivityToJSONTyped(json, false);
+}
+export function ChatStudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activity': StudyPlanActivityToJSON(value['activity']),
+        'ordinal': value['ordinal'],
+        'total': value['total'],
+        'studyPlanId': value['studyPlanId'],
+        'studyObjectiveId': value['studyObjectiveId'],
+    };
+}

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

@@ -47,6 +47,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
 export * from './CreateAccountRequest';

package/dist/esm/models/index.js

@@ -49,6 +49,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
 export * from './CreateAccountRequest';

package/dist/models/ChatStudyPlanActivity.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { StudyPlanActivity } from './StudyPlanActivity';
+/**
+ *
+ * @export
+ * @interface ChatStudyPlanActivity
+ */
+export interface ChatStudyPlanActivity {
+    /**
+     * The activity itself. Its `chatId` is the activity's most recent linked chat — the resume target — which is not necessarily the chat this was looked up by.
+     * @type {StudyPlanActivity}
+     * @memberof ChatStudyPlanActivity
+     */
+    activity: StudyPlanActivity;
+    /**
+     * 1-based position of the activity among the plan's position-ordered activities.
+     * @type {number}
+     * @memberof ChatStudyPlanActivity
+     */
+    ordinal: number;
+    /**
+     * How many activities the plan contains.
+     * @type {number}
+     * @memberof ChatStudyPlanActivity
+     */
+    total: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatStudyPlanActivity
+     */
+    studyPlanId: string;
+    /**
+     * The study objective the plan belongs to.
+     * @type {string}
+     * @memberof ChatStudyPlanActivity
+     */
+    studyObjectiveId: string;
+}
+/**
+ * Check if a given object implements the ChatStudyPlanActivity interface.
+ */
+export declare function instanceOfChatStudyPlanActivity(value: object): value is ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityFromJSON(json: any): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityToJSON(json: any): ChatStudyPlanActivity;
+export declare function ChatStudyPlanActivityToJSONTyped(value?: ChatStudyPlanActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatStudyPlanActivity.js

@@ -0,0 +1,67 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfChatStudyPlanActivity = instanceOfChatStudyPlanActivity;
+exports.ChatStudyPlanActivityFromJSON = ChatStudyPlanActivityFromJSON;
+exports.ChatStudyPlanActivityFromJSONTyped = ChatStudyPlanActivityFromJSONTyped;
+exports.ChatStudyPlanActivityToJSON = ChatStudyPlanActivityToJSON;
+exports.ChatStudyPlanActivityToJSONTyped = ChatStudyPlanActivityToJSONTyped;
+const StudyPlanActivity_1 = require("./StudyPlanActivity");
+/**
+ * Check if a given object implements the ChatStudyPlanActivity interface.
+ */
+function instanceOfChatStudyPlanActivity(value) {
+    if (!('activity' in value) || value['activity'] === undefined)
+        return false;
+    if (!('ordinal' in value) || value['ordinal'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('studyPlanId' in value) || value['studyPlanId'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    return true;
+}
+function ChatStudyPlanActivityFromJSON(json) {
+    return ChatStudyPlanActivityFromJSONTyped(json, false);
+}
+function ChatStudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activity': (0, StudyPlanActivity_1.StudyPlanActivityFromJSON)(json['activity']),
+        'ordinal': json['ordinal'],
+        'total': json['total'],
+        'studyPlanId': json['studyPlanId'],
+        'studyObjectiveId': json['studyObjectiveId'],
+    };
+}
+function ChatStudyPlanActivityToJSON(json) {
+    return ChatStudyPlanActivityToJSONTyped(json, false);
+}
+function ChatStudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activity': (0, StudyPlanActivity_1.StudyPlanActivityToJSON)(value['activity']),
+        'ordinal': value['ordinal'],
+        'total': value['total'],
+        'studyPlanId': value['studyPlanId'],
+        'studyObjectiveId': value['studyObjectiveId'],
+    };
+}

package/dist/models/index.d.ts

@@ -47,6 +47,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
 export * from './CreateAccountRequest';

package/dist/models/index.js

@@ -65,6 +65,7 @@ __exportStar(require("./ChatRequestMessageMetadata"), exports);
 __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);
+__exportStar(require("./ChatStudyPlanActivity"), exports);
 __exportStar(require("./ConceptAssessmentEntity"), exports);
 __exportStar(require("./ConceptChange"), exports);
 __exportStar(require("./CreateAccountRequest"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.31.1",
+  "version": "3.32.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {