@instructure/athena-api-client 3.32.0 → 3.33.1

package/dist/apis/ChatsApi.d.ts

@@ -41,6 +41,7 @@ export interface ResumeChatStreamRequest {
 export interface SendChatMessageRequest {
     xUserId: string;
     chatRequest: ChatRequest;
+    xUserFeatures?: string;
     xAthenaClient?: string;
     xCanvasDomain?: string;
     xCanvasToken?: string;

package/dist/apis/ChatsApi.js

@@ -310,6 +310,9 @@ class ChatsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserFeatures'] != null) {
+                headerParameters['X-User-Features'] = String(requestParameters['xUserFeatures']);
+            }
             if (requestParameters['xAthenaClient'] != null) {
                 headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
             }

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

@@ -41,6 +41,7 @@ export interface ResumeChatStreamRequest {
 export interface SendChatMessageRequest {
     xUserId: string;
     chatRequest: ChatRequest;
+    xUserFeatures?: string;
     xAthenaClient?: string;
     xCanvasDomain?: string;
     xCanvasToken?: string;

package/dist/esm/apis/ChatsApi.js

@@ -307,6 +307,9 @@ export class ChatsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserFeatures'] != null) {
+                headerParameters['X-User-Features'] = String(requestParameters['xUserFeatures']);
+            }
             if (requestParameters['xAthenaClient'] != null) {
                 headerParameters['X-Athena-Client'] = String(requestParameters['xAthenaClient']);
             }

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

@@ -46,6 +46,18 @@ export interface StudyPlan {
      * @memberof StudyPlan
      */
     sourceToolCallId: string | null;
+    /**
+     * The learner's readiness for the plan's owner at the moment the plan was saved, as a raw score in `[0, 1]` — scale it for display. `null` means readiness could not be determined then (concepts unavailable, the owner's concept roster not active yet, or no concepts at all) and is distinct from `0`, which is a real "no mastery" reading.
+     * @type {number}
+     * @memberof StudyPlan
+     */
+    readinessBefore: number | null;
+    /**
+     * The learner's readiness the first time the plan became fully complete, as a raw score in `[0, 1]`. Stamped once and never re-stamped, so it stays a stable historical claim — un-completing an activity does not clear it. `null` means the plan has never been fully complete, or readiness could not be determined at that moment; as with `readinessBefore`, `null` is distinct from `0`.
+     * @type {number}
+     * @memberof StudyPlan
+     */
+    readinessAfter: number | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/StudyPlan.js

@@ -32,6 +32,10 @@ export function instanceOfStudyPlan(value) {
         return false;
     if (!('sourceToolCallId' in value) || value['sourceToolCallId'] === undefined)
         return false;
+    if (!('readinessBefore' in value) || value['readinessBefore'] === undefined)
+        return false;
+    if (!('readinessAfter' in value) || value['readinessAfter'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -53,6 +57,8 @@ export function StudyPlanFromJSONTyped(json, ignoreDiscriminator) {
         'ownerType': json['ownerType'],
         'ownerId': json['ownerId'],
         'sourceToolCallId': json['sourceToolCallId'],
+        'readinessBefore': json['readinessBefore'],
+        'readinessAfter': json['readinessAfter'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
         'activities': (json['activities'].map(StudyPlanActivityFromJSON)),
@@ -71,6 +77,8 @@ export function StudyPlanToJSONTyped(value, ignoreDiscriminator = false) {
         'ownerType': value['ownerType'],
         'ownerId': value['ownerId'],
         'sourceToolCallId': value['sourceToolCallId'],
+        'readinessBefore': value['readinessBefore'],
+        'readinessAfter': value['readinessAfter'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
         'activities': (value['activities'].map(StudyPlanActivityToJSON)),

package/dist/models/StudyPlan.d.ts

@@ -46,6 +46,18 @@ export interface StudyPlan {
      * @memberof StudyPlan
      */
     sourceToolCallId: string | null;
+    /**
+     * The learner's readiness for the plan's owner at the moment the plan was saved, as a raw score in `[0, 1]` — scale it for display. `null` means readiness could not be determined then (concepts unavailable, the owner's concept roster not active yet, or no concepts at all) and is distinct from `0`, which is a real "no mastery" reading.
+     * @type {number}
+     * @memberof StudyPlan
+     */
+    readinessBefore: number | null;
+    /**
+     * The learner's readiness the first time the plan became fully complete, as a raw score in `[0, 1]`. Stamped once and never re-stamped, so it stays a stable historical claim — un-completing an activity does not clear it. `null` means the plan has never been fully complete, or readiness could not be determined at that moment; as with `readinessBefore`, `null` is distinct from `0`.
+     * @type {number}
+     * @memberof StudyPlan
+     */
+    readinessAfter: number | null;
     /**
      *
      * @type {Date}

package/dist/models/StudyPlan.js

@@ -40,6 +40,10 @@ function instanceOfStudyPlan(value) {
         return false;
     if (!('sourceToolCallId' in value) || value['sourceToolCallId'] === undefined)
         return false;
+    if (!('readinessBefore' in value) || value['readinessBefore'] === undefined)
+        return false;
+    if (!('readinessAfter' in value) || value['readinessAfter'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -61,6 +65,8 @@ function StudyPlanFromJSONTyped(json, ignoreDiscriminator) {
         'ownerType': json['ownerType'],
         'ownerId': json['ownerId'],
         'sourceToolCallId': json['sourceToolCallId'],
+        'readinessBefore': json['readinessBefore'],
+        'readinessAfter': json['readinessAfter'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
         'activities': (json['activities'].map(StudyPlanActivity_1.StudyPlanActivityFromJSON)),
@@ -79,6 +85,8 @@ function StudyPlanToJSONTyped(value, ignoreDiscriminator = false) {
         'ownerType': value['ownerType'],
         'ownerId': value['ownerId'],
         'sourceToolCallId': value['sourceToolCallId'],
+        'readinessBefore': value['readinessBefore'],
+        'readinessAfter': value['readinessAfter'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
         'activities': (value['activities'].map(StudyPlanActivity_1.StudyPlanActivityToJSON)),

package/package.json

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