@instructure/athena-api-client 3.41.8 → 3.42.0

package/README.md

@@ -300,6 +300,7 @@ All URIs are relative to *http://localhost:3000*
 - [LearningMomentCount](docs/LearningMomentCount.md)
 - [LearningSessionEvaluation](docs/LearningSessionEvaluation.md)
 - [LearningStreakResponse](docs/LearningStreakResponse.md)
+- [LevelUpClose](docs/LevelUpClose.md)
 - [Message](docs/Message.md)
 - [MessageAttachment](docs/MessageAttachment.md)
 - [MessageCountResponse](docs/MessageCountResponse.md)

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { LevelUpClose } from './LevelUpClose';
 /**
  *
  * @export
@@ -129,6 +130,12 @@ export interface Chat {
      * @memberof Chat
      */
     closedAt: Date | null;
+    /**
+     * Level Up only: the stored close the close screen shows. Null when the chat isn't a closed Level Up, or closed before closes were stored (read `goalAchieved` for those).
+     * @type {LevelUpClose}
+     * @memberof Chat
+     */
+    levelUpClose: LevelUpClose | null;
 }
 /**
  * @export

package/dist/esm/models/Chat.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { LevelUpCloseFromJSON, LevelUpCloseToJSON, } from './LevelUpClose';
 /**
  * @export
  */
@@ -60,6 +61,8 @@ export function instanceOfChat(value) {
         return false;
     if (!('closedAt' in value) || value['closedAt'] === undefined)
         return false;
+    if (!('levelUpClose' in value) || value['levelUpClose'] === undefined)
+        return false;
     return true;
 }
 export function ChatFromJSON(json) {
@@ -89,6 +92,7 @@ export function ChatFromJSONTyped(json, ignoreDiscriminator) {
         'initialStrength': json['initialStrength'],
         'primaryConceptId': json['primaryConceptId'],
         'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
+        'levelUpClose': LevelUpCloseFromJSON(json['levelUpClose']),
     };
 }
 export function ChatToJSON(json) {
@@ -118,5 +122,6 @@ export function ChatToJSONTyped(value, ignoreDiscriminator = false) {
         'initialStrength': value['initialStrength'],
         'primaryConceptId': value['primaryConceptId'],
         'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
+        'levelUpClose': LevelUpCloseToJSON(value['levelUpClose']),
     };
 }

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

@@ -0,0 +1,94 @@
+/**
+ * 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 LevelUpClose
+ */
+export interface LevelUpClose {
+    /**
+     * How the session closed. `pending-confirmation`: Expert-level work was banked and is confirmed by a second sitting at least a day later; `tier` names what was certified, never Expert.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    state: LevelUpCloseStateEnum;
+    /**
+     * The tier the close screen names: the tier certified, or the tier held. Never a tier the close didn't certify.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    tier: LevelUpCloseTierEnum;
+    /**
+     * The session's target tier.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    targetTier: LevelUpCloseTargetTierEnum | null;
+    /**
+     * What we saw: the moves the learner showed, in the tutor's words.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    seen: string;
+    /**
+     * Not yet: what wasn't shown, or wasn't asked. Empty when the close reached its tier.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    notYet: string;
+    /**
+     * Next time: the move the next session starts on.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    next: string;
+}
+/**
+ * @export
+ */
+export declare const LevelUpCloseStateEnum: {
+    readonly HitTarget: "hit-target";
+    readonly BonusTier: "bonus-tier";
+    readonly TargetNotReached: "target-not-reached";
+    readonly PendingConfirmation: "pending-confirmation";
+};
+export type LevelUpCloseStateEnum = typeof LevelUpCloseStateEnum[keyof typeof LevelUpCloseStateEnum];
+/**
+ * @export
+ */
+export declare const LevelUpCloseTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type LevelUpCloseTierEnum = typeof LevelUpCloseTierEnum[keyof typeof LevelUpCloseTierEnum];
+/**
+ * @export
+ */
+export declare const LevelUpCloseTargetTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type LevelUpCloseTargetTierEnum = typeof LevelUpCloseTargetTierEnum[keyof typeof LevelUpCloseTargetTierEnum];
+/**
+ * Check if a given object implements the LevelUpClose interface.
+ */
+export declare function instanceOfLevelUpClose(value: object): value is LevelUpClose;
+export declare function LevelUpCloseFromJSON(json: any): LevelUpClose;
+export declare function LevelUpCloseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LevelUpClose;
+export declare function LevelUpCloseToJSON(json: any): LevelUpClose;
+export declare function LevelUpCloseToJSONTyped(value?: LevelUpClose | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LevelUpClose.js

@@ -0,0 +1,92 @@
+/* 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 LevelUpCloseStateEnum = {
+    HitTarget: 'hit-target',
+    BonusTier: 'bonus-tier',
+    TargetNotReached: 'target-not-reached',
+    PendingConfirmation: 'pending-confirmation'
+};
+/**
+ * @export
+ */
+export const LevelUpCloseTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+export const LevelUpCloseTargetTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * Check if a given object implements the LevelUpClose interface.
+ */
+export function instanceOfLevelUpClose(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('tier' in value) || value['tier'] === undefined)
+        return false;
+    if (!('targetTier' in value) || value['targetTier'] === undefined)
+        return false;
+    if (!('seen' in value) || value['seen'] === undefined)
+        return false;
+    if (!('notYet' in value) || value['notYet'] === undefined)
+        return false;
+    if (!('next' in value) || value['next'] === undefined)
+        return false;
+    return true;
+}
+export function LevelUpCloseFromJSON(json) {
+    return LevelUpCloseFromJSONTyped(json, false);
+}
+export function LevelUpCloseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': json['state'],
+        'tier': json['tier'],
+        'targetTier': json['targetTier'],
+        'seen': json['seen'],
+        'notYet': json['notYet'],
+        'next': json['next'],
+    };
+}
+export function LevelUpCloseToJSON(json) {
+    return LevelUpCloseToJSONTyped(json, false);
+}
+export function LevelUpCloseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': value['state'],
+        'tier': value['tier'],
+        'targetTier': value['targetTier'],
+        'seen': value['seen'],
+        'notYet': value['notYet'],
+        'next': value['next'],
+    };
+}

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

@@ -52,6 +52,12 @@ export interface UserConcept {
      * @memberof UserConcept
      */
     concept: UserConceptConcept;
+    /**
+     * When Expert-level work on this concept was banked in a Level Up and not yet confirmed: the earliest such sitting since the last Expert certification. Expert is confirmed by a second sitting at least a day later; until then `strength` stays below Expert. Null when nothing is pending or the reading is already Expert.
+     * @type {Date}
+     * @memberof UserConcept
+     */
+    expertPendingSince: Date | null;
 }
 /**
  * Check if a given object implements the UserConcept interface.

package/dist/esm/models/UserConcept.js

@@ -28,6 +28,8 @@ export function instanceOfUserConcept(value) {
         return false;
     if (!('concept' in value) || value['concept'] === undefined)
         return false;
+    if (!('expertPendingSince' in value) || value['expertPendingSince'] === undefined)
+        return false;
     return true;
 }
 export function UserConceptFromJSON(json) {
@@ -44,6 +46,7 @@ export function UserConceptFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
         'concept': UserConceptConceptFromJSON(json['concept']),
+        'expertPendingSince': (json['expertPendingSince'] == null ? null : new Date(json['expertPendingSince'])),
     };
 }
 export function UserConceptToJSON(json) {
@@ -60,5 +63,6 @@ export function UserConceptToJSONTyped(value, ignoreDiscriminator = false) {
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
         'concept': UserConceptConceptToJSON(value['concept']),
+        'expertPendingSince': value['expertPendingSince'] == null ? value['expertPendingSince'] : value['expertPendingSince'].toISOString(),
     };
 }

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

@@ -102,6 +102,7 @@ export * from './LearningMoment';
 export * from './LearningMomentCount';
 export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
+export * from './LevelUpClose';
 export * from './Message';
 export * from './MessageAttachment';
 export * from './MessageCountResponse';

package/dist/esm/models/index.js

@@ -104,6 +104,7 @@ export * from './LearningMoment';
 export * from './LearningMomentCount';
 export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
+export * from './LevelUpClose';
 export * from './Message';
 export * from './MessageAttachment';
 export * from './MessageCountResponse';

package/dist/models/Chat.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { LevelUpClose } from './LevelUpClose';
 /**
  *
  * @export
@@ -129,6 +130,12 @@ export interface Chat {
      * @memberof Chat
      */
     closedAt: Date | null;
+    /**
+     * Level Up only: the stored close the close screen shows. Null when the chat isn't a closed Level Up, or closed before closes were stored (read `goalAchieved` for those).
+     * @type {LevelUpClose}
+     * @memberof Chat
+     */
+    levelUpClose: LevelUpClose | null;
 }
 /**
  * @export

package/dist/models/Chat.js

@@ -19,6 +19,7 @@ exports.ChatFromJSON = ChatFromJSON;
 exports.ChatFromJSONTyped = ChatFromJSONTyped;
 exports.ChatToJSON = ChatToJSON;
 exports.ChatToJSONTyped = ChatToJSONTyped;
+const LevelUpClose_1 = require("./LevelUpClose");
 /**
  * @export
  */
@@ -68,6 +69,8 @@ function instanceOfChat(value) {
         return false;
     if (!('closedAt' in value) || value['closedAt'] === undefined)
         return false;
+    if (!('levelUpClose' in value) || value['levelUpClose'] === undefined)
+        return false;
     return true;
 }
 function ChatFromJSON(json) {
@@ -97,6 +100,7 @@ function ChatFromJSONTyped(json, ignoreDiscriminator) {
         'initialStrength': json['initialStrength'],
         'primaryConceptId': json['primaryConceptId'],
         'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
+        'levelUpClose': (0, LevelUpClose_1.LevelUpCloseFromJSON)(json['levelUpClose']),
     };
 }
 function ChatToJSON(json) {
@@ -126,5 +130,6 @@ function ChatToJSONTyped(value, ignoreDiscriminator = false) {
         'initialStrength': value['initialStrength'],
         'primaryConceptId': value['primaryConceptId'],
         'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
+        'levelUpClose': (0, LevelUpClose_1.LevelUpCloseToJSON)(value['levelUpClose']),
     };
 }

package/dist/models/LevelUpClose.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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 LevelUpClose
+ */
+export interface LevelUpClose {
+    /**
+     * How the session closed. `pending-confirmation`: Expert-level work was banked and is confirmed by a second sitting at least a day later; `tier` names what was certified, never Expert.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    state: LevelUpCloseStateEnum;
+    /**
+     * The tier the close screen names: the tier certified, or the tier held. Never a tier the close didn't certify.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    tier: LevelUpCloseTierEnum;
+    /**
+     * The session's target tier.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    targetTier: LevelUpCloseTargetTierEnum | null;
+    /**
+     * What we saw: the moves the learner showed, in the tutor's words.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    seen: string;
+    /**
+     * Not yet: what wasn't shown, or wasn't asked. Empty when the close reached its tier.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    notYet: string;
+    /**
+     * Next time: the move the next session starts on.
+     * @type {string}
+     * @memberof LevelUpClose
+     */
+    next: string;
+}
+/**
+ * @export
+ */
+export declare const LevelUpCloseStateEnum: {
+    readonly HitTarget: "hit-target";
+    readonly BonusTier: "bonus-tier";
+    readonly TargetNotReached: "target-not-reached";
+    readonly PendingConfirmation: "pending-confirmation";
+};
+export type LevelUpCloseStateEnum = typeof LevelUpCloseStateEnum[keyof typeof LevelUpCloseStateEnum];
+/**
+ * @export
+ */
+export declare const LevelUpCloseTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type LevelUpCloseTierEnum = typeof LevelUpCloseTierEnum[keyof typeof LevelUpCloseTierEnum];
+/**
+ * @export
+ */
+export declare const LevelUpCloseTargetTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type LevelUpCloseTargetTierEnum = typeof LevelUpCloseTargetTierEnum[keyof typeof LevelUpCloseTargetTierEnum];
+/**
+ * Check if a given object implements the LevelUpClose interface.
+ */
+export declare function instanceOfLevelUpClose(value: object): value is LevelUpClose;
+export declare function LevelUpCloseFromJSON(json: any): LevelUpClose;
+export declare function LevelUpCloseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LevelUpClose;
+export declare function LevelUpCloseToJSON(json: any): LevelUpClose;
+export declare function LevelUpCloseToJSONTyped(value?: LevelUpClose | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LevelUpClose.js

@@ -0,0 +1,100 @@
+"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.LevelUpCloseTargetTierEnum = exports.LevelUpCloseTierEnum = exports.LevelUpCloseStateEnum = void 0;
+exports.instanceOfLevelUpClose = instanceOfLevelUpClose;
+exports.LevelUpCloseFromJSON = LevelUpCloseFromJSON;
+exports.LevelUpCloseFromJSONTyped = LevelUpCloseFromJSONTyped;
+exports.LevelUpCloseToJSON = LevelUpCloseToJSON;
+exports.LevelUpCloseToJSONTyped = LevelUpCloseToJSONTyped;
+/**
+ * @export
+ */
+exports.LevelUpCloseStateEnum = {
+    HitTarget: 'hit-target',
+    BonusTier: 'bonus-tier',
+    TargetNotReached: 'target-not-reached',
+    PendingConfirmation: 'pending-confirmation'
+};
+/**
+ * @export
+ */
+exports.LevelUpCloseTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+exports.LevelUpCloseTargetTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * Check if a given object implements the LevelUpClose interface.
+ */
+function instanceOfLevelUpClose(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('tier' in value) || value['tier'] === undefined)
+        return false;
+    if (!('targetTier' in value) || value['targetTier'] === undefined)
+        return false;
+    if (!('seen' in value) || value['seen'] === undefined)
+        return false;
+    if (!('notYet' in value) || value['notYet'] === undefined)
+        return false;
+    if (!('next' in value) || value['next'] === undefined)
+        return false;
+    return true;
+}
+function LevelUpCloseFromJSON(json) {
+    return LevelUpCloseFromJSONTyped(json, false);
+}
+function LevelUpCloseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': json['state'],
+        'tier': json['tier'],
+        'targetTier': json['targetTier'],
+        'seen': json['seen'],
+        'notYet': json['notYet'],
+        'next': json['next'],
+    };
+}
+function LevelUpCloseToJSON(json) {
+    return LevelUpCloseToJSONTyped(json, false);
+}
+function LevelUpCloseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': value['state'],
+        'tier': value['tier'],
+        'targetTier': value['targetTier'],
+        'seen': value['seen'],
+        'notYet': value['notYet'],
+        'next': value['next'],
+    };
+}

package/dist/models/UserConcept.d.ts

@@ -52,6 +52,12 @@ export interface UserConcept {
      * @memberof UserConcept
      */
     concept: UserConceptConcept;
+    /**
+     * When Expert-level work on this concept was banked in a Level Up and not yet confirmed: the earliest such sitting since the last Expert certification. Expert is confirmed by a second sitting at least a day later; until then `strength` stays below Expert. Null when nothing is pending or the reading is already Expert.
+     * @type {Date}
+     * @memberof UserConcept
+     */
+    expertPendingSince: Date | null;
 }
 /**
  * Check if a given object implements the UserConcept interface.

package/dist/models/UserConcept.js

@@ -35,6 +35,8 @@ function instanceOfUserConcept(value) {
         return false;
     if (!('concept' in value) || value['concept'] === undefined)
         return false;
+    if (!('expertPendingSince' in value) || value['expertPendingSince'] === undefined)
+        return false;
     return true;
 }
 function UserConceptFromJSON(json) {
@@ -51,6 +53,7 @@ function UserConceptFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
         'concept': (0, UserConceptConcept_1.UserConceptConceptFromJSON)(json['concept']),
+        'expertPendingSince': (json['expertPendingSince'] == null ? null : new Date(json['expertPendingSince'])),
     };
 }
 function UserConceptToJSON(json) {
@@ -67,5 +70,6 @@ function UserConceptToJSONTyped(value, ignoreDiscriminator = false) {
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
         'concept': (0, UserConceptConcept_1.UserConceptConceptToJSON)(value['concept']),
+        'expertPendingSince': value['expertPendingSince'] == null ? value['expertPendingSince'] : value['expertPendingSince'].toISOString(),
     };
 }

package/dist/models/index.d.ts

@@ -102,6 +102,7 @@ export * from './LearningMoment';
 export * from './LearningMomentCount';
 export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
+export * from './LevelUpClose';
 export * from './Message';
 export * from './MessageAttachment';
 export * from './MessageCountResponse';

package/dist/models/index.js

@@ -120,6 +120,7 @@ __exportStar(require("./LearningMoment"), exports);
 __exportStar(require("./LearningMomentCount"), exports);
 __exportStar(require("./LearningSessionEvaluation"), exports);
 __exportStar(require("./LearningStreakResponse"), exports);
+__exportStar(require("./LevelUpClose"), exports);
 __exportStar(require("./Message"), exports);
 __exportStar(require("./MessageAttachment"), exports);
 __exportStar(require("./MessageCountResponse"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.41.8",
+  "version": "3.42.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {