@instructure/athena-api-client 4.2.1 → 4.4.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, 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';
+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, AdminReviseConceptDiagramRequestToJSON, AdminReviseConceptImageRequestToJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTopConceptFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -356,6 +356,47 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
+     * Get one concept with its media counts
+     */
+    adminGetConceptRaw(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 adminGetConcept().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adminGetConcept().');
+            }
+            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/concepts/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptSearchResultFromJSON(jsonValue));
+        });
+    }
+    /**
+     * The concept with its count of non-deleted library images and diagrams, in the same shape as a concept search result.
+     * Get one concept with its media counts
+     */
+    adminGetConcept(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetConceptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * One diagram, hidden or deleted included, with its brief and assembled HTML document and its revision lineage.
      * Get a library concept diagram in any state
@@ -1322,6 +1363,46 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
+     * List the concepts the most users have
+     */
+    adminListTopConceptsRaw(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 adminListTopConcepts().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            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/concepts/top`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AdminTopConceptFromJSON));
+        });
+    }
+    /**
+     * Concepts ranked by how many distinct users hold a user concept for them (a user with several account users counts once), most first, then by name. Concepts no user holds are left out. Each comes with its count of non-deleted library images and diagrams, for choosing which concepts to pre-generate media for.
+     * List the concepts the most users have
+     */
+    adminListTopConcepts(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListTopConceptsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List top N streaks across the account
      */
@@ -1361,7 +1442,7 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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).
+     * 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). To change only part of the diagram and keep the rest, use adminReviseConceptDiagram instead.
      * Enqueue a hidden revision of a concept diagram
      */
     adminRegenerateConceptDiagramRaw(requestParameters, initOverrides) {
@@ -1397,7 +1478,7 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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).
+     * 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). To change only part of the diagram and keep the rest, use adminReviseConceptDiagram instead.
      * Enqueue a hidden revision of a concept diagram
      */
     adminRegenerateConceptDiagram(requestParameters, initOverrides) {
@@ -1407,7 +1488,7 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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).
+     * 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). To change only part of the image and keep the rest, use adminReviseConceptImage instead.
      * Enqueue a hidden revision of a concept image
      */
     adminRegenerateConceptImageRaw(requestParameters, initOverrides) {
@@ -1443,7 +1524,7 @@ export class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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).
+     * 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). To change only part of the image and keep the rest, use adminReviseConceptImage instead.
      * Enqueue a hidden revision of a concept image
      */
     adminRegenerateConceptImage(requestParameters, initOverrides) {
@@ -1575,6 +1656,98 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns 202 with a pending job (operation revise) 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, as for a regenerate). Each job runs its paid generation at most once. Unlike a regenerate, the admin sends only what should change: the authoring model gets the original diagram\'s HTML fragment and is asked to apply these changes and keep everything else. The stored brief is the original\'s with the changes appended. The changes are recorded on the new revision as revisionInstructions. The new diagram is 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 with only the given changes
+     */
+    adminReviseConceptDiagramRaw(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 adminReviseConceptDiagram().');
+            }
+            if (requestParameters['diagramId'] == null) {
+                throw new runtime.RequiredError('diagramId', 'Required parameter "diagramId" was null or undefined when calling adminReviseConceptDiagram().');
+            }
+            if (requestParameters['adminReviseConceptDiagramRequest'] == null) {
+                throw new runtime.RequiredError('adminReviseConceptDiagramRequest', 'Required parameter "adminReviseConceptDiagramRequest" was null or undefined when calling adminReviseConceptDiagram().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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-diagrams/{diagramId}/revise`;
+            urlPath = urlPath.replace(`{${"diagramId"}}`, encodeURIComponent(String(requestParameters['diagramId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AdminReviseConceptDiagramRequestToJSON(requestParameters['adminReviseConceptDiagramRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns 202 with a pending job (operation revise) 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, as for a regenerate). Each job runs its paid generation at most once. Unlike a regenerate, the admin sends only what should change: the authoring model gets the original diagram\'s HTML fragment and is asked to apply these changes and keep everything else. The stored brief is the original\'s with the changes appended. The changes are recorded on the new revision as revisionInstructions. The new diagram is 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 with only the given changes
+     */
+    adminReviseConceptDiagram(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminReviseConceptDiagramRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns 202 with a pending job (operation revise) 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, as for a regenerate). Each job runs its paid generation at most once. Unlike a regenerate, the admin sends only what should change: the original image itself goes to the image model\'s edit endpoint as a reference, with instructions to apply these changes and keep everything else. The stored prompt is the original\'s with the changes appended. The changes are recorded on the new revision as revisionInstructions. The new image is 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 with only the given changes
+     */
+    adminReviseConceptImageRaw(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 adminReviseConceptImage().');
+            }
+            if (requestParameters['imageId'] == null) {
+                throw new runtime.RequiredError('imageId', 'Required parameter "imageId" was null or undefined when calling adminReviseConceptImage().');
+            }
+            if (requestParameters['adminReviseConceptImageRequest'] == null) {
+                throw new runtime.RequiredError('adminReviseConceptImageRequest', 'Required parameter "adminReviseConceptImageRequest" was null or undefined when calling adminReviseConceptImage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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-images/{imageId}/revise`;
+            urlPath = urlPath.replace(`{${"imageId"}}`, encodeURIComponent(String(requestParameters['imageId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AdminReviseConceptImageRequestToJSON(requestParameters['adminReviseConceptImageRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaJobFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns 202 with a pending job (operation revise) 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, as for a regenerate). Each job runs its paid generation at most once. Unlike a regenerate, the admin sends only what should change: the original image itself goes to the image model\'s edit endpoint as a reference, with instructions to apply these changes and keep everything else. The stored prompt is the original\'s with the changes appended. The changes are recorded on the new revision as revisionInstructions. The new image is 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 with only the given changes
+     */
+    adminReviseConceptImage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminReviseConceptImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Concepts whose name contains the query (case-insensitive), exact and prefix matches first, each with its count of non-deleted library images and diagrams. For picking the concept an admin-generated image or diagram is filed under. Without a query, concepts by name.
      * Search the global concepts by name

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

@@ -149,6 +149,12 @@ export interface AdminConceptDiagram {
      * @memberof AdminConceptDiagram
      */
     revisesDiagramId: string | null;
+    /**
+     * The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
+     * @type {string}
+     * @memberof AdminConceptDiagram
+     */
+    revisionInstructions: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/AdminConceptDiagram.js

@@ -76,6 +76,8 @@ export function instanceOfAdminConceptDiagram(value) {
         return false;
     if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('effort' in value) || value['effort'] === undefined)
@@ -112,6 +114,7 @@ export function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesDiagramId': json['revisesDiagramId'],
+        'revisionInstructions': json['revisionInstructions'],
         'title': json['title'],
         'effort': json['effort'],
     };
@@ -146,6 +149,7 @@ export function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = fals
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesDiagramId': value['revisesDiagramId'],
+        'revisionInstructions': value['revisionInstructions'],
         'title': value['title'],
         'effort': value['effort'],
     };

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

@@ -151,6 +151,12 @@ export interface AdminConceptDiagramDetail {
      * @memberof AdminConceptDiagramDetail
      */
     revisesDiagramId: string | null;
+    /**
+     * The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
+     * @type {string}
+     * @memberof AdminConceptDiagramDetail
+     */
+    revisionInstructions: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/AdminConceptDiagramDetail.js

@@ -78,6 +78,8 @@ export function instanceOfAdminConceptDiagramDetail(value) {
         return false;
     if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('effort' in value) || value['effort'] === undefined)
@@ -126,6 +128,7 @@ export function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesDiagramId': json['revisesDiagramId'],
+        'revisionInstructions': json['revisionInstructions'],
         'title': json['title'],
         'effort': json['effort'],
         'brief': json['brief'],
@@ -166,6 +169,7 @@ export function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesDiagramId': value['revisesDiagramId'],
+        'revisionInstructions': value['revisionInstructions'],
         'title': value['title'],
         'effort': value['effort'],
         'brief': value['brief'],

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

@@ -149,6 +149,12 @@ export interface AdminConceptImage {
      * @memberof AdminConceptImage
      */
     revisesImageId: string | null;
+    /**
+     * The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
+     * @type {string}
+     * @memberof AdminConceptImage
+     */
+    revisionInstructions: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/AdminConceptImage.js

@@ -76,6 +76,8 @@ export function instanceOfAdminConceptImage(value) {
         return false;
     if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('quality' in value) || value['quality'] === undefined)
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
@@ -118,6 +120,7 @@ export function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesImageId': json['revisesImageId'],
+        'revisionInstructions': json['revisionInstructions'],
         'quality': json['quality'],
         'mimeType': json['mimeType'],
         'width': json['width'],
@@ -155,6 +158,7 @@ export function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false)
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesImageId': value['revisesImageId'],
+        'revisionInstructions': value['revisionInstructions'],
         'quality': value['quality'],
         'mimeType': value['mimeType'],
         'width': value['width'],

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

@@ -151,6 +151,12 @@ export interface AdminConceptImageDetail {
      * @memberof AdminConceptImageDetail
      */
     revisesImageId: string | null;
+    /**
+     * The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
+     * @type {string}
+     * @memberof AdminConceptImageDetail
+     */
+    revisionInstructions: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/AdminConceptImageDetail.js

@@ -78,6 +78,8 @@ export function instanceOfAdminConceptImageDetail(value) {
         return false;
     if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('quality' in value) || value['quality'] === undefined)
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
@@ -132,6 +134,7 @@ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator)
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesImageId': json['revisesImageId'],
+        'revisionInstructions': json['revisionInstructions'],
         'quality': json['quality'],
         'mimeType': json['mimeType'],
         'width': json['width'],
@@ -175,6 +178,7 @@ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator =
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesImageId': value['revisesImageId'],
+        'revisionInstructions': value['revisionInstructions'],
         'quality': value['quality'],
         'mimeType': value['mimeType'],
         'width': value['width'],

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

@@ -29,7 +29,7 @@ export interface AdminConceptMediaJob {
      */
     kind: AdminConceptMediaJobKindEnum;
     /**
-     *
+     * generate: a new draft. regenerate: a revision from a rewritten prompt or brief. revise: a revision edited from the source row with only the requested changes applied.
      * @type {string}
      * @memberof AdminConceptMediaJob
      */
@@ -47,13 +47,13 @@ export interface 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.
+     * 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 or revise, which files under the revised row's concept.
      * @type {string}
      * @memberof AdminConceptMediaJob
      */
     conceptResolution: AdminConceptMediaJobConceptResolutionEnum | null;
     /**
-     * For a regenerate, the image or diagram being revised
+     * For a regenerate or revise, the image or diagram being revised
      * @type {string}
      * @memberof AdminConceptMediaJob
      */
@@ -109,6 +109,7 @@ export type AdminConceptMediaJobKindEnum = typeof AdminConceptMediaJobKindEnum[k
 export declare const AdminConceptMediaJobOperationEnum: {
     readonly Generate: "generate";
     readonly Regenerate: "regenerate";
+    readonly Revise: "revise";
 };
 export type AdminConceptMediaJobOperationEnum = typeof AdminConceptMediaJobOperationEnum[keyof typeof AdminConceptMediaJobOperationEnum];
 /**

package/dist/esm/models/AdminConceptMediaJob.js

@@ -24,7 +24,8 @@ export const AdminConceptMediaJobKindEnum = {
  */
 export const AdminConceptMediaJobOperationEnum = {
     Generate: 'generate',
-    Regenerate: 'regenerate'
+    Regenerate: 'regenerate',
+    Revise: 'revise'
 };
 /**
  * @export

package/dist/esm/models/AdminReviseConceptDiagramRequest.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 AdminReviseConceptDiagramRequest
+ */
+export interface AdminReviseConceptDiagramRequest {
+    /**
+     * Only what should change, in plain words. The new diagram is made from the revised diagram itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
+     * @type {string}
+     * @memberof AdminReviseConceptDiagramRequest
+     */
+    instructions: string;
+    /**
+     * Title for the new revision. Defaults to the original's.
+     * @type {string}
+     * @memberof AdminReviseConceptDiagramRequest
+     */
+    title?: string;
+    /**
+     * Description for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
+     * @type {string}
+     * @memberof AdminReviseConceptDiagramRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminReviseConceptDiagramRequest interface.
+ */
+export declare function instanceOfAdminReviseConceptDiagramRequest(value: object): value is AdminReviseConceptDiagramRequest;
+export declare function AdminReviseConceptDiagramRequestFromJSON(json: any): AdminReviseConceptDiagramRequest;
+export declare function AdminReviseConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptDiagramRequest;
+export declare function AdminReviseConceptDiagramRequestToJSON(json: any): AdminReviseConceptDiagramRequest;
+export declare function AdminReviseConceptDiagramRequestToJSONTyped(value?: AdminReviseConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminReviseConceptDiagramRequest.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 AdminReviseConceptDiagramRequest interface.
+ */
+export function instanceOfAdminReviseConceptDiagramRequest(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+export function AdminReviseConceptDiagramRequestFromJSON(json) {
+    return AdminReviseConceptDiagramRequestFromJSONTyped(json, false);
+}
+export function AdminReviseConceptDiagramRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminReviseConceptDiagramRequestToJSON(json) {
+    return AdminReviseConceptDiagramRequestToJSONTyped(json, false);
+}
+export function AdminReviseConceptDiagramRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+        'title': value['title'],
+        'description': value['description'],
+    };
+}

package/dist/esm/models/AdminReviseConceptImageRequest.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 AdminReviseConceptImageRequest
+ */
+export interface AdminReviseConceptImageRequest {
+    /**
+     * Only what should change, in plain words. The new image is made from the revised image itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
+     * @type {string}
+     * @memberof AdminReviseConceptImageRequest
+     */
+    instructions: string;
+    /**
+     * Alt text for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
+     * @type {string}
+     * @memberof AdminReviseConceptImageRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminReviseConceptImageRequest interface.
+ */
+export declare function instanceOfAdminReviseConceptImageRequest(value: object): value is AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestFromJSON(json: any): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestToJSON(json: any): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestToJSONTyped(value?: AdminReviseConceptImageRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminReviseConceptImageRequest.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 AdminReviseConceptImageRequest interface.
+ */
+export function instanceOfAdminReviseConceptImageRequest(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+export function AdminReviseConceptImageRequestFromJSON(json) {
+    return AdminReviseConceptImageRequestFromJSONTyped(json, false);
+}
+export function AdminReviseConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function AdminReviseConceptImageRequestToJSON(json) {
+    return AdminReviseConceptImageRequestToJSONTyped(json, false);
+}
+export function AdminReviseConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+        'description': value['description'],
+    };
+}

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

@@ -151,6 +151,12 @@ export interface AdminShownConceptDiagram {
      * @memberof AdminShownConceptDiagram
      */
     revisesDiagramId: string | null;
+    /**
+     * The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
+     * @type {string}
+     * @memberof AdminShownConceptDiagram
+     */
+    revisionInstructions: string | null;
     /**
      *
      * @type {string}