@instructure/athena-api-client 1.0.9 → 1.0.11

package/dist/esm/models/MessagePart.js

@@ -0,0 +1,43 @@
+/* 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 MessagePart interface.
+ */
+export function instanceOfMessagePart(value) {
+    return true;
+}
+export function MessagePartFromJSON(json) {
+    return MessagePartFromJSONTyped(json, false);
+}
+export function MessagePartFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'] == null ? undefined : json['type'],
+        'text': json['text'] == null ? undefined : json['text'],
+    };
+}
+export function MessagePartToJSON(json) {
+    return MessagePartToJSONTyped(json, false);
+}
+export function MessagePartToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'text': value['text'],
+    };
+}

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

@@ -17,7 +17,7 @@ import type { Message } from './Message';
  */
 export interface PaginatedMessages {
     /**
-     *
+     * Array of message objects
      * @type {Array<Message>}
      * @memberof PaginatedMessages
      */

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

@@ -0,0 +1,56 @@
+/**
+ * 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 Plan
+ */
+export interface Plan {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof Plan
+     */
+    id: string;
+    /**
+     * Plan name
+     * @type {string}
+     * @memberof Plan
+     */
+    name: string;
+    /**
+     * Plan rank (higher = better)
+     * @type {number}
+     * @memberof Plan
+     */
+    rank: number;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof Plan
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof Plan
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the Plan interface.
+ */
+export declare function instanceOfPlan(value: object): value is Plan;
+export declare function PlanFromJSON(json: any): Plan;
+export declare function PlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): Plan;
+export declare function PlanToJSON(json: any): Plan;
+export declare function PlanToJSONTyped(value?: Plan | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Plan.js

@@ -0,0 +1,59 @@
+/* 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 Plan interface.
+ */
+export function instanceOfPlan(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('rank' in value) || value['rank'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function PlanFromJSON(json) {
+    return PlanFromJSONTyped(json, false);
+}
+export function PlanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'rank': json['rank'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function PlanToJSON(json) {
+    return PlanToJSONTyped(json, false);
+}
+export function PlanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'rank': value['rank'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -32,7 +32,7 @@ export interface QuizQuestion {
      * @type {string}
      * @memberof QuizQuestion
      */
-    conceptId?: string | null;
+    conceptId: string | null;
     /**
      *
      * @type {number}
@@ -56,7 +56,7 @@ export interface QuizQuestion {
      * @type {Array<string>}
      * @memberof QuizQuestion
      */
-    options?: Array<string> | null;
+    options: Array<string> | null;
     /**
      *
      * @type {string}
@@ -68,13 +68,13 @@ export interface QuizQuestion {
      * @type {string}
      * @memberof QuizQuestion
      */
-    explanation?: string | null;
+    explanation: string | null;
     /**
      *
      * @type {string}
      * @memberof QuizQuestion
      */
-    topic?: string | null;
+    topic: string | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/QuizQuestion.js

@@ -29,14 +29,22 @@ export function instanceOfQuizQuestion(value) {
         return false;
     if (!('quizId' in value) || value['quizId'] === undefined)
         return false;
+    if (!('conceptId' in value) || value['conceptId'] === 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 (!('options' in value) || value['options'] === undefined)
+        return false;
     if (!('correctAnswer' in value) || value['correctAnswer'] === undefined)
         return false;
+    if (!('explanation' in value) || value['explanation'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -51,14 +59,14 @@ export function QuizQuestionFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'quizId': json['quizId'],
-        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
+        'conceptId': json['conceptId'],
         'ordinal': json['ordinal'],
         'type': json['type'],
         'question': json['question'],
-        'options': json['options'] == null ? undefined : json['options'],
+        'options': json['options'] == null ? null : json['options'],
         'correctAnswer': json['correctAnswer'],
-        'explanation': json['explanation'] == null ? undefined : json['explanation'],
-        'topic': json['topic'] == null ? undefined : json['topic'],
+        'explanation': json['explanation'],
+        'topic': json['topic'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }

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

@@ -44,13 +44,13 @@ export interface QuizResponse {
      * @type {boolean}
      * @memberof QuizResponse
      */
-    isCorrect?: boolean | null;
+    isCorrect: boolean | null;
     /**
      *
      * @type {string}
      * @memberof QuizResponse
      */
-    rating?: QuizResponseRatingEnum | null;
+    rating: QuizResponseRatingEnum | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/QuizResponse.js

@@ -30,6 +30,10 @@ export function instanceOfQuizResponse(value) {
         return false;
     if (!('userAnswer' in value) || value['userAnswer'] === undefined)
         return false;
+    if (!('isCorrect' in value) || value['isCorrect'] === undefined)
+        return false;
+    if (!('rating' in value) || value['rating'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     return true;
@@ -46,8 +50,8 @@ export function QuizResponseFromJSONTyped(json, ignoreDiscriminator) {
         'sessionId': json['sessionId'],
         'questionId': json['questionId'],
         'userAnswer': json['userAnswer'],
-        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
-        'rating': json['rating'] == null ? undefined : json['rating'],
+        'isCorrect': json['isCorrect'],
+        'rating': json['rating'],
         'createdAt': (new Date(json['createdAt'])),
     };
 }

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

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { QuizSessionSummaryScore } from './QuizSessionSummaryScore';
+import type { Score } from './Score';
 import type { Quiz } from './Quiz';
 import type { QuizSession } from './QuizSession';
 import type { QuizQuestion } from './QuizQuestion';
@@ -46,10 +46,10 @@ export interface QuizSessionSummary {
     responses: Array<QuizResponse>;
     /**
      *
-     * @type {QuizSessionSummaryScore}
+     * @type {Score}
      * @memberof QuizSessionSummary
      */
-    score: QuizSessionSummaryScore;
+    score: Score;
 }
 /**
  * Check if a given object implements the QuizSessionSummary interface.

package/dist/esm/models/QuizSessionSummary.js

@@ -11,7 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { QuizSessionSummaryScoreFromJSON, QuizSessionSummaryScoreToJSON, } from './QuizSessionSummaryScore';
+import { ScoreFromJSON, ScoreToJSON, } from './Score';
 import { QuizFromJSON, QuizToJSON, } from './Quiz';
 import { QuizSessionFromJSON, QuizSessionToJSON, } from './QuizSession';
 import { QuizQuestionFromJSON, QuizQuestionToJSON, } from './QuizQuestion';
@@ -44,7 +44,7 @@ export function QuizSessionSummaryFromJSONTyped(json, ignoreDiscriminator) {
         'quiz': QuizFromJSON(json['quiz']),
         'questions': (json['questions'].map(QuizQuestionFromJSON)),
         'responses': (json['responses'].map(QuizResponseFromJSON)),
-        'score': QuizSessionSummaryScoreFromJSON(json['score']),
+        'score': ScoreFromJSON(json['score']),
     };
 }
 export function QuizSessionSummaryToJSON(json) {
@@ -59,6 +59,6 @@ export function QuizSessionSummaryToJSONTyped(value, ignoreDiscriminator = false
         'quiz': QuizToJSON(value['quiz']),
         'questions': (value['questions'].map(QuizQuestionToJSON)),
         'responses': (value['responses'].map(QuizResponseToJSON)),
-        'score': QuizSessionSummaryScoreToJSON(value['score']),
+        'score': ScoreToJSON(value['score']),
     };
 }

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

@@ -0,0 +1,47 @@
+/**
+ * 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 { ScoreByTypeValue } from './ScoreByTypeValue';
+/**
+ *
+ * @export
+ * @interface Score
+ */
+export interface Score {
+    /**
+     *
+     * @type {number}
+     * @memberof Score
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Score
+     */
+    totalQuestions: number;
+    /**
+     *
+     * @type {{ [key: string]: ScoreByTypeValue; }}
+     * @memberof Score
+     */
+    byType: {
+        [key: string]: ScoreByTypeValue;
+    };
+}
+/**
+ * Check if a given object implements the Score interface.
+ */
+export declare function instanceOfScore(value: object): value is Score;
+export declare function ScoreFromJSON(json: any): Score;
+export declare function ScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): Score;
+export declare function ScoreToJSON(json: any): Score;
+export declare function ScoreToJSONTyped(value?: Score | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Score.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 Score interface.
+ */
+export function instanceOfScore(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 ScoreFromJSON(json) {
+    return ScoreFromJSONTyped(json, false);
+}
+export function ScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+        'byType': (mapValues(json['byType'], ScoreByTypeValueFromJSON)),
+    };
+}
+export function ScoreToJSON(json) {
+    return ScoreToJSONTyped(json, false);
+}
+export function ScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+        'byType': (mapValues(value['byType'], ScoreByTypeValueToJSON)),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 UpdateAccountDto
+ */
+export interface UpdateAccountDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateAccountDto
+     */
+    planId: string | null;
+}
+/**
+ * Check if a given object implements the UpdateAccountDto interface.
+ */
+export declare function instanceOfUpdateAccountDto(value: object): value is UpdateAccountDto;
+export declare function UpdateAccountDtoFromJSON(json: any): UpdateAccountDto;
+export declare function UpdateAccountDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAccountDto;
+export declare function UpdateAccountDtoToJSON(json: any): UpdateAccountDto;
+export declare function UpdateAccountDtoToJSONTyped(value?: UpdateAccountDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateAccountDto.js

@@ -0,0 +1,43 @@
+/* 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 UpdateAccountDto interface.
+ */
+export function instanceOfUpdateAccountDto(value) {
+    if (!('planId' in value) || value['planId'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateAccountDtoFromJSON(json) {
+    return UpdateAccountDtoFromJSONTyped(json, false);
+}
+export function UpdateAccountDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'planId': json['planId'],
+    };
+}
+export function UpdateAccountDtoToJSON(json) {
+    return UpdateAccountDtoToJSONTyped(json, false);
+}
+export function UpdateAccountDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'planId': value['planId'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 UpdateFeatureDto
+ */
+export interface UpdateFeatureDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateFeatureDto
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateFeatureDto
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateFeatureDto
+     */
+    planId?: string;
+}
+/**
+ * Check if a given object implements the UpdateFeatureDto interface.
+ */
+export declare function instanceOfUpdateFeatureDto(value: object): value is UpdateFeatureDto;
+export declare function UpdateFeatureDtoFromJSON(json: any): UpdateFeatureDto;
+export declare function UpdateFeatureDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateFeatureDto;
+export declare function UpdateFeatureDtoToJSON(json: any): UpdateFeatureDto;
+export declare function UpdateFeatureDtoToJSONTyped(value?: UpdateFeatureDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateFeatureDto.js

@@ -0,0 +1,45 @@
+/* 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 UpdateFeatureDto interface.
+ */
+export function instanceOfUpdateFeatureDto(value) {
+    return true;
+}
+export function UpdateFeatureDtoFromJSON(json) {
+    return UpdateFeatureDtoFromJSONTyped(json, false);
+}
+export function UpdateFeatureDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'planId': json['planId'] == null ? undefined : json['planId'],
+    };
+}
+export function UpdateFeatureDtoToJSON(json) {
+    return UpdateFeatureDtoToJSONTyped(json, false);
+}
+export function UpdateFeatureDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'planId': value['planId'],
+    };
+}

package/dist/esm/models/UpdatePlanDto.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 UpdatePlanDto
+ */
+export interface UpdatePlanDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdatePlanDto
+     */
+    name?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdatePlanDto
+     */
+    rank?: number;
+}
+/**
+ * Check if a given object implements the UpdatePlanDto interface.
+ */
+export declare function instanceOfUpdatePlanDto(value: object): value is UpdatePlanDto;
+export declare function UpdatePlanDtoFromJSON(json: any): UpdatePlanDto;
+export declare function UpdatePlanDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdatePlanDto;
+export declare function UpdatePlanDtoToJSON(json: any): UpdatePlanDto;
+export declare function UpdatePlanDtoToJSONTyped(value?: UpdatePlanDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdatePlanDto.js

@@ -0,0 +1,43 @@
+/* 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 UpdatePlanDto interface.
+ */
+export function instanceOfUpdatePlanDto(value) {
+    return true;
+}
+export function UpdatePlanDtoFromJSON(json) {
+    return UpdatePlanDtoFromJSONTyped(json, false);
+}
+export function UpdatePlanDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'rank': json['rank'] == null ? undefined : json['rank'],
+    };
+}
+export function UpdatePlanDtoToJSON(json) {
+    return UpdatePlanDtoToJSONTyped(json, false);
+}
+export function UpdatePlanDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'rank': value['rank'],
+    };
+}