@instructure/athena-api-client 3.46.2 → 4.0.0

package/dist/esm/models/AdminConceptMediaJob.js

@@ -0,0 +1,139 @@
+/* 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';
+/**
+ * @export
+ */
+export const AdminConceptMediaJobKindEnum = {
+    Image: 'image',
+    Diagram: 'diagram'
+};
+/**
+ * @export
+ */
+export const AdminConceptMediaJobOperationEnum = {
+    Generate: 'generate',
+    Regenerate: 'regenerate'
+};
+/**
+ * @export
+ */
+export const AdminConceptMediaJobStatusEnum = {
+    Pending: 'pending',
+    Running: 'running',
+    Succeeded: 'succeeded',
+    Failed: 'failed'
+};
+/**
+ * @export
+ */
+export const AdminConceptMediaJobConceptResolutionEnum = {
+    Selected: 'selected',
+    MatchedExact: 'matched_exact',
+    MatchedSimilar: 'matched_similar',
+    Created: 'created'
+};
+/**
+ * @export
+ */
+export const AdminConceptMediaJobErrorCodeEnum = {
+    OffTopic: 'off_topic',
+    ModerationBlocked: 'moderation_blocked',
+    Timeout: 'timeout',
+    NotFound: 'not_found',
+    GenerationFailed: 'generation_failed',
+    AuthoringFailed: 'authoring_failed',
+    SaveFailed: 'save_failed',
+    LimitReached: 'limit_reached',
+    InternalError: 'internal_error',
+    DeliveryFailed: 'delivery_failed'
+};
+/**
+ * Check if a given object implements the AdminConceptMediaJob interface.
+ */
+export function instanceOfAdminConceptMediaJob(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('operation' in value) || value['operation'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('concept' in value) || value['concept'] === undefined)
+        return false;
+    if (!('conceptResolution' in value) || value['conceptResolution'] === undefined)
+        return false;
+    if (!('sourceMediaId' in value) || value['sourceMediaId'] === undefined)
+        return false;
+    if (!('resultMediaId' in value) || value['resultMediaId'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    if (!('errorMessage' in value) || value['errorMessage'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('finishedAt' in value) || value['finishedAt'] === undefined)
+        return false;
+    return true;
+}
+export function AdminConceptMediaJobFromJSON(json) {
+    return AdminConceptMediaJobFromJSONTyped(json, false);
+}
+export function AdminConceptMediaJobFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'kind': json['kind'],
+        'operation': json['operation'],
+        'status': json['status'],
+        'concept': AdminConceptMediaConceptFromJSON(json['concept']),
+        'conceptResolution': json['conceptResolution'],
+        'sourceMediaId': json['sourceMediaId'],
+        'resultMediaId': json['resultMediaId'],
+        'errorCode': json['errorCode'],
+        'errorMessage': json['errorMessage'],
+        'createdAt': (new Date(json['createdAt'])),
+        'startedAt': (json['startedAt'] == null ? null : new Date(json['startedAt'])),
+        'finishedAt': (json['finishedAt'] == null ? null : new Date(json['finishedAt'])),
+    };
+}
+export function AdminConceptMediaJobToJSON(json) {
+    return AdminConceptMediaJobToJSONTyped(json, false);
+}
+export function AdminConceptMediaJobToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'kind': value['kind'],
+        'operation': value['operation'],
+        'status': value['status'],
+        'concept': AdminConceptMediaConceptToJSON(value['concept']),
+        'conceptResolution': value['conceptResolution'],
+        'sourceMediaId': value['sourceMediaId'],
+        'resultMediaId': value['resultMediaId'],
+        'errorCode': value['errorCode'],
+        'errorMessage': value['errorMessage'],
+        'createdAt': value['createdAt'].toISOString(),
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+/**
+ * A row linked by revision lineage: a parent or a child.
+ * @export
+ * @interface AdminConceptMediaRevision
+ */
+export interface AdminConceptMediaRevision {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaRevision
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaRevision
+     */
+    state: AdminConceptMediaRevisionStateEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaRevision
+     */
+    origin: AdminConceptMediaRevisionOriginEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptMediaRevision
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptMediaRevisionStateEnum: {
+    readonly Visible: "visible";
+    readonly Hidden: "hidden";
+    readonly Deleted: "deleted";
+};
+export type AdminConceptMediaRevisionStateEnum = typeof AdminConceptMediaRevisionStateEnum[keyof typeof AdminConceptMediaRevisionStateEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptMediaRevisionOriginEnum: {
+    readonly Chat: "chat";
+    readonly Admin: "admin";
+};
+export type AdminConceptMediaRevisionOriginEnum = typeof AdminConceptMediaRevisionOriginEnum[keyof typeof AdminConceptMediaRevisionOriginEnum];
+/**
+ * Check if a given object implements the AdminConceptMediaRevision interface.
+ */
+export declare function instanceOfAdminConceptMediaRevision(value: object): value is AdminConceptMediaRevision;
+export declare function AdminConceptMediaRevisionFromJSON(json: any): AdminConceptMediaRevision;
+export declare function AdminConceptMediaRevisionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaRevision;
+export declare function AdminConceptMediaRevisionToJSON(json: any): AdminConceptMediaRevision;
+export declare function AdminConceptMediaRevisionToJSONTyped(value?: AdminConceptMediaRevision | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminConceptMediaRevision.js

@@ -0,0 +1,70 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AdminConceptMediaRevisionStateEnum = {
+    Visible: 'visible',
+    Hidden: 'hidden',
+    Deleted: 'deleted'
+};
+/**
+ * @export
+ */
+export const AdminConceptMediaRevisionOriginEnum = {
+    Chat: 'chat',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the AdminConceptMediaRevision interface.
+ */
+export function instanceOfAdminConceptMediaRevision(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('origin' in value) || value['origin'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function AdminConceptMediaRevisionFromJSON(json) {
+    return AdminConceptMediaRevisionFromJSONTyped(json, false);
+}
+export function AdminConceptMediaRevisionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'state': json['state'],
+        'origin': json['origin'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function AdminConceptMediaRevisionToJSON(json) {
+    return AdminConceptMediaRevisionToJSONTyped(json, false);
+}
+export function AdminConceptMediaRevisionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'state': value['state'],
+        'origin': value['origin'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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'],
+    };
+}