@instructure/athena-api-client 1.0.6 → 1.0.8

package/dist/esm/models/QuizSessionSummaryScore.js

@@ -0,0 +1,53 @@
+/* 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 { mapValues } from '../runtime';
+import { ScoreByTypeValueFromJSON, ScoreByTypeValueToJSON, } from './ScoreByTypeValue';
+/**
+ * Check if a given object implements the QuizSessionSummaryScore interface.
+ */
+export function instanceOfQuizSessionSummaryScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    if (!('byType' in value) || value['byType'] === undefined)
+        return false;
+    return true;
+}
+export function QuizSessionSummaryScoreFromJSON(json) {
+    return QuizSessionSummaryScoreFromJSONTyped(json, false);
+}
+export function QuizSessionSummaryScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+        'byType': (mapValues(json['byType'], ScoreByTypeValueFromJSON)),
+    };
+}
+export function QuizSessionSummaryScoreToJSON(json) {
+    return QuizSessionSummaryScoreToJSONTyped(json, false);
+}
+export function QuizSessionSummaryScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+        'byType': (mapValues(value['byType'], ScoreByTypeValueToJSON)),
+    };
+}

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

@@ -0,0 +1,83 @@
+/**
+ * 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 { QuizQuestion } from './QuizQuestion';
+/**
+ *
+ * @export
+ * @interface QuizWithQuestions
+ */
+export interface QuizWithQuestions {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    chatId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    mode: QuizWithQuestionsModeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizWithQuestions
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Array<QuizQuestion>}
+     * @memberof QuizWithQuestions
+     */
+    questions: Array<QuizQuestion>;
+}
+/**
+ * @export
+ */
+export declare const QuizWithQuestionsModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type QuizWithQuestionsModeEnum = typeof QuizWithQuestionsModeEnum[keyof typeof QuizWithQuestionsModeEnum];
+/**
+ * Check if a given object implements the QuizWithQuestions interface.
+ */
+export declare function instanceOfQuizWithQuestions(value: object): value is QuizWithQuestions;
+export declare function QuizWithQuestionsFromJSON(json: any): QuizWithQuestions;
+export declare function QuizWithQuestionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizWithQuestions;
+export declare function QuizWithQuestionsToJSON(json: any): QuizWithQuestions;
+export declare function QuizWithQuestionsToJSONTyped(value?: QuizWithQuestions | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizWithQuestions.js

@@ -0,0 +1,77 @@
+/* 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 { QuizQuestionFromJSON, QuizQuestionToJSON, } from './QuizQuestion';
+/**
+ * @export
+ */
+export const QuizWithQuestionsModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the QuizWithQuestions interface.
+ */
+export function instanceOfQuizWithQuestions(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === 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 (!('questions' in value) || value['questions'] === undefined)
+        return false;
+    return true;
+}
+export function QuizWithQuestionsFromJSON(json) {
+    return QuizWithQuestionsFromJSONTyped(json, false);
+}
+export function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'mode': json['mode'],
+        'createdAt': (new Date(json['createdAt'])),
+        'questions': (json['questions'].map(QuizQuestionFromJSON)),
+    };
+}
+export function QuizWithQuestionsToJSON(json) {
+    return QuizWithQuestionsToJSONTyped(json, false);
+}
+export function QuizWithQuestionsToJSONTyped(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(),
+        'questions': (value['questions'].map(QuizQuestionToJSON)),
+    };
+}

package/dist/esm/models/ScoreByTypeValue.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 ScoreByTypeValue
+ */
+export interface ScoreByTypeValue {
+    /**
+     *
+     * @type {number}
+     * @memberof ScoreByTypeValue
+     */
+    correct: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ScoreByTypeValue
+     */
+    total: number;
+}
+/**
+ * Check if a given object implements the ScoreByTypeValue interface.
+ */
+export declare function instanceOfScoreByTypeValue(value: object): value is ScoreByTypeValue;
+export declare function ScoreByTypeValueFromJSON(json: any): ScoreByTypeValue;
+export declare function ScoreByTypeValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScoreByTypeValue;
+export declare function ScoreByTypeValueToJSON(json: any): ScoreByTypeValue;
+export declare function ScoreByTypeValueToJSONTyped(value?: ScoreByTypeValue | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScoreByTypeValue.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 ScoreByTypeValue interface.
+ */
+export function instanceOfScoreByTypeValue(value) {
+    if (!('correct' in value) || value['correct'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    return true;
+}
+export function ScoreByTypeValueFromJSON(json) {
+    return ScoreByTypeValueFromJSONTyped(json, false);
+}
+export function ScoreByTypeValueFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'correct': json['correct'],
+        'total': json['total'],
+    };
+}
+export function ScoreByTypeValueToJSON(json) {
+    return ScoreByTypeValueToJSONTyped(json, false);
+}
+export function ScoreByTypeValueToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'correct': value['correct'],
+        'total': value['total'],
+    };
+}

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

@@ -0,0 +1,58 @@
+/**
+ * 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 SubmitQuizResponseRequest
+ */
+export interface SubmitQuizResponseRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    questionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    userAnswer: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SubmitQuizResponseRequest
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    rating?: SubmitQuizResponseRequestRatingEnum | null;
+}
+/**
+ * @export
+ */
+export declare const SubmitQuizResponseRequestRatingEnum: {
+    readonly WasRight: "was-right";
+    readonly NeedPractice: "need-practice";
+};
+export type SubmitQuizResponseRequestRatingEnum = typeof SubmitQuizResponseRequestRatingEnum[keyof typeof SubmitQuizResponseRequestRatingEnum];
+/**
+ * Check if a given object implements the SubmitQuizResponseRequest interface.
+ */
+export declare function instanceOfSubmitQuizResponseRequest(value: object): value is SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestFromJSON(json: any): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestToJSON(json: any): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestToJSONTyped(value?: SubmitQuizResponseRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SubmitQuizResponseRequest.js

@@ -0,0 +1,58 @@
+/* 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 SubmitQuizResponseRequestRatingEnum = {
+    WasRight: 'was-right',
+    NeedPractice: 'need-practice'
+};
+/**
+ * Check if a given object implements the SubmitQuizResponseRequest interface.
+ */
+export function instanceOfSubmitQuizResponseRequest(value) {
+    if (!('questionId' in value) || value['questionId'] === undefined)
+        return false;
+    if (!('userAnswer' in value) || value['userAnswer'] === undefined)
+        return false;
+    return true;
+}
+export function SubmitQuizResponseRequestFromJSON(json) {
+    return SubmitQuizResponseRequestFromJSONTyped(json, false);
+}
+export function SubmitQuizResponseRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'questionId': json['questionId'],
+        'userAnswer': json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+    };
+}
+export function SubmitQuizResponseRequestToJSON(json) {
+    return SubmitQuizResponseRequestToJSONTyped(json, false);
+}
+export function SubmitQuizResponseRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'questionId': value['questionId'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'rating': value['rating'],
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 UpdateQuizSessionRequest
+ */
+export interface UpdateQuizSessionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateQuizSessionRequest
+     */
+    status: UpdateQuizSessionRequestStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const UpdateQuizSessionRequestStatusEnum: {
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type UpdateQuizSessionRequestStatusEnum = typeof UpdateQuizSessionRequestStatusEnum[keyof typeof UpdateQuizSessionRequestStatusEnum];
+/**
+ * Check if a given object implements the UpdateQuizSessionRequest interface.
+ */
+export declare function instanceOfUpdateQuizSessionRequest(value: object): value is UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestFromJSON(json: any): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestToJSON(json: any): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestToJSONTyped(value?: UpdateQuizSessionRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateQuizSessionRequest.js

@@ -0,0 +1,50 @@
+/* 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 UpdateQuizSessionRequestStatusEnum = {
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the UpdateQuizSessionRequest interface.
+ */
+export function instanceOfUpdateQuizSessionRequest(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateQuizSessionRequestFromJSON(json) {
+    return UpdateQuizSessionRequestFromJSONTyped(json, false);
+}
+export function UpdateQuizSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+    };
+}
+export function UpdateQuizSessionRequestToJSON(json) {
+    return UpdateQuizSessionRequestToJSONTyped(json, false);
+}
+export function UpdateQuizSessionRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+    };
+}

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

@@ -18,9 +18,19 @@ export * from './ModelError';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './Quiz';
+export * from './QuizQuestion';
+export * from './QuizResponse';
+export * from './QuizSession';
+export * from './QuizSessionSummary';
+export * from './QuizSessionSummaryScore';
+export * from './QuizWithQuestions';
+export * from './ScoreByTypeValue';
 export * from './ServiceToken';
+export * from './SubmitQuizResponseRequest';
 export * from './Tag';
 export * from './UpdateChatRequest';
+export * from './UpdateQuizSessionRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlRequest';

package/dist/esm/models/index.js

@@ -20,9 +20,19 @@ export * from './ModelError';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './Quiz';
+export * from './QuizQuestion';
+export * from './QuizResponse';
+export * from './QuizSession';
+export * from './QuizSessionSummary';
+export * from './QuizSessionSummaryScore';
+export * from './QuizWithQuestions';
+export * from './ScoreByTypeValue';
 export * from './ServiceToken';
+export * from './SubmitQuizResponseRequest';
 export * from './Tag';
 export * from './UpdateChatRequest';
+export * from './UpdateQuizSessionRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlRequest';

package/dist/models/Chat.d.ts

@@ -38,13 +38,13 @@ export interface Chat {
      * @type {string}
      * @memberof Chat
      */
-    chatType?: string | null;
+    chatType: string | null;
     /**
      * Last viewed timestamp
      * @type {Date}
      * @memberof Chat
      */
-    lastViewedAt?: Date | null;
+    lastViewedAt: Date | null;
     /**
      * External user ID (matches the X-User-Id header value)
      * @type {string}
@@ -62,31 +62,31 @@ export interface Chat {
      * @type {string}
      * @memberof Chat
      */
-    subjectId?: string | null;
+    subjectId: string | null;
     /**
      * Latest job ID
      * @type {string}
      * @memberof Chat
      */
-    latestJobId?: string | null;
+    latestJobId: string | null;
     /**
      * Scheduled analysis timestamp
      * @type {Date}
      * @memberof Chat
      */
-    analysisScheduledFor?: Date | null;
+    analysisScheduledFor: Date | null;
     /**
      * Chat goal
      * @type {string}
      * @memberof Chat
      */
-    goal?: string | null;
+    goal: string | null;
     /**
      * Whether the goal has been achieved
      * @type {boolean}
      * @memberof Chat
      */
-    goalAchieved?: boolean | null;
+    goalAchieved: boolean | null;
     /**
      * Whether the chat is marked for review
      * @type {boolean}

package/dist/models/Chat.js

@@ -36,10 +36,24 @@ function instanceOfChat(value) {
         return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
+    if (!('chatType' in value) || value['chatType'] === undefined)
+        return false;
+    if (!('lastViewedAt' in value) || value['lastViewedAt'] === undefined)
+        return false;
     if (!('userId' in value) || value['userId'] === undefined)
         return false;
     if (!('visibility' in value) || value['visibility'] === undefined)
         return false;
+    if (!('subjectId' in value) || value['subjectId'] === undefined)
+        return false;
+    if (!('latestJobId' in value) || value['latestJobId'] === undefined)
+        return false;
+    if (!('analysisScheduledFor' in value) || value['analysisScheduledFor'] === undefined)
+        return false;
+    if (!('goal' in value) || value['goal'] === undefined)
+        return false;
+    if (!('goalAchieved' in value) || value['goalAchieved'] === undefined)
+        return false;
     if (!('forReview' in value) || value['forReview'] === undefined)
         return false;
     return true;
@@ -55,15 +69,15 @@ function ChatFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'createdAt': (new Date(json['createdAt'])),
         'title': json['title'],
-        'chatType': json['chatType'] == null ? undefined : json['chatType'],
-        'lastViewedAt': json['lastViewedAt'] == null ? undefined : (new Date(json['lastViewedAt'])),
+        'chatType': json['chatType'],
+        'lastViewedAt': (json['lastViewedAt'] == null ? null : new Date(json['lastViewedAt'])),
         'userId': json['userId'],
         'visibility': json['visibility'],
-        'subjectId': json['subjectId'] == null ? undefined : json['subjectId'],
-        'latestJobId': json['latestJobId'] == null ? undefined : json['latestJobId'],
-        'analysisScheduledFor': json['analysisScheduledFor'] == null ? undefined : (new Date(json['analysisScheduledFor'])),
-        'goal': json['goal'] == null ? undefined : json['goal'],
-        'goalAchieved': json['goalAchieved'] == null ? undefined : json['goalAchieved'],
+        'subjectId': json['subjectId'],
+        'latestJobId': json['latestJobId'],
+        'analysisScheduledFor': (json['analysisScheduledFor'] == null ? null : new Date(json['analysisScheduledFor'])),
+        'goal': json['goal'],
+        'goalAchieved': json['goalAchieved'],
         'forReview': json['forReview'],
     };
 }

package/dist/models/ChatRequestAttachmentsInner.d.ts

@@ -27,6 +27,12 @@ export interface ChatRequestAttachmentsInner {
      * @memberof ChatRequestAttachmentsInner
      */
     mimeType: ChatRequestAttachmentsInnerMimeTypeEnum;
+    /**
+     * Original filename of the uploaded file
+     * @type {string}
+     * @memberof ChatRequestAttachmentsInner
+     */
+    name: string;
 }
 /**
  * @export