@instructure/athena-api-client 3.0.5 → 3.1.0

package/README.md

@@ -95,6 +95,7 @@ All URIs are relative to *http://localhost:3000*
 *LearningMomentsApi* | [**getLearningMomentsCount**](docs/LearningMomentsApi.md#getlearningmomentscount) | **GET** /api/v1/learning-moments/count | Get learning moments count
 *LearningMomentsApi* | [**listLearningMoments**](docs/LearningMomentsApi.md#listlearningmoments) | **GET** /api/v1/learning-moments | List learning moments
 *LearningSessionEvaluationsApi* | [**listLearningSessionEvaluations**](docs/LearningSessionEvaluationsApi.md#listlearningsessionevaluations) | **GET** /api/v1/chats/{chatId}/learning-session-evaluations | List learning session evaluations for a chat
+*LearningSessionEvaluationsApi* | [**listLearningSessionEvaluationsForConcept**](docs/LearningSessionEvaluationsApi.md#listlearningsessionevaluationsforconcept) | **GET** /api/v1/user-concepts/{conceptId}/learning-session-evaluations | List learning session evaluations for a concept
 *LearningStreakApi* | [**getLearningStreak**](docs/LearningStreakApi.md#getlearningstreak) | **GET** /api/v1/learning-streak | Get learning streak
 *MessagesApi* | [**createChatMessages**](docs/MessagesApi.md#createchatmessages) | **POST** /api/v1/chats/{chatId}/messages | Save messages to a chat
 *MessagesApi* | [**deleteMessages**](docs/MessagesApi.md#deletemessages) | **DELETE** /api/v1/chats/{chatId}/messages | Delete messages from timestamp

package/dist/apis/LearningSessionEvaluationsApi.d.ts

@@ -15,6 +15,10 @@ export interface ListLearningSessionEvaluationsRequest {
     chatId: string;
     xUserId: string;
 }
+export interface ListLearningSessionEvaluationsForConceptRequest {
+    conceptId: string;
+    xUserId: string;
+}
 /**
  *
  */
@@ -29,4 +33,14 @@ export declare class LearningSessionEvaluationsApi extends runtime.BaseAPI {
      * List learning session evaluations for a chat
      */
     listLearningSessionEvaluations(requestParameters: ListLearningSessionEvaluationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LearningSessionEvaluation>>;
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConceptRaw(requestParameters: ListLearningSessionEvaluationsForConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<LearningSessionEvaluation>>>;
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConcept(requestParameters: ListLearningSessionEvaluationsForConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LearningSessionEvaluation>>;
 }

package/dist/apis/LearningSessionEvaluationsApi.js

@@ -70,5 +70,46 @@ class LearningSessionEvaluationsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConceptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['conceptId'] == null) {
+                throw new runtime.RequiredError('conceptId', 'Required parameter "conceptId" was null or undefined when calling listLearningSessionEvaluationsForConcept().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listLearningSessionEvaluationsForConcept().');
+            }
+            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/user-concepts/{conceptId}/learning-session-evaluations`;
+            urlPath = urlPath.replace(`{${"conceptId"}}`, encodeURIComponent(String(requestParameters['conceptId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.LearningSessionEvaluationFromJSON));
+        });
+    }
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConcept(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listLearningSessionEvaluationsForConceptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 exports.LearningSessionEvaluationsApi = LearningSessionEvaluationsApi;

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

@@ -15,6 +15,10 @@ export interface ListLearningSessionEvaluationsRequest {
     chatId: string;
     xUserId: string;
 }
+export interface ListLearningSessionEvaluationsForConceptRequest {
+    conceptId: string;
+    xUserId: string;
+}
 /**
  *
  */
@@ -29,4 +33,14 @@ export declare class LearningSessionEvaluationsApi extends runtime.BaseAPI {
      * List learning session evaluations for a chat
      */
     listLearningSessionEvaluations(requestParameters: ListLearningSessionEvaluationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LearningSessionEvaluation>>;
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConceptRaw(requestParameters: ListLearningSessionEvaluationsForConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<LearningSessionEvaluation>>>;
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConcept(requestParameters: ListLearningSessionEvaluationsForConceptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<LearningSessionEvaluation>>;
 }

package/dist/esm/apis/LearningSessionEvaluationsApi.js

@@ -67,4 +67,45 @@ export class LearningSessionEvaluationsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConceptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['conceptId'] == null) {
+                throw new runtime.RequiredError('conceptId', 'Required parameter "conceptId" was null or undefined when calling listLearningSessionEvaluationsForConcept().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listLearningSessionEvaluationsForConcept().');
+            }
+            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/user-concepts/{conceptId}/learning-session-evaluations`;
+            urlPath = urlPath.replace(`{${"conceptId"}}`, encodeURIComponent(String(requestParameters['conceptId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(LearningSessionEvaluationFromJSON));
+        });
+    }
+    /**
+     * Returns every per-turn evaluator signal (the learning evidence) across all of the authenticated account user\'s learning-session chats (chatType \'level-up\' or \'quick-practice\') where the supplied concept is the chat\'s primary concept. Aggregates a concept\'s evidence across sessions; each row carries its chatId so callers can group by session. Account-user-scoped — only the caller\'s own chats are considered, never another user\'s. Rows are returned in (createdAt, id) ascending order — a chronological evidence stream. Returns an empty array when the caller has no primary-concept session for the concept (the normal \'no evidence yet\' signal); it intentionally does not assert that the concept exists.
+     * List learning session evaluations for a concept
+     */
+    listLearningSessionEvaluationsForConcept(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listLearningSessionEvaluationsForConceptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }

package/package.json

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