@instructure/athena-api-client 2.11.6 → 2.12.0

package/README.md

@@ -107,6 +107,7 @@ All URIs are relative to *http://localhost:3000*
 *QuizSessionsApi* | [**submitQuizResponse**](docs/QuizSessionsApi.md#submitquizresponseoperation) | **POST** /api/v1/quiz-sessions/{sessionId}/responses | Submit a quiz response
 *QuizSessionsApi* | [**updateQuizSession**](docs/QuizSessionsApi.md#updatequizsessionoperation) | **PATCH** /api/v1/quiz-sessions/{sessionId} | Update quiz session status
 *QuizzesApi* | [**getQuiz**](docs/QuizzesApi.md#getquiz) | **GET** /api/v1/quizzes/{quizId} | Get quiz with questions
+*QuizzesApi* | [**listQuizzes**](docs/QuizzesApi.md#listquizzes) | **GET** /api/v1/quizzes | List user quizzes
 *ServiceTokensApi* | [**createServiceToken**](docs/ServiceTokensApi.md#createservicetoken) | **POST** /api/v1/tokens | Create a new service token
 *ServiceTokensApi* | [**deleteServiceToken**](docs/ServiceTokensApi.md#deleteservicetoken) | **DELETE** /api/v1/tokens/{id} | Delete service token
 *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
@@ -173,9 +174,11 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedChats](docs/PaginatedChats.md)
 - [PaginatedLearningMoments](docs/PaginatedLearningMoments.md)
 - [PaginatedMessages](docs/PaginatedMessages.md)
+- [PaginatedQuizzes](docs/PaginatedQuizzes.md)
 - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [Plan](docs/Plan.md)
 - [Quiz](docs/Quiz.md)
+- [QuizListItem](docs/QuizListItem.md)
 - [QuizQuestion](docs/QuizQuestion.md)
 - [QuizResponse](docs/QuizResponse.md)
 - [QuizSession](docs/QuizSession.md)

package/dist/apis/QuizzesApi.d.ts

@@ -10,11 +10,17 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { QuizWithQuestions } from '../models/index';
+import type { PaginatedQuizzes, QuizWithQuestions } from '../models/index';
 export interface GetQuizRequest {
     quizId: string;
     xUserId: string;
 }
+export interface ListQuizzesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListQuizzesModeEnum;
+}
 /**
  *
  */
@@ -29,4 +35,22 @@ export declare class QuizzesApi extends runtime.BaseAPI {
      * Get quiz with questions
      */
     getQuiz(requestParameters: GetQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizWithQuestions>;
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzesRaw(requestParameters: ListQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizzes>>;
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzes(requestParameters: ListQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
 }
+/**
+ * @export
+ */
+export declare const ListQuizzesModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListQuizzesModeEnum = typeof ListQuizzesModeEnum[keyof typeof ListQuizzesModeEnum];

package/dist/apis/QuizzesApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuizzesApi = void 0;
+exports.ListQuizzesModeEnum = exports.QuizzesApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -70,5 +70,58 @@ class QuizzesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzesRaw(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 listQuizzes().');
+            }
+            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/quizzes`;
+            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 a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 exports.QuizzesApi = QuizzesApi;
+/**
+ * @export
+ */
+exports.ListQuizzesModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};

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

@@ -10,11 +10,17 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { QuizWithQuestions } from '../models/index';
+import type { PaginatedQuizzes, QuizWithQuestions } from '../models/index';
 export interface GetQuizRequest {
     quizId: string;
     xUserId: string;
 }
+export interface ListQuizzesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListQuizzesModeEnum;
+}
 /**
  *
  */
@@ -29,4 +35,22 @@ export declare class QuizzesApi extends runtime.BaseAPI {
      * Get quiz with questions
      */
     getQuiz(requestParameters: GetQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizWithQuestions>;
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzesRaw(requestParameters: ListQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizzes>>;
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzes(requestParameters: ListQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
 }
+/**
+ * @export
+ */
+export declare const ListQuizzesModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListQuizzesModeEnum = typeof ListQuizzesModeEnum[keyof typeof ListQuizzesModeEnum];

package/dist/esm/apis/QuizzesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { QuizWithQuestionsFromJSON, } from '../models/index';
+import { PaginatedQuizzesFromJSON, QuizWithQuestionsFromJSON, } from '../models/index';
 /**
  *
  */
@@ -67,4 +67,57 @@ export class QuizzesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzesRaw(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 listQuizzes().');
+            }
+            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/quizzes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedQuizzesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
+     * List user quizzes
+     */
+    listQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
+/**
+ * @export
+ */
+export const ListQuizzesModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};

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

@@ -0,0 +1,39 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { QuizListItem } from './QuizListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedQuizzes
+ */
+export interface PaginatedQuizzes {
+    /**
+     * Array of quiz objects
+     * @type {Array<QuizListItem>}
+     * @memberof PaginatedQuizzes
+     */
+    data: Array<QuizListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedQuizzes
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedQuizzes interface.
+ */
+export declare function instanceOfPaginatedQuizzes(value: object): value is PaginatedQuizzes;
+export declare function PaginatedQuizzesFromJSON(json: any): PaginatedQuizzes;
+export declare function PaginatedQuizzesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedQuizzes;
+export declare function PaginatedQuizzesToJSON(json: any): PaginatedQuizzes;
+export declare function PaginatedQuizzesToJSONTyped(value?: PaginatedQuizzes | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedQuizzes.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuizListItemFromJSON, QuizListItemToJSON, } from './QuizListItem';
+/**
+ * Check if a given object implements the PaginatedQuizzes interface.
+ */
+export function instanceOfPaginatedQuizzes(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedQuizzesFromJSON(json) {
+    return PaginatedQuizzesFromJSONTyped(json, false);
+}
+export function PaginatedQuizzesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(QuizListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedQuizzesToJSON(json) {
+    return PaginatedQuizzesToJSONTyped(json, false);
+}
+export function PaginatedQuizzesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(QuizListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -32,7 +32,7 @@ export interface Quiz {
      * @type {string}
      * @memberof Quiz
      */
-    chatId?: string | null;
+    chatId: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/Quiz.js

@@ -26,6 +26,8 @@ export function instanceOfQuiz(value) {
         return false;
     if (!('accountUserId' in value) || value['accountUserId'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('topic' in value) || value['topic'] === undefined)
@@ -46,7 +48,7 @@ export function QuizFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
-        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'chatId': json['chatId'],
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],

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

@@ -0,0 +1,82 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface QuizListItem
+ */
+export interface QuizListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    chatId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    mode: QuizListItemModeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizListItem
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizListItem
+     */
+    questionCount: number;
+}
+/**
+ * @export
+ */
+export declare const QuizListItemModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type QuizListItemModeEnum = typeof QuizListItemModeEnum[keyof typeof QuizListItemModeEnum];
+/**
+ * Check if a given object implements the QuizListItem interface.
+ */
+export declare function instanceOfQuizListItem(value: object): value is QuizListItem;
+export declare function QuizListItemFromJSON(json: any): QuizListItem;
+export declare function QuizListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizListItem;
+export declare function QuizListItemToJSON(json: any): QuizListItem;
+export declare function QuizListItemToJSONTyped(value?: QuizListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizListItem.js

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const QuizListItemModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the QuizListItem interface.
+ */
+export function instanceOfQuizListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined)
+        return false;
+    return true;
+}
+export function QuizListItemFromJSON(json) {
+    return QuizListItemFromJSONTyped(json, false);
+}
+export function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'mode': json['mode'],
+        'createdAt': (new Date(json['createdAt'])),
+        'questionCount': json['questionCount'],
+    };
+}
+export function QuizListItemToJSON(json) {
+    return QuizListItemToJSONTyped(json, false);
+}
+export function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'chatId': value['chatId'],
+        'title': value['title'],
+        'topic': value['topic'],
+        'mode': value['mode'],
+        'createdAt': value['createdAt'].toISOString(),
+        'questionCount': value['questionCount'],
+    };
+}

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

@@ -33,7 +33,7 @@ export interface QuizWithQuestions {
      * @type {string}
      * @memberof QuizWithQuestions
      */
-    chatId?: string | null;
+    chatId: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/QuizWithQuestions.js

@@ -27,6 +27,8 @@ export function instanceOfQuizWithQuestions(value) {
         return false;
     if (!('accountUserId' in value) || value['accountUserId'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('topic' in value) || value['topic'] === undefined)
@@ -49,7 +51,7 @@ export function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
-        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'chatId': json['chatId'],
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],

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

@@ -43,9 +43,11 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
 export * from './Quiz';
+export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';

package/dist/esm/models/index.js

@@ -45,9 +45,11 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
 export * from './Quiz';
+export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';

package/dist/models/PaginatedQuizzes.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { QuizListItem } from './QuizListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedQuizzes
+ */
+export interface PaginatedQuizzes {
+    /**
+     * Array of quiz objects
+     * @type {Array<QuizListItem>}
+     * @memberof PaginatedQuizzes
+     */
+    data: Array<QuizListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedQuizzes
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedQuizzes interface.
+ */
+export declare function instanceOfPaginatedQuizzes(value: object): value is PaginatedQuizzes;
+export declare function PaginatedQuizzesFromJSON(json: any): PaginatedQuizzes;
+export declare function PaginatedQuizzesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedQuizzes;
+export declare function PaginatedQuizzesToJSON(json: any): PaginatedQuizzes;
+export declare function PaginatedQuizzesToJSONTyped(value?: PaginatedQuizzes | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PaginatedQuizzes.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPaginatedQuizzes = instanceOfPaginatedQuizzes;
+exports.PaginatedQuizzesFromJSON = PaginatedQuizzesFromJSON;
+exports.PaginatedQuizzesFromJSONTyped = PaginatedQuizzesFromJSONTyped;
+exports.PaginatedQuizzesToJSON = PaginatedQuizzesToJSON;
+exports.PaginatedQuizzesToJSONTyped = PaginatedQuizzesToJSONTyped;
+const QuizListItem_1 = require("./QuizListItem");
+/**
+ * Check if a given object implements the PaginatedQuizzes interface.
+ */
+function instanceOfPaginatedQuizzes(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedQuizzesFromJSON(json) {
+    return PaginatedQuizzesFromJSONTyped(json, false);
+}
+function PaginatedQuizzesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(QuizListItem_1.QuizListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function PaginatedQuizzesToJSON(json) {
+    return PaginatedQuizzesToJSONTyped(json, false);
+}
+function PaginatedQuizzesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(QuizListItem_1.QuizListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/Quiz.d.ts

@@ -32,7 +32,7 @@ export interface Quiz {
      * @type {string}
      * @memberof Quiz
      */
-    chatId?: string | null;
+    chatId: string | null;
     /**
      *
      * @type {string}

package/dist/models/Quiz.js

@@ -34,6 +34,8 @@ function instanceOfQuiz(value) {
         return false;
     if (!('accountUserId' in value) || value['accountUserId'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('topic' in value) || value['topic'] === undefined)
@@ -54,7 +56,7 @@ function QuizFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
-        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'chatId': json['chatId'],
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],

package/dist/models/QuizListItem.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface QuizListItem
+ */
+export interface QuizListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    chatId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    mode: QuizListItemModeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizListItem
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizListItem
+     */
+    questionCount: number;
+}
+/**
+ * @export
+ */
+export declare const QuizListItemModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type QuizListItemModeEnum = typeof QuizListItemModeEnum[keyof typeof QuizListItemModeEnum];
+/**
+ * Check if a given object implements the QuizListItem interface.
+ */
+export declare function instanceOfQuizListItem(value: object): value is QuizListItem;
+export declare function QuizListItemFromJSON(json: any): QuizListItem;
+export declare function QuizListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizListItem;
+export declare function QuizListItemToJSON(json: any): QuizListItem;
+export declare function QuizListItemToJSONTyped(value?: QuizListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizListItem.js

@@ -0,0 +1,86 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuizListItemModeEnum = void 0;
+exports.instanceOfQuizListItem = instanceOfQuizListItem;
+exports.QuizListItemFromJSON = QuizListItemFromJSON;
+exports.QuizListItemFromJSONTyped = QuizListItemFromJSONTyped;
+exports.QuizListItemToJSON = QuizListItemToJSON;
+exports.QuizListItemToJSONTyped = QuizListItemToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizListItemModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the QuizListItem interface.
+ */
+function instanceOfQuizListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined)
+        return false;
+    return true;
+}
+function QuizListItemFromJSON(json) {
+    return QuizListItemFromJSONTyped(json, false);
+}
+function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'mode': json['mode'],
+        'createdAt': (new Date(json['createdAt'])),
+        'questionCount': json['questionCount'],
+    };
+}
+function QuizListItemToJSON(json) {
+    return QuizListItemToJSONTyped(json, false);
+}
+function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'chatId': value['chatId'],
+        'title': value['title'],
+        'topic': value['topic'],
+        'mode': value['mode'],
+        'createdAt': value['createdAt'].toISOString(),
+        'questionCount': value['questionCount'],
+    };
+}

package/dist/models/QuizWithQuestions.d.ts

@@ -33,7 +33,7 @@ export interface QuizWithQuestions {
      * @type {string}
      * @memberof QuizWithQuestions
      */
-    chatId?: string | null;
+    chatId: string | null;
     /**
      *
      * @type {string}

package/dist/models/QuizWithQuestions.js

@@ -35,6 +35,8 @@ function instanceOfQuizWithQuestions(value) {
         return false;
     if (!('accountUserId' in value) || value['accountUserId'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('topic' in value) || value['topic'] === undefined)
@@ -57,7 +59,7 @@ function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
-        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'chatId': json['chatId'],
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],

package/dist/models/index.d.ts

@@ -43,9 +43,11 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
 export * from './Quiz';
+export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';

package/dist/models/index.js

@@ -61,9 +61,11 @@ __exportStar(require("./MessagePartsInner"), exports);
 __exportStar(require("./PaginatedChats"), exports);
 __exportStar(require("./PaginatedLearningMoments"), exports);
 __exportStar(require("./PaginatedMessages"), exports);
+__exportStar(require("./PaginatedQuizzes"), exports);
 __exportStar(require("./PaginatedTaxonomies"), exports);
 __exportStar(require("./Plan"), exports);
 __exportStar(require("./Quiz"), exports);
+__exportStar(require("./QuizListItem"), exports);
 __exportStar(require("./QuizQuestion"), exports);
 __exportStar(require("./QuizResponse"), exports);
 __exportStar(require("./QuizSession"), exports);

package/package.json

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