@instructure/athena-api-client 3.41.8 → 3.42.1

package/dist/esm/models/PaginatedConceptDiagrams.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 { ConceptDiagramGalleryItem } from './ConceptDiagramGalleryItem';
+/**
+ *
+ * @export
+ * @interface PaginatedConceptDiagrams
+ */
+export interface PaginatedConceptDiagrams {
+    /**
+     *
+     * @type {Array<ConceptDiagramGalleryItem>}
+     * @memberof PaginatedConceptDiagrams
+     */
+    data: Array<ConceptDiagramGalleryItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedConceptDiagrams
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedConceptDiagrams interface.
+ */
+export declare function instanceOfPaginatedConceptDiagrams(value: object): value is PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsFromJSON(json: any): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsToJSON(json: any): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsToJSONTyped(value?: PaginatedConceptDiagrams | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedConceptDiagrams.js

@@ -0,0 +1,48 @@
+/* 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 { ConceptDiagramGalleryItemFromJSON, ConceptDiagramGalleryItemToJSON, } from './ConceptDiagramGalleryItem';
+/**
+ * Check if a given object implements the PaginatedConceptDiagrams interface.
+ */
+export function instanceOfPaginatedConceptDiagrams(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedConceptDiagramsFromJSON(json) {
+    return PaginatedConceptDiagramsFromJSONTyped(json, false);
+}
+export function PaginatedConceptDiagramsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ConceptDiagramGalleryItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedConceptDiagramsToJSON(json) {
+    return PaginatedConceptDiagramsToJSONTyped(json, false);
+}
+export function PaginatedConceptDiagramsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ConceptDiagramGalleryItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/esm/models/PaginatedConceptImages.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 { ConceptImageGalleryItem } from './ConceptImageGalleryItem';
+/**
+ *
+ * @export
+ * @interface PaginatedConceptImages
+ */
+export interface PaginatedConceptImages {
+    /**
+     *
+     * @type {Array<ConceptImageGalleryItem>}
+     * @memberof PaginatedConceptImages
+     */
+    data: Array<ConceptImageGalleryItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedConceptImages
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedConceptImages interface.
+ */
+export declare function instanceOfPaginatedConceptImages(value: object): value is PaginatedConceptImages;
+export declare function PaginatedConceptImagesFromJSON(json: any): PaginatedConceptImages;
+export declare function PaginatedConceptImagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedConceptImages;
+export declare function PaginatedConceptImagesToJSON(json: any): PaginatedConceptImages;
+export declare function PaginatedConceptImagesToJSONTyped(value?: PaginatedConceptImages | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedConceptImages.js

@@ -0,0 +1,48 @@
+/* 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 { ConceptImageGalleryItemFromJSON, ConceptImageGalleryItemToJSON, } from './ConceptImageGalleryItem';
+/**
+ * Check if a given object implements the PaginatedConceptImages interface.
+ */
+export function instanceOfPaginatedConceptImages(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedConceptImagesFromJSON(json) {
+    return PaginatedConceptImagesFromJSONTyped(json, false);
+}
+export function PaginatedConceptImagesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ConceptImageGalleryItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedConceptImagesToJSON(json) {
+    return PaginatedConceptImagesToJSONTyped(json, false);
+}
+export function PaginatedConceptImagesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ConceptImageGalleryItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -73,6 +73,9 @@ export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
+export * from './ConceptDiagramDetail';
+export * from './ConceptDiagramGalleryItem';
+export * from './ConceptImageGalleryItem';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -102,12 +105,15 @@ export * from './LearningMoment';
 export * from './LearningMomentCount';
 export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
+export * from './LevelUpClose';
 export * from './Message';
 export * from './MessageAttachment';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ObjectiveResource';
 export * from './PaginatedChats';
+export * from './PaginatedConceptDiagrams';
+export * from './PaginatedConceptImages';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './PaginatedObjectiveResources';

package/dist/esm/models/index.js

@@ -75,6 +75,9 @@ export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
+export * from './ConceptDiagramDetail';
+export * from './ConceptDiagramGalleryItem';
+export * from './ConceptImageGalleryItem';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -104,12 +107,15 @@ export * from './LearningMoment';
 export * from './LearningMomentCount';
 export * from './LearningSessionEvaluation';
 export * from './LearningStreakResponse';
+export * from './LevelUpClose';
 export * from './Message';
 export * from './MessageAttachment';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ObjectiveResource';
 export * from './PaginatedChats';
+export * from './PaginatedConceptDiagrams';
+export * from './PaginatedConceptImages';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './PaginatedObjectiveResources';

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/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/models/ConceptDiagramDetail.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.instanceOfConceptDiagramDetail = instanceOfConceptDiagramDetail;
+exports.ConceptDiagramDetailFromJSON = ConceptDiagramDetailFromJSON;
+exports.ConceptDiagramDetailFromJSONTyped = ConceptDiagramDetailFromJSONTyped;
+exports.ConceptDiagramDetailToJSON = ConceptDiagramDetailToJSON;
+exports.ConceptDiagramDetailToJSONTyped = ConceptDiagramDetailToJSONTyped;
+/**
+ * Check if a given object implements the ConceptDiagramDetail interface.
+ */
+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;
+}
+function ConceptDiagramDetailFromJSON(json) {
+    return ConceptDiagramDetailFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function ConceptDiagramDetailToJSON(json) {
+    return ConceptDiagramDetailToJSONTyped(json, false);
+}
+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/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/models/ConceptDiagramGalleryItem.js

@@ -0,0 +1,74 @@
+"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.instanceOfConceptDiagramGalleryItem = instanceOfConceptDiagramGalleryItem;
+exports.ConceptDiagramGalleryItemFromJSON = ConceptDiagramGalleryItemFromJSON;
+exports.ConceptDiagramGalleryItemFromJSONTyped = ConceptDiagramGalleryItemFromJSONTyped;
+exports.ConceptDiagramGalleryItemToJSON = ConceptDiagramGalleryItemToJSON;
+exports.ConceptDiagramGalleryItemToJSONTyped = ConceptDiagramGalleryItemToJSONTyped;
+/**
+ * Check if a given object implements the ConceptDiagramGalleryItem interface.
+ */
+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;
+}
+function ConceptDiagramGalleryItemFromJSON(json) {
+    return ConceptDiagramGalleryItemFromJSONTyped(json, false);
+}
+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'])),
+    };
+}
+function ConceptDiagramGalleryItemToJSON(json) {
+    return ConceptDiagramGalleryItemToJSONTyped(json, false);
+}
+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(),
+    };
+}