@instructure/athena-api-client 4.0.1 → 4.0.2

package/dist/esm/apis/StudyGuidesApi.js

@@ -0,0 +1,308 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateStudyGuideQuizRequestToJSON, CreateStudyGuideRequestToJSON, PaginatedStudyGuidesFromJSON, RegenerateStudyGuideRequestToJSON, StudyGuideFromJSON, StudyGuideQuizFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudyGuidesApi extends runtime.BaseAPI {
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuideRaw(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 createStudyGuide().');
+            }
+            if (requestParameters['createStudyGuideRequest'] == null) {
+                throw new runtime.RequiredError('createStudyGuideRequest', 'Required parameter "createStudyGuideRequest" was null or undefined when calling createStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudyGuideRequestToJSON(requestParameters['createStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuizRaw(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 createStudyGuideQuiz().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling createStudyGuideQuiz().');
+            }
+            if (requestParameters['createStudyGuideQuizRequest'] == null) {
+                throw new runtime.RequiredError('createStudyGuideQuizRequest', 'Required parameter "createStudyGuideQuizRequest" was null or undefined when calling createStudyGuideQuiz().');
+            }
+            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/study-guides/{studyGuideId}/quizzes`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudyGuideQuizRequestToJSON(requestParameters['createStudyGuideQuizRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideQuizFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudyGuideQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuideRaw(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 deleteStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling deleteStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/study-guides/{studyGuideId}`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteStudyGuideRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuideRaw(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 getStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling getStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/study-guides/{studyGuideId}`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuidesRaw(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 listStudyGuides().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
+            if (requestParameters['studyObjectiveId'] != null) {
+                queryParameters['studyObjectiveId'] = requestParameters['studyObjectiveId'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            const headerParameters = {};
+            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/study-guides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedStudyGuidesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuides(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudyGuidesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuideRaw(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 regenerateStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling regenerateStudyGuide().');
+            }
+            if (requestParameters['regenerateStudyGuideRequest'] == null) {
+                throw new runtime.RequiredError('regenerateStudyGuideRequest', 'Required parameter "regenerateStudyGuideRequest" was null or undefined when calling regenerateStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides/{studyGuideId}/regenerate`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: RegenerateStudyGuideRequestToJSON(requestParameters['regenerateStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.regenerateStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -23,6 +23,7 @@ export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './SharedQuizzesApi';
+export * from './StudyGuidesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';

package/dist/esm/apis/index.js

@@ -25,6 +25,7 @@ export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './SharedQuizzesApi';
+export * from './StudyGuidesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';

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

@@ -36,6 +36,7 @@ export declare const AssociateUserFileRequestKindEnum: {
     readonly Message: "message";
     readonly StudyObjective: "study_objective";
     readonly ObjectiveResource: "objective_resource";
+    readonly StudyGuide: "study_guide";
 };
 export type AssociateUserFileRequestKindEnum = typeof AssociateUserFileRequestKindEnum[keyof typeof AssociateUserFileRequestKindEnum];
 /**

package/dist/esm/models/AssociateUserFileRequest.js

@@ -18,7 +18,8 @@ export const AssociateUserFileRequestKindEnum = {
     Chat: 'chat',
     Message: 'message',
     StudyObjective: 'study_objective',
-    ObjectiveResource: 'objective_resource'
+    ObjectiveResource: 'objective_resource',
+    StudyGuide: 'study_guide'
 };
 /**
  * Check if a given object implements the AssociateUserFileRequest interface.

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

@@ -0,0 +1,46 @@
+/**
+ * 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 CreateStudyGuideQuizRequest
+ */
+export interface CreateStudyGuideQuizRequest {
+    /**
+     * 'quiz' for a graded practice quiz, 'flashcards' for a deck.
+     * @type {string}
+     * @memberof CreateStudyGuideQuizRequest
+     */
+    mode?: CreateStudyGuideQuizRequestModeEnum;
+    /**
+     * Concepts on the guide to build from. Omit for the whole guide (the 'Take Practice Quiz' button). Ids not on the guide are ignored.
+     * @type {Array<string>}
+     * @memberof CreateStudyGuideQuizRequest
+     */
+    conceptIds?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const CreateStudyGuideQuizRequestModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type CreateStudyGuideQuizRequestModeEnum = typeof CreateStudyGuideQuizRequestModeEnum[keyof typeof CreateStudyGuideQuizRequestModeEnum];
+/**
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
+ */
+export declare function instanceOfCreateStudyGuideQuizRequest(value: object): value is CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestFromJSON(json: any): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestToJSON(json: any): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestToJSONTyped(value?: CreateStudyGuideQuizRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyGuideQuizRequest.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 CreateStudyGuideQuizRequestModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
+ */
+export function instanceOfCreateStudyGuideQuizRequest(value) {
+    return true;
+}
+export function CreateStudyGuideQuizRequestFromJSON(json) {
+    return CreateStudyGuideQuizRequestFromJSONTyped(json, false);
+}
+export function CreateStudyGuideQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'mode': json['mode'] == null ? undefined : json['mode'],
+        'conceptIds': json['conceptIds'] == null ? undefined : json['conceptIds'],
+    };
+}
+export function CreateStudyGuideQuizRequestToJSON(json) {
+    return CreateStudyGuideQuizRequestToJSONTyped(json, false);
+}
+export function CreateStudyGuideQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'mode': value['mode'],
+        'conceptIds': value['conceptIds'],
+    };
+}

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

@@ -0,0 +1,55 @@
+/* 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 CreateStudyGuideRequest interface.
+ */
+export function instanceOfCreateStudyGuideRequest(value) {
+    return true;
+}
+export function CreateStudyGuideRequestFromJSON(json) {
+    return CreateStudyGuideRequestFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function CreateStudyGuideRequestToJSON(json) {
+    return CreateStudyGuideRequestToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/PaginatedStudyGuides.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 { StudyGuideListItemFromJSON, StudyGuideListItemToJSON, } from './StudyGuideListItem';
+/**
+ * Check if a given object implements the PaginatedStudyGuides interface.
+ */
+export function instanceOfPaginatedStudyGuides(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedStudyGuidesFromJSON(json) {
+    return PaginatedStudyGuidesFromJSONTyped(json, false);
+}
+export function PaginatedStudyGuidesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(StudyGuideListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedStudyGuidesToJSON(json) {
+    return PaginatedStudyGuidesToJSONTyped(json, false);
+}
+export function PaginatedStudyGuidesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(StudyGuideListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}