@instructure/athena-api-client 3.37.11 → 3.38.1

package/dist/apis/StudyPlansApi.d.ts

@@ -68,12 +68,12 @@ export declare class StudyPlansApi extends runtime.BaseAPI {
      */
     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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlan(requestParameters: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyPlan>;

package/dist/apis/StudyPlansApi.js

@@ -152,7 +152,7 @@ class StudyPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlanRaw(requestParameters, initOverrides) {
@@ -188,7 +188,7 @@ class StudyPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlan(requestParameters, initOverrides) {

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

@@ -68,12 +68,12 @@ export declare class StudyPlansApi extends runtime.BaseAPI {
      */
     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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlan(requestParameters: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyPlan>;

package/dist/esm/apis/StudyPlansApi.js

@@ -149,7 +149,7 @@ export class StudyPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlanRaw(requestParameters, initOverrides) {
@@ -185,7 +185,7 @@ export class StudyPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. Each activity has a `kind` (default `chat`); a `tutor-me` activity must name a `conceptId` from the objective\'s concept roster.
      * Save (or replace) a study objective\'s plan
      */
     saveStudyObjectiveStudyPlan(requestParameters, initOverrides) {

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

@@ -45,7 +45,27 @@ export interface CreateStudyPlanDtoActivitiesInner {
      * @memberof CreateStudyPlanDtoActivitiesInner
      */
     description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    kind?: CreateStudyPlanDtoActivitiesInnerKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    conceptId?: string | null;
 }
+/**
+ * @export
+ */
+export declare const CreateStudyPlanDtoActivitiesInnerKindEnum: {
+    readonly Chat: "chat";
+    readonly TutorMe: "tutor-me";
+};
+export type CreateStudyPlanDtoActivitiesInnerKindEnum = typeof CreateStudyPlanDtoActivitiesInnerKindEnum[keyof typeof CreateStudyPlanDtoActivitiesInnerKindEnum];
 /**
  * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
  */

package/dist/esm/models/CreateStudyPlanDtoActivitiesInner.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const CreateStudyPlanDtoActivitiesInnerKindEnum = {
+    Chat: 'chat',
+    TutorMe: 'tutor-me'
+};
 /**
  * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
  */
@@ -34,6 +41,8 @@ export function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, ignoreDiscr
         'duration': json['duration'] == null ? undefined : json['duration'],
         'title': json['title'],
         'description': json['description'] == null ? undefined : json['description'],
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
     };
 }
 export function CreateStudyPlanDtoActivitiesInnerToJSON(json) {
@@ -49,5 +58,7 @@ export function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value, ignoreDiscri
         'duration': value['duration'],
         'title': value['title'],
         'description': value['description'],
+        'kind': value['kind'],
+        'conceptId': value['conceptId'],
     };
 }

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

@@ -63,6 +63,24 @@ export interface StudyPlanActivity {
      * @memberof StudyPlanActivity
      */
     completedAt: Date | null;
+    /**
+     * What starting the activity launches. `chat` is a regular chat that runs the activity; `tutor-me` is a Level Up session on `conceptId`. This is the effective kind: a `tutor-me` activity whose concept no longer exists is reported as `chat`, so a `tutor-me` activity always has a non-null `conceptId`. Treat any unrecognized value as `chat`.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    kind: StudyPlanActivityKindEnum;
+    /**
+     * The concept a `tutor-me` activity tutors on. Always set for `tutor-me`, always null for `chat`.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    conceptId: string | null;
+    /**
+     * Name of the concept named by `conceptId`, for labelling the activity without a second fetch. Null whenever `conceptId` is null.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    conceptName: string | 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}
@@ -70,6 +88,14 @@ export interface StudyPlanActivity {
      */
     chatId: string | null;
 }
+/**
+ * @export
+ */
+export declare const StudyPlanActivityKindEnum: {
+    readonly Chat: "chat";
+    readonly TutorMe: "tutor-me";
+};
+export type StudyPlanActivityKindEnum = typeof StudyPlanActivityKindEnum[keyof typeof StudyPlanActivityKindEnum];
 /**
  * Check if a given object implements the StudyPlanActivity interface.
  */

package/dist/esm/models/StudyPlanActivity.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const StudyPlanActivityKindEnum = {
+    Chat: 'chat',
+    TutorMe: 'tutor-me'
+};
 /**
  * Check if a given object implements the StudyPlanActivity interface.
  */
@@ -31,6 +38,12 @@ export function instanceOfStudyPlanActivity(value) {
         return false;
     if (!('completedAt' in value) || value['completedAt'] === undefined)
         return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
     if (!('chatId' in value) || value['chatId'] === undefined)
         return false;
     return true;
@@ -51,6 +64,9 @@ export function StudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'description': json['description'],
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'kind': json['kind'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
         'chatId': json['chatId'],
     };
 }
@@ -70,6 +86,9 @@ export function StudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false)
         'title': value['title'],
         'description': value['description'],
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'kind': value['kind'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
         'chatId': value['chatId'],
     };
 }

package/dist/models/CreateStudyPlanDtoActivitiesInner.d.ts

@@ -45,7 +45,27 @@ export interface CreateStudyPlanDtoActivitiesInner {
      * @memberof CreateStudyPlanDtoActivitiesInner
      */
     description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    kind?: CreateStudyPlanDtoActivitiesInnerKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    conceptId?: string | null;
 }
+/**
+ * @export
+ */
+export declare const CreateStudyPlanDtoActivitiesInnerKindEnum: {
+    readonly Chat: "chat";
+    readonly TutorMe: "tutor-me";
+};
+export type CreateStudyPlanDtoActivitiesInnerKindEnum = typeof CreateStudyPlanDtoActivitiesInnerKindEnum[keyof typeof CreateStudyPlanDtoActivitiesInnerKindEnum];
 /**
  * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
  */

package/dist/models/CreateStudyPlanDtoActivitiesInner.js

@@ -13,11 +13,19 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateStudyPlanDtoActivitiesInnerKindEnum = void 0;
 exports.instanceOfCreateStudyPlanDtoActivitiesInner = instanceOfCreateStudyPlanDtoActivitiesInner;
 exports.CreateStudyPlanDtoActivitiesInnerFromJSON = CreateStudyPlanDtoActivitiesInnerFromJSON;
 exports.CreateStudyPlanDtoActivitiesInnerFromJSONTyped = CreateStudyPlanDtoActivitiesInnerFromJSONTyped;
 exports.CreateStudyPlanDtoActivitiesInnerToJSON = CreateStudyPlanDtoActivitiesInnerToJSON;
 exports.CreateStudyPlanDtoActivitiesInnerToJSONTyped = CreateStudyPlanDtoActivitiesInnerToJSONTyped;
+/**
+ * @export
+ */
+exports.CreateStudyPlanDtoActivitiesInnerKindEnum = {
+    Chat: 'chat',
+    TutorMe: 'tutor-me'
+};
 /**
  * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
  */
@@ -41,6 +49,8 @@ function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, ignoreDiscriminato
         'duration': json['duration'] == null ? undefined : json['duration'],
         'title': json['title'],
         'description': json['description'] == null ? undefined : json['description'],
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
     };
 }
 function CreateStudyPlanDtoActivitiesInnerToJSON(json) {
@@ -56,5 +66,7 @@ function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value, ignoreDiscriminator
         'duration': value['duration'],
         'title': value['title'],
         'description': value['description'],
+        'kind': value['kind'],
+        'conceptId': value['conceptId'],
     };
 }

package/dist/models/StudyPlanActivity.d.ts

@@ -63,6 +63,24 @@ export interface StudyPlanActivity {
      * @memberof StudyPlanActivity
      */
     completedAt: Date | null;
+    /**
+     * What starting the activity launches. `chat` is a regular chat that runs the activity; `tutor-me` is a Level Up session on `conceptId`. This is the effective kind: a `tutor-me` activity whose concept no longer exists is reported as `chat`, so a `tutor-me` activity always has a non-null `conceptId`. Treat any unrecognized value as `chat`.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    kind: StudyPlanActivityKindEnum;
+    /**
+     * The concept a `tutor-me` activity tutors on. Always set for `tutor-me`, always null for `chat`.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    conceptId: string | null;
+    /**
+     * Name of the concept named by `conceptId`, for labelling the activity without a second fetch. Null whenever `conceptId` is null.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    conceptName: string | 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}
@@ -70,6 +88,14 @@ export interface StudyPlanActivity {
      */
     chatId: string | null;
 }
+/**
+ * @export
+ */
+export declare const StudyPlanActivityKindEnum: {
+    readonly Chat: "chat";
+    readonly TutorMe: "tutor-me";
+};
+export type StudyPlanActivityKindEnum = typeof StudyPlanActivityKindEnum[keyof typeof StudyPlanActivityKindEnum];
 /**
  * Check if a given object implements the StudyPlanActivity interface.
  */

package/dist/models/StudyPlanActivity.js

@@ -13,11 +13,19 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StudyPlanActivityKindEnum = void 0;
 exports.instanceOfStudyPlanActivity = instanceOfStudyPlanActivity;
 exports.StudyPlanActivityFromJSON = StudyPlanActivityFromJSON;
 exports.StudyPlanActivityFromJSONTyped = StudyPlanActivityFromJSONTyped;
 exports.StudyPlanActivityToJSON = StudyPlanActivityToJSON;
 exports.StudyPlanActivityToJSONTyped = StudyPlanActivityToJSONTyped;
+/**
+ * @export
+ */
+exports.StudyPlanActivityKindEnum = {
+    Chat: 'chat',
+    TutorMe: 'tutor-me'
+};
 /**
  * Check if a given object implements the StudyPlanActivity interface.
  */
@@ -38,6 +46,12 @@ function instanceOfStudyPlanActivity(value) {
         return false;
     if (!('completedAt' in value) || value['completedAt'] === undefined)
         return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
     if (!('chatId' in value) || value['chatId'] === undefined)
         return false;
     return true;
@@ -58,6 +72,9 @@ function StudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'description': json['description'],
         'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'kind': json['kind'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
         'chatId': json['chatId'],
     };
 }
@@ -77,6 +94,9 @@ function StudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'description': value['description'],
         'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'kind': value['kind'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
         'chatId': value['chatId'],
     };
 }

package/package.json

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