@instructure/athena-api-client 3.46.2 → 3.47.0

package/dist/esm/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;

package/dist/esm/models/AdminConceptImage.js

@@ -0,0 +1,148 @@
+/* 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 { AdminConceptMediaActorFromJSON, AdminConceptMediaActorToJSON, } from './AdminConceptMediaActor';
+/**
+ * @export
+ */
+export const AdminConceptImageStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+export const AdminConceptImageOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminConceptImage interface.
+ */
+export function instanceOfAdminConceptImage(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;
+    return true;
+}
+export function AdminConceptImageFromJSON(json) {
+    return AdminConceptImageFromJSONTyped(json, false);
+}
+export function AdminConceptImageFromJSONTyped(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'],
+    };
+}
+export function AdminConceptImageToJSON(json) {
+    return AdminConceptImageToJSONTyped(json, false);
+}
+export function AdminConceptImageToJSONTyped(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'],
+    };
+}

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

@@ -0,0 +1,221 @@
+/**
+ * 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 AdminConceptImageDetail
+ */
+export interface AdminConceptImageDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    state: AdminConceptImageDetailStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    origin: AdminConceptImageDetailOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImageDetail
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImageDetail
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImageDetail
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImageDetail
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImageDetail
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminConceptImageDetail
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    description: string;
+    /**
+     * The image this one revises
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    revisesImageId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    quality: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImageDetail
+     */
+    width: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    url: string | null;
+    /**
+     * The full prompt sent to the image model, style preamble included
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    modelPrompt: string;
+    /**
+     * The image this one revises, in any state; null if none or gone
+     * @type {AdminConceptMediaRevision}
+     * @memberof AdminConceptImageDetail
+     */
+    parent: AdminConceptMediaRevision | null;
+    /**
+     * Images that revise this one, oldest first, in any state
+     * @type {Array<AdminConceptMediaRevision>}
+     * @memberof AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    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 AdminConceptImageDetail
+     */
+    historyTruncated: boolean;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptImageDetailStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminConceptImageDetailStateEnum = typeof AdminConceptImageDetailStateEnum[keyof typeof AdminConceptImageDetailStateEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptImageDetailOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminConceptImageDetailOriginEnum = typeof AdminConceptImageDetailOriginEnum[keyof typeof AdminConceptImageDetailOriginEnum];
+/**
+ * Check if a given object implements the AdminConceptImageDetail interface.
+ */
+export declare function instanceOfAdminConceptImageDetail(value: object): value is AdminConceptImageDetail;
+export declare function AdminConceptImageDetailFromJSON(json: any): AdminConceptImageDetail;
+export declare function AdminConceptImageDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptImageDetail;
+export declare function AdminConceptImageDetailToJSON(json: any): AdminConceptImageDetail;
+export declare function AdminConceptImageDetailToJSONTyped(value?: AdminConceptImageDetail | null, ignoreDiscriminator?: boolean): any;