@instructure/athena-api-client 4.0.1 → 4.0.2

package/dist/models/CreateStudyGuideRequest.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 CreateStudyGuideRequest
+ */
+export interface CreateStudyGuideRequest {
+    /**
+     * Study objective the guide is for. Its course, study space, Canvas link, due date, notes, attachments and extracted concepts all feed generation. When set, courseId/studySpaceId/canvasObjectRef are taken from it.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    studyObjectiveId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    studySpaceId?: string;
+    /**
+     * Canvas course id, when the guide is for a Canvas course.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    courseId?: string;
+    /**
+     * The Canvas assessment formatted '{type}:{local_id}' (e.g. 'quiz:123'). Read live (title, description, points, due date) when Canvas credentials are sent.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    canvasObjectRef?: string;
+    /**
+     * The chat the guide was requested from, if any.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    chatId?: string;
+    /**
+     * The assessment's name as the learner gave it, used when there is no Canvas item or objective to read it from.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    assessmentTitle?: string;
+    /**
+     * What the learner says is on the assessment, in their own words (chapters, topics, 'everything since the midterm'). The generator treats it as evidence of scope.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    learnerContext?: string;
+    /**
+     * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
+     * @type {Array<string>}
+     * @memberof CreateStudyGuideRequest
+     */
+    userFileIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the CreateStudyGuideRequest interface.
+ */
+export declare function instanceOfCreateStudyGuideRequest(value: object): value is CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestFromJSON(json: any): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestToJSON(json: any): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestToJSONTyped(value?: CreateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateStudyGuideRequest.js

@@ -0,0 +1,62 @@
+"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.instanceOfCreateStudyGuideRequest = instanceOfCreateStudyGuideRequest;
+exports.CreateStudyGuideRequestFromJSON = CreateStudyGuideRequestFromJSON;
+exports.CreateStudyGuideRequestFromJSONTyped = CreateStudyGuideRequestFromJSONTyped;
+exports.CreateStudyGuideRequestToJSON = CreateStudyGuideRequestToJSON;
+exports.CreateStudyGuideRequestToJSONTyped = CreateStudyGuideRequestToJSONTyped;
+/**
+ * Check if a given object implements the CreateStudyGuideRequest interface.
+ */
+function instanceOfCreateStudyGuideRequest(value) {
+    return true;
+}
+function CreateStudyGuideRequestFromJSON(json) {
+    return CreateStudyGuideRequestFromJSONTyped(json, false);
+}
+function CreateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
+        'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
+        'courseId': json['courseId'] == null ? undefined : json['courseId'],
+        'canvasObjectRef': json['canvasObjectRef'] == null ? undefined : json['canvasObjectRef'],
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'assessmentTitle': json['assessmentTitle'] == null ? undefined : json['assessmentTitle'],
+        'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
+        'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
+    };
+}
+function CreateStudyGuideRequestToJSON(json) {
+    return CreateStudyGuideRequestToJSONTyped(json, false);
+}
+function CreateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'studyObjectiveId': value['studyObjectiveId'],
+        'studySpaceId': value['studySpaceId'],
+        'courseId': value['courseId'],
+        'canvasObjectRef': value['canvasObjectRef'],
+        'chatId': value['chatId'],
+        'assessmentTitle': value['assessmentTitle'],
+        'learnerContext': value['learnerContext'],
+        'userFileIds': value['userFileIds'],
+    };
+}

package/dist/models/PaginatedStudyGuides.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 { StudyGuideListItem } from './StudyGuideListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedStudyGuides
+ */
+export interface PaginatedStudyGuides {
+    /**
+     *
+     * @type {Array<StudyGuideListItem>}
+     * @memberof PaginatedStudyGuides
+     */
+    data: Array<StudyGuideListItem>;
+    /**
+     *
+     * @type {string}
+     * @memberof PaginatedStudyGuides
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedStudyGuides interface.
+ */
+export declare function instanceOfPaginatedStudyGuides(value: object): value is PaginatedStudyGuides;
+export declare function PaginatedStudyGuidesFromJSON(json: any): PaginatedStudyGuides;
+export declare function PaginatedStudyGuidesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStudyGuides;
+export declare function PaginatedStudyGuidesToJSON(json: any): PaginatedStudyGuides;
+export declare function PaginatedStudyGuidesToJSONTyped(value?: PaginatedStudyGuides | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PaginatedStudyGuides.js

@@ -0,0 +1,55 @@
+"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.instanceOfPaginatedStudyGuides = instanceOfPaginatedStudyGuides;
+exports.PaginatedStudyGuidesFromJSON = PaginatedStudyGuidesFromJSON;
+exports.PaginatedStudyGuidesFromJSONTyped = PaginatedStudyGuidesFromJSONTyped;
+exports.PaginatedStudyGuidesToJSON = PaginatedStudyGuidesToJSON;
+exports.PaginatedStudyGuidesToJSONTyped = PaginatedStudyGuidesToJSONTyped;
+const StudyGuideListItem_1 = require("./StudyGuideListItem");
+/**
+ * Check if a given object implements the PaginatedStudyGuides interface.
+ */
+function instanceOfPaginatedStudyGuides(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedStudyGuidesFromJSON(json) {
+    return PaginatedStudyGuidesFromJSONTyped(json, false);
+}
+function PaginatedStudyGuidesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(StudyGuideListItem_1.StudyGuideListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function PaginatedStudyGuidesToJSON(json) {
+    return PaginatedStudyGuidesToJSONTyped(json, false);
+}
+function PaginatedStudyGuidesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(StudyGuideListItem_1.StudyGuideListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/RegenerateStudyGuideRequest.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 RegenerateStudyGuideRequest
+ */
+export interface RegenerateStudyGuideRequest {
+    /**
+     * Additional context, appended to what the learner already said. Omit to retry with the same inputs.
+     * @type {string}
+     * @memberof RegenerateStudyGuideRequest
+     */
+    learnerContext?: string;
+    /**
+     * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
+     * @type {Array<string>}
+     * @memberof RegenerateStudyGuideRequest
+     */
+    userFileIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the RegenerateStudyGuideRequest interface.
+ */
+export declare function instanceOfRegenerateStudyGuideRequest(value: object): value is RegenerateStudyGuideRequest;
+export declare function RegenerateStudyGuideRequestFromJSON(json: any): RegenerateStudyGuideRequest;
+export declare function RegenerateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegenerateStudyGuideRequest;
+export declare function RegenerateStudyGuideRequestToJSON(json: any): RegenerateStudyGuideRequest;
+export declare function RegenerateStudyGuideRequestToJSONTyped(value?: RegenerateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RegenerateStudyGuideRequest.js

@@ -0,0 +1,50 @@
+"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.instanceOfRegenerateStudyGuideRequest = instanceOfRegenerateStudyGuideRequest;
+exports.RegenerateStudyGuideRequestFromJSON = RegenerateStudyGuideRequestFromJSON;
+exports.RegenerateStudyGuideRequestFromJSONTyped = RegenerateStudyGuideRequestFromJSONTyped;
+exports.RegenerateStudyGuideRequestToJSON = RegenerateStudyGuideRequestToJSON;
+exports.RegenerateStudyGuideRequestToJSONTyped = RegenerateStudyGuideRequestToJSONTyped;
+/**
+ * Check if a given object implements the RegenerateStudyGuideRequest interface.
+ */
+function instanceOfRegenerateStudyGuideRequest(value) {
+    return true;
+}
+function RegenerateStudyGuideRequestFromJSON(json) {
+    return RegenerateStudyGuideRequestFromJSONTyped(json, false);
+}
+function RegenerateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
+        'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
+    };
+}
+function RegenerateStudyGuideRequestToJSON(json) {
+    return RegenerateStudyGuideRequestToJSONTyped(json, false);
+}
+function RegenerateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'learnerContext': value['learnerContext'],
+        'userFileIds': value['userFileIds'],
+    };
+}

package/dist/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/models/StudyGuide.js

@@ -0,0 +1,135 @@
+"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.StudyGuideStatusEnum = void 0;
+exports.instanceOfStudyGuide = instanceOfStudyGuide;
+exports.StudyGuideFromJSON = StudyGuideFromJSON;
+exports.StudyGuideFromJSONTyped = StudyGuideFromJSONTyped;
+exports.StudyGuideToJSON = StudyGuideToJSON;
+exports.StudyGuideToJSONTyped = StudyGuideToJSONTyped;
+const StudyGuideFile_1 = require("./StudyGuideFile");
+const StudyGuideSourceSummary_1 = require("./StudyGuideSourceSummary");
+const StudyGuideConcept_1 = require("./StudyGuideConcept");
+/**
+ * @export
+ */
+exports.StudyGuideStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    NeedsContext: 'needs-context',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the StudyGuide interface.
+ */
+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;
+}
+function StudyGuideFromJSON(json) {
+    return StudyGuideFromJSONTyped(json, false);
+}
+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': (0, StudyGuideSourceSummary_1.StudyGuideSourceSummaryFromJSON)(json['sourceSummary']),
+        'concepts': (json['concepts'].map(StudyGuideConcept_1.StudyGuideConceptFromJSON)),
+        'files': (json['files'].map(StudyGuideFile_1.StudyGuideFileFromJSON)),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+function StudyGuideToJSON(json) {
+    return StudyGuideToJSONTyped(json, false);
+}
+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': (0, StudyGuideSourceSummary_1.StudyGuideSourceSummaryToJSON)(value['sourceSummary']),
+        'concepts': (value['concepts'].map(StudyGuideConcept_1.StudyGuideConceptToJSON)),
+        'files': (value['files'].map(StudyGuideFile_1.StudyGuideFileToJSON)),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/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;