@instructure/athena-api-client 1.0.6 → 1.0.8

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(),
+    };
+}

package/dist/models/QuizQuestion.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 QuizQuestion
+ */
+export interface QuizQuestion {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    conceptId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizQuestion
+     */
+    ordinal: number;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    type: QuizQuestionTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    question: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof QuizQuestion
+     */
+    options?: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    correctAnswer: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    explanation?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    topic?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizQuestion
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const QuizQuestionTypeEnum: {
+    readonly Mcq: "mcq";
+    readonly FillBlank: "fill-blank";
+    readonly SpotError: "spot-error";
+    readonly TeachBack: "teach-back";
+    readonly Flashcard: "flashcard";
+};
+export type QuizQuestionTypeEnum = typeof QuizQuestionTypeEnum[keyof typeof QuizQuestionTypeEnum];
+/**
+ * Check if a given object implements the QuizQuestion interface.
+ */
+export declare function instanceOfQuizQuestion(value: object): value is QuizQuestion;
+export declare function QuizQuestionFromJSON(json: any): QuizQuestion;
+export declare function QuizQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizQuestion;
+export declare function QuizQuestionToJSON(json: any): QuizQuestion;
+export declare function QuizQuestionToJSONTyped(value?: QuizQuestion | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizQuestion.js

@@ -0,0 +1,93 @@
+"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.QuizQuestionTypeEnum = void 0;
+exports.instanceOfQuizQuestion = instanceOfQuizQuestion;
+exports.QuizQuestionFromJSON = QuizQuestionFromJSON;
+exports.QuizQuestionFromJSONTyped = QuizQuestionFromJSONTyped;
+exports.QuizQuestionToJSON = QuizQuestionToJSON;
+exports.QuizQuestionToJSONTyped = QuizQuestionToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizQuestionTypeEnum = {
+    Mcq: 'mcq',
+    FillBlank: 'fill-blank',
+    SpotError: 'spot-error',
+    TeachBack: 'teach-back',
+    Flashcard: 'flashcard'
+};
+/**
+ * Check if a given object implements the QuizQuestion interface.
+ */
+function instanceOfQuizQuestion(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('ordinal' in value) || value['ordinal'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('question' in value) || value['question'] === undefined)
+        return false;
+    if (!('correctAnswer' in value) || value['correctAnswer'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function QuizQuestionFromJSON(json) {
+    return QuizQuestionFromJSONTyped(json, false);
+}
+function QuizQuestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
+        'ordinal': json['ordinal'],
+        'type': json['type'],
+        'question': json['question'],
+        'options': json['options'] == null ? undefined : json['options'],
+        'correctAnswer': json['correctAnswer'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'topic': json['topic'] == null ? undefined : json['topic'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+function QuizQuestionToJSON(json) {
+    return QuizQuestionToJSONTyped(json, false);
+}
+function QuizQuestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'conceptId': value['conceptId'],
+        'ordinal': value['ordinal'],
+        'type': value['type'],
+        'question': value['question'],
+        'options': value['options'],
+        'correctAnswer': value['correctAnswer'],
+        'explanation': value['explanation'],
+        'topic': value['topic'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

package/dist/models/QuizResponse.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 QuizResponse
+ */
+export interface QuizResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    sessionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    questionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    userAnswer: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof QuizResponse
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    rating?: QuizResponseRatingEnum | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizResponse
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const QuizResponseRatingEnum: {
+    readonly WasRight: "was-right";
+    readonly NeedPractice: "need-practice";
+};
+export type QuizResponseRatingEnum = typeof QuizResponseRatingEnum[keyof typeof QuizResponseRatingEnum];
+/**
+ * Check if a given object implements the QuizResponse interface.
+ */
+export declare function instanceOfQuizResponse(value: object): value is QuizResponse;
+export declare function QuizResponseFromJSON(json: any): QuizResponse;
+export declare function QuizResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizResponse;
+export declare function QuizResponseToJSON(json: any): QuizResponse;
+export declare function QuizResponseToJSONTyped(value?: QuizResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizResponse.js

@@ -0,0 +1,78 @@
+"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.QuizResponseRatingEnum = void 0;
+exports.instanceOfQuizResponse = instanceOfQuizResponse;
+exports.QuizResponseFromJSON = QuizResponseFromJSON;
+exports.QuizResponseFromJSONTyped = QuizResponseFromJSONTyped;
+exports.QuizResponseToJSON = QuizResponseToJSON;
+exports.QuizResponseToJSONTyped = QuizResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizResponseRatingEnum = {
+    WasRight: 'was-right',
+    NeedPractice: 'need-practice'
+};
+/**
+ * Check if a given object implements the QuizResponse interface.
+ */
+function instanceOfQuizResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
+        return false;
+    if (!('questionId' in value) || value['questionId'] === undefined)
+        return false;
+    if (!('userAnswer' in value) || value['userAnswer'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function QuizResponseFromJSON(json) {
+    return QuizResponseFromJSONTyped(json, false);
+}
+function QuizResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'sessionId': json['sessionId'],
+        'questionId': json['questionId'],
+        'userAnswer': json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+function QuizResponseToJSON(json) {
+    return QuizResponseToJSONTyped(json, false);
+}
+function QuizResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'sessionId': value['sessionId'],
+        'questionId': value['questionId'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'rating': value['rating'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

package/dist/models/QuizSession.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 QuizSession
+ */
+export interface QuizSession {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    status: QuizSessionStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSession
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSession
+     */
+    completedAt?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const QuizSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type QuizSessionStatusEnum = typeof QuizSessionStatusEnum[keyof typeof QuizSessionStatusEnum];
+/**
+ * Check if a given object implements the QuizSession interface.
+ */
+export declare function instanceOfQuizSession(value: object): value is QuizSession;
+export declare function QuizSessionFromJSON(json: any): QuizSession;
+export declare function QuizSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSession;
+export declare function QuizSessionToJSON(json: any): QuizSession;
+export declare function QuizSessionToJSONTyped(value?: QuizSession | null, ignoreDiscriminator?: boolean): any;