@instructure/athena-api-client 4.0.1 → 4.1.0

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

@@ -0,0 +1,153 @@
+/**
+ * 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 { StudyGuideFile } from './StudyGuideFile';
+import type { StudyGuideSourceSummary } from './StudyGuideSourceSummary';
+import type { StudyGuideConcept } from './StudyGuideConcept';
+/**
+ *
+ * @export
+ * @interface StudyGuide
+ */
+export interface StudyGuide {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    studySpaceId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    studyObjectiveId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    chatId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    courseId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    canvasObjectRef: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    assessmentTitle: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    learnerContext: string | null;
+    /**
+     * 'generating' while the generator runs (poll); 'ready' with concepts; 'needs-context' when Athena could not tell what the assessment covers (see refusalReason and missingContext, then regenerate with more); 'failed' on an infrastructure error.
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    status: StudyGuideStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    refusalReason: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof StudyGuide
+     */
+    missingContext: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuide
+     */
+    summary: string | null;
+    /**
+     *
+     * @type {StudyGuideSourceSummary}
+     * @memberof StudyGuide
+     */
+    sourceSummary: StudyGuideSourceSummary | null;
+    /**
+     *
+     * @type {Array<StudyGuideConcept>}
+     * @memberof StudyGuide
+     */
+    concepts: Array<StudyGuideConcept>;
+    /**
+     *
+     * @type {Array<StudyGuideFile>}
+     * @memberof StudyGuide
+     */
+    files: Array<StudyGuideFile>;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyGuide
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyGuide
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const StudyGuideStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly NeedsContext: "needs-context";
+    readonly Failed: "failed";
+};
+export type StudyGuideStatusEnum = typeof StudyGuideStatusEnum[keyof typeof StudyGuideStatusEnum];
+/**
+ * Check if a given object implements the StudyGuide interface.
+ */
+export declare function instanceOfStudyGuide(value: object): value is StudyGuide;
+export declare function StudyGuideFromJSON(json: any): StudyGuide;
+export declare function StudyGuideFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuide;
+export declare function StudyGuideToJSON(json: any): StudyGuide;
+export declare function StudyGuideToJSONTyped(value?: StudyGuide | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyGuide.js

@@ -0,0 +1,127 @@
+/* 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 { StudyGuideFileFromJSON, StudyGuideFileToJSON, } from './StudyGuideFile';
+import { StudyGuideSourceSummaryFromJSON, StudyGuideSourceSummaryToJSON, } from './StudyGuideSourceSummary';
+import { StudyGuideConceptFromJSON, StudyGuideConceptToJSON, } from './StudyGuideConcept';
+/**
+ * @export
+ */
+export const StudyGuideStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    NeedsContext: 'needs-context',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the StudyGuide interface.
+ */
+export function instanceOfStudyGuide(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('assessmentTitle' in value) || value['assessmentTitle'] === undefined)
+        return false;
+    if (!('learnerContext' in value) || value['learnerContext'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('refusalReason' in value) || value['refusalReason'] === undefined)
+        return false;
+    if (!('missingContext' in value) || value['missingContext'] === undefined)
+        return false;
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('sourceSummary' in value) || value['sourceSummary'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function StudyGuideFromJSON(json) {
+    return StudyGuideFromJSONTyped(json, false);
+}
+export function StudyGuideFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'studySpaceId': json['studySpaceId'],
+        'studyObjectiveId': json['studyObjectiveId'],
+        'chatId': json['chatId'],
+        'courseId': json['courseId'],
+        'canvasObjectRef': json['canvasObjectRef'],
+        'title': json['title'],
+        'assessmentTitle': json['assessmentTitle'],
+        'learnerContext': json['learnerContext'],
+        'status': json['status'],
+        'refusalReason': json['refusalReason'],
+        'missingContext': json['missingContext'] == null ? null : json['missingContext'],
+        'summary': json['summary'],
+        'sourceSummary': StudyGuideSourceSummaryFromJSON(json['sourceSummary']),
+        'concepts': (json['concepts'].map(StudyGuideConceptFromJSON)),
+        'files': (json['files'].map(StudyGuideFileFromJSON)),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function StudyGuideToJSON(json) {
+    return StudyGuideToJSONTyped(json, false);
+}
+export function StudyGuideToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'studySpaceId': value['studySpaceId'],
+        'studyObjectiveId': value['studyObjectiveId'],
+        'chatId': value['chatId'],
+        'courseId': value['courseId'],
+        'canvasObjectRef': value['canvasObjectRef'],
+        'title': value['title'],
+        'assessmentTitle': value['assessmentTitle'],
+        'learnerContext': value['learnerContext'],
+        'status': value['status'],
+        'refusalReason': value['refusalReason'],
+        'missingContext': value['missingContext'],
+        'summary': value['summary'],
+        'sourceSummary': StudyGuideSourceSummaryToJSON(value['sourceSummary']),
+        'concepts': (value['concepts'].map(StudyGuideConceptToJSON)),
+        'files': (value['files'].map(StudyGuideFileToJSON)),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/StudyGuideConcept.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 StudyGuideConcept
+ */
+export interface StudyGuideConcept {
+    /**
+     * Row id.
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    id: string;
+    /**
+     * Shared concept id, usable with the quiz and tutoring surfaces.
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    conceptId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    shortName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    description: string;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideConcept
+     */
+    displayOrder: number;
+    /**
+     * Why this concept is on the assessment and what to focus on, as read from the sources.
+     * @type {string}
+     * @memberof StudyGuideConcept
+     */
+    focusNote: string | null;
+}
+/**
+ * Check if a given object implements the StudyGuideConcept interface.
+ */
+export declare function instanceOfStudyGuideConcept(value: object): value is StudyGuideConcept;
+export declare function StudyGuideConceptFromJSON(json: any): StudyGuideConcept;
+export declare function StudyGuideConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideConcept;
+export declare function StudyGuideConceptToJSON(json: any): StudyGuideConcept;
+export declare function StudyGuideConceptToJSONTyped(value?: StudyGuideConcept | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyGuideConcept.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 StudyGuideConcept interface.
+ */
+export function instanceOfStudyGuideConcept(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('shortName' in value) || value['shortName'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('focusNote' in value) || value['focusNote'] === undefined)
+        return false;
+    return true;
+}
+export function StudyGuideConceptFromJSON(json) {
+    return StudyGuideConceptFromJSONTyped(json, false);
+}
+export function StudyGuideConceptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'conceptId': json['conceptId'],
+        'name': json['name'],
+        'shortName': json['shortName'],
+        'description': json['description'],
+        'displayOrder': json['displayOrder'],
+        'focusNote': json['focusNote'],
+    };
+}
+export function StudyGuideConceptToJSON(json) {
+    return StudyGuideConceptToJSONTyped(json, false);
+}
+export function StudyGuideConceptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'conceptId': value['conceptId'],
+        'name': value['name'],
+        'shortName': value['shortName'],
+        'description': value['description'],
+        'displayOrder': value['displayOrder'],
+        'focusNote': value['focusNote'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 StudyGuideFile
+ */
+export interface StudyGuideFile {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideFile
+     */
+    userFileId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideFile
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideFile
+     */
+    mimeType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideFile
+     */
+    sizeBytes: number;
+    /**
+     * Freshly-signed GET URL; do not persist.
+     * @type {string}
+     * @memberof StudyGuideFile
+     */
+    previewUrl: string;
+}
+/**
+ * Check if a given object implements the StudyGuideFile interface.
+ */
+export declare function instanceOfStudyGuideFile(value: object): value is StudyGuideFile;
+export declare function StudyGuideFileFromJSON(json: any): StudyGuideFile;
+export declare function StudyGuideFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideFile;
+export declare function StudyGuideFileToJSON(json: any): StudyGuideFile;
+export declare function StudyGuideFileToJSONTyped(value?: StudyGuideFile | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyGuideFile.js

@@ -0,0 +1,59 @@
+/* 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 StudyGuideFile interface.
+ */
+export function instanceOfStudyGuideFile(value) {
+    if (!('userFileId' in value) || value['userFileId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
+        return false;
+    if (!('previewUrl' in value) || value['previewUrl'] === undefined)
+        return false;
+    return true;
+}
+export function StudyGuideFileFromJSON(json) {
+    return StudyGuideFileFromJSONTyped(json, false);
+}
+export function StudyGuideFileFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userFileId': json['userFileId'],
+        'name': json['name'],
+        'mimeType': json['mimeType'],
+        'sizeBytes': json['sizeBytes'],
+        'previewUrl': json['previewUrl'],
+    };
+}
+export function StudyGuideFileToJSON(json) {
+    return StudyGuideFileToJSONTyped(json, false);
+}
+export function StudyGuideFileToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'userFileId': value['userFileId'],
+        'name': value['name'],
+        'mimeType': value['mimeType'],
+        'sizeBytes': value['sizeBytes'],
+        'previewUrl': value['previewUrl'],
+    };
+}

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

@@ -0,0 +1,102 @@
+/**
+ * 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 StudyGuideListItem
+ */
+export interface StudyGuideListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    studySpaceId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    studyObjectiveId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    courseId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    assessmentTitle: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    status: StudyGuideListItemStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideListItem
+     */
+    summary: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideListItem
+     */
+    conceptCount: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyGuideListItem
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyGuideListItem
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const StudyGuideListItemStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly NeedsContext: "needs-context";
+    readonly Failed: "failed";
+};
+export type StudyGuideListItemStatusEnum = typeof StudyGuideListItemStatusEnum[keyof typeof StudyGuideListItemStatusEnum];
+/**
+ * Check if a given object implements the StudyGuideListItem interface.
+ */
+export declare function instanceOfStudyGuideListItem(value: object): value is StudyGuideListItem;
+export declare function StudyGuideListItemFromJSON(json: any): StudyGuideListItem;
+export declare function StudyGuideListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideListItem;
+export declare function StudyGuideListItemToJSON(json: any): StudyGuideListItem;
+export declare function StudyGuideListItemToJSONTyped(value?: StudyGuideListItem | null, ignoreDiscriminator?: boolean): any;