@instructure/athena-api-client 3.46.2 → 3.47.0

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

@@ -0,0 +1,56 @@
+/**
+ * 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 AdminConceptSearchResult
+ */
+export interface AdminConceptSearchResult {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptSearchResult
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptSearchResult
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptSearchResult
+     */
+    description: string;
+    /**
+     * Library images of this concept that are not deleted
+     * @type {number}
+     * @memberof AdminConceptSearchResult
+     */
+    imageCount: number;
+    /**
+     * Library diagrams of this concept that are not deleted
+     * @type {number}
+     * @memberof AdminConceptSearchResult
+     */
+    diagramCount: number;
+}
+/**
+ * Check if a given object implements the AdminConceptSearchResult interface.
+ */
+export declare function instanceOfAdminConceptSearchResult(value: object): value is AdminConceptSearchResult;
+export declare function AdminConceptSearchResultFromJSON(json: any): AdminConceptSearchResult;
+export declare function AdminConceptSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptSearchResult;
+export declare function AdminConceptSearchResultToJSON(json: any): AdminConceptSearchResult;
+export declare function AdminConceptSearchResultToJSONTyped(value?: AdminConceptSearchResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminConceptSearchResult.js

@@ -0,0 +1,59 @@
+/* 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 AdminConceptSearchResult interface.
+ */
+export function instanceOfAdminConceptSearchResult(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('imageCount' in value) || value['imageCount'] === undefined)
+        return false;
+    if (!('diagramCount' in value) || value['diagramCount'] === undefined)
+        return false;
+    return true;
+}
+export function AdminConceptSearchResultFromJSON(json) {
+    return AdminConceptSearchResultFromJSONTyped(json, false);
+}
+export function AdminConceptSearchResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'imageCount': json['imageCount'],
+        'diagramCount': json['diagramCount'],
+    };
+}
+export function AdminConceptSearchResultToJSON(json) {
+    return AdminConceptSearchResultToJSONTyped(json, false);
+}
+export function AdminConceptSearchResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'imageCount': value['imageCount'],
+        'diagramCount': value['diagramCount'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 AdminGenerateConceptDiagramRequest
+ */
+export interface AdminGenerateConceptDiagramRequest {
+    /**
+     * The existing concept the diagram is filed under, as-is. Exactly one of conceptId and conceptName is required.
+     * @type {string}
+     * @memberof AdminGenerateConceptDiagramRequest
+     */
+    conceptId?: string;
+    /**
+     * A concept name, resolved the way learner generation resolves one: an exact (case-insensitive, normalized) name match, else the nearest concept within the dedup distance, else a new concept. The diagram is then filed under that concept exactly as with conceptId; conceptResolution in the response says which happened. Exactly one of conceptId and conceptName is required.
+     * @type {string}
+     * @memberof AdminGenerateConceptDiagramRequest
+     */
+    conceptName?: string;
+    /**
+     * The brief the authoring model draws from
+     * @type {string}
+     * @memberof AdminGenerateConceptDiagramRequest
+     */
+    instructions: string;
+    /**
+     * Diagram title. Defaults to the concept's name.
+     * @type {string}
+     * @memberof AdminGenerateConceptDiagramRequest
+     */
+    title?: string;
+    /**
+     * What the diagram shows, and what later library lookups match against. Defaults to the instructions.
+     * @type {string}
+     * @memberof AdminGenerateConceptDiagramRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminGenerateConceptDiagramRequest interface.
+ */
+export declare function instanceOfAdminGenerateConceptDiagramRequest(value: object): value is AdminGenerateConceptDiagramRequest;
+export declare function AdminGenerateConceptDiagramRequestFromJSON(json: any): AdminGenerateConceptDiagramRequest;
+export declare function AdminGenerateConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminGenerateConceptDiagramRequest;
+export declare function AdminGenerateConceptDiagramRequestToJSON(json: any): AdminGenerateConceptDiagramRequest;
+export declare function AdminGenerateConceptDiagramRequestToJSONTyped(value?: AdminGenerateConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminGenerateConceptDiagramRequest.js

@@ -0,0 +1,51 @@
+/* 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 AdminGenerateConceptDiagramRequest interface.
+ */
+export function instanceOfAdminGenerateConceptDiagramRequest(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+export function AdminGenerateConceptDiagramRequestFromJSON(json) {
+    return AdminGenerateConceptDiagramRequestFromJSONTyped(json, false);
+}
+export function AdminGenerateConceptDiagramRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
+        'conceptName': json['conceptName'] == null ? undefined : json['conceptName'],
+        'instructions': json['instructions'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminGenerateConceptDiagramRequestToJSON(json) {
+    return AdminGenerateConceptDiagramRequestToJSONTyped(json, false);
+}
+export function AdminGenerateConceptDiagramRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'instructions': value['instructions'],
+        'title': value['title'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 AdminGenerateConceptImageRequest
+ */
+export interface AdminGenerateConceptImageRequest {
+    /**
+     * The existing concept the image is filed under, as-is. Exactly one of conceptId and conceptName is required.
+     * @type {string}
+     * @memberof AdminGenerateConceptImageRequest
+     */
+    conceptId?: string;
+    /**
+     * A concept name, resolved the way learner generation resolves one: an exact (case-insensitive, normalized) name match, else the nearest concept within the dedup distance, else a new concept. The image is then filed under that concept exactly as with conceptId; conceptResolution in the response says which happened. Exactly one of conceptId and conceptName is required.
+     * @type {string}
+     * @memberof AdminGenerateConceptImageRequest
+     */
+    conceptName?: string;
+    /**
+     * What the image should show. Sent to the image model after the fixed style preamble.
+     * @type {string}
+     * @memberof AdminGenerateConceptImageRequest
+     */
+    instructions: string;
+    /**
+     * Alt text, and what later library lookups match against. Defaults to the instructions.
+     * @type {string}
+     * @memberof AdminGenerateConceptImageRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminGenerateConceptImageRequest interface.
+ */
+export declare function instanceOfAdminGenerateConceptImageRequest(value: object): value is AdminGenerateConceptImageRequest;
+export declare function AdminGenerateConceptImageRequestFromJSON(json: any): AdminGenerateConceptImageRequest;
+export declare function AdminGenerateConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminGenerateConceptImageRequest;
+export declare function AdminGenerateConceptImageRequestToJSON(json: any): AdminGenerateConceptImageRequest;
+export declare function AdminGenerateConceptImageRequestToJSONTyped(value?: AdminGenerateConceptImageRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminGenerateConceptImageRequest.js

@@ -0,0 +1,49 @@
+/* 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 AdminGenerateConceptImageRequest interface.
+ */
+export function instanceOfAdminGenerateConceptImageRequest(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+export function AdminGenerateConceptImageRequestFromJSON(json) {
+    return AdminGenerateConceptImageRequestFromJSONTyped(json, false);
+}
+export function AdminGenerateConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
+        'conceptName': json['conceptName'] == null ? undefined : json['conceptName'],
+        'instructions': json['instructions'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminGenerateConceptImageRequestToJSON(json) {
+    return AdminGenerateConceptImageRequestToJSONTyped(json, false);
+}
+export function AdminGenerateConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'instructions': value['instructions'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,219 @@
+/**
+ * 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 AdminGeneratedConceptDiagram
+ */
+export interface AdminGeneratedConceptDiagram {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    id: string;
+    /**
+     *
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    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 AdminGeneratedConceptDiagram
+     */
+    state: AdminGeneratedConceptDiagramStateEnum;
+    /**
+     * chat: generated in a learner's tutor turn. admin: an admin draft or regeneration.
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    origin: AdminGeneratedConceptDiagramOriginEnum;
+    /**
+     * Who generated it. Null when that account user was deleted or belongs to a different account (see creatorOutsideAccount).
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    creator: AdminConceptMediaActor | null;
+    /**
+     * True when the creator exists but belongs to a different account, so their details are withheld.
+     * @type {boolean}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    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 AdminGeneratedConceptDiagram
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    hiddenAt: Date | null;
+    /**
+     * Who hid it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    hiddenBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    deletedAt: Date | null;
+    /**
+     * Who deleted it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    deletedBy: AdminConceptMediaActor | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    model: string;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    inputTokens: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    outputTokens: number | null;
+    /**
+     * Null when usage or price was missing; never estimated.
+     * @type {number}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    costUsd: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    description: string;
+    /**
+     * The diagram this one revises
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    revisesDiagramId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    title: string;
+    /**
+     * The authoring model's effort level, when one was configured
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    effort: string | null;
+    /**
+     * The brief the authoring model drew from: what to prefill for a regeneration
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    brief: string;
+    /**
+     * The complete assembled HTML document, for a sandboxed iframe
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    document: string;
+    /**
+     * The diagram this one revises, in any state; null if none or gone
+     * @type {AdminConceptMediaRevision}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    parent: AdminConceptMediaRevision | null;
+    /**
+     * Diagrams that revise this one, oldest first, in any state
+     * @type {Array<AdminConceptMediaRevision>}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    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 AdminGeneratedConceptDiagram
+     */
+    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 AdminGeneratedConceptDiagram
+     */
+    historyTruncated: boolean;
+    /**
+     * How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created.
+     * @type {string}
+     * @memberof AdminGeneratedConceptDiagram
+     */
+    conceptResolution: AdminGeneratedConceptDiagramConceptResolutionEnum;
+}
+/**
+ * @export
+ */
+export declare const AdminGeneratedConceptDiagramStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminGeneratedConceptDiagramStateEnum = typeof AdminGeneratedConceptDiagramStateEnum[keyof typeof AdminGeneratedConceptDiagramStateEnum];
+/**
+ * @export
+ */
+export declare const AdminGeneratedConceptDiagramOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminGeneratedConceptDiagramOriginEnum = typeof AdminGeneratedConceptDiagramOriginEnum[keyof typeof AdminGeneratedConceptDiagramOriginEnum];
+/**
+ * @export
+ */
+export declare const AdminGeneratedConceptDiagramConceptResolutionEnum: {
+    readonly Selected: "selected";
+    readonly MatchedExact: "matched_exact";
+    readonly MatchedSimilar: "matched_similar";
+    readonly Created: "created";
+};
+export type AdminGeneratedConceptDiagramConceptResolutionEnum = typeof AdminGeneratedConceptDiagramConceptResolutionEnum[keyof typeof AdminGeneratedConceptDiagramConceptResolutionEnum];
+/**
+ * Check if a given object implements the AdminGeneratedConceptDiagram interface.
+ */
+export declare function instanceOfAdminGeneratedConceptDiagram(value: object): value is AdminGeneratedConceptDiagram;
+export declare function AdminGeneratedConceptDiagramFromJSON(json: any): AdminGeneratedConceptDiagram;
+export declare function AdminGeneratedConceptDiagramFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminGeneratedConceptDiagram;
+export declare function AdminGeneratedConceptDiagramToJSON(json: any): AdminGeneratedConceptDiagram;
+export declare function AdminGeneratedConceptDiagramToJSONTyped(value?: AdminGeneratedConceptDiagram | null, ignoreDiscriminator?: boolean): any;