@instructure/athena-api-client 4.2.0 → 4.3.0

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

package/dist/models/AdminReviseConceptImageRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AdminReviseConceptImageRequest
+ */
+export interface AdminReviseConceptImageRequest {
+    /**
+     * Only what should change, in plain words. The new image is made from the revised image itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
+     * @type {string}
+     * @memberof AdminReviseConceptImageRequest
+     */
+    instructions: string;
+    /**
+     * Alt text for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
+     * @type {string}
+     * @memberof AdminReviseConceptImageRequest
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the AdminReviseConceptImageRequest interface.
+ */
+export declare function instanceOfAdminReviseConceptImageRequest(value: object): value is AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestFromJSON(json: any): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestToJSON(json: any): AdminReviseConceptImageRequest;
+export declare function AdminReviseConceptImageRequestToJSONTyped(value?: AdminReviseConceptImageRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminReviseConceptImageRequest.js

@@ -0,0 +1,52 @@
+"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.instanceOfAdminReviseConceptImageRequest = instanceOfAdminReviseConceptImageRequest;
+exports.AdminReviseConceptImageRequestFromJSON = AdminReviseConceptImageRequestFromJSON;
+exports.AdminReviseConceptImageRequestFromJSONTyped = AdminReviseConceptImageRequestFromJSONTyped;
+exports.AdminReviseConceptImageRequestToJSON = AdminReviseConceptImageRequestToJSON;
+exports.AdminReviseConceptImageRequestToJSONTyped = AdminReviseConceptImageRequestToJSONTyped;
+/**
+ * Check if a given object implements the AdminReviseConceptImageRequest interface.
+ */
+function instanceOfAdminReviseConceptImageRequest(value) {
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    return true;
+}
+function AdminReviseConceptImageRequestFromJSON(json) {
+    return AdminReviseConceptImageRequestFromJSONTyped(json, false);
+}
+function AdminReviseConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'instructions': json['instructions'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+function AdminReviseConceptImageRequestToJSON(json) {
+    return AdminReviseConceptImageRequestToJSONTyped(json, false);
+}
+function AdminReviseConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'instructions': value['instructions'],
+        'description': value['description'],
+    };
+}

package/dist/models/AdminShownConceptDiagram.d.ts

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

package/dist/models/AdminShownConceptDiagram.js

@@ -86,6 +86,8 @@ function instanceOfAdminShownConceptDiagram(value) {
         return false;
     if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('effort' in value) || value['effort'] === undefined)
@@ -138,6 +140,7 @@ function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesDiagramId': json['revisesDiagramId'],
+        'revisionInstructions': json['revisionInstructions'],
         'title': json['title'],
         'effort': json['effort'],
         'brief': json['brief'],
@@ -180,6 +183,7 @@ function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator = false)
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesDiagramId': value['revisesDiagramId'],
+        'revisionInstructions': value['revisionInstructions'],
         'title': value['title'],
         'effort': value['effort'],
         'brief': value['brief'],

package/dist/models/AdminShownConceptImage.d.ts

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

package/dist/models/AdminShownConceptImage.js

@@ -86,6 +86,8 @@ function instanceOfAdminShownConceptImage(value) {
         return false;
     if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
         return false;
+    if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
+        return false;
     if (!('quality' in value) || value['quality'] === undefined)
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
@@ -144,6 +146,7 @@ function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'costUsd': json['costUsd'],
         'description': json['description'],
         'revisesImageId': json['revisesImageId'],
+        'revisionInstructions': json['revisionInstructions'],
         'quality': json['quality'],
         'mimeType': json['mimeType'],
         'width': json['width'],
@@ -189,6 +192,7 @@ function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
         'costUsd': value['costUsd'],
         'description': value['description'],
         'revisesImageId': value['revisesImageId'],
+        'revisionInstructions': value['revisionInstructions'],
         'quality': value['quality'],
         'mimeType': value['mimeType'],
         'width': value['width'],

package/dist/models/index.d.ts

@@ -53,6 +53,8 @@ export * from './AdminQuizSourceMaterial';
 export * from './AdminRegenerateConceptDiagramRequest';
 export * from './AdminRegenerateConceptImageRequest';
 export * from './AdminResetLearningDataResponse';
+export * from './AdminReviseConceptDiagramRequest';
+export * from './AdminReviseConceptImageRequest';
 export * from './AdminShowConceptMediaRequest';
 export * from './AdminShownConceptDiagram';
 export * from './AdminShownConceptImage';

package/dist/models/index.js

@@ -71,6 +71,8 @@ __exportStar(require("./AdminQuizSourceMaterial"), exports);
 __exportStar(require("./AdminRegenerateConceptDiagramRequest"), exports);
 __exportStar(require("./AdminRegenerateConceptImageRequest"), exports);
 __exportStar(require("./AdminResetLearningDataResponse"), exports);
+__exportStar(require("./AdminReviseConceptDiagramRequest"), exports);
+__exportStar(require("./AdminReviseConceptImageRequest"), exports);
 __exportStar(require("./AdminShowConceptMediaRequest"), exports);
 __exportStar(require("./AdminShownConceptDiagram"), exports);
 __exportStar(require("./AdminShownConceptImage"), exports);

package/package.json

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