@instructure/athena-api-client 3.41.8 → 3.42.1

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/ConceptDiagramDetail.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 ConceptDiagramDetail
+ */
+export interface ConceptDiagramDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    conceptName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    description: string;
+    /**
+     * The chat the diagram was authored in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptDiagramDetail
+     */
+    createdAt: Date;
+    /**
+     * The complete assembled HTML document, to render in a sandboxed iframe
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    document: string;
+}
+/**
+ * Check if a given object implements the ConceptDiagramDetail interface.
+ */
+export declare function instanceOfConceptDiagramDetail(value: object): value is ConceptDiagramDetail;
+export declare function ConceptDiagramDetailFromJSON(json: any): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailToJSON(json: any): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailToJSONTyped(value?: ConceptDiagramDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptDiagramDetail.js

@@ -0,0 +1,71 @@
+/* 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 ConceptDiagramDetail interface.
+ */
+export function instanceOfConceptDiagramDetail(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptDiagramDetailFromJSON(json) {
+    return ConceptDiagramDetailFromJSONTyped(json, false);
+}
+export function ConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'title': json['title'],
+        'description': json['description'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'document': json['document'],
+    };
+}
+export function ConceptDiagramDetailToJSON(json) {
+    return ConceptDiagramDetailToJSONTyped(json, false);
+}
+export function ConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'title': value['title'],
+        'description': value['description'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'document': value['document'],
+    };
+}

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

@@ -0,0 +1,68 @@
+/**
+ * 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 ConceptDiagramGalleryItem
+ */
+export interface ConceptDiagramGalleryItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    conceptName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    description: string;
+    /**
+     * The chat the diagram was authored in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the ConceptDiagramGalleryItem interface.
+ */
+export declare function instanceOfConceptDiagramGalleryItem(value: object): value is ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemFromJSON(json: any): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemToJSON(json: any): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemToJSONTyped(value?: ConceptDiagramGalleryItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptDiagramGalleryItem.js

@@ -0,0 +1,67 @@
+/* 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 ConceptDiagramGalleryItem interface.
+ */
+export function instanceOfConceptDiagramGalleryItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptDiagramGalleryItemFromJSON(json) {
+    return ConceptDiagramGalleryItemFromJSONTyped(json, false);
+}
+export function ConceptDiagramGalleryItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'title': json['title'],
+        'description': json['description'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function ConceptDiagramGalleryItemToJSON(json) {
+    return ConceptDiagramGalleryItemToJSONTyped(json, false);
+}
+export function ConceptDiagramGalleryItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'title': value['title'],
+        'description': value['description'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,86 @@
+/**
+ * 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 ConceptImageGalleryItem
+ */
+export interface ConceptImageGalleryItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    conceptName: string;
+    /**
+     * Alt text for the image
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConceptImageGalleryItem
+     */
+    width: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConceptImageGalleryItem
+     */
+    height: number;
+    /**
+     * Short-lived signed read URL. Null when the URL could not be signed.
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    url: string | null;
+    /**
+     * The chat the image was generated in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptImageGalleryItem
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the ConceptImageGalleryItem interface.
+ */
+export declare function instanceOfConceptImageGalleryItem(value: object): value is ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemFromJSON(json: any): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemToJSON(json: any): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemToJSONTyped(value?: ConceptImageGalleryItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptImageGalleryItem.js

@@ -0,0 +1,79 @@
+/* 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 ConceptImageGalleryItem interface.
+ */
+export function instanceOfConceptImageGalleryItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('width' in value) || value['width'] === undefined)
+        return false;
+    if (!('height' in value) || value['height'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptImageGalleryItemFromJSON(json) {
+    return ConceptImageGalleryItemFromJSONTyped(json, false);
+}
+export function ConceptImageGalleryItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'description': json['description'],
+        'mimeType': json['mimeType'],
+        'width': json['width'],
+        'height': json['height'],
+        'url': json['url'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function ConceptImageGalleryItemToJSON(json) {
+    return ConceptImageGalleryItemToJSONTyped(json, false);
+}
+export function ConceptImageGalleryItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'description': value['description'],
+        'mimeType': value['mimeType'],
+        'width': value['width'],
+        'height': value['height'],
+        'url': value['url'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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'],
+    };
+}