@instructure/athena-api-client 3.46.1 → 3.47.0

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

package/dist/esm/models/AdminPaginatedConceptImages.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 { AdminConceptImageFromJSON, AdminConceptImageToJSON, } from './AdminConceptImage';
+/**
+ * Check if a given object implements the AdminPaginatedConceptImages interface.
+ */
+export function instanceOfAdminPaginatedConceptImages(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function AdminPaginatedConceptImagesFromJSON(json) {
+    return AdminPaginatedConceptImagesFromJSONTyped(json, false);
+}
+export function AdminPaginatedConceptImagesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminConceptImageFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function AdminPaginatedConceptImagesToJSON(json) {
+    return AdminPaginatedConceptImagesToJSONTyped(json, false);
+}
+export function AdminPaginatedConceptImagesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminConceptImageToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 AdminRegenerateConceptDiagramRequest
+ */
+export interface AdminRegenerateConceptDiagramRequest {
+    /**
+     * The edited brief (prefill from the original's brief)
+     * @type {string}
+     * @memberof AdminRegenerateConceptDiagramRequest
+     */
+    brief: string;
+    /**
+     * Title for the new revision. Defaults to the original's.
+     * @type {string}
+     * @memberof AdminRegenerateConceptDiagramRequest
+     */
+    title?: string;
+    /**
+     * Description for the new revision. Defaults to the original's.
+     * @type {string}
+     * @memberof AdminRegenerateConceptDiagramRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminRegenerateConceptDiagramRequest interface.
+ */
+export declare function instanceOfAdminRegenerateConceptDiagramRequest(value: object): value is AdminRegenerateConceptDiagramRequest;
+export declare function AdminRegenerateConceptDiagramRequestFromJSON(json: any): AdminRegenerateConceptDiagramRequest;
+export declare function AdminRegenerateConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminRegenerateConceptDiagramRequest;
+export declare function AdminRegenerateConceptDiagramRequestToJSON(json: any): AdminRegenerateConceptDiagramRequest;
+export declare function AdminRegenerateConceptDiagramRequestToJSONTyped(value?: AdminRegenerateConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminRegenerateConceptDiagramRequest.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the AdminRegenerateConceptDiagramRequest interface.
+ */
+export function instanceOfAdminRegenerateConceptDiagramRequest(value) {
+    if (!('brief' in value) || value['brief'] === undefined)
+        return false;
+    return true;
+}
+export function AdminRegenerateConceptDiagramRequestFromJSON(json) {
+    return AdminRegenerateConceptDiagramRequestFromJSONTyped(json, false);
+}
+export function AdminRegenerateConceptDiagramRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'brief': json['brief'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminRegenerateConceptDiagramRequestToJSON(json) {
+    return AdminRegenerateConceptDiagramRequestToJSONTyped(json, false);
+}
+export function AdminRegenerateConceptDiagramRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'brief': value['brief'],
+        'title': value['title'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 AdminRegenerateConceptImageRequest
+ */
+export interface AdminRegenerateConceptImageRequest {
+    /**
+     * The edited prompt, without the style preamble (prefill from modelPrompt). A prompt that still carries the preamble is accepted and not doubled.
+     * @type {string}
+     * @memberof AdminRegenerateConceptImageRequest
+     */
+    prompt: string;
+    /**
+     * Alt text for the new revision. Defaults to the original's.
+     * @type {string}
+     * @memberof AdminRegenerateConceptImageRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminRegenerateConceptImageRequest interface.
+ */
+export declare function instanceOfAdminRegenerateConceptImageRequest(value: object): value is AdminRegenerateConceptImageRequest;
+export declare function AdminRegenerateConceptImageRequestFromJSON(json: any): AdminRegenerateConceptImageRequest;
+export declare function AdminRegenerateConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminRegenerateConceptImageRequest;
+export declare function AdminRegenerateConceptImageRequestToJSON(json: any): AdminRegenerateConceptImageRequest;
+export declare function AdminRegenerateConceptImageRequestToJSONTyped(value?: AdminRegenerateConceptImageRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminRegenerateConceptImageRequest.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the AdminRegenerateConceptImageRequest interface.
+ */
+export function instanceOfAdminRegenerateConceptImageRequest(value) {
+    if (!('prompt' in value) || value['prompt'] === undefined)
+        return false;
+    return true;
+}
+export function AdminRegenerateConceptImageRequestFromJSON(json) {
+    return AdminRegenerateConceptImageRequestFromJSONTyped(json, false);
+}
+export function AdminRegenerateConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'prompt': json['prompt'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminRegenerateConceptImageRequestToJSON(json) {
+    return AdminRegenerateConceptImageRequestToJSONTyped(json, false);
+}
+export function AdminRegenerateConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'prompt': value['prompt'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 AdminShowConceptMediaRequest
+ */
+export interface AdminShowConceptMediaRequest {
+    /**
+     * Also hide every other currently visible version in this row's revision family (the rows the detail's history lists), in the same transaction, recording the caller as their hider. Hidden and deleted versions are left as they are. Defaults to false: only this row changes.
+     * @type {boolean}
+     * @memberof AdminShowConceptMediaRequest
+     */
+    hideOtherVersions?: boolean;
+}
+/**
+ * Check if a given object implements the AdminShowConceptMediaRequest interface.
+ */
+export declare function instanceOfAdminShowConceptMediaRequest(value: object): value is AdminShowConceptMediaRequest;
+export declare function AdminShowConceptMediaRequestFromJSON(json: any): AdminShowConceptMediaRequest;
+export declare function AdminShowConceptMediaRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminShowConceptMediaRequest;
+export declare function AdminShowConceptMediaRequestToJSON(json: any): AdminShowConceptMediaRequest;
+export declare function AdminShowConceptMediaRequestToJSONTyped(value?: AdminShowConceptMediaRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminShowConceptMediaRequest.js

@@ -0,0 +1,41 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the AdminShowConceptMediaRequest interface.
+ */
+export function instanceOfAdminShowConceptMediaRequest(value) {
+    return true;
+}
+export function AdminShowConceptMediaRequestFromJSON(json) {
+    return AdminShowConceptMediaRequestFromJSONTyped(json, false);
+}
+export function AdminShowConceptMediaRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'hideOtherVersions': json['hideOtherVersions'] == null ? undefined : json['hideOtherVersions'],
+    };
+}
+export function AdminShowConceptMediaRequestToJSON(json) {
+    return AdminShowConceptMediaRequestToJSONTyped(json, false);
+}
+export function AdminShowConceptMediaRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'hideOtherVersions': value['hideOtherVersions'],
+    };
+}

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;