@instructure/athena-api-client 3.42.0 → 3.42.1

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

@@ -0,0 +1,74 @@
+/**
+ * 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 ConceptDiagramDetail
+ */
+export interface ConceptDiagramDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    conceptName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    description: string;
+    /**
+     * The chat the diagram was authored in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptDiagramDetail
+     */
+    createdAt: Date;
+    /**
+     * The complete assembled HTML document, to render in a sandboxed iframe
+     * @type {string}
+     * @memberof ConceptDiagramDetail
+     */
+    document: string;
+}
+/**
+ * Check if a given object implements the ConceptDiagramDetail interface.
+ */
+export declare function instanceOfConceptDiagramDetail(value: object): value is ConceptDiagramDetail;
+export declare function ConceptDiagramDetailFromJSON(json: any): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailToJSON(json: any): ConceptDiagramDetail;
+export declare function ConceptDiagramDetailToJSONTyped(value?: ConceptDiagramDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptDiagramDetail.js

@@ -0,0 +1,71 @@
+/* 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 ConceptDiagramDetail interface.
+ */
+export function instanceOfConceptDiagramDetail(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('document' in value) || value['document'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptDiagramDetailFromJSON(json) {
+    return ConceptDiagramDetailFromJSONTyped(json, false);
+}
+export function ConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'title': json['title'],
+        'description': json['description'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'document': json['document'],
+    };
+}
+export function ConceptDiagramDetailToJSON(json) {
+    return ConceptDiagramDetailToJSONTyped(json, false);
+}
+export function ConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'title': value['title'],
+        'description': value['description'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'document': value['document'],
+    };
+}

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

@@ -0,0 +1,68 @@
+/**
+ * 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 ConceptDiagramGalleryItem
+ */
+export interface ConceptDiagramGalleryItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    conceptName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    description: string;
+    /**
+     * The chat the diagram was authored in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptDiagramGalleryItem
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the ConceptDiagramGalleryItem interface.
+ */
+export declare function instanceOfConceptDiagramGalleryItem(value: object): value is ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemFromJSON(json: any): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemToJSON(json: any): ConceptDiagramGalleryItem;
+export declare function ConceptDiagramGalleryItemToJSONTyped(value?: ConceptDiagramGalleryItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptDiagramGalleryItem.js

@@ -0,0 +1,67 @@
+/* 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 ConceptDiagramGalleryItem interface.
+ */
+export function instanceOfConceptDiagramGalleryItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptDiagramGalleryItemFromJSON(json) {
+    return ConceptDiagramGalleryItemFromJSONTyped(json, false);
+}
+export function ConceptDiagramGalleryItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'title': json['title'],
+        'description': json['description'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function ConceptDiagramGalleryItemToJSON(json) {
+    return ConceptDiagramGalleryItemToJSONTyped(json, false);
+}
+export function ConceptDiagramGalleryItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'title': value['title'],
+        'description': value['description'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,86 @@
+/**
+ * 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 ConceptImageGalleryItem
+ */
+export interface ConceptImageGalleryItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    conceptName: string;
+    /**
+     * Alt text for the image
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConceptImageGalleryItem
+     */
+    width: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConceptImageGalleryItem
+     */
+    height: number;
+    /**
+     * Short-lived signed read URL. Null when the URL could not be signed.
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    url: string | null;
+    /**
+     * The chat the image was generated in. Null once that chat is deleted.
+     * @type {string}
+     * @memberof ConceptImageGalleryItem
+     */
+    sourceChatId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ConceptImageGalleryItem
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the ConceptImageGalleryItem interface.
+ */
+export declare function instanceOfConceptImageGalleryItem(value: object): value is ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemFromJSON(json: any): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemToJSON(json: any): ConceptImageGalleryItem;
+export declare function ConceptImageGalleryItemToJSONTyped(value?: ConceptImageGalleryItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptImageGalleryItem.js

@@ -0,0 +1,79 @@
+/* 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 ConceptImageGalleryItem interface.
+ */
+export function instanceOfConceptImageGalleryItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('conceptName' in value) || value['conceptName'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('width' in value) || value['width'] === undefined)
+        return false;
+    if (!('height' in value) || value['height'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('sourceChatId' in value) || value['sourceChatId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptImageGalleryItemFromJSON(json) {
+    return ConceptImageGalleryItemFromJSONTyped(json, false);
+}
+export function ConceptImageGalleryItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'conceptName': json['conceptName'],
+        'description': json['description'],
+        'mimeType': json['mimeType'],
+        'width': json['width'],
+        'height': json['height'],
+        'url': json['url'],
+        'sourceChatId': json['sourceChatId'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function ConceptImageGalleryItemToJSON(json) {
+    return ConceptImageGalleryItemToJSONTyped(json, false);
+}
+export function ConceptImageGalleryItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'conceptName': value['conceptName'],
+        'description': value['description'],
+        'mimeType': value['mimeType'],
+        'width': value['width'],
+        'height': value['height'],
+        'url': value['url'],
+        'sourceChatId': value['sourceChatId'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { ConceptDiagramGalleryItem } from './ConceptDiagramGalleryItem';
+/**
+ *
+ * @export
+ * @interface PaginatedConceptDiagrams
+ */
+export interface PaginatedConceptDiagrams {
+    /**
+     *
+     * @type {Array<ConceptDiagramGalleryItem>}
+     * @memberof PaginatedConceptDiagrams
+     */
+    data: Array<ConceptDiagramGalleryItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedConceptDiagrams
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedConceptDiagrams interface.
+ */
+export declare function instanceOfPaginatedConceptDiagrams(value: object): value is PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsFromJSON(json: any): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsToJSON(json: any): PaginatedConceptDiagrams;
+export declare function PaginatedConceptDiagramsToJSONTyped(value?: PaginatedConceptDiagrams | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedConceptDiagrams.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+import { ConceptDiagramGalleryItemFromJSON, ConceptDiagramGalleryItemToJSON, } from './ConceptDiagramGalleryItem';
+/**
+ * Check if a given object implements the PaginatedConceptDiagrams interface.
+ */
+export function instanceOfPaginatedConceptDiagrams(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedConceptDiagramsFromJSON(json) {
+    return PaginatedConceptDiagramsFromJSONTyped(json, false);
+}
+export function PaginatedConceptDiagramsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ConceptDiagramGalleryItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedConceptDiagramsToJSON(json) {
+    return PaginatedConceptDiagramsToJSONTyped(json, false);
+}
+export function PaginatedConceptDiagramsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ConceptDiagramGalleryItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { ConceptImageGalleryItem } from './ConceptImageGalleryItem';
+/**
+ *
+ * @export
+ * @interface PaginatedConceptImages
+ */
+export interface PaginatedConceptImages {
+    /**
+     *
+     * @type {Array<ConceptImageGalleryItem>}
+     * @memberof PaginatedConceptImages
+     */
+    data: Array<ConceptImageGalleryItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedConceptImages
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedConceptImages interface.
+ */
+export declare function instanceOfPaginatedConceptImages(value: object): value is PaginatedConceptImages;
+export declare function PaginatedConceptImagesFromJSON(json: any): PaginatedConceptImages;
+export declare function PaginatedConceptImagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedConceptImages;
+export declare function PaginatedConceptImagesToJSON(json: any): PaginatedConceptImages;
+export declare function PaginatedConceptImagesToJSONTyped(value?: PaginatedConceptImages | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedConceptImages.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+import { ConceptImageGalleryItemFromJSON, ConceptImageGalleryItemToJSON, } from './ConceptImageGalleryItem';
+/**
+ * Check if a given object implements the PaginatedConceptImages interface.
+ */
+export function instanceOfPaginatedConceptImages(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedConceptImagesFromJSON(json) {
+    return PaginatedConceptImagesFromJSONTyped(json, false);
+}
+export function PaginatedConceptImagesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ConceptImageGalleryItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedConceptImagesToJSON(json) {
+    return PaginatedConceptImagesToJSONTyped(json, false);
+}
+export function PaginatedConceptImagesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ConceptImageGalleryItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -73,6 +73,9 @@ export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
+export * from './ConceptDiagramDetail';
+export * from './ConceptDiagramGalleryItem';
+export * from './ConceptImageGalleryItem';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -109,6 +112,8 @@ export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ObjectiveResource';
 export * from './PaginatedChats';
+export * from './PaginatedConceptDiagrams';
+export * from './PaginatedConceptImages';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './PaginatedObjectiveResources';

package/dist/esm/models/index.js

@@ -75,6 +75,9 @@ export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';
+export * from './ConceptDiagramDetail';
+export * from './ConceptDiagramGalleryItem';
+export * from './ConceptImageGalleryItem';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -111,6 +114,8 @@ export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ObjectiveResource';
 export * from './PaginatedChats';
+export * from './PaginatedConceptDiagrams';
+export * from './PaginatedConceptImages';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './PaginatedObjectiveResources';