@instructure/athena-api-client 3.46.2 → 4.0.0

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

@@ -0,0 +1,215 @@
+/**
+ * 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 { AdminConceptMediaHistoryEntry } from './AdminConceptMediaHistoryEntry';
+import type { AdminConceptMediaActor } from './AdminConceptMediaActor';
+import type { AdminConceptMediaRevision } from './AdminConceptMediaRevision';
+/**
+ *
+ * @export
+ * @interface AdminShownConceptDiagram
+ */
+export interface AdminShownConceptDiagram {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminShownConceptDiagram
+     */
+    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 AdminShownConceptDiagram
+     */
+    state: AdminShownConceptDiagramStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    origin: AdminShownConceptDiagramOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptDiagram
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminShownConceptDiagram
+     */
+    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 AdminShownConceptDiagram
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptDiagram
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptDiagram
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptDiagram
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptDiagram
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptDiagram
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptDiagram
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptDiagram
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminShownConceptDiagram
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    description: string;
+    /**
+     * The diagram this one revises
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    revisesDiagramId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    title: string;
+    /**
+     * The authoring model's effort level, when one was configured
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    effort: string | null;
+    /**
+     * The brief the authoring model drew from: what to prefill for a regeneration
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    brief: string;
+    /**
+     * The complete assembled HTML document, for a sandboxed iframe
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    document: string;
+    /**
+     * The diagram this one revises, in any state; null if none or gone
+     * @type {AdminConceptMediaRevision}
+     * @memberof AdminShownConceptDiagram
+     */
+    parent: AdminConceptMediaRevision | null;
+    /**
+     * Diagrams that revise this one, oldest first, in any state
+     * @type {Array<AdminConceptMediaRevision>}
+     * @memberof AdminShownConceptDiagram
+     */
+    revisions: Array<AdminConceptMediaRevision>;
+    /**
+     * The whole revision family this row belongs to: its original (found by following revises links up until one ends) and every row that revises the original, directly or through other revisions, across all branches. Includes this row and rows in every state, deleted versions included. Oldest first by createdAt, then id. At most 100 rows; see historyTruncated.
+     * @type {Array<AdminConceptMediaHistoryEntry>}
+     * @memberof AdminShownConceptDiagram
+     */
+    history: Array<AdminConceptMediaHistoryEntry>;
+    /**
+     * True when the family has more rows than history can hold, so history is incomplete. This row and the rows it revises are always kept.
+     * @type {boolean}
+     * @memberof AdminShownConceptDiagram
+     */
+    historyTruncated: boolean;
+    /**
+     * With hideOtherVersions, the other versions in this row's revision family that were visible and are now hidden by this call, oldest first by createdAt, then id. Empty without the flag, or when no other version was visible. Versions that were already hidden or deleted are left as they were and are not listed.
+     * @type {Array<string>}
+     * @memberof AdminShownConceptDiagram
+     */
+    hiddenVersionIds: Array<string>;
+    /**
+     * True when hideOtherVersions was set and the revision family has more rows than the 100-row history cap, so only visible versions within the capped set (the same rows history lists) were hidden and others may still be visible. Always false without the flag.
+     * @type {boolean}
+     * @memberof AdminShownConceptDiagram
+     */
+    hiddenVersionsTruncated: boolean;
+}
+/**
+ * @export
+ */
+export declare const AdminShownConceptDiagramStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminShownConceptDiagramStateEnum = typeof AdminShownConceptDiagramStateEnum[keyof typeof AdminShownConceptDiagramStateEnum];
+/**
+ * @export
+ */
+export declare const AdminShownConceptDiagramOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminShownConceptDiagramOriginEnum = typeof AdminShownConceptDiagramOriginEnum[keyof typeof AdminShownConceptDiagramOriginEnum];
+/**
+ * Check if a given object implements the AdminShownConceptDiagram interface.
+ */
+export declare function instanceOfAdminShownConceptDiagram(value: object): value is AdminShownConceptDiagram;
+export declare function AdminShownConceptDiagramFromJSON(json: any): AdminShownConceptDiagram;
+export declare function AdminShownConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminShownConceptDiagram;
+export declare function AdminShownConceptDiagramToJSON(json: any): AdminShownConceptDiagram;
+export declare function AdminShownConceptDiagramToJSONTyped(value?: AdminShownConceptDiagram | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminShownConceptDiagram.js

@@ -0,0 +1,170 @@
+/* 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 AdminShownConceptDiagramStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+export const AdminShownConceptDiagramOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminShownConceptDiagram interface.
+ */
+export function instanceOfAdminShownConceptDiagram(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;
+    if (!('brief' in value) || value['brief'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === 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 AdminShownConceptDiagramFromJSON(json) {
+    return AdminShownConceptDiagramFromJSONTyped(json, false);
+}
+export function AdminShownConceptDiagramFromJSONTyped(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'],
+        'revisesDiagramId': json['revisesDiagramId'],
+        'title': json['title'],
+        'effort': json['effort'],
+        'brief': json['brief'],
+        'document': json['document'],
+        '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 AdminShownConceptDiagramToJSON(json) {
+    return AdminShownConceptDiagramToJSONTyped(json, false);
+}
+export function AdminShownConceptDiagramToJSONTyped(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'],
+        'revisesDiagramId': value['revisesDiagramId'],
+        'title': value['title'],
+        'effort': value['effort'],
+        'brief': value['brief'],
+        'document': value['document'],
+        '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/AdminShownConceptImage.d.ts

@@ -0,0 +1,233 @@
+/**
+ * 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 { AdminConceptMediaHistoryEntry } from './AdminConceptMediaHistoryEntry';
+import type { AdminConceptMediaActor } from './AdminConceptMediaActor';
+import type { AdminConceptMediaRevision } from './AdminConceptMediaRevision';
+/**
+ *
+ * @export
+ * @interface AdminShownConceptImage
+ */
+export interface AdminShownConceptImage {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminShownConceptImage
+     */
+    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 AdminShownConceptImage
+     */
+    state: AdminShownConceptImageStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    origin: AdminShownConceptImageOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptImage
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminShownConceptImage
+     */
+    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 AdminShownConceptImage
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptImage
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptImage
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptImage
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminShownConceptImage
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptImage
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptImage
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptImage
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminShownConceptImage
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    description: string;
+    /**
+     * The image this one revises
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    revisesImageId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    quality: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptImage
+     */
+    width: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminShownConceptImage
+     */
+    height: number;
+    /**
+     * Signed read URL, valid for 12 hours, for any state (admins preview hidden and deleted images). Null when the URL could not be signed.
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    url: string | null;
+    /**
+     * The full prompt sent to the image model, style preamble included
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    prompt: string;
+    /**
+     * The prompt without the fixed style preamble: what to prefill for a regeneration. The preamble is added back when generating.
+     * @type {string}
+     * @memberof AdminShownConceptImage
+     */
+    modelPrompt: string;
+    /**
+     * The image this one revises, in any state; null if none or gone
+     * @type {AdminConceptMediaRevision}
+     * @memberof AdminShownConceptImage
+     */
+    parent: AdminConceptMediaRevision | null;
+    /**
+     * Images that revise this one, oldest first, in any state
+     * @type {Array<AdminConceptMediaRevision>}
+     * @memberof AdminShownConceptImage
+     */
+    revisions: Array<AdminConceptMediaRevision>;
+    /**
+     * The whole revision family this row belongs to: its original (found by following revises links up until one ends) and every row that revises the original, directly or through other revisions, across all branches. Includes this row and rows in every state, deleted versions included. Oldest first by createdAt, then id. At most 100 rows; see historyTruncated.
+     * @type {Array<AdminConceptMediaHistoryEntry>}
+     * @memberof AdminShownConceptImage
+     */
+    history: Array<AdminConceptMediaHistoryEntry>;
+    /**
+     * True when the family has more rows than history can hold, so history is incomplete. This row and the rows it revises are always kept.
+     * @type {boolean}
+     * @memberof AdminShownConceptImage
+     */
+    historyTruncated: boolean;
+    /**
+     * With hideOtherVersions, the other versions in this row's revision family that were visible and are now hidden by this call, oldest first by createdAt, then id. Empty without the flag, or when no other version was visible. Versions that were already hidden or deleted are left as they were and are not listed.
+     * @type {Array<string>}
+     * @memberof AdminShownConceptImage
+     */
+    hiddenVersionIds: Array<string>;
+    /**
+     * True when hideOtherVersions was set and the revision family has more rows than the 100-row history cap, so only visible versions within the capped set (the same rows history lists) were hidden and others may still be visible. Always false without the flag.
+     * @type {boolean}
+     * @memberof AdminShownConceptImage
+     */
+    hiddenVersionsTruncated: boolean;
+}
+/**
+ * @export
+ */
+export declare const AdminShownConceptImageStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminShownConceptImageStateEnum = typeof AdminShownConceptImageStateEnum[keyof typeof AdminShownConceptImageStateEnum];
+/**
+ * @export
+ */
+export declare const AdminShownConceptImageOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminShownConceptImageOriginEnum = typeof AdminShownConceptImageOriginEnum[keyof typeof AdminShownConceptImageOriginEnum];
+/**
+ * Check if a given object implements the AdminShownConceptImage interface.
+ */
+export declare function instanceOfAdminShownConceptImage(value: object): value is AdminShownConceptImage;
+export declare function AdminShownConceptImageFromJSON(json: any): AdminShownConceptImage;
+export declare function AdminShownConceptImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminShownConceptImage;
+export declare function AdminShownConceptImageToJSON(json: any): AdminShownConceptImage;
+export declare function AdminShownConceptImageToJSONTyped(value?: AdminShownConceptImage | null, ignoreDiscriminator?: boolean): any;