@instructure/athena-api-client 2.12.1 → 2.13.0

package/README.md

@@ -104,6 +104,7 @@ All URIs are relative to *http://localhost:3000*
 *PlansApi* | [**updatePlan**](docs/PlansApi.md#updateplan) | **PATCH** /api/v1/plans/{id} | Update a plan
 *QuizSessionsApi* | [**createQuizSession**](docs/QuizSessionsApi.md#createquizsession) | **POST** /api/v1/quizzes/{quizId}/sessions | Create a quiz session
 *QuizSessionsApi* | [**getQuizSessionSummary**](docs/QuizSessionsApi.md#getquizsessionsummary) | **GET** /api/v1/quiz-sessions/{sessionId}/summary | Get quiz session summary
+*QuizSessionsApi* | [**listQuizSessions**](docs/QuizSessionsApi.md#listquizsessions) | **GET** /api/v1/quiz-sessions | List user quiz sessions
 *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
@@ -174,6 +175,7 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedChats](docs/PaginatedChats.md)
 - [PaginatedLearningMoments](docs/PaginatedLearningMoments.md)
 - [PaginatedMessages](docs/PaginatedMessages.md)
+- [PaginatedQuizSessions](docs/PaginatedQuizSessions.md)
 - [PaginatedQuizzes](docs/PaginatedQuizzes.md)
 - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [Plan](docs/Plan.md)
@@ -182,6 +184,8 @@ All URIs are relative to *http://localhost:3000*
 - [QuizQuestion](docs/QuizQuestion.md)
 - [QuizResponse](docs/QuizResponse.md)
 - [QuizSession](docs/QuizSession.md)
+- [QuizSessionListItem](docs/QuizSessionListItem.md)
+- [QuizSessionScore](docs/QuizSessionScore.md)
 - [QuizSessionSummary](docs/QuizSessionSummary.md)
 - [QuizWithQuestions](docs/QuizWithQuestions.md)
 - [Score](docs/Score.md)

package/dist/apis/QuizSessionsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { QuizResponse, QuizSession, QuizSessionSummary, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
+import type { PaginatedQuizSessions, QuizResponse, QuizSession, QuizSessionSummary, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
 export interface CreateQuizSessionRequest {
     quizId: string;
     xUserId: string;
@@ -19,6 +19,13 @@ export interface GetQuizSessionSummaryRequest {
     sessionId: string;
     xUserId: string;
 }
+export interface ListQuizSessionsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListQuizSessionsModeEnum;
+    status?: ListQuizSessionsStatusEnum;
+}
 export interface SubmitQuizResponseOperationRequest {
     sessionId: string;
     xUserId: string;
@@ -53,6 +60,16 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      * Get quiz session summary
      */
     getQuizSessionSummary(requestParameters: GetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSessionSummary>;
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessionsRaw(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizSessions>>;
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessions(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizSessions>;
     /**
      * Submits an answer for a question within a quiz session.
      * Submit a quiz response
@@ -74,3 +91,20 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      */
     updateQuizSession(requestParameters: UpdateQuizSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSession>;
 }
+/**
+ * @export
+ */
+export declare const ListQuizSessionsModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListQuizSessionsModeEnum = typeof ListQuizSessionsModeEnum[keyof typeof ListQuizSessionsModeEnum];
+/**
+ * @export
+ */
+export declare const ListQuizSessionsStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type ListQuizSessionsStatusEnum = typeof ListQuizSessionsStatusEnum[keyof typeof ListQuizSessionsStatusEnum];

package/dist/apis/QuizSessionsApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuizSessionsApi = void 0;
+exports.ListQuizSessionsStatusEnum = exports.ListQuizSessionsModeEnum = exports.QuizSessionsApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -111,6 +111,55 @@ class QuizSessionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessionsRaw(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 listQuizSessions().');
+            }
+            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'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            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/quiz-sessions`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedQuizSessionsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listQuizSessionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Submits an answer for a question within a quiz session.
      * Submit a quiz response
@@ -205,3 +254,18 @@ class QuizSessionsApi extends runtime.BaseAPI {
     }
 }
 exports.QuizSessionsApi = QuizSessionsApi;
+/**
+ * @export
+ */
+exports.ListQuizSessionsModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+exports.ListQuizSessionsStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { QuizResponse, QuizSession, QuizSessionSummary, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
+import type { PaginatedQuizSessions, QuizResponse, QuizSession, QuizSessionSummary, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
 export interface CreateQuizSessionRequest {
     quizId: string;
     xUserId: string;
@@ -19,6 +19,13 @@ export interface GetQuizSessionSummaryRequest {
     sessionId: string;
     xUserId: string;
 }
+export interface ListQuizSessionsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    mode?: ListQuizSessionsModeEnum;
+    status?: ListQuizSessionsStatusEnum;
+}
 export interface SubmitQuizResponseOperationRequest {
     sessionId: string;
     xUserId: string;
@@ -53,6 +60,16 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      * Get quiz session summary
      */
     getQuizSessionSummary(requestParameters: GetQuizSessionSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSessionSummary>;
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessionsRaw(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedQuizSessions>>;
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessions(requestParameters: ListQuizSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizSessions>;
     /**
      * Submits an answer for a question within a quiz session.
      * Submit a quiz response
@@ -74,3 +91,20 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      */
     updateQuizSession(requestParameters: UpdateQuizSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSession>;
 }
+/**
+ * @export
+ */
+export declare const ListQuizSessionsModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListQuizSessionsModeEnum = typeof ListQuizSessionsModeEnum[keyof typeof ListQuizSessionsModeEnum];
+/**
+ * @export
+ */
+export declare const ListQuizSessionsStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type ListQuizSessionsStatusEnum = typeof ListQuizSessionsStatusEnum[keyof typeof ListQuizSessionsStatusEnum];

package/dist/esm/apis/QuizSessionsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { QuizResponseFromJSON, QuizSessionFromJSON, QuizSessionSummaryFromJSON, SubmitQuizResponseRequestToJSON, UpdateQuizSessionRequestToJSON, } from '../models/index';
+import { PaginatedQuizSessionsFromJSON, QuizResponseFromJSON, QuizSessionFromJSON, QuizSessionSummaryFromJSON, SubmitQuizResponseRequestToJSON, UpdateQuizSessionRequestToJSON, } from '../models/index';
 /**
  *
  */
@@ -108,6 +108,55 @@ export class QuizSessionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessionsRaw(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 listQuizSessions().');
+            }
+            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'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            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/quiz-sessions`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedQuizSessionsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of quiz sessions owned by the authenticated user, ordered by start date (newest first), with embedded quiz info and score summary.
+     * List user quiz sessions
+     */
+    listQuizSessions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listQuizSessionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Submits an answer for a question within a quiz session.
      * Submit a quiz response
@@ -201,3 +250,18 @@ export class QuizSessionsApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const ListQuizSessionsModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const ListQuizSessionsStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};

package/dist/esm/models/PaginatedQuizSessions.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 { QuizSessionListItem } from './QuizSessionListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedQuizSessions
+ */
+export interface PaginatedQuizSessions {
+    /**
+     * Array of quiz session objects
+     * @type {Array<QuizSessionListItem>}
+     * @memberof PaginatedQuizSessions
+     */
+    data: Array<QuizSessionListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedQuizSessions
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedQuizSessions interface.
+ */
+export declare function instanceOfPaginatedQuizSessions(value: object): value is PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsFromJSON(json: any): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsToJSON(json: any): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsToJSONTyped(value?: PaginatedQuizSessions | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedQuizSessions.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 { QuizSessionListItemFromJSON, QuizSessionListItemToJSON, } from './QuizSessionListItem';
+/**
+ * Check if a given object implements the PaginatedQuizSessions interface.
+ */
+export function instanceOfPaginatedQuizSessions(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedQuizSessionsFromJSON(json) {
+    return PaginatedQuizSessionsFromJSONTyped(json, false);
+}
+export function PaginatedQuizSessionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(QuizSessionListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedQuizSessionsToJSON(json) {
+    return PaginatedQuizSessionsToJSONTyped(json, false);
+}
+export function PaginatedQuizSessionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(QuizSessionListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,85 @@
+/**
+ * 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 { Quiz } from './Quiz';
+import type { QuizSessionScore } from './QuizSessionScore';
+/**
+ *
+ * @export
+ * @interface QuizSessionListItem
+ */
+export interface QuizSessionListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    status: QuizSessionListItemStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    completedAt: Date | null;
+    /**
+     *
+     * @type {Quiz}
+     * @memberof QuizSessionListItem
+     */
+    quiz: Quiz;
+    /**
+     *
+     * @type {QuizSessionScore}
+     * @memberof QuizSessionListItem
+     */
+    score: QuizSessionScore;
+}
+/**
+ * @export
+ */
+export declare const QuizSessionListItemStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type QuizSessionListItemStatusEnum = typeof QuizSessionListItemStatusEnum[keyof typeof QuizSessionListItemStatusEnum];
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+export declare function instanceOfQuizSessionListItem(value: object): value is QuizSessionListItem;
+export declare function QuizSessionListItemFromJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionListItem;
+export declare function QuizSessionListItemToJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemToJSONTyped(value?: QuizSessionListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizSessionListItem.js

@@ -0,0 +1,81 @@
+/* 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 { QuizFromJSON, QuizToJSON, } from './Quiz';
+import { QuizSessionScoreFromJSON, QuizSessionScoreToJSON, } from './QuizSessionScore';
+/**
+ * @export
+ */
+export const QuizSessionListItemStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+export function instanceOfQuizSessionListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('quiz' in value) || value['quiz'] === undefined)
+        return false;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+export function QuizSessionListItemFromJSON(json) {
+    return QuizSessionListItemFromJSONTyped(json, false);
+}
+export function QuizSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'accountUserId': json['accountUserId'],
+        'status': json['status'],
+        'startedAt': (new Date(json['startedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'quiz': QuizFromJSON(json['quiz']),
+        'score': QuizSessionScoreFromJSON(json['score']),
+    };
+}
+export function QuizSessionListItemToJSON(json) {
+    return QuizSessionListItemToJSONTyped(json, false);
+}
+export function QuizSessionListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'accountUserId': value['accountUserId'],
+        'status': value['status'],
+        'startedAt': value['startedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'quiz': QuizToJSON(value['quiz']),
+        'score': QuizSessionScoreToJSON(value['score']),
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 QuizSessionScore
+ */
+export interface QuizSessionScore {
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalQuestions: number;
+}
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+export declare function instanceOfQuizSessionScore(value: object): value is QuizSessionScore;
+export declare function QuizSessionScoreFromJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionScore;
+export declare function QuizSessionScoreToJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreToJSONTyped(value?: QuizSessionScore | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizSessionScore.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+export function instanceOfQuizSessionScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    return true;
+}
+export function QuizSessionScoreFromJSON(json) {
+    return QuizSessionScoreFromJSONTyped(json, false);
+}
+export function QuizSessionScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+    };
+}
+export function QuizSessionScoreToJSON(json) {
+    return QuizSessionScoreToJSONTyped(json, false);
+}
+export function QuizSessionScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+    };
+}

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

@@ -43,6 +43,7 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
@@ -51,6 +52,8 @@ export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
+export * from './QuizSessionListItem';
+export * from './QuizSessionScore';
 export * from './QuizSessionSummary';
 export * from './QuizWithQuestions';
 export * from './Score';

package/dist/esm/models/index.js

@@ -45,6 +45,7 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
@@ -53,6 +54,8 @@ export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
+export * from './QuizSessionListItem';
+export * from './QuizSessionScore';
 export * from './QuizSessionSummary';
 export * from './QuizWithQuestions';
 export * from './Score';

package/dist/models/PaginatedQuizSessions.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 { QuizSessionListItem } from './QuizSessionListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedQuizSessions
+ */
+export interface PaginatedQuizSessions {
+    /**
+     * Array of quiz session objects
+     * @type {Array<QuizSessionListItem>}
+     * @memberof PaginatedQuizSessions
+     */
+    data: Array<QuizSessionListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedQuizSessions
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedQuizSessions interface.
+ */
+export declare function instanceOfPaginatedQuizSessions(value: object): value is PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsFromJSON(json: any): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsToJSON(json: any): PaginatedQuizSessions;
+export declare function PaginatedQuizSessionsToJSONTyped(value?: PaginatedQuizSessions | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PaginatedQuizSessions.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.instanceOfPaginatedQuizSessions = instanceOfPaginatedQuizSessions;
+exports.PaginatedQuizSessionsFromJSON = PaginatedQuizSessionsFromJSON;
+exports.PaginatedQuizSessionsFromJSONTyped = PaginatedQuizSessionsFromJSONTyped;
+exports.PaginatedQuizSessionsToJSON = PaginatedQuizSessionsToJSON;
+exports.PaginatedQuizSessionsToJSONTyped = PaginatedQuizSessionsToJSONTyped;
+const QuizSessionListItem_1 = require("./QuizSessionListItem");
+/**
+ * Check if a given object implements the PaginatedQuizSessions interface.
+ */
+function instanceOfPaginatedQuizSessions(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedQuizSessionsFromJSON(json) {
+    return PaginatedQuizSessionsFromJSONTyped(json, false);
+}
+function PaginatedQuizSessionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(QuizSessionListItem_1.QuizSessionListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function PaginatedQuizSessionsToJSON(json) {
+    return PaginatedQuizSessionsToJSONTyped(json, false);
+}
+function PaginatedQuizSessionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(QuizSessionListItem_1.QuizSessionListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/QuizSessionListItem.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 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 { Quiz } from './Quiz';
+import type { QuizSessionScore } from './QuizSessionScore';
+/**
+ *
+ * @export
+ * @interface QuizSessionListItem
+ */
+export interface QuizSessionListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    status: QuizSessionListItemStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    completedAt: Date | null;
+    /**
+     *
+     * @type {Quiz}
+     * @memberof QuizSessionListItem
+     */
+    quiz: Quiz;
+    /**
+     *
+     * @type {QuizSessionScore}
+     * @memberof QuizSessionListItem
+     */
+    score: QuizSessionScore;
+}
+/**
+ * @export
+ */
+export declare const QuizSessionListItemStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type QuizSessionListItemStatusEnum = typeof QuizSessionListItemStatusEnum[keyof typeof QuizSessionListItemStatusEnum];
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+export declare function instanceOfQuizSessionListItem(value: object): value is QuizSessionListItem;
+export declare function QuizSessionListItemFromJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionListItem;
+export declare function QuizSessionListItemToJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemToJSONTyped(value?: QuizSessionListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionListItem.js

@@ -0,0 +1,89 @@
+"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.QuizSessionListItemStatusEnum = void 0;
+exports.instanceOfQuizSessionListItem = instanceOfQuizSessionListItem;
+exports.QuizSessionListItemFromJSON = QuizSessionListItemFromJSON;
+exports.QuizSessionListItemFromJSONTyped = QuizSessionListItemFromJSONTyped;
+exports.QuizSessionListItemToJSON = QuizSessionListItemToJSON;
+exports.QuizSessionListItemToJSONTyped = QuizSessionListItemToJSONTyped;
+const Quiz_1 = require("./Quiz");
+const QuizSessionScore_1 = require("./QuizSessionScore");
+/**
+ * @export
+ */
+exports.QuizSessionListItemStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+function instanceOfQuizSessionListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('quiz' in value) || value['quiz'] === undefined)
+        return false;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionListItemFromJSON(json) {
+    return QuizSessionListItemFromJSONTyped(json, false);
+}
+function QuizSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'accountUserId': json['accountUserId'],
+        'status': json['status'],
+        'startedAt': (new Date(json['startedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'quiz': (0, Quiz_1.QuizFromJSON)(json['quiz']),
+        'score': (0, QuizSessionScore_1.QuizSessionScoreFromJSON)(json['score']),
+    };
+}
+function QuizSessionListItemToJSON(json) {
+    return QuizSessionListItemToJSONTyped(json, false);
+}
+function QuizSessionListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'accountUserId': value['accountUserId'],
+        'status': value['status'],
+        'startedAt': value['startedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'quiz': (0, Quiz_1.QuizToJSON)(value['quiz']),
+        'score': (0, QuizSessionScore_1.QuizSessionScoreToJSON)(value['score']),
+    };
+}

package/dist/models/QuizSessionScore.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 QuizSessionScore
+ */
+export interface QuizSessionScore {
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalQuestions: number;
+}
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+export declare function instanceOfQuizSessionScore(value: object): value is QuizSessionScore;
+export declare function QuizSessionScoreFromJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionScore;
+export declare function QuizSessionScoreToJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreToJSONTyped(value?: QuizSessionScore | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionScore.js

@@ -0,0 +1,54 @@
+"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.instanceOfQuizSessionScore = instanceOfQuizSessionScore;
+exports.QuizSessionScoreFromJSON = QuizSessionScoreFromJSON;
+exports.QuizSessionScoreFromJSONTyped = QuizSessionScoreFromJSONTyped;
+exports.QuizSessionScoreToJSON = QuizSessionScoreToJSON;
+exports.QuizSessionScoreToJSONTyped = QuizSessionScoreToJSONTyped;
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+function instanceOfQuizSessionScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionScoreFromJSON(json) {
+    return QuizSessionScoreFromJSONTyped(json, false);
+}
+function QuizSessionScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+    };
+}
+function QuizSessionScoreToJSON(json) {
+    return QuizSessionScoreToJSONTyped(json, false);
+}
+function QuizSessionScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+    };
+}

package/dist/models/index.d.ts

@@ -43,6 +43,7 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
@@ -51,6 +52,8 @@ export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
+export * from './QuizSessionListItem';
+export * from './QuizSessionScore';
 export * from './QuizSessionSummary';
 export * from './QuizWithQuestions';
 export * from './Score';

package/dist/models/index.js

@@ -61,6 +61,7 @@ __exportStar(require("./MessagePartsInner"), exports);
 __exportStar(require("./PaginatedChats"), exports);
 __exportStar(require("./PaginatedLearningMoments"), exports);
 __exportStar(require("./PaginatedMessages"), exports);
+__exportStar(require("./PaginatedQuizSessions"), exports);
 __exportStar(require("./PaginatedQuizzes"), exports);
 __exportStar(require("./PaginatedTaxonomies"), exports);
 __exportStar(require("./Plan"), exports);
@@ -69,6 +70,8 @@ __exportStar(require("./QuizListItem"), exports);
 __exportStar(require("./QuizQuestion"), exports);
 __exportStar(require("./QuizResponse"), exports);
 __exportStar(require("./QuizSession"), exports);
+__exportStar(require("./QuizSessionListItem"), exports);
+__exportStar(require("./QuizSessionScore"), exports);
 __exportStar(require("./QuizSessionSummary"), exports);
 __exportStar(require("./QuizWithQuestions"), exports);
 __exportStar(require("./Score"), exports);

package/package.json

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