@instructure/athena-api-client 3.46.2 → 4.0.0

package/dist/esm/models/AdminShownConceptImage.js

@@ -0,0 +1,182 @@
+/* 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 { AdminConceptMediaConceptFromJSON, AdminConceptMediaConceptToJSON, } from './AdminConceptMediaConcept';
+import { AdminConceptMediaHistoryEntryFromJSON, AdminConceptMediaHistoryEntryToJSON, } from './AdminConceptMediaHistoryEntry';
+import { AdminConceptMediaActorFromJSON, AdminConceptMediaActorToJSON, } from './AdminConceptMediaActor';
+import { AdminConceptMediaRevisionFromJSON, AdminConceptMediaRevisionToJSON, } from './AdminConceptMediaRevision';
+/**
+ * @export
+ */
+export const AdminShownConceptImageStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+export const AdminShownConceptImageOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminShownConceptImage interface.
+ */
+export function instanceOfAdminShownConceptImage(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('concept' in value) || value['concept'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('origin' in value) || value['origin'] === undefined)
+        return false;
+    if (!('creator' in value) || value['creator'] === undefined)
+        return false;
+    if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('hiddenAt' in value) || value['hiddenAt'] === undefined)
+        return false;
+    if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
+        return false;
+    if (!('deletedAt' in value) || value['deletedAt'] === undefined)
+        return false;
+    if (!('deletedBy' in value) || value['deletedBy'] === undefined)
+        return false;
+    if (!('model' in value) || value['model'] === undefined)
+        return false;
+    if (!('inputTokens' in value) || value['inputTokens'] === undefined)
+        return false;
+    if (!('outputTokens' in value) || value['outputTokens'] === undefined)
+        return false;
+    if (!('costUsd' in value) || value['costUsd'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
+        return false;
+    if (!('quality' in value) || value['quality'] === 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 (!('prompt' in value) || value['prompt'] === undefined)
+        return false;
+    if (!('modelPrompt' in value) || value['modelPrompt'] === undefined)
+        return false;
+    if (!('parent' in value) || value['parent'] === undefined)
+        return false;
+    if (!('revisions' in value) || value['revisions'] === undefined)
+        return false;
+    if (!('history' in value) || value['history'] === undefined)
+        return false;
+    if (!('historyTruncated' in value) || value['historyTruncated'] === undefined)
+        return false;
+    if (!('hiddenVersionIds' in value) || value['hiddenVersionIds'] === undefined)
+        return false;
+    if (!('hiddenVersionsTruncated' in value) || value['hiddenVersionsTruncated'] === undefined)
+        return false;
+    return true;
+}
+export function AdminShownConceptImageFromJSON(json) {
+    return AdminShownConceptImageFromJSONTyped(json, false);
+}
+export function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'concept': AdminConceptMediaConceptFromJSON(json['concept']),
+        'state': json['state'],
+        'origin': json['origin'],
+        'creator': AdminConceptMediaActorFromJSON(json['creator']),
+        'creatorOutsideAccount': json['creatorOutsideAccount'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
+        'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
+        'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
+        'model': json['model'],
+        'inputTokens': json['inputTokens'],
+        'outputTokens': json['outputTokens'],
+        'costUsd': json['costUsd'],
+        'description': json['description'],
+        'revisesImageId': json['revisesImageId'],
+        'quality': json['quality'],
+        'mimeType': json['mimeType'],
+        'width': json['width'],
+        'height': json['height'],
+        'url': json['url'],
+        'prompt': json['prompt'],
+        'modelPrompt': json['modelPrompt'],
+        'parent': AdminConceptMediaRevisionFromJSON(json['parent']),
+        'revisions': (json['revisions'].map(AdminConceptMediaRevisionFromJSON)),
+        'history': (json['history'].map(AdminConceptMediaHistoryEntryFromJSON)),
+        'historyTruncated': json['historyTruncated'],
+        'hiddenVersionIds': json['hiddenVersionIds'],
+        'hiddenVersionsTruncated': json['hiddenVersionsTruncated'],
+    };
+}
+export function AdminShownConceptImageToJSON(json) {
+    return AdminShownConceptImageToJSONTyped(json, false);
+}
+export function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'concept': AdminConceptMediaConceptToJSON(value['concept']),
+        'state': value['state'],
+        'origin': value['origin'],
+        'creator': AdminConceptMediaActorToJSON(value['creator']),
+        'creatorOutsideAccount': value['creatorOutsideAccount'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
+        'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
+        'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
+        'model': value['model'],
+        'inputTokens': value['inputTokens'],
+        'outputTokens': value['outputTokens'],
+        'costUsd': value['costUsd'],
+        'description': value['description'],
+        'revisesImageId': value['revisesImageId'],
+        'quality': value['quality'],
+        'mimeType': value['mimeType'],
+        'width': value['width'],
+        'height': value['height'],
+        'url': value['url'],
+        'prompt': value['prompt'],
+        'modelPrompt': value['modelPrompt'],
+        'parent': AdminConceptMediaRevisionToJSON(value['parent']),
+        'revisions': (value['revisions'].map(AdminConceptMediaRevisionToJSON)),
+        'history': (value['history'].map(AdminConceptMediaHistoryEntryToJSON)),
+        'historyTruncated': value['historyTruncated'],
+        'hiddenVersionIds': value['hiddenVersionIds'],
+        'hiddenVersionsTruncated': value['hiddenVersionsTruncated'],
+    };
+}

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

@@ -17,11 +17,25 @@ export * from './AdminChatAnalysis';
 export * from './AdminChatCanvasUsage';
 export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
+export * from './AdminConceptDiagram';
+export * from './AdminConceptDiagramDetail';
+export * from './AdminConceptImage';
+export * from './AdminConceptImageDetail';
+export * from './AdminConceptMediaActor';
+export * from './AdminConceptMediaConcept';
+export * from './AdminConceptMediaHistoryEntry';
+export * from './AdminConceptMediaJob';
+export * from './AdminConceptMediaRevision';
+export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
 export * from './AdminExchangeMessage';
+export * from './AdminGenerateConceptDiagramRequest';
+export * from './AdminGenerateConceptImageRequest';
 export * from './AdminLastExchange';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';
+export * from './AdminPaginatedConceptDiagrams';
+export * from './AdminPaginatedConceptImages';
 export * from './AdminPaginatedLastExchanges';
 export * from './AdminPaginatedQuizParticipantSessions';
 export * from './AdminPaginatedQuizSessions';
@@ -36,7 +50,12 @@ export * from './AdminQuizSessionListItem';
 export * from './AdminQuizSessionScore';
 export * from './AdminQuizSourceFile';
 export * from './AdminQuizSourceMaterial';
+export * from './AdminRegenerateConceptDiagramRequest';
+export * from './AdminRegenerateConceptImageRequest';
 export * from './AdminResetLearningDataResponse';
+export * from './AdminShowConceptMediaRequest';
+export * from './AdminShownConceptDiagram';
+export * from './AdminShownConceptImage';
 export * from './AdminStreak';
 export * from './AdminStudyObjectiveCanvasTypeCount';
 export * from './AdminStudyObjectiveListItem';

package/dist/esm/models/index.js

@@ -19,11 +19,25 @@ export * from './AdminChatAnalysis';
 export * from './AdminChatCanvasUsage';
 export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
+export * from './AdminConceptDiagram';
+export * from './AdminConceptDiagramDetail';
+export * from './AdminConceptImage';
+export * from './AdminConceptImageDetail';
+export * from './AdminConceptMediaActor';
+export * from './AdminConceptMediaConcept';
+export * from './AdminConceptMediaHistoryEntry';
+export * from './AdminConceptMediaJob';
+export * from './AdminConceptMediaRevision';
+export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
 export * from './AdminExchangeMessage';
+export * from './AdminGenerateConceptDiagramRequest';
+export * from './AdminGenerateConceptImageRequest';
 export * from './AdminLastExchange';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';
+export * from './AdminPaginatedConceptDiagrams';
+export * from './AdminPaginatedConceptImages';
 export * from './AdminPaginatedLastExchanges';
 export * from './AdminPaginatedQuizParticipantSessions';
 export * from './AdminPaginatedQuizSessions';
@@ -38,7 +52,12 @@ export * from './AdminQuizSessionListItem';
 export * from './AdminQuizSessionScore';
 export * from './AdminQuizSourceFile';
 export * from './AdminQuizSourceMaterial';
+export * from './AdminRegenerateConceptDiagramRequest';
+export * from './AdminRegenerateConceptImageRequest';
 export * from './AdminResetLearningDataResponse';
+export * from './AdminShowConceptMediaRequest';
+export * from './AdminShownConceptDiagram';
+export * from './AdminShownConceptImage';
 export * from './AdminStreak';
 export * from './AdminStudyObjectiveCanvasTypeCount';
 export * from './AdminStudyObjectiveListItem';

package/dist/models/AdminConceptDiagram.d.ts

@@ -0,0 +1,165 @@
+/**
+ * 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 { AdminConceptMediaConcept } from './AdminConceptMediaConcept';
+import type { AdminConceptMediaActor } from './AdminConceptMediaActor';
+/**
+ * A library diagram without its HTML document
+ * @export
+ * @interface AdminConceptDiagram
+ */
+export interface AdminConceptDiagram {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminConceptDiagram
+     */
+    concept: AdminConceptMediaConcept;
+    /**
+     * visible: served to learners. hidden: kept out of every learner read. deleted: soft-deleted, kept out of every learner read and out of the default admin list. A change applies to later reads only: an image URL already handed out stays valid until it expires (12 hours).
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    state: AdminConceptDiagramStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    origin: AdminConceptDiagramOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagram
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminConceptDiagram
+     */
+    creatorOutsideAccount: boolean;
+    /**
+     * The chat it was generated in. Null for admin drafts, once the chat is deleted, or when the creator is outside the caller's account.
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagram
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagram
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagram
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagram
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagram
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptDiagram
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptDiagram
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminConceptDiagram
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    description: string;
+    /**
+     * The diagram this one revises
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    revisesDiagramId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    title: string;
+    /**
+     * The authoring model's effort level, when one was configured
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    effort: string | null;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptDiagramStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminConceptDiagramStateEnum = typeof AdminConceptDiagramStateEnum[keyof typeof AdminConceptDiagramStateEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptDiagramOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminConceptDiagramOriginEnum = typeof AdminConceptDiagramOriginEnum[keyof typeof AdminConceptDiagramOriginEnum];
+/**
+ * Check if a given object implements the AdminConceptDiagram interface.
+ */
+export declare function instanceOfAdminConceptDiagram(value: object): value is AdminConceptDiagram;
+export declare function AdminConceptDiagramFromJSON(json: any): AdminConceptDiagram;
+export declare function AdminConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptDiagram;
+export declare function AdminConceptDiagramToJSON(json: any): AdminConceptDiagram;
+export declare function AdminConceptDiagramToJSONTyped(value?: AdminConceptDiagram | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminConceptDiagram.js

@@ -0,0 +1,144 @@
+"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.AdminConceptDiagramOriginEnum = exports.AdminConceptDiagramStateEnum = void 0;
+exports.instanceOfAdminConceptDiagram = instanceOfAdminConceptDiagram;
+exports.AdminConceptDiagramFromJSON = AdminConceptDiagramFromJSON;
+exports.AdminConceptDiagramFromJSONTyped = AdminConceptDiagramFromJSONTyped;
+exports.AdminConceptDiagramToJSON = AdminConceptDiagramToJSON;
+exports.AdminConceptDiagramToJSONTyped = AdminConceptDiagramToJSONTyped;
+const AdminConceptMediaConcept_1 = require("./AdminConceptMediaConcept");
+const AdminConceptMediaActor_1 = require("./AdminConceptMediaActor");
+/**
+ * @export
+ */
+exports.AdminConceptDiagramStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+exports.AdminConceptDiagramOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminConceptDiagram interface.
+ */
+function instanceOfAdminConceptDiagram(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('concept' in value) || value['concept'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('origin' in value) || value['origin'] === undefined)
+        return false;
+    if (!('creator' in value) || value['creator'] === undefined)
+        return false;
+    if (!('creatorOutsideAccount' in value) || value['creatorOutsideAccount'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('hiddenAt' in value) || value['hiddenAt'] === undefined)
+        return false;
+    if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
+        return false;
+    if (!('deletedAt' in value) || value['deletedAt'] === undefined)
+        return false;
+    if (!('deletedBy' in value) || value['deletedBy'] === undefined)
+        return false;
+    if (!('model' in value) || value['model'] === undefined)
+        return false;
+    if (!('inputTokens' in value) || value['inputTokens'] === undefined)
+        return false;
+    if (!('outputTokens' in value) || value['outputTokens'] === undefined)
+        return false;
+    if (!('costUsd' in value) || value['costUsd'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('effort' in value) || value['effort'] === undefined)
+        return false;
+    return true;
+}
+function AdminConceptDiagramFromJSON(json) {
+    return AdminConceptDiagramFromJSONTyped(json, false);
+}
+function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'concept': (0, AdminConceptMediaConcept_1.AdminConceptMediaConceptFromJSON)(json['concept']),
+        'state': json['state'],
+        'origin': json['origin'],
+        'creator': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['creator']),
+        'creatorOutsideAccount': json['creatorOutsideAccount'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
+        'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
+        'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
+        'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
+        'model': json['model'],
+        'inputTokens': json['inputTokens'],
+        'outputTokens': json['outputTokens'],
+        'costUsd': json['costUsd'],
+        'description': json['description'],
+        'revisesDiagramId': json['revisesDiagramId'],
+        'title': json['title'],
+        'effort': json['effort'],
+    };
+}
+function AdminConceptDiagramToJSON(json) {
+    return AdminConceptDiagramToJSONTyped(json, false);
+}
+function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'concept': (0, AdminConceptMediaConcept_1.AdminConceptMediaConceptToJSON)(value['concept']),
+        'state': value['state'],
+        'origin': value['origin'],
+        'creator': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['creator']),
+        'creatorOutsideAccount': value['creatorOutsideAccount'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
+        'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
+        'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
+        'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
+        'model': value['model'],
+        'inputTokens': value['inputTokens'],
+        'outputTokens': value['outputTokens'],
+        'costUsd': value['costUsd'],
+        'description': value['description'],
+        'revisesDiagramId': value['revisesDiagramId'],
+        'title': value['title'],
+        'effort': value['effort'],
+    };
+}