@instructure/athena-api-client 3.46.2 → 4.0.0

package/dist/models/AdminConceptDiagramDetail.d.ts

@@ -0,0 +1,203 @@
+/**
+ * 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 AdminConceptDiagramDetail
+ */
+export interface AdminConceptDiagramDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminConceptDiagramDetail
+     */
+    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 AdminConceptDiagramDetail
+     */
+    state: AdminConceptDiagramDetailStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    origin: AdminConceptDiagramDetailOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagramDetail
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminConceptDiagramDetail
+     */
+    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 AdminConceptDiagramDetail
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagramDetail
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagramDetail
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptDiagramDetail
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptDiagramDetail
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminConceptDiagramDetail
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    description: string;
+    /**
+     * The diagram this one revises
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    revisesDiagramId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    title: string;
+    /**
+     * The authoring model's effort level, when one was configured
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    effort: string | null;
+    /**
+     * The brief the authoring model drew from: what to prefill for a regeneration
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    brief: string;
+    /**
+     * The complete assembled HTML document, for a sandboxed iframe
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    document: string;
+    /**
+     * The diagram this one revises, in any state; null if none or gone
+     * @type {AdminConceptMediaRevision}
+     * @memberof AdminConceptDiagramDetail
+     */
+    parent: AdminConceptMediaRevision | null;
+    /**
+     * Diagrams that revise this one, oldest first, in any state
+     * @type {Array<AdminConceptMediaRevision>}
+     * @memberof AdminConceptDiagramDetail
+     */
+    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 AdminConceptDiagramDetail
+     */
+    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 AdminConceptDiagramDetail
+     */
+    historyTruncated: boolean;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptDiagramDetailStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminConceptDiagramDetailStateEnum = typeof AdminConceptDiagramDetailStateEnum[keyof typeof AdminConceptDiagramDetailStateEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptDiagramDetailOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminConceptDiagramDetailOriginEnum = typeof AdminConceptDiagramDetailOriginEnum[keyof typeof AdminConceptDiagramDetailOriginEnum];
+/**
+ * Check if a given object implements the AdminConceptDiagramDetail interface.
+ */
+export declare function instanceOfAdminConceptDiagramDetail(value: object): value is AdminConceptDiagramDetail;
+export declare function AdminConceptDiagramDetailFromJSON(json: any): AdminConceptDiagramDetail;
+export declare function AdminConceptDiagramDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptDiagramDetail;
+export declare function AdminConceptDiagramDetailToJSON(json: any): AdminConceptDiagramDetail;
+export declare function AdminConceptDiagramDetailToJSONTyped(value?: AdminConceptDiagramDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminConceptDiagramDetail.js

@@ -0,0 +1,170 @@
+"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.AdminConceptDiagramDetailOriginEnum = exports.AdminConceptDiagramDetailStateEnum = void 0;
+exports.instanceOfAdminConceptDiagramDetail = instanceOfAdminConceptDiagramDetail;
+exports.AdminConceptDiagramDetailFromJSON = AdminConceptDiagramDetailFromJSON;
+exports.AdminConceptDiagramDetailFromJSONTyped = AdminConceptDiagramDetailFromJSONTyped;
+exports.AdminConceptDiagramDetailToJSON = AdminConceptDiagramDetailToJSON;
+exports.AdminConceptDiagramDetailToJSONTyped = AdminConceptDiagramDetailToJSONTyped;
+const AdminConceptMediaConcept_1 = require("./AdminConceptMediaConcept");
+const AdminConceptMediaHistoryEntry_1 = require("./AdminConceptMediaHistoryEntry");
+const AdminConceptMediaActor_1 = require("./AdminConceptMediaActor");
+const AdminConceptMediaRevision_1 = require("./AdminConceptMediaRevision");
+/**
+ * @export
+ */
+exports.AdminConceptDiagramDetailStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+exports.AdminConceptDiagramDetailOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminConceptDiagramDetail interface.
+ */
+function instanceOfAdminConceptDiagramDetail(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;
+    return true;
+}
+function AdminConceptDiagramDetailFromJSON(json) {
+    return AdminConceptDiagramDetailFromJSONTyped(json, false);
+}
+function AdminConceptDiagramDetailFromJSONTyped(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'],
+        'brief': json['brief'],
+        'document': json['document'],
+        'parent': (0, AdminConceptMediaRevision_1.AdminConceptMediaRevisionFromJSON)(json['parent']),
+        'revisions': (json['revisions'].map(AdminConceptMediaRevision_1.AdminConceptMediaRevisionFromJSON)),
+        'history': (json['history'].map(AdminConceptMediaHistoryEntry_1.AdminConceptMediaHistoryEntryFromJSON)),
+        'historyTruncated': json['historyTruncated'],
+    };
+}
+function AdminConceptDiagramDetailToJSON(json) {
+    return AdminConceptDiagramDetailToJSONTyped(json, false);
+}
+function AdminConceptDiagramDetailToJSONTyped(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'],
+        'brief': value['brief'],
+        'document': value['document'],
+        'parent': (0, AdminConceptMediaRevision_1.AdminConceptMediaRevisionToJSON)(value['parent']),
+        'revisions': (value['revisions'].map(AdminConceptMediaRevision_1.AdminConceptMediaRevisionToJSON)),
+        'history': (value['history'].map(AdminConceptMediaHistoryEntry_1.AdminConceptMediaHistoryEntryToJSON)),
+        'historyTruncated': value['historyTruncated'],
+    };
+}

package/dist/models/AdminConceptImage.d.ts

@@ -0,0 +1,183 @@
+/**
+ * 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';
+/**
+ *
+ * @export
+ * @interface AdminConceptImage
+ */
+export interface AdminConceptImage {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminConceptImage
+     */
+    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 AdminConceptImage
+     */
+    state: AdminConceptImageStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    origin: AdminConceptImageOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImage
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminConceptImage
+     */
+    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 AdminConceptImage
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImage
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImage
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImage
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImage
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminConceptImage
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    description: string;
+    /**
+     * The image this one revises
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    revisesImageId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    quality: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImage
+     */
+    width: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImage
+     */
+    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 AdminConceptImage
+     */
+    url: string | null;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptImageStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminConceptImageStateEnum = typeof AdminConceptImageStateEnum[keyof typeof AdminConceptImageStateEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptImageOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminConceptImageOriginEnum = typeof AdminConceptImageOriginEnum[keyof typeof AdminConceptImageOriginEnum];
+/**
+ * Check if a given object implements the AdminConceptImage interface.
+ */
+export declare function instanceOfAdminConceptImage(value: object): value is AdminConceptImage;
+export declare function AdminConceptImageFromJSON(json: any): AdminConceptImage;
+export declare function AdminConceptImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptImage;
+export declare function AdminConceptImageToJSON(json: any): AdminConceptImage;
+export declare function AdminConceptImageToJSONTyped(value?: AdminConceptImage | null, ignoreDiscriminator?: boolean): any;