@instructure/athena-api-client 3.47.0 → 4.0.1

package/dist/apis/AdminApi.js

@@ -112,8 +112,8 @@ 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* () {
@@ -140,12 +140,12 @@ class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: (0, index_1.AdminGenerateConceptDiagramRequestToJSON)(requestParameters['adminGenerateConceptDiagramRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminGeneratedConceptDiagramFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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* () {
@@ -154,8 +154,8 @@ 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* () {
@@ -182,12 +182,12 @@ class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: (0, index_1.AdminGenerateConceptImageRequestToJSON)(requestParameters['adminGenerateConceptImageRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminGeneratedConceptImageFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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* () {
@@ -441,6 +441,47 @@ 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) => (0, index_1.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
@@ -682,7 +723,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Keeps the diagram out of every learner read. Idempotent: an already hidden diagram keeps its original hide time and actor. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Keeps the diagram out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: a diagram an admin already hid keeps its original hide time and actor. A diagram hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
      * Hide a concept diagram from learners
      */
     adminHideConceptDiagramRaw(requestParameters, initOverrides) {
@@ -713,7 +754,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Keeps the diagram out of every learner read. Idempotent: an already hidden diagram keeps its original hide time and actor. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Keeps the diagram out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: a diagram an admin already hid keeps its original hide time and actor. A diagram hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
      * Hide a concept diagram from learners
      */
     adminHideConceptDiagram(requestParameters, initOverrides) {
@@ -723,7 +764,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Keeps the image out of every learner read. Idempotent: an already hidden image keeps its original hide time and actor. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Keeps the image out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: an image an admin already hid keeps its original hide time and actor. An image hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
      * Hide a concept image from learners
      */
     adminHideConceptImageRaw(requestParameters, initOverrides) {
@@ -754,7 +795,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Keeps the image out of every learner read. Idempotent: an already hidden image keeps its original hide time and actor. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Keeps the image out of every learner read and clears any approval (approvedAt), so a later show re-approves it. Idempotent: an image an admin already hid keeps its original hide time and actor. An image hidden by a learner flag becomes an admin hide (hiddenByFlag false, with this call\'s time and actor). Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
      * Hide a concept image from learners
      */
     adminHideConceptImage(requestParameters, initOverrides) {
@@ -1323,8 +1364,8 @@ 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* () {
@@ -1355,12 +1396,12 @@ class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: (0, index_1.AdminRegenerateConceptDiagramRequestToJSON)(requestParameters['adminRegenerateConceptDiagramRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminConceptDiagramDetailFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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* () {
@@ -1369,8 +1410,8 @@ 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* () {
@@ -1401,12 +1442,12 @@ class AdminApi extends runtime.BaseAPI {
                 query: queryParameters,
                 body: (0, index_1.AdminRegenerateConceptImageRequestToJSON)(requestParameters['adminRegenerateConceptImageRequest']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminConceptImageDetailFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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* () {
@@ -1456,7 +1497,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the deletion and leaves the diagram hidden for review; show it to serve it to learners again. A diagram that is not deleted is unchanged.
+     * Clears the deletion and any approval and leaves the diagram hidden for review (a diagram already hidden keeps its hide); show it to serve it to learners again. A diagram that is not deleted is unchanged.
      * Restore a soft-deleted concept diagram
      */
     adminRestoreConceptDiagramRaw(requestParameters, initOverrides) {
@@ -1487,7 +1528,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the deletion and leaves the diagram hidden for review; show it to serve it to learners again. A diagram that is not deleted is unchanged.
+     * Clears the deletion and any approval and leaves the diagram hidden for review (a diagram already hidden keeps its hide); show it to serve it to learners again. A diagram that is not deleted is unchanged.
      * Restore a soft-deleted concept diagram
      */
     adminRestoreConceptDiagram(requestParameters, initOverrides) {
@@ -1497,7 +1538,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the deletion and leaves the image hidden for review; show it to serve it to learners again. A image that is not deleted is unchanged.
+     * Clears the deletion and any approval and leaves the image hidden for review (an image already hidden keeps its hide); show it to serve it to learners again. An image that is not deleted is unchanged.
      * Restore a soft-deleted concept image
      */
     adminRestoreConceptImageRaw(requestParameters, initOverrides) {
@@ -1528,7 +1569,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the deletion and leaves the image hidden for review; show it to serve it to learners again. A image that is not deleted is unchanged.
+     * Clears the deletion and any approval and leaves the image hidden for review (an image already hidden keeps its hide); show it to serve it to learners again. An image that is not deleted is unchanged.
      * Restore a soft-deleted concept image
      */
     adminRestoreConceptImage(requestParameters, initOverrides) {
@@ -1581,7 +1622,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the hide so learners can be served the diagram again. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
+     * Clears the hide so learners can be served the diagram again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved diagram. Showing a visible diagram approves it too. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
      * Show a hidden concept diagram to learners
      */
     adminShowConceptDiagramRaw(requestParameters, initOverrides) {
@@ -1614,7 +1655,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the hide so learners can be served the diagram again. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
+     * Clears the hide so learners can be served the diagram again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved diagram. Showing a visible diagram approves it too. A deleted diagram must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this diagram changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads.
      * Show a hidden concept diagram to learners
      */
     adminShowConceptDiagram(requestParameters, initOverrides) {
@@ -1624,7 +1665,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the hide so learners can be served the image again. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
+     * Clears the hide so learners can be served the image again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved image. Showing a visible image approves it too. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
      * Show a hidden concept image to learners
      */
     adminShowConceptImageRaw(requestParameters, initOverrides) {
@@ -1657,7 +1698,7 @@ class AdminApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Clears the hide so learners can be served the image again. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
+     * Clears the hide so learners can be served the image again, and records the caller\'s approval (approvedAt, approvedBy): a learner flag never hides an approved image. Showing a visible image approves it too. A deleted image must be restored first (409, and nothing changes). The body is optional; without it, or with hideOtherVersions false, only this image changes. With hideOtherVersions true, every other visible version in its revision family (the rows history lists) is hidden in the same transaction, with the caller recorded as hider and their approval cleared; hidden and deleted versions are left as they are. hiddenVersionIds lists what was hidden, and hiddenVersionsTruncated says when the family exceeded the history cap so only the capped set was checked. Learner reads are unaffected beyond the rows hidden, and only for later reads (a signed URL already handed out stays valid until it expires, 12 hours).
      * Show a hidden concept image to learners
      */
     adminShowConceptImage(requestParameters, initOverrides) {
@@ -1758,6 +1799,7 @@ exports.AdminListConceptDiagramsStateEnum = {
     NotDeleted: 'not_deleted',
     Visible: 'visible',
     Hidden: 'hidden',
+    Flagged: 'flagged',
     Deleted: 'deleted',
     All: 'all'
 };
@@ -1775,6 +1817,7 @@ exports.AdminListConceptImagesStateEnum = {
     NotDeleted: 'not_deleted',
     Visible: 'visible',
     Hidden: 'hidden',
+    Flagged: 'flagged',
     Deleted: 'deleted',
     All: 'all'
 };

package/dist/apis/ConceptDiagramsApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ConceptDiagramDetail, PaginatedConceptDiagrams } from '../models/index';
+import type { ConceptDiagramDetail, ConceptMediaFlagResult, PaginatedConceptDiagrams } from '../models/index';
+export interface FlagConceptDiagramRequest {
+    xUserId: string;
+    diagramId: string;
+}
 export interface GetMyConceptDiagramRequest {
     xUserId: string;
     diagramId: string;
@@ -24,6 +28,16 @@ export interface ListMyConceptDiagramsRequest {
  *
  */
 export declare class ConceptDiagramsApi extends runtime.BaseAPI {
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept diagram. A visible diagram that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any diagram id; the calling client is expected to check that the diagram was shown to this learner. Idempotent: a diagram that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved diagram stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Flag a concept diagram so learners stop being shown it
+     */
+    flagConceptDiagramRaw(requestParameters: FlagConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConceptMediaFlagResult>>;
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept diagram. A visible diagram that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any diagram id; the calling client is expected to check that the diagram was shown to this learner. Idempotent: a diagram that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved diagram stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Flag a concept diagram so learners stop being shown it
+     */
+    flagConceptDiagram(requestParameters: FlagConceptDiagramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConceptMediaFlagResult>;
     /**
      * Returns one non-hidden diagram the authenticated user authored, including its assembled HTML document.
      * Get a concept diagram the user authored

package/dist/apis/ConceptDiagramsApi.js

@@ -29,6 +29,47 @@ const index_1 = require("../models/index");
  *
  */
 class ConceptDiagramsApi extends runtime.BaseAPI {
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept diagram. A visible diagram that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any diagram id; the calling client is expected to check that the diagram was shown to this learner. Idempotent: a diagram that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved diagram stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Flag a concept diagram so learners stop being shown it
+     */
+    flagConceptDiagramRaw(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 flagConceptDiagram().');
+            }
+            if (requestParameters['diagramId'] == null) {
+                throw new runtime.RequiredError('diagramId', 'Required parameter "diagramId" was null or undefined when calling flagConceptDiagram().');
+            }
+            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/concept-diagrams/{diagramId}/flag`;
+            urlPath = urlPath.replace(`{${"diagramId"}}`, encodeURIComponent(String(requestParameters['diagramId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ConceptMediaFlagResultFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept diagram. A visible diagram that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any diagram id; the calling client is expected to check that the diagram was shown to this learner. Idempotent: a diagram that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved diagram stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a diagram already rendered in an open chat stays until the chat is reloaded.
+     * Flag a concept diagram so learners stop being shown it
+     */
+    flagConceptDiagram(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.flagConceptDiagramRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns one non-hidden diagram the authenticated user authored, including its assembled HTML document.
      * Get a concept diagram the user authored

package/dist/apis/ConceptImagesApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedConceptImages } from '../models/index';
+import type { ConceptMediaFlagResult, PaginatedConceptImages } from '../models/index';
+export interface FlagConceptImageRequest {
+    xUserId: string;
+    imageId: string;
+}
 export interface ListMyConceptImagesRequest {
     xUserId: string;
     limit?: number;
@@ -20,6 +24,16 @@ export interface ListMyConceptImagesRequest {
  *
  */
 export declare class ConceptImagesApi extends runtime.BaseAPI {
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Flag a concept image so learners stop being shown it
+     */
+    flagConceptImageRaw(requestParameters: FlagConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConceptMediaFlagResult>>;
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Flag a concept image so learners stop being shown it
+     */
+    flagConceptImage(requestParameters: FlagConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConceptMediaFlagResult>;
     /**
      * Returns the non-hidden concept images the authenticated user generated in chat, newest first, each with a freshly signed read URL and the chat it came from. Images generated by other learners are never included, even when this user has been shown them.
      * List the concept images the user generated

package/dist/apis/ConceptImagesApi.js

@@ -29,6 +29,47 @@ const index_1 = require("../models/index");
  *
  */
 class ConceptImagesApi extends runtime.BaseAPI {
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Flag a concept image so learners stop being shown it
+     */
+    flagConceptImageRaw(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 flagConceptImage().');
+            }
+            if (requestParameters['imageId'] == null) {
+                throw new runtime.RequiredError('imageId', 'Required parameter "imageId" was null or undefined when calling flagConceptImage().');
+            }
+            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/concept-images/{imageId}/flag`;
+            urlPath = urlPath.replace(`{${"imageId"}}`, encodeURIComponent(String(requestParameters['imageId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ConceptMediaFlagResultFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Flag a concept image so learners stop being shown it
+     */
+    flagConceptImage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.flagConceptImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns the non-hidden concept images the authenticated user generated in chat, newest first, each with a freshly signed read URL and the chat it came from. Images generated by other learners are never included, even when this user has been shown them.
      * List the concept images the user generated