@instructure/athena-api-client 2.14.4 → 2.15.1

package/dist/esm/models/UserConceptConcept.js

@@ -0,0 +1,51 @@
+/* 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 UserConceptConcept interface.
+ */
+export function instanceOfUserConceptConcept(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+export function UserConceptConceptFromJSON(json) {
+    return UserConceptConceptFromJSONTyped(json, false);
+}
+export function UserConceptConceptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+    };
+}
+export function UserConceptConceptToJSON(json) {
+    return UserConceptConceptToJSONTyped(json, false);
+}
+export function UserConceptConceptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+    };
+}

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

@@ -36,6 +36,7 @@ export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
 export * from './LearningMomentCount';
+export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageAttachment';
@@ -47,6 +48,7 @@ export * from './PaginatedMessages';
 export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
+export * from './PaginatedUserConcepts';
 export * from './Plan';
 export * from './Quiz';
 export * from './QuizListItem';
@@ -82,8 +84,11 @@ export * from './UploadUrlRequest';
 export * from './UploadUrlRequestFilesInner';
 export * from './UploadUrlResponse';
 export * from './UpsertOverrideDto';
+export * from './UpsertUserConceptByNameRequest';
 export * from './UpsertUserContextRequest';
 export * from './UpsertVoteRequest';
+export * from './UserConcept';
+export * from './UserConceptConcept';
 export * from './UserContext';
 export * from './Vote';
 export * from './VotesResponse';

package/dist/esm/models/index.js

@@ -38,6 +38,7 @@ export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
 export * from './LearningMomentCount';
+export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageAttachment';
@@ -49,6 +50,7 @@ export * from './PaginatedMessages';
 export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
+export * from './PaginatedUserConcepts';
 export * from './Plan';
 export * from './Quiz';
 export * from './QuizListItem';
@@ -84,8 +86,11 @@ export * from './UploadUrlRequest';
 export * from './UploadUrlRequestFilesInner';
 export * from './UploadUrlResponse';
 export * from './UpsertOverrideDto';
+export * from './UpsertUserConceptByNameRequest';
 export * from './UpsertUserContextRequest';
 export * from './UpsertVoteRequest';
+export * from './UserConcept';
+export * from './UserConceptConcept';
 export * from './UserContext';
 export * from './Vote';
 export * from './VotesResponse';

package/dist/models/LearningSessionEvaluation.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 LearningSessionEvaluation
+ */
+export interface LearningSessionEvaluation {
+    /**
+     * Unique identifier for this evaluation row
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    id: string;
+    /**
+     * Chat the evaluation belongs to
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    chatId: string;
+    /**
+     * Message whose user turn this evaluation scored
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    messageId: string;
+    /**
+     * Evaluator-produced mastery strength for this turn, as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    strength: string;
+    /**
+     * Evaluator-produced confidence weight for this turn's signal, as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    confidence: string;
+    /**
+     * Short human-readable label for the evidence the evaluator surfaced (e.g. 'retrieval-correct').
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    evidenceLabel: string | null;
+    /**
+     * Free-form evaluator rationale.
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    reason: string | null;
+    /**
+     * Session beat the turn landed in (Level Up: 'orient' | 'warmup' | 'teach' | 'practice' | 'stretch' | 'teachback' | 'wrap'; Quick Practice: 'anchor' | 'retrieval' | 'commit').
+     * @type {string}
+     * @memberof LearningSessionEvaluation
+     */
+    sessionBeat: string;
+    /**
+     * When this evaluation was persisted
+     * @type {Date}
+     * @memberof LearningSessionEvaluation
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the LearningSessionEvaluation interface.
+ */
+export declare function instanceOfLearningSessionEvaluation(value: object): value is LearningSessionEvaluation;
+export declare function LearningSessionEvaluationFromJSON(json: any): LearningSessionEvaluation;
+export declare function LearningSessionEvaluationFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningSessionEvaluation;
+export declare function LearningSessionEvaluationToJSON(json: any): LearningSessionEvaluation;
+export declare function LearningSessionEvaluationToJSONTyped(value?: LearningSessionEvaluation | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LearningSessionEvaluation.js

@@ -0,0 +1,82 @@
+"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.instanceOfLearningSessionEvaluation = instanceOfLearningSessionEvaluation;
+exports.LearningSessionEvaluationFromJSON = LearningSessionEvaluationFromJSON;
+exports.LearningSessionEvaluationFromJSONTyped = LearningSessionEvaluationFromJSONTyped;
+exports.LearningSessionEvaluationToJSON = LearningSessionEvaluationToJSON;
+exports.LearningSessionEvaluationToJSONTyped = LearningSessionEvaluationToJSONTyped;
+/**
+ * Check if a given object implements the LearningSessionEvaluation interface.
+ */
+function instanceOfLearningSessionEvaluation(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('messageId' in value) || value['messageId'] === undefined)
+        return false;
+    if (!('strength' in value) || value['strength'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('evidenceLabel' in value) || value['evidenceLabel'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    if (!('sessionBeat' in value) || value['sessionBeat'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function LearningSessionEvaluationFromJSON(json) {
+    return LearningSessionEvaluationFromJSONTyped(json, false);
+}
+function LearningSessionEvaluationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'chatId': json['chatId'],
+        'messageId': json['messageId'],
+        'strength': json['strength'],
+        'confidence': json['confidence'],
+        'evidenceLabel': json['evidenceLabel'],
+        'reason': json['reason'],
+        'sessionBeat': json['sessionBeat'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+function LearningSessionEvaluationToJSON(json) {
+    return LearningSessionEvaluationToJSONTyped(json, false);
+}
+function LearningSessionEvaluationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'chatId': value['chatId'],
+        'messageId': value['messageId'],
+        'strength': value['strength'],
+        'confidence': value['confidence'],
+        'evidenceLabel': value['evidenceLabel'],
+        'reason': value['reason'],
+        'sessionBeat': value['sessionBeat'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

package/dist/models/PaginatedUserConcepts.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { UserConcept } from './UserConcept';
+/**
+ *
+ * @export
+ * @interface PaginatedUserConcepts
+ */
+export interface PaginatedUserConcepts {
+    /**
+     * Array of user-concept rows for the current page
+     * @type {Array<UserConcept>}
+     * @memberof PaginatedUserConcepts
+     */
+    data: Array<UserConcept>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedUserConcepts
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedUserConcepts interface.
+ */
+export declare function instanceOfPaginatedUserConcepts(value: object): value is PaginatedUserConcepts;
+export declare function PaginatedUserConceptsFromJSON(json: any): PaginatedUserConcepts;
+export declare function PaginatedUserConceptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedUserConcepts;
+export declare function PaginatedUserConceptsToJSON(json: any): PaginatedUserConcepts;
+export declare function PaginatedUserConceptsToJSONTyped(value?: PaginatedUserConcepts | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PaginatedUserConcepts.js

@@ -0,0 +1,55 @@
+"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.instanceOfPaginatedUserConcepts = instanceOfPaginatedUserConcepts;
+exports.PaginatedUserConceptsFromJSON = PaginatedUserConceptsFromJSON;
+exports.PaginatedUserConceptsFromJSONTyped = PaginatedUserConceptsFromJSONTyped;
+exports.PaginatedUserConceptsToJSON = PaginatedUserConceptsToJSON;
+exports.PaginatedUserConceptsToJSONTyped = PaginatedUserConceptsToJSONTyped;
+const UserConcept_1 = require("./UserConcept");
+/**
+ * Check if a given object implements the PaginatedUserConcepts interface.
+ */
+function instanceOfPaginatedUserConcepts(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedUserConceptsFromJSON(json) {
+    return PaginatedUserConceptsFromJSONTyped(json, false);
+}
+function PaginatedUserConceptsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(UserConcept_1.UserConceptFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function PaginatedUserConceptsToJSON(json) {
+    return PaginatedUserConceptsToJSONTyped(json, false);
+}
+function PaginatedUserConceptsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(UserConcept_1.UserConceptToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/UpsertUserConceptByNameRequest.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 UpsertUserConceptByNameRequest
+ */
+export interface UpsertUserConceptByNameRequest {
+    /**
+     * Learner-supplied concept name. Leading/trailing whitespace is trimmed and internal runs of whitespace are collapsed before lookup; matching is case-insensitive. When a new concept row is created, the caller's original casing is preserved.
+     * @type {string}
+     * @memberof UpsertUserConceptByNameRequest
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the UpsertUserConceptByNameRequest interface.
+ */
+export declare function instanceOfUpsertUserConceptByNameRequest(value: object): value is UpsertUserConceptByNameRequest;
+export declare function UpsertUserConceptByNameRequestFromJSON(json: any): UpsertUserConceptByNameRequest;
+export declare function UpsertUserConceptByNameRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertUserConceptByNameRequest;
+export declare function UpsertUserConceptByNameRequestToJSON(json: any): UpsertUserConceptByNameRequest;
+export declare function UpsertUserConceptByNameRequestToJSONTyped(value?: UpsertUserConceptByNameRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpsertUserConceptByNameRequest.js

@@ -0,0 +1,50 @@
+"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.instanceOfUpsertUserConceptByNameRequest = instanceOfUpsertUserConceptByNameRequest;
+exports.UpsertUserConceptByNameRequestFromJSON = UpsertUserConceptByNameRequestFromJSON;
+exports.UpsertUserConceptByNameRequestFromJSONTyped = UpsertUserConceptByNameRequestFromJSONTyped;
+exports.UpsertUserConceptByNameRequestToJSON = UpsertUserConceptByNameRequestToJSON;
+exports.UpsertUserConceptByNameRequestToJSONTyped = UpsertUserConceptByNameRequestToJSONTyped;
+/**
+ * Check if a given object implements the UpsertUserConceptByNameRequest interface.
+ */
+function instanceOfUpsertUserConceptByNameRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function UpsertUserConceptByNameRequestFromJSON(json) {
+    return UpsertUserConceptByNameRequestFromJSONTyped(json, false);
+}
+function UpsertUserConceptByNameRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+    };
+}
+function UpsertUserConceptByNameRequestToJSON(json) {
+    return UpsertUserConceptByNameRequestToJSONTyped(json, false);
+}
+function UpsertUserConceptByNameRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+    };
+}

package/dist/models/UserConcept.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 { UserConceptConcept } from './UserConceptConcept';
+/**
+ *
+ * @export
+ * @interface UserConcept
+ */
+export interface UserConcept {
+    /**
+     * Foreign key to the concept row
+     * @type {string}
+     * @memberof UserConcept
+     */
+    conceptId: string;
+    /**
+     * Current mastery strength for this learner + concept, expressed as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof UserConcept
+     */
+    strength: string;
+    /**
+     * Current confidence weight for the strength signal, expressed as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof UserConcept
+     */
+    confidence: string;
+    /**
+     * When this user-concept row was first created
+     * @type {Date}
+     * @memberof UserConcept
+     */
+    createdAt: Date;
+    /**
+     * When this user-concept row's strength/confidence last changed
+     * @type {Date}
+     * @memberof UserConcept
+     */
+    updatedAt: Date;
+    /**
+     * Concept metadata joined in for convenience
+     * @type {UserConceptConcept}
+     * @memberof UserConcept
+     */
+    concept: UserConceptConcept;
+}
+/**
+ * Check if a given object implements the UserConcept interface.
+ */
+export declare function instanceOfUserConcept(value: object): value is UserConcept;
+export declare function UserConceptFromJSON(json: any): UserConcept;
+export declare function UserConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserConcept;
+export declare function UserConceptToJSON(json: any): UserConcept;
+export declare function UserConceptToJSONTyped(value?: UserConcept | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UserConcept.js

@@ -0,0 +1,71 @@
+"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.instanceOfUserConcept = instanceOfUserConcept;
+exports.UserConceptFromJSON = UserConceptFromJSON;
+exports.UserConceptFromJSONTyped = UserConceptFromJSONTyped;
+exports.UserConceptToJSON = UserConceptToJSON;
+exports.UserConceptToJSONTyped = UserConceptToJSONTyped;
+const UserConceptConcept_1 = require("./UserConceptConcept");
+/**
+ * Check if a given object implements the UserConcept interface.
+ */
+function instanceOfUserConcept(value) {
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('strength' in value) || value['strength'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if (!('concept' in value) || value['concept'] === undefined)
+        return false;
+    return true;
+}
+function UserConceptFromJSON(json) {
+    return UserConceptFromJSONTyped(json, false);
+}
+function UserConceptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'],
+        'strength': json['strength'],
+        'confidence': json['confidence'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'concept': (0, UserConceptConcept_1.UserConceptConceptFromJSON)(json['concept']),
+    };
+}
+function UserConceptToJSON(json) {
+    return UserConceptToJSONTyped(json, false);
+}
+function UserConceptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'strength': value['strength'],
+        'confidence': value['confidence'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+        'concept': (0, UserConceptConcept_1.UserConceptConceptToJSON)(value['concept']),
+    };
+}

package/dist/models/UserConceptConcept.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 UserConceptConcept
+ */
+export interface UserConceptConcept {
+    /**
+     * Unique identifier of the concept
+     * @type {string}
+     * @memberof UserConceptConcept
+     */
+    id: string;
+    /**
+     * Human-readable concept name
+     * @type {string}
+     * @memberof UserConceptConcept
+     */
+    name: string;
+    /**
+     * Optional free-form description
+     * @type {string}
+     * @memberof UserConceptConcept
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the UserConceptConcept interface.
+ */
+export declare function instanceOfUserConceptConcept(value: object): value is UserConceptConcept;
+export declare function UserConceptConceptFromJSON(json: any): UserConceptConcept;
+export declare function UserConceptConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserConceptConcept;
+export declare function UserConceptConceptToJSON(json: any): UserConceptConcept;
+export declare function UserConceptConceptToJSONTyped(value?: UserConceptConcept | null, ignoreDiscriminator?: boolean): any;