@instructure/athena-api-client 3.47.0 → 4.0.1

package/dist/esm/apis/ConceptDiagramsApi.js

@@ -21,11 +21,52 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { ConceptDiagramDetailFromJSON, PaginatedConceptDiagramsFromJSON, } from '../models/index';
+import { ConceptDiagramDetailFromJSON, ConceptMediaFlagResultFromJSON, PaginatedConceptDiagramsFromJSON, } from '../models/index';
 /**
  *
  */
 export 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) => 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/esm/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/esm/apis/ConceptImagesApi.js

@@ -21,11 +21,52 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedConceptImagesFromJSON, } from '../models/index';
+import { ConceptMediaFlagResultFromJSON, PaginatedConceptImagesFromJSON, } from '../models/index';
 /**
  *
  */
 export 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) => 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

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

@@ -72,11 +72,29 @@ export interface AdminConceptDiagram {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptDiagram
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptDiagram
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptDiagram
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagram
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptDiagram.js

@@ -52,6 +52,12 @@ export function instanceOfAdminConceptDiagram(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -92,6 +98,9 @@ export function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -122,6 +131,9 @@ export function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = fals
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -74,11 +74,29 @@ export interface AdminConceptDiagramDetail {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptDiagramDetail
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptDiagramDetail
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagramDetail
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptDiagramDetail.js

@@ -54,6 +54,12 @@ export function instanceOfAdminConceptDiagramDetail(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -106,6 +112,9 @@ export function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -142,6 +151,9 @@ export function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -72,11 +72,29 @@ export interface AdminConceptImage {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptImage
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptImage
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImage
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptImage.js

@@ -52,6 +52,12 @@ export function instanceOfAdminConceptImage(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -98,6 +104,9 @@ export function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -131,6 +140,9 @@ export function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false)
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -74,11 +74,29 @@ export interface AdminConceptImageDetail {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptImageDetail
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptImageDetail
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImageDetail
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptImageDetail.js

@@ -54,6 +54,12 @@ export function instanceOfAdminConceptImageDetail(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -112,6 +118,9 @@ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator)
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -151,6 +160,9 @@ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator =
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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;