@instructure/athena-api-client 3.36.0 → 3.37.0

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

@@ -51,6 +51,18 @@ export interface Quiz {
      * @memberof Quiz
      */
     mode: QuizModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof Quiz
+     */
+    generationStatus: QuizGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof Quiz
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -66,6 +78,15 @@ export declare const QuizModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizModeEnum = typeof QuizModeEnum[keyof typeof QuizModeEnum];
+/**
+ * @export
+ */
+export declare const QuizGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizGenerationStatusEnum = typeof QuizGenerationStatusEnum[keyof typeof QuizGenerationStatusEnum];
 /**
  * Check if a given object implements the Quiz interface.
  */

package/dist/esm/models/Quiz.js

@@ -18,6 +18,14 @@ export const QuizModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+export const QuizGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the Quiz interface.
  */
@@ -34,6 +42,10 @@ export function instanceOfQuiz(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -52,6 +64,8 @@ export function QuizFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -69,6 +83,8 @@ export function QuizToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
     };
 }

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

@@ -51,6 +51,18 @@ export interface QuizListItem {
      * @memberof QuizListItem
      */
     mode: QuizListItemModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    generationStatus: QuizListItemGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof QuizListItem
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -72,6 +84,15 @@ export declare const QuizListItemModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizListItemModeEnum = typeof QuizListItemModeEnum[keyof typeof QuizListItemModeEnum];
+/**
+ * @export
+ */
+export declare const QuizListItemGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizListItemGenerationStatusEnum = typeof QuizListItemGenerationStatusEnum[keyof typeof QuizListItemGenerationStatusEnum];
 /**
  * Check if a given object implements the QuizListItem interface.
  */

package/dist/esm/models/QuizListItem.js

@@ -18,6 +18,14 @@ export const QuizListItemModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+export const QuizListItemGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the QuizListItem interface.
  */
@@ -34,6 +42,10 @@ export function instanceOfQuizListItem(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('questionCount' in value) || value['questionCount'] === undefined)
@@ -54,6 +66,8 @@ export function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
         'questionCount': json['questionCount'],
     };
@@ -72,6 +86,8 @@ export function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
         'questionCount': value['questionCount'],
     };

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

@@ -52,6 +52,18 @@ export interface QuizWithQuestions {
      * @memberof QuizWithQuestions
      */
     mode: QuizWithQuestionsModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    generationStatus: QuizWithQuestionsGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof QuizWithQuestions
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -73,6 +85,15 @@ export declare const QuizWithQuestionsModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizWithQuestionsModeEnum = typeof QuizWithQuestionsModeEnum[keyof typeof QuizWithQuestionsModeEnum];
+/**
+ * @export
+ */
+export declare const QuizWithQuestionsGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizWithQuestionsGenerationStatusEnum = typeof QuizWithQuestionsGenerationStatusEnum[keyof typeof QuizWithQuestionsGenerationStatusEnum];
 /**
  * Check if a given object implements the QuizWithQuestions interface.
  */

package/dist/esm/models/QuizWithQuestions.js

@@ -19,6 +19,14 @@ export const QuizWithQuestionsModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+export const QuizWithQuestionsGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the QuizWithQuestions interface.
  */
@@ -35,6 +43,10 @@ export function instanceOfQuizWithQuestions(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('questions' in value) || value['questions'] === undefined)
@@ -55,6 +67,8 @@ export function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
         'questions': (json['questions'].map(QuizQuestionFromJSON)),
     };
@@ -73,6 +87,8 @@ export function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false)
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
         'questions': (value['questions'].map(QuizQuestionToJSON)),
     };

package/dist/models/Quiz.d.ts

@@ -51,6 +51,18 @@ export interface Quiz {
      * @memberof Quiz
      */
     mode: QuizModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof Quiz
+     */
+    generationStatus: QuizGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof Quiz
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -66,6 +78,15 @@ export declare const QuizModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizModeEnum = typeof QuizModeEnum[keyof typeof QuizModeEnum];
+/**
+ * @export
+ */
+export declare const QuizGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizGenerationStatusEnum = typeof QuizGenerationStatusEnum[keyof typeof QuizGenerationStatusEnum];
 /**
  * Check if a given object implements the Quiz interface.
  */

package/dist/models/Quiz.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuizModeEnum = void 0;
+exports.QuizGenerationStatusEnum = exports.QuizModeEnum = void 0;
 exports.instanceOfQuiz = instanceOfQuiz;
 exports.QuizFromJSON = QuizFromJSON;
 exports.QuizFromJSONTyped = QuizFromJSONTyped;
@@ -26,6 +26,14 @@ exports.QuizModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+exports.QuizGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the Quiz interface.
  */
@@ -42,6 +50,10 @@ function instanceOfQuiz(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -60,6 +72,8 @@ function QuizFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -77,6 +91,8 @@ function QuizToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
     };
 }

package/dist/models/QuizListItem.d.ts

@@ -51,6 +51,18 @@ export interface QuizListItem {
      * @memberof QuizListItem
      */
     mode: QuizListItemModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof QuizListItem
+     */
+    generationStatus: QuizListItemGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof QuizListItem
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -72,6 +84,15 @@ export declare const QuizListItemModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizListItemModeEnum = typeof QuizListItemModeEnum[keyof typeof QuizListItemModeEnum];
+/**
+ * @export
+ */
+export declare const QuizListItemGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizListItemGenerationStatusEnum = typeof QuizListItemGenerationStatusEnum[keyof typeof QuizListItemGenerationStatusEnum];
 /**
  * Check if a given object implements the QuizListItem interface.
  */

package/dist/models/QuizListItem.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuizListItemModeEnum = void 0;
+exports.QuizListItemGenerationStatusEnum = exports.QuizListItemModeEnum = void 0;
 exports.instanceOfQuizListItem = instanceOfQuizListItem;
 exports.QuizListItemFromJSON = QuizListItemFromJSON;
 exports.QuizListItemFromJSONTyped = QuizListItemFromJSONTyped;
@@ -26,6 +26,14 @@ exports.QuizListItemModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+exports.QuizListItemGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the QuizListItem interface.
  */
@@ -42,6 +50,10 @@ function instanceOfQuizListItem(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('questionCount' in value) || value['questionCount'] === undefined)
@@ -62,6 +74,8 @@ function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
         'questionCount': json['questionCount'],
     };
@@ -80,6 +94,8 @@ function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
         'questionCount': value['questionCount'],
     };

package/dist/models/QuizWithQuestions.d.ts

@@ -52,6 +52,18 @@ export interface QuizWithQuestions {
      * @memberof QuizWithQuestions
      */
     mode: QuizWithQuestionsModeEnum;
+    /**
+     * Whether more questions may still be appended to this quiz. "generating" means the generator is still writing questions and the client should keep polling; "ready" means no further questions will appear; "failed" means generation ended with nothing usable. Quizzes written in a single transaction are "ready" from the start.
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    generationStatus: QuizWithQuestionsGenerationStatusEnum;
+    /**
+     * How many questions the generation requested. Use it as the total while generationStatus is "generating" and fewer questions have arrived than were asked for. Null for quizzes created before the count was recorded.
+     * @type {number}
+     * @memberof QuizWithQuestions
+     */
+    expectedQuestionCount: number | null;
     /**
      *
      * @type {Date}
@@ -73,6 +85,15 @@ export declare const QuizWithQuestionsModeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type QuizWithQuestionsModeEnum = typeof QuizWithQuestionsModeEnum[keyof typeof QuizWithQuestionsModeEnum];
+/**
+ * @export
+ */
+export declare const QuizWithQuestionsGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type QuizWithQuestionsGenerationStatusEnum = typeof QuizWithQuestionsGenerationStatusEnum[keyof typeof QuizWithQuestionsGenerationStatusEnum];
 /**
  * Check if a given object implements the QuizWithQuestions interface.
  */

package/dist/models/QuizWithQuestions.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuizWithQuestionsModeEnum = void 0;
+exports.QuizWithQuestionsGenerationStatusEnum = exports.QuizWithQuestionsModeEnum = void 0;
 exports.instanceOfQuizWithQuestions = instanceOfQuizWithQuestions;
 exports.QuizWithQuestionsFromJSON = QuizWithQuestionsFromJSON;
 exports.QuizWithQuestionsFromJSONTyped = QuizWithQuestionsFromJSONTyped;
@@ -27,6 +27,14 @@ exports.QuizWithQuestionsModeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+exports.QuizWithQuestionsGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
 /**
  * Check if a given object implements the QuizWithQuestions interface.
  */
@@ -43,6 +51,10 @@ function instanceOfQuizWithQuestions(value) {
         return false;
     if (!('mode' in value) || value['mode'] === undefined)
         return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('questions' in value) || value['questions'] === undefined)
@@ -63,6 +75,8 @@ function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'],
         'topic': json['topic'],
         'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
         'questions': (json['questions'].map(QuizQuestion_1.QuizQuestionFromJSON)),
     };
@@ -81,6 +95,8 @@ function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'topic': value['topic'],
         'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
         'questions': (value['questions'].map(QuizQuestion_1.QuizQuestionToJSON)),
     };

package/package.json

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