@instructure/athena-api-client 3.18.10 → 3.19.1

package/README.md

@@ -136,6 +136,7 @@ All URIs are relative to *http://localhost:3000*
 *StudyObjectivesApi* | [**deleteStudyObjective**](docs/StudyObjectivesApi.md#deletestudyobjective) | **DELETE** /api/v1/study-objectives/{studyObjectiveId} | Delete a study objective
 *StudyObjectivesApi* | [**getStudyObjective**](docs/StudyObjectivesApi.md#getstudyobjective) | **GET** /api/v1/study-objectives/{studyObjectiveId} | Get a study objective by ID
 *StudyObjectivesApi* | [**listObjectiveResources**](docs/StudyObjectivesApi.md#listobjectiveresources) | **GET** /api/v1/study-objectives/{studyObjectiveId}/resources | List resources attached to a study objective
+*StudyObjectivesApi* | [**listStudyObjectiveQuizzes**](docs/StudyObjectivesApi.md#liststudyobjectivequizzes) | **GET** /api/v1/study-objectives/{studyObjectiveId}/quizzes | List quizzes and flashcards for a study objective
 *StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course
 *StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective
 *StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades

package/dist/apis/StudyObjectivesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
+import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
 export interface CreateObjectiveResourceRequest {
     xUserId: string;
     studyObjectiveId: string;
@@ -40,6 +40,13 @@ export interface ListObjectiveResourcesRequest {
     limit?: number;
     cursor?: string;
 }
+export interface ListStudyObjectiveQuizzesRequest {
+    xUserId: string;
+    studyObjectiveId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListStudyObjectiveQuizzesModeEnum;
+}
 export interface ListStudyObjectivesRequest {
     xUserId: string;
     courseId: string;
@@ -110,6 +117,16 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      * List resources attached to a study objective
      */
     listObjectiveResources(requestParameters: ListObjectiveResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedObjectiveResources>;
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzesRaw(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizzes>>;
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzes(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
     /**
      * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
      * List study objectives for a course
@@ -129,6 +146,14 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
 }
+/**
+ * @export
+ */
+export declare const ListStudyObjectiveQuizzesModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListStudyObjectiveQuizzesModeEnum = typeof ListStudyObjectiveQuizzesModeEnum[keyof typeof ListStudyObjectiveQuizzesModeEnum];
 /**
  * @export
  */

package/dist/apis/StudyObjectivesApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListStudyObjectivesStatusEnum = exports.StudyObjectivesApi = void 0;
+exports.ListStudyObjectivesStatusEnum = exports.ListStudyObjectiveQuizzesModeEnum = exports.StudyObjectivesApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -286,6 +286,56 @@ class StudyObjectivesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzesRaw(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 listStudyObjectiveQuizzes().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling listStudyObjectiveQuizzes().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['mode'] != null) {
+                queryParameters['mode'] = requestParameters['mode'];
+            }
+            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/study-objectives/{studyObjectiveId}/quizzes`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedQuizzesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudyObjectiveQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
      * List study objectives for a course
@@ -384,6 +434,13 @@ class StudyObjectivesApi extends runtime.BaseAPI {
     }
 }
 exports.StudyObjectivesApi = StudyObjectivesApi;
+/**
+ * @export
+ */
+exports.ListStudyObjectiveQuizzesModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
 /**
  * @export
  */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
+import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
 export interface CreateObjectiveResourceRequest {
     xUserId: string;
     studyObjectiveId: string;
@@ -40,6 +40,13 @@ export interface ListObjectiveResourcesRequest {
     limit?: number;
     cursor?: string;
 }
+export interface ListStudyObjectiveQuizzesRequest {
+    xUserId: string;
+    studyObjectiveId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListStudyObjectiveQuizzesModeEnum;
+}
 export interface ListStudyObjectivesRequest {
     xUserId: string;
     courseId: string;
@@ -110,6 +117,16 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      * List resources attached to a study objective
      */
     listObjectiveResources(requestParameters: ListObjectiveResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedObjectiveResources>;
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzesRaw(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizzes>>;
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzes(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
     /**
      * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
      * List study objectives for a course
@@ -129,6 +146,14 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
 }
+/**
+ * @export
+ */
+export declare const ListStudyObjectiveQuizzesModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListStudyObjectiveQuizzesModeEnum = typeof ListStudyObjectiveQuizzesModeEnum[keyof typeof ListStudyObjectiveQuizzesModeEnum];
 /**
  * @export
  */

package/dist/esm/apis/StudyObjectivesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateObjectiveResourceDtoToJSON, CreateStudyObjectiveDtoToJSON, ObjectiveResourceFromJSON, PaginatedObjectiveResourcesFromJSON, PaginatedStudyObjectivesFromJSON, StudyObjectiveFromJSON, UpdateStudyObjectiveDtoToJSON, } from '../models/index';
+import { CreateObjectiveResourceDtoToJSON, CreateStudyObjectiveDtoToJSON, ObjectiveResourceFromJSON, PaginatedObjectiveResourcesFromJSON, PaginatedQuizzesFromJSON, PaginatedStudyObjectivesFromJSON, StudyObjectiveFromJSON, UpdateStudyObjectiveDtoToJSON, } from '../models/index';
 /**
  *
  */
@@ -283,6 +283,56 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzesRaw(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 listStudyObjectiveQuizzes().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling listStudyObjectiveQuizzes().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['mode'] != null) {
+                queryParameters['mode'] = requestParameters['mode'];
+            }
+            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/study-objectives/{studyObjectiveId}/quizzes`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedQuizzesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the quizzes and flashcard sets attached to a study objective, ordered by creation date (newest first). Each item carries the id of the chat it was generated in, so a client can open the originating conversation.
+     * List quizzes and flashcards for a study objective
+     */
+    listStudyObjectiveQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudyObjectiveQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
      * List study objectives for a course
@@ -380,6 +430,13 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const ListStudyObjectiveQuizzesModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
 /**
  * @export
  */

package/package.json

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