@instructure/athena-api-client 1.0.7 → 1.0.9

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/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

package/dist/models/ChatRequestAttachmentsInner.js

@@ -37,6 +37,8 @@ function instanceOfChatRequestAttachmentsInner(value) {
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
         return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
     return true;
 }
 function ChatRequestAttachmentsInnerFromJSON(json) {
@@ -49,6 +51,7 @@ function ChatRequestAttachmentsInnerFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'fileId': json['fileId'],
         'mimeType': json['mimeType'],
+        'name': json['name'],
     };
 }
 function ChatRequestAttachmentsInnerToJSON(json) {
@@ -61,5 +64,6 @@ function ChatRequestAttachmentsInnerToJSONTyped(value, ignoreDiscriminator = fal
     return {
         'fileId': value['fileId'],
         'mimeType': value['mimeType'],
+        'name': value['name'],
     };
 }

package/dist/models/MessageAttachmentsInner.d.ts

@@ -27,6 +27,12 @@ export interface MessageAttachmentsInner {
      * @memberof MessageAttachmentsInner
      */
     mimeType: MessageAttachmentsInnerMimeTypeEnum;
+    /**
+     * Original filename of the uploaded file
+     * @type {string}
+     * @memberof MessageAttachmentsInner
+     */
+    name: string;
     /**
      * Fresh signed GET URL (expires in 30 minutes). Absent for legacy attachments without a fileId.
      * @type {string}

package/dist/models/MessageAttachmentsInner.js

@@ -37,6 +37,8 @@ function instanceOfMessageAttachmentsInner(value) {
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
         return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
     return true;
 }
 function MessageAttachmentsInnerFromJSON(json) {
@@ -49,6 +51,7 @@ function MessageAttachmentsInnerFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'fileId': json['fileId'],
         'mimeType': json['mimeType'],
+        'name': json['name'],
         'url': json['url'] == null ? undefined : json['url'],
     };
 }
@@ -62,6 +65,7 @@ function MessageAttachmentsInnerToJSONTyped(value, ignoreDiscriminator = false)
     return {
         'fileId': value['fileId'],
         'mimeType': value['mimeType'],
+        'name': value['name'],
         'url': value['url'],
     };
 }

package/dist/models/Quiz.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 Quiz
+ */
+export interface Quiz {
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    chatId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Quiz
+     */
+    mode: QuizModeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof Quiz
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const QuizModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type QuizModeEnum = typeof QuizModeEnum[keyof typeof QuizModeEnum];
+/**
+ * Check if a given object implements the Quiz interface.
+ */
+export declare function instanceOfQuiz(value: object): value is Quiz;
+export declare function QuizFromJSON(json: any): Quiz;
+export declare function QuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): Quiz;
+export declare function QuizToJSON(json: any): Quiz;
+export declare function QuizToJSONTyped(value?: Quiz | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Quiz.js

@@ -0,0 +1,80 @@
+"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.QuizModeEnum = void 0;
+exports.instanceOfQuiz = instanceOfQuiz;
+exports.QuizFromJSON = QuizFromJSON;
+exports.QuizFromJSONTyped = QuizFromJSONTyped;
+exports.QuizToJSON = QuizToJSON;
+exports.QuizToJSONTyped = QuizToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the Quiz interface.
+ */
+function instanceOfQuiz(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;
+    return true;
+}
+function QuizFromJSON(json) {
+    return QuizFromJSONTyped(json, false);
+}
+function QuizFromJSONTyped(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'])),
+    };
+}
+function QuizToJSON(json) {
+    return QuizToJSONTyped(json, false);
+}
+function QuizToJSONTyped(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(),
+    };
+}