@instructure/athena-api-client 3.21.0 → 3.22.0

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/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) {

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/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(),
     };
 }

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

@@ -63,6 +63,12 @@ export interface StudyPlanActivity {
      * @memberof StudyPlanActivity
      */
     completedAt: Date | null;
+    /**
+     * The most recent chat started from this activity, or null when it has never been started. Reopen this chat rather than starting a second one.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    chatId: string | null;
 }
 /**
  * Check if a given object implements the StudyPlanActivity interface.

package/dist/esm/models/StudyPlanActivity.js

@@ -31,6 +31,8 @@ export function instanceOfStudyPlanActivity(value) {
         return false;
     if (!('completedAt' in value) || value['completedAt'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     return true;
 }
 export function StudyPlanActivityFromJSON(json) {
@@ -49,6 +51,7 @@ export function StudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'description': json['description'],
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'chatId': json['chatId'],
     };
 }
 export function StudyPlanActivityToJSON(json) {
@@ -67,5 +70,6 @@ export function StudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false)
         'title': value['title'],
         'description': value['description'],
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'chatId': value['chatId'],
     };
 }

package/dist/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/models/CreateObjectiveResourceDto.js

@@ -25,7 +25,8 @@ exports.CreateObjectiveResourceDtoToJSONTyped = CreateObjectiveResourceDtoToJSON
 exports.CreateObjectiveResourceDtoResourceTypeEnum = {
     Chat: 'chat',
     Quiz: 'quiz',
-    Flashcard: 'flashcard'
+    Flashcard: 'flashcard',
+    PlanActivity: 'plan-activity'
 };
 /**
  * Check if a given object implements the CreateObjectiveResourceDto interface.
@@ -47,6 +48,7 @@ function CreateObjectiveResourceDtoFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'chatId': json['chatId'],
         'resourceType': json['resourceType'],
+        'studyPlanActivityId': json['studyPlanActivityId'] == null ? undefined : json['studyPlanActivityId'],
     };
 }
 function CreateObjectiveResourceDtoToJSON(json) {
@@ -59,5 +61,6 @@ function CreateObjectiveResourceDtoToJSONTyped(value, ignoreDiscriminator = fals
     return {
         'chatId': value['chatId'],
         'resourceType': value['resourceType'],
+        'studyPlanActivityId': value['studyPlanActivityId'],
     };
 }

package/dist/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/models/ObjectiveResource.js

@@ -25,7 +25,8 @@ exports.ObjectiveResourceToJSONTyped = ObjectiveResourceToJSONTyped;
 exports.ObjectiveResourceResourceTypeEnum = {
     Chat: 'chat',
     Quiz: 'quiz',
-    Flashcard: 'flashcard'
+    Flashcard: 'flashcard',
+    PlanActivity: 'plan-activity'
 };
 /**
  * Check if a given object implements the ObjectiveResource interface.
@@ -41,6 +42,8 @@ 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;
@@ -58,6 +61,7 @@ function ObjectiveResourceFromJSONTyped(json, ignoreDiscriminator) {
         'accountUserId': json['accountUserId'],
         'chatId': json['chatId'],
         'resourceType': json['resourceType'],
+        'studyPlanActivityId': json['studyPlanActivityId'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -74,6 +78,7 @@ function ObjectiveResourceToJSONTyped(value, ignoreDiscriminator = false) {
         'accountUserId': value['accountUserId'],
         'chatId': value['chatId'],
         'resourceType': value['resourceType'],
+        'studyPlanActivityId': value['studyPlanActivityId'],
         'createdAt': value['createdAt'].toISOString(),
     };
 }

package/dist/models/StudyPlanActivity.d.ts

@@ -63,6 +63,12 @@ export interface StudyPlanActivity {
      * @memberof StudyPlanActivity
      */
     completedAt: Date | null;
+    /**
+     * The most recent chat started from this activity, or null when it has never been started. Reopen this chat rather than starting a second one.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    chatId: string | null;
 }
 /**
  * Check if a given object implements the StudyPlanActivity interface.

package/dist/models/StudyPlanActivity.js

@@ -38,6 +38,8 @@ function instanceOfStudyPlanActivity(value) {
         return false;
     if (!('completedAt' in value) || value['completedAt'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     return true;
 }
 function StudyPlanActivityFromJSON(json) {
@@ -56,6 +58,7 @@ function StudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'description': json['description'],
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'chatId': json['chatId'],
     };
 }
 function StudyPlanActivityToJSON(json) {
@@ -74,5 +77,6 @@ function StudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'description': value['description'],
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'chatId': value['chatId'],
     };
 }

package/package.json

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