@instructure/athena-api-client 3.47.0 → 4.0.0

package/dist/models/AdminConceptMediaJob.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 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';
+/**
+ * An asynchronous admin generation of a hidden concept image or diagram draft. Poll adminGetConceptMediaJob until status is succeeded (open resultMediaId with the kind's get operation) or failed (see errorCode and errorMessage).
+ * @export
+ * @interface AdminConceptMediaJob
+ */
+export interface AdminConceptMediaJob {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    kind: AdminConceptMediaJobKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    operation: AdminConceptMediaJobOperationEnum;
+    /**
+     * pending: queued, not started. running: a worker is generating. succeeded and failed are final.
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    status: AdminConceptMediaJobStatusEnum;
+    /**
+     * The concept the draft is filed under, resolved at enqueue
+     * @type {AdminConceptMediaConcept}
+     * @memberof AdminConceptMediaJob
+     */
+    concept: AdminConceptMediaConcept;
+    /**
+     * 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. Null for a regenerate, which files under the revised row's concept.
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    conceptResolution: AdminConceptMediaJobConceptResolutionEnum | null;
+    /**
+     * For a regenerate, the image or diagram being revised
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    sourceMediaId: string | null;
+    /**
+     * When succeeded, the new hidden draft: an image id for kind image, a diagram id for kind diagram
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    resultMediaId: string | null;
+    /**
+     * When failed, why
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    errorCode: AdminConceptMediaJobErrorCodeEnum | null;
+    /**
+     * When failed, a message to show the admin
+     * @type {string}
+     * @memberof AdminConceptMediaJob
+     */
+    errorMessage: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptMediaJob
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptMediaJob
+     */
+    startedAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminConceptMediaJob
+     */
+    finishedAt: Date | null;
+}
+/**
+ * @export
+ */
+export declare const AdminConceptMediaJobKindEnum: {
+    readonly Image: "image";
+    readonly Diagram: "diagram";
+};
+export type AdminConceptMediaJobKindEnum = typeof AdminConceptMediaJobKindEnum[keyof typeof AdminConceptMediaJobKindEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptMediaJobOperationEnum: {
+    readonly Generate: "generate";
+    readonly Regenerate: "regenerate";
+};
+export type AdminConceptMediaJobOperationEnum = typeof AdminConceptMediaJobOperationEnum[keyof typeof AdminConceptMediaJobOperationEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptMediaJobStatusEnum: {
+    readonly Pending: "pending";
+    readonly Running: "running";
+    readonly Succeeded: "succeeded";
+    readonly Failed: "failed";
+};
+export type AdminConceptMediaJobStatusEnum = typeof AdminConceptMediaJobStatusEnum[keyof typeof AdminConceptMediaJobStatusEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptMediaJobConceptResolutionEnum: {
+    readonly Selected: "selected";
+    readonly MatchedExact: "matched_exact";
+    readonly MatchedSimilar: "matched_similar";
+    readonly Created: "created";
+};
+export type AdminConceptMediaJobConceptResolutionEnum = typeof AdminConceptMediaJobConceptResolutionEnum[keyof typeof AdminConceptMediaJobConceptResolutionEnum];
+/**
+ * @export
+ */
+export declare const AdminConceptMediaJobErrorCodeEnum: {
+    readonly OffTopic: "off_topic";
+    readonly ModerationBlocked: "moderation_blocked";
+    readonly Timeout: "timeout";
+    readonly NotFound: "not_found";
+    readonly GenerationFailed: "generation_failed";
+    readonly AuthoringFailed: "authoring_failed";
+    readonly SaveFailed: "save_failed";
+    readonly LimitReached: "limit_reached";
+    readonly InternalError: "internal_error";
+    readonly DeliveryFailed: "delivery_failed";
+};
+export type AdminConceptMediaJobErrorCodeEnum = typeof AdminConceptMediaJobErrorCodeEnum[keyof typeof AdminConceptMediaJobErrorCodeEnum];
+/**
+ * Check if a given object implements the AdminConceptMediaJob interface.
+ */
+export declare function instanceOfAdminConceptMediaJob(value: object): value is AdminConceptMediaJob;
+export declare function AdminConceptMediaJobFromJSON(json: any): AdminConceptMediaJob;
+export declare function AdminConceptMediaJobFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaJob;
+export declare function AdminConceptMediaJobToJSON(json: any): AdminConceptMediaJob;
+export declare function AdminConceptMediaJobToJSONTyped(value?: AdminConceptMediaJob | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminConceptMediaJob.js

@@ -0,0 +1,147 @@
+"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.AdminConceptMediaJobErrorCodeEnum = exports.AdminConceptMediaJobConceptResolutionEnum = exports.AdminConceptMediaJobStatusEnum = exports.AdminConceptMediaJobOperationEnum = exports.AdminConceptMediaJobKindEnum = void 0;
+exports.instanceOfAdminConceptMediaJob = instanceOfAdminConceptMediaJob;
+exports.AdminConceptMediaJobFromJSON = AdminConceptMediaJobFromJSON;
+exports.AdminConceptMediaJobFromJSONTyped = AdminConceptMediaJobFromJSONTyped;
+exports.AdminConceptMediaJobToJSON = AdminConceptMediaJobToJSON;
+exports.AdminConceptMediaJobToJSONTyped = AdminConceptMediaJobToJSONTyped;
+const AdminConceptMediaConcept_1 = require("./AdminConceptMediaConcept");
+/**
+ * @export
+ */
+exports.AdminConceptMediaJobKindEnum = {
+    Image: 'image',
+    Diagram: 'diagram'
+};
+/**
+ * @export
+ */
+exports.AdminConceptMediaJobOperationEnum = {
+    Generate: 'generate',
+    Regenerate: 'regenerate'
+};
+/**
+ * @export
+ */
+exports.AdminConceptMediaJobStatusEnum = {
+    Pending: 'pending',
+    Running: 'running',
+    Succeeded: 'succeeded',
+    Failed: 'failed'
+};
+/**
+ * @export
+ */
+exports.AdminConceptMediaJobConceptResolutionEnum = {
+    Selected: 'selected',
+    MatchedExact: 'matched_exact',
+    MatchedSimilar: 'matched_similar',
+    Created: 'created'
+};
+/**
+ * @export
+ */
+exports.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.
+ */
+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;
+}
+function AdminConceptMediaJobFromJSON(json) {
+    return AdminConceptMediaJobFromJSONTyped(json, false);
+}
+function AdminConceptMediaJobFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'kind': json['kind'],
+        'operation': json['operation'],
+        'status': json['status'],
+        'concept': (0, AdminConceptMediaConcept_1.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'])),
+    };
+}
+function AdminConceptMediaJobToJSON(json) {
+    return AdminConceptMediaJobToJSONTyped(json, false);
+}
+function AdminConceptMediaJobToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'kind': value['kind'],
+        'operation': value['operation'],
+        'status': value['status'],
+        'concept': (0, AdminConceptMediaConcept_1.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/models/index.d.ts

@@ -24,14 +24,13 @@ export * from './AdminConceptImageDetail';
 export * from './AdminConceptMediaActor';
 export * from './AdminConceptMediaConcept';
 export * from './AdminConceptMediaHistoryEntry';
+export * from './AdminConceptMediaJob';
 export * from './AdminConceptMediaRevision';
 export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
 export * from './AdminExchangeMessage';
 export * from './AdminGenerateConceptDiagramRequest';
 export * from './AdminGenerateConceptImageRequest';
-export * from './AdminGeneratedConceptDiagram';
-export * from './AdminGeneratedConceptImage';
 export * from './AdminLastExchange';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';

package/dist/models/index.js

@@ -42,14 +42,13 @@ __exportStar(require("./AdminConceptImageDetail"), exports);
 __exportStar(require("./AdminConceptMediaActor"), exports);
 __exportStar(require("./AdminConceptMediaConcept"), exports);
 __exportStar(require("./AdminConceptMediaHistoryEntry"), exports);
+__exportStar(require("./AdminConceptMediaJob"), exports);
 __exportStar(require("./AdminConceptMediaRevision"), exports);
 __exportStar(require("./AdminConceptSearchResult"), exports);
 __exportStar(require("./AdminExchangeChat"), exports);
 __exportStar(require("./AdminExchangeMessage"), exports);
 __exportStar(require("./AdminGenerateConceptDiagramRequest"), exports);
 __exportStar(require("./AdminGenerateConceptImageRequest"), exports);
-__exportStar(require("./AdminGeneratedConceptDiagram"), exports);
-__exportStar(require("./AdminGeneratedConceptImage"), exports);
 __exportStar(require("./AdminLastExchange"), exports);
 __exportStar(require("./AdminPaginatedActiveStreaks"), exports);
 __exportStar(require("./AdminPaginatedChats"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.47.0",
+  "version": "4.0.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {