@instructure/athena-api-client 4.4.4 → 4.5.0

package/README.md

@@ -99,6 +99,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminSearchConcepts**](docs/AdminApi.md#adminsearchconcepts) | **GET** /api/v1/admin/concepts | Search the global concepts by name
 *AdminApi* | [**adminShowConceptDiagram**](docs/AdminApi.md#adminshowconceptdiagram) | **POST** /api/v1/admin/concept-diagrams/{diagramId}/show | Show a hidden concept diagram to learners
 *AdminApi* | [**adminShowConceptImage**](docs/AdminApi.md#adminshowconceptimage) | **POST** /api/v1/admin/concept-images/{imageId}/show | Show a hidden concept image to learners
+*AdminApi* | [**adminSuggestConceptMediaPrompt**](docs/AdminApi.md#adminsuggestconceptmediapromptoperation) | **POST** /api/v1/admin/concepts/{id}/media-prompt | Suggest instructions for generating a concept\'s media
 *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat
 *AdminApi* | [**adminUpdateChat**](docs/AdminApi.md#adminupdatechatoperation) | **PATCH** /api/v1/admin/chats/{chatId} | Update a chat (admin)
 *CanvasCourseAccessApi* | [**getCanvasCourseAccess**](docs/CanvasCourseAccessApi.md#getcanvascourseaccess) | **GET** /api/v1/canvas/course-access | Read the Canvas course-access map Athena is enforcing
@@ -256,6 +257,7 @@ All URIs are relative to *http://localhost:3000*
 - [AdminConceptMediaConcept](docs/AdminConceptMediaConcept.md)
 - [AdminConceptMediaHistoryEntry](docs/AdminConceptMediaHistoryEntry.md)
 - [AdminConceptMediaJob](docs/AdminConceptMediaJob.md)
+- [AdminConceptMediaPromptSuggestion](docs/AdminConceptMediaPromptSuggestion.md)
 - [AdminConceptMediaRevision](docs/AdminConceptMediaRevision.md)
 - [AdminConceptSearchResult](docs/AdminConceptSearchResult.md)
 - [AdminExchangeChat](docs/AdminExchangeChat.md)
@@ -295,6 +297,7 @@ All URIs are relative to *http://localhost:3000*
 - [AdminStudyObjectiveOriginCounts](docs/AdminStudyObjectiveOriginCounts.md)
 - [AdminStudyObjectiveSummary](docs/AdminStudyObjectiveSummary.md)
 - [AdminStudyObjectiveUserCounts](docs/AdminStudyObjectiveUserCounts.md)
+- [AdminSuggestConceptMediaPromptRequest](docs/AdminSuggestConceptMediaPromptRequest.md)
 - [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md)
 - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
 - [AdminTopConcept](docs/AdminTopConcept.md)

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptMediaJob, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptMediaJob, AdminConceptMediaPromptSuggestion, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminSuggestConceptMediaPromptRequest, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminDeleteConceptDiagramRequest {
     xUserId: string;
     diagramId: string;
@@ -227,6 +227,11 @@ export interface AdminShowConceptImageRequest {
     imageId: string;
     adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
 }
+export interface AdminSuggestConceptMediaPromptOperationRequest {
+    xUserId: string;
+    id: string;
+    adminSuggestConceptMediaPromptRequest: AdminSuggestConceptMediaPromptRequest;
+}
 export interface AdminTriggerChatAnalysisRequest {
     xUserId: string;
     chatId: string;
@@ -640,6 +645,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Show a hidden concept image to learners
      */
     adminShowConceptImage(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptImage>;
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPromptRaw(requestParameters: AdminSuggestConceptMediaPromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaPromptSuggestion>>;
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPrompt(requestParameters: AdminSuggestConceptMediaPromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaPromptSuggestion>;
     /**
      * Trigger re-analysis for a chat
      */

package/dist/apis/AdminApi.js

@@ -1880,6 +1880,52 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPromptRaw(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 adminSuggestConceptMediaPrompt().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adminSuggestConceptMediaPrompt().');
+            }
+            if (requestParameters['adminSuggestConceptMediaPromptRequest'] == null) {
+                throw new runtime.RequiredError('adminSuggestConceptMediaPromptRequest', 'Required parameter "adminSuggestConceptMediaPromptRequest" was null or undefined when calling adminSuggestConceptMediaPrompt().');
+            }
+            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/concepts/{id}/media-prompt`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.AdminSuggestConceptMediaPromptRequestToJSON)(requestParameters['adminSuggestConceptMediaPromptRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminConceptMediaPromptSuggestionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPrompt(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminSuggestConceptMediaPromptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Trigger re-analysis for a chat
      */

package/dist/esm/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptMediaJob, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminConceptDiagramDetail, AdminConceptImageDetail, AdminConceptMediaJob, AdminConceptMediaPromptSuggestion, AdminConceptSearchResult, AdminGenerateConceptDiagramRequest, AdminGenerateConceptImageRequest, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedConceptDiagrams, AdminPaginatedConceptImages, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminRegenerateConceptDiagramRequest, AdminRegenerateConceptImageRequest, AdminResetLearningDataResponse, AdminReviseConceptDiagramRequest, AdminReviseConceptImageRequest, AdminShowConceptMediaRequest, AdminShownConceptDiagram, AdminShownConceptImage, AdminStreak, AdminStudyObjectiveSummary, AdminSuggestConceptMediaPromptRequest, AdminTopConcept, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminDeleteConceptDiagramRequest {
     xUserId: string;
     diagramId: string;
@@ -227,6 +227,11 @@ export interface AdminShowConceptImageRequest {
     imageId: string;
     adminShowConceptMediaRequest?: AdminShowConceptMediaRequest;
 }
+export interface AdminSuggestConceptMediaPromptOperationRequest {
+    xUserId: string;
+    id: string;
+    adminSuggestConceptMediaPromptRequest: AdminSuggestConceptMediaPromptRequest;
+}
 export interface AdminTriggerChatAnalysisRequest {
     xUserId: string;
     chatId: string;
@@ -640,6 +645,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Show a hidden concept image to learners
      */
     adminShowConceptImage(requestParameters: AdminShowConceptImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminShownConceptImage>;
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPromptRaw(requestParameters: AdminSuggestConceptMediaPromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConceptMediaPromptSuggestion>>;
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPrompt(requestParameters: AdminSuggestConceptMediaPromptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConceptMediaPromptSuggestion>;
     /**
      * Trigger re-analysis for a chat
      */

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, AdminReviseConceptDiagramRequestToJSON, AdminReviseConceptImageRequestToJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTopConceptFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminConceptDiagramDetailFromJSON, AdminConceptImageDetailFromJSON, AdminConceptMediaJobFromJSON, AdminConceptMediaPromptSuggestionFromJSON, AdminConceptSearchResultFromJSON, AdminGenerateConceptDiagramRequestToJSON, AdminGenerateConceptImageRequestToJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedConceptDiagramsFromJSON, AdminPaginatedConceptImagesFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminRegenerateConceptDiagramRequestToJSON, AdminRegenerateConceptImageRequestToJSON, AdminResetLearningDataResponseFromJSON, AdminReviseConceptDiagramRequestToJSON, AdminReviseConceptImageRequestToJSON, AdminShowConceptMediaRequestToJSON, AdminShownConceptDiagramFromJSON, AdminShownConceptImageFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminSuggestConceptMediaPromptRequestToJSON, AdminTopConceptFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -1877,6 +1877,52 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPromptRaw(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 adminSuggestConceptMediaPrompt().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adminSuggestConceptMediaPrompt().');
+            }
+            if (requestParameters['adminSuggestConceptMediaPromptRequest'] == null) {
+                throw new runtime.RequiredError('adminSuggestConceptMediaPromptRequest', 'Required parameter "adminSuggestConceptMediaPromptRequest" was null or undefined when calling adminSuggestConceptMediaPrompt().');
+            }
+            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/concepts/{id}/media-prompt`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AdminSuggestConceptMediaPromptRequestToJSON(requestParameters['adminSuggestConceptMediaPromptRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminConceptMediaPromptSuggestionFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Asks a model to write instructions for a new image or interactive diagram of the concept, from its name and description, in the shape the generate endpoints take. Nothing is stored or generated: the admin reviews and edits the text before starting a generate with it.
+     * Suggest instructions for generating a concept\'s media
+     */
+    adminSuggestConceptMediaPrompt(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminSuggestConceptMediaPromptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Trigger re-analysis for a chat
      */

package/dist/esm/models/AdminConceptMediaPromptSuggestion.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 AdminConceptMediaPromptSuggestion
+ */
+export interface AdminConceptMediaPromptSuggestion {
+    /**
+     * Suggested instructions for generating the media, for the admin to review and edit before generating
+     * @type {string}
+     * @memberof AdminConceptMediaPromptSuggestion
+     */
+    instructions: string;
+    /**
+     * Suggested alt text for the media the instructions describe. Empty when the model wrote none. It describes the intended media, not the generated result, so the admin should check it against what comes back
+     * @type {string}
+     * @memberof AdminConceptMediaPromptSuggestion
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the AdminConceptMediaPromptSuggestion interface.
+ */
+export declare function instanceOfAdminConceptMediaPromptSuggestion(value: object): value is AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionFromJSON(json: any): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionToJSON(json: any): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionToJSONTyped(value?: AdminConceptMediaPromptSuggestion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminConceptMediaPromptSuggestion.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 AdminConceptMediaPromptSuggestion interface.
+ */
+export function instanceOfAdminConceptMediaPromptSuggestion(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+export function AdminConceptMediaPromptSuggestionFromJSON(json) {
+    return AdminConceptMediaPromptSuggestionFromJSONTyped(json, false);
+}
+export function AdminConceptMediaPromptSuggestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+        'description': json['description'],
+    };
+}
+export function AdminConceptMediaPromptSuggestionToJSON(json) {
+    return AdminConceptMediaPromptSuggestionToJSONTyped(json, false);
+}
+export function AdminConceptMediaPromptSuggestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 AdminSuggestConceptMediaPromptRequest
+ */
+export interface AdminSuggestConceptMediaPromptRequest {
+    /**
+     * The kind of media the instructions are for: a static image or an interactive diagram.
+     * @type {string}
+     * @memberof AdminSuggestConceptMediaPromptRequest
+     */
+    kind: AdminSuggestConceptMediaPromptRequestKindEnum;
+}
+/**
+ * @export
+ */
+export declare const AdminSuggestConceptMediaPromptRequestKindEnum: {
+    readonly Image: "image";
+    readonly Diagram: "diagram";
+};
+export type AdminSuggestConceptMediaPromptRequestKindEnum = typeof AdminSuggestConceptMediaPromptRequestKindEnum[keyof typeof AdminSuggestConceptMediaPromptRequestKindEnum];
+/**
+ * Check if a given object implements the AdminSuggestConceptMediaPromptRequest interface.
+ */
+export declare function instanceOfAdminSuggestConceptMediaPromptRequest(value: object): value is AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestFromJSON(json: any): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestToJSON(json: any): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestToJSONTyped(value?: AdminSuggestConceptMediaPromptRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminSuggestConceptMediaPromptRequest.js

@@ -0,0 +1,50 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AdminSuggestConceptMediaPromptRequestKindEnum = {
+    Image: 'image',
+    Diagram: 'diagram'
+};
+/**
+ * Check if a given object implements the AdminSuggestConceptMediaPromptRequest interface.
+ */
+export function instanceOfAdminSuggestConceptMediaPromptRequest(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    return true;
+}
+export function AdminSuggestConceptMediaPromptRequestFromJSON(json) {
+    return AdminSuggestConceptMediaPromptRequestFromJSONTyped(json, false);
+}
+export function AdminSuggestConceptMediaPromptRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'kind': json['kind'],
+    };
+}
+export function AdminSuggestConceptMediaPromptRequestToJSON(json) {
+    return AdminSuggestConceptMediaPromptRequestToJSONTyped(json, false);
+}
+export function AdminSuggestConceptMediaPromptRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'kind': value['kind'],
+    };
+}

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

@@ -25,6 +25,7 @@ export * from './AdminConceptMediaActor';
 export * from './AdminConceptMediaConcept';
 export * from './AdminConceptMediaHistoryEntry';
 export * from './AdminConceptMediaJob';
+export * from './AdminConceptMediaPromptSuggestion';
 export * from './AdminConceptMediaRevision';
 export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
@@ -64,6 +65,7 @@ export * from './AdminStudyObjectiveListItem';
 export * from './AdminStudyObjectiveOriginCounts';
 export * from './AdminStudyObjectiveSummary';
 export * from './AdminStudyObjectiveUserCounts';
+export * from './AdminSuggestConceptMediaPromptRequest';
 export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTopConcept';

package/dist/esm/models/index.js

@@ -27,6 +27,7 @@ export * from './AdminConceptMediaActor';
 export * from './AdminConceptMediaConcept';
 export * from './AdminConceptMediaHistoryEntry';
 export * from './AdminConceptMediaJob';
+export * from './AdminConceptMediaPromptSuggestion';
 export * from './AdminConceptMediaRevision';
 export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
@@ -66,6 +67,7 @@ export * from './AdminStudyObjectiveListItem';
 export * from './AdminStudyObjectiveOriginCounts';
 export * from './AdminStudyObjectiveSummary';
 export * from './AdminStudyObjectiveUserCounts';
+export * from './AdminSuggestConceptMediaPromptRequest';
 export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTopConcept';

package/dist/models/AdminConceptMediaPromptSuggestion.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 AdminConceptMediaPromptSuggestion
+ */
+export interface AdminConceptMediaPromptSuggestion {
+    /**
+     * Suggested instructions for generating the media, for the admin to review and edit before generating
+     * @type {string}
+     * @memberof AdminConceptMediaPromptSuggestion
+     */
+    instructions: string;
+    /**
+     * Suggested alt text for the media the instructions describe. Empty when the model wrote none. It describes the intended media, not the generated result, so the admin should check it against what comes back
+     * @type {string}
+     * @memberof AdminConceptMediaPromptSuggestion
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the AdminConceptMediaPromptSuggestion interface.
+ */
+export declare function instanceOfAdminConceptMediaPromptSuggestion(value: object): value is AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionFromJSON(json: any): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionToJSON(json: any): AdminConceptMediaPromptSuggestion;
+export declare function AdminConceptMediaPromptSuggestionToJSONTyped(value?: AdminConceptMediaPromptSuggestion | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminConceptMediaPromptSuggestion.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAdminConceptMediaPromptSuggestion = instanceOfAdminConceptMediaPromptSuggestion;
+exports.AdminConceptMediaPromptSuggestionFromJSON = AdminConceptMediaPromptSuggestionFromJSON;
+exports.AdminConceptMediaPromptSuggestionFromJSONTyped = AdminConceptMediaPromptSuggestionFromJSONTyped;
+exports.AdminConceptMediaPromptSuggestionToJSON = AdminConceptMediaPromptSuggestionToJSON;
+exports.AdminConceptMediaPromptSuggestionToJSONTyped = AdminConceptMediaPromptSuggestionToJSONTyped;
+/**
+ * Check if a given object implements the AdminConceptMediaPromptSuggestion interface.
+ */
+function instanceOfAdminConceptMediaPromptSuggestion(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+function AdminConceptMediaPromptSuggestionFromJSON(json) {
+    return AdminConceptMediaPromptSuggestionFromJSONTyped(json, false);
+}
+function AdminConceptMediaPromptSuggestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+        'description': json['description'],
+    };
+}
+function AdminConceptMediaPromptSuggestionToJSON(json) {
+    return AdminConceptMediaPromptSuggestionToJSONTyped(json, false);
+}
+function AdminConceptMediaPromptSuggestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+        'description': value['description'],
+    };
+}

package/dist/models/AdminSuggestConceptMediaPromptRequest.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 AdminSuggestConceptMediaPromptRequest
+ */
+export interface AdminSuggestConceptMediaPromptRequest {
+    /**
+     * The kind of media the instructions are for: a static image or an interactive diagram.
+     * @type {string}
+     * @memberof AdminSuggestConceptMediaPromptRequest
+     */
+    kind: AdminSuggestConceptMediaPromptRequestKindEnum;
+}
+/**
+ * @export
+ */
+export declare const AdminSuggestConceptMediaPromptRequestKindEnum: {
+    readonly Image: "image";
+    readonly Diagram: "diagram";
+};
+export type AdminSuggestConceptMediaPromptRequestKindEnum = typeof AdminSuggestConceptMediaPromptRequestKindEnum[keyof typeof AdminSuggestConceptMediaPromptRequestKindEnum];
+/**
+ * Check if a given object implements the AdminSuggestConceptMediaPromptRequest interface.
+ */
+export declare function instanceOfAdminSuggestConceptMediaPromptRequest(value: object): value is AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestFromJSON(json: any): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestToJSON(json: any): AdminSuggestConceptMediaPromptRequest;
+export declare function AdminSuggestConceptMediaPromptRequestToJSONTyped(value?: AdminSuggestConceptMediaPromptRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminSuggestConceptMediaPromptRequest.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminSuggestConceptMediaPromptRequestKindEnum = void 0;
+exports.instanceOfAdminSuggestConceptMediaPromptRequest = instanceOfAdminSuggestConceptMediaPromptRequest;
+exports.AdminSuggestConceptMediaPromptRequestFromJSON = AdminSuggestConceptMediaPromptRequestFromJSON;
+exports.AdminSuggestConceptMediaPromptRequestFromJSONTyped = AdminSuggestConceptMediaPromptRequestFromJSONTyped;
+exports.AdminSuggestConceptMediaPromptRequestToJSON = AdminSuggestConceptMediaPromptRequestToJSON;
+exports.AdminSuggestConceptMediaPromptRequestToJSONTyped = AdminSuggestConceptMediaPromptRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.AdminSuggestConceptMediaPromptRequestKindEnum = {
+    Image: 'image',
+    Diagram: 'diagram'
+};
+/**
+ * Check if a given object implements the AdminSuggestConceptMediaPromptRequest interface.
+ */
+function instanceOfAdminSuggestConceptMediaPromptRequest(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    return true;
+}
+function AdminSuggestConceptMediaPromptRequestFromJSON(json) {
+    return AdminSuggestConceptMediaPromptRequestFromJSONTyped(json, false);
+}
+function AdminSuggestConceptMediaPromptRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'kind': json['kind'],
+    };
+}
+function AdminSuggestConceptMediaPromptRequestToJSON(json) {
+    return AdminSuggestConceptMediaPromptRequestToJSONTyped(json, false);
+}
+function AdminSuggestConceptMediaPromptRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'kind': value['kind'],
+    };
+}

package/dist/models/index.d.ts

@@ -25,6 +25,7 @@ export * from './AdminConceptMediaActor';
 export * from './AdminConceptMediaConcept';
 export * from './AdminConceptMediaHistoryEntry';
 export * from './AdminConceptMediaJob';
+export * from './AdminConceptMediaPromptSuggestion';
 export * from './AdminConceptMediaRevision';
 export * from './AdminConceptSearchResult';
 export * from './AdminExchangeChat';
@@ -64,6 +65,7 @@ export * from './AdminStudyObjectiveListItem';
 export * from './AdminStudyObjectiveOriginCounts';
 export * from './AdminStudyObjectiveSummary';
 export * from './AdminStudyObjectiveUserCounts';
+export * from './AdminSuggestConceptMediaPromptRequest';
 export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTopConcept';

package/dist/models/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./AdminConceptMediaActor"), exports);
 __exportStar(require("./AdminConceptMediaConcept"), exports);
 __exportStar(require("./AdminConceptMediaHistoryEntry"), exports);
 __exportStar(require("./AdminConceptMediaJob"), exports);
+__exportStar(require("./AdminConceptMediaPromptSuggestion"), exports);
 __exportStar(require("./AdminConceptMediaRevision"), exports);
 __exportStar(require("./AdminConceptSearchResult"), exports);
 __exportStar(require("./AdminExchangeChat"), exports);
@@ -82,6 +83,7 @@ __exportStar(require("./AdminStudyObjectiveListItem"), exports);
 __exportStar(require("./AdminStudyObjectiveOriginCounts"), exports);
 __exportStar(require("./AdminStudyObjectiveSummary"), exports);
 __exportStar(require("./AdminStudyObjectiveUserCounts"), exports);
+__exportStar(require("./AdminSuggestConceptMediaPromptRequest"), exports);
 __exportStar(require("./AdminTaxonomyEnrollment"), exports);
 __exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
 __exportStar(require("./AdminTopConcept"), exports);

package/package.json

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