@instructure/athena-api-client 3.47.0 → 4.0.0

package/dist/esm/apis/AdminApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminConceptDiagramDetailFromJSON, AdminConceptImageDetailFromJSON, AdminConceptSearchResultFromJSON, AdminGenerateConceptDiagramRequestToJSON, AdminGenerateConceptImageRequestToJSON, AdminGeneratedConceptDiagramFromJSON, AdminGeneratedConceptImageFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedConceptDiagramsFromJSON, AdminPaginatedConceptImagesFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminRegenerateConceptDiagramRequestToJSON, AdminRegenerateConceptImageRequestToJSON, AdminResetLearningDataResponseFromJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminConceptDiagramDetailFromJSON, AdminConceptImageDetailFromJSON, AdminConceptMediaJobFromJSON, AdminConceptSearchResultFromJSON, AdminGenerateConceptDiagramRequestToJSON, AdminGenerateConceptImageRequestToJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedConceptDiagramsFromJSON, AdminPaginatedConceptImagesFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminRegenerateConceptDiagramRequestToJSON, AdminRegenerateConceptImageRequestToJSON, AdminResetLearningDataResponseFromJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -109,8 +109,8 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generates a new diagram filed under exactly one concept: conceptId as-is, or conceptName resolved first (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the response says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat. It is stored hidden for review and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours), not the learner limit.
-     * Generate a hidden draft diagram for a concept
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
+     * Enqueue a hidden draft diagram for a concept
      */
     adminGenerateConceptDiagramRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -137,12 +137,12 @@ export class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: AdminGenerateConceptDiagramRequestToJSON(requestParameters['adminGenerateConceptDiagramRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => AdminGeneratedConceptDiagramFromJSON(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
         });
     }
     /**
-     * Generates a new diagram filed under exactly one concept: conceptId as-is, or conceptName resolved first (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the response says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat. It is stored hidden for review and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours), not the learner limit.
-     * Generate a hidden draft diagram for a concept
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The diagram is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing diagram. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
+     * Enqueue a hidden draft diagram for a concept
      */
     adminGenerateConceptDiagram(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -151,8 +151,8 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generates a new image filed under exactly one concept: conceptId as-is, or conceptName resolved first (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the response says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat. It is stored hidden for review and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours), not the learner limit.
-     * Generate a hidden draft image for a concept
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
+     * Enqueue a hidden draft image for a concept
      */
     adminGenerateConceptImageRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -179,12 +179,12 @@ export class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: AdminGenerateConceptImageRequestToJSON(requestParameters['adminGenerateConceptImageRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => AdminGeneratedConceptImageFromJSON(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
         });
     }
     /**
-     * Generates a new image filed under exactly one concept: conceptId as-is, or conceptName resolved first (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the response says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat. It is stored hidden for review and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours), not the learner limit.
-     * Generate a hidden draft image for a concept
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The draft is filed under exactly one concept: conceptId as-is, or conceptName resolved before the job is queued (exact normalized name match, else the nearest concept within the dedup distance, else a new concept, which stays even if generation then fails). conceptResolution in the job says which. Exactly one of conceptId and conceptName is required. The image is attributed to the calling account user with no source chat, stored hidden for review, and never matched to an existing image. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours, counting queued and running jobs as well as saved drafts), not the learner limit.
+     * Enqueue a hidden draft image for a concept
      */
     adminGenerateConceptImage(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -438,6 +438,47 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Poll after a generate or regenerate (every few seconds) until status is succeeded or failed. On success, resultMediaId is the new hidden draft: open it with adminGetConceptImage or adminGetConceptDiagram per kind. On failure, errorCode and errorMessage say why. A job left pending or running past its deadline (the generation timeout plus a margin while running; 30 minutes while pending) is reported failed with errorCode timeout. Only jobs requested by account users in the caller\'s account are found.
+     * Get an admin concept media generation job
+     */
+    adminGetConceptMediaJobRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetConceptMediaJob().');
+            }
+            if (requestParameters['jobId'] == null) {
+                throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling adminGetConceptMediaJob().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/concept-media-jobs/{jobId}`;
+            urlPath = urlPath.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Poll after a generate or regenerate (every few seconds) until status is succeeded or failed. On success, resultMediaId is the new hidden draft: open it with adminGetConceptImage or adminGetConceptDiagram per kind. On failure, errorCode and errorMessage say why. A job left pending or running past its deadline (the generation timeout plus a margin while running; 30 minutes while pending) is reported failed with errorCode timeout. Only jobs requested by account users in the caller\'s account are found.
+     * Get an admin concept media generation job
+     */
+    adminGetConceptMediaJob(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetConceptMediaJobRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns the session summary (quiz details, questions, responses, score) for any quiz session belonging to a user within the caller\'s account. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Unlike the per-user `getQuizSessionSummary` endpoint, this endpoint does not gate on the `enhanced-quizzing` feature flag; an admin can read any historical session in their account regardless of whether the chat owner currently has the feature.
      * Get quiz session summary for any session within the account
@@ -1320,8 +1361,8 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generates a new diagram from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
-     * Generate a hidden revision of a concept diagram
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new diagram is generated from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
+     * Enqueue a hidden revision of a concept diagram
      */
     adminRegenerateConceptDiagramRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1352,12 +1393,12 @@ export class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: AdminRegenerateConceptDiagramRequestToJSON(requestParameters['adminRegenerateConceptDiagramRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptDiagramDetailFromJSON(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
         });
     }
     /**
-     * Generates a new diagram from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
-     * Generate a hidden revision of a concept diagram
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new diagram is generated from an edited brief, linked to the original by revisesDiagramId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_DIAGRAM_DAILY_LIMIT per rolling 24 hours).
+     * Enqueue a hidden revision of a concept diagram
      */
     adminRegenerateConceptDiagram(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1366,8 +1407,8 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generates a new image from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
-     * Generate a hidden revision of a concept image
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new image is generated from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
+     * Enqueue a hidden revision of a concept image
      */
     adminRegenerateConceptImageRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1398,12 +1439,12 @@ export class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: AdminRegenerateConceptImageRequestToJSON(requestParameters['adminRegenerateConceptImageRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptImageDetailFromJSON(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
         });
     }
     /**
-     * Generates a new image from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
-     * Generate a hidden revision of a concept image
+     * Returns 202 with a pending job at once; the generation runs in a background worker. Poll adminGetConceptMediaJob with the job id until status is succeeded (resultMediaId is the new draft) or failed (errorCode says why: off_topic, moderation_blocked, timeout, not_found, generation_failed, authoring_failed, save_failed, limit_reached, internal_error, delivery_failed). Each job runs its paid generation at most once: retry a failed job by enqueueing a new one. The new image is generated from an edited prompt, linked to the original by revisesImageId even when the original is hidden or deleted, filed under the original\'s concept, attributed to the caller, and stored hidden. The original is left as it is. Counts against the caller\'s admin limit (ADMIN_CONCEPT_IMAGE_DAILY_LIMIT per rolling 24 hours).
+     * Enqueue a hidden revision of a concept image
      */
     adminRegenerateConceptImage(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/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/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/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/esm/models/index.js

@@ -26,14 +26,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';