@instructure/athena-api-client 4.0.1 → 4.0.2

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;

package/dist/esm/models/StudyGuideListItem.js

@@ -0,0 +1,92 @@
+/* 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 StudyGuideListItemStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    NeedsContext: 'needs-context',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the StudyGuideListItem interface.
+ */
+export function instanceOfStudyGuideListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('assessmentTitle' in value) || value['assessmentTitle'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('conceptCount' in value) || value['conceptCount'] === 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 StudyGuideListItemFromJSON(json) {
+    return StudyGuideListItemFromJSONTyped(json, false);
+}
+export function StudyGuideListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'studySpaceId': json['studySpaceId'],
+        'studyObjectiveId': json['studyObjectiveId'],
+        'courseId': json['courseId'],
+        'title': json['title'],
+        'assessmentTitle': json['assessmentTitle'],
+        'status': json['status'],
+        'summary': json['summary'],
+        'conceptCount': json['conceptCount'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function StudyGuideListItemToJSON(json) {
+    return StudyGuideListItemToJSONTyped(json, false);
+}
+export function StudyGuideListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'studySpaceId': value['studySpaceId'],
+        'studyObjectiveId': value['studyObjectiveId'],
+        'courseId': value['courseId'],
+        'title': value['title'],
+        'assessmentTitle': value['assessmentTitle'],
+        'status': value['status'],
+        'summary': value['summary'],
+        'conceptCount': value['conceptCount'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,58 @@
+/**
+ * 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 StudyGuideQuiz
+ */
+export interface StudyGuideQuiz {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideQuiz
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideQuiz
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyGuideQuiz
+     */
+    mode: StudyGuideQuizModeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideQuiz
+     */
+    questionCount: number;
+}
+/**
+ * @export
+ */
+export declare const StudyGuideQuizModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type StudyGuideQuizModeEnum = typeof StudyGuideQuizModeEnum[keyof typeof StudyGuideQuizModeEnum];
+/**
+ * Check if a given object implements the StudyGuideQuiz interface.
+ */
+export declare function instanceOfStudyGuideQuiz(value: object): value is StudyGuideQuiz;
+export declare function StudyGuideQuizFromJSON(json: any): StudyGuideQuiz;
+export declare function StudyGuideQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideQuiz;
+export declare function StudyGuideQuizToJSON(json: any): StudyGuideQuiz;
+export declare function StudyGuideQuizToJSONTyped(value?: StudyGuideQuiz | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyGuideQuiz.js

@@ -0,0 +1,62 @@
+/* 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 StudyGuideQuizModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the StudyGuideQuiz interface.
+ */
+export function instanceOfStudyGuideQuiz(value) {
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined)
+        return false;
+    return true;
+}
+export function StudyGuideQuizFromJSON(json) {
+    return StudyGuideQuizFromJSONTyped(json, false);
+}
+export function StudyGuideQuizFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'quizId': json['quizId'],
+        'title': json['title'],
+        'mode': json['mode'],
+        'questionCount': json['questionCount'],
+    };
+}
+export function StudyGuideQuizToJSON(json) {
+    return StudyGuideQuizToJSONTyped(json, false);
+}
+export function StudyGuideQuizToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'quizId': value['quizId'],
+        'title': value['title'],
+        'mode': value['mode'],
+        'questionCount': value['questionCount'],
+    };
+}

package/dist/esm/models/StudyGuideSourceSummary.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 StudyGuideSourceSummary
+ */
+export interface StudyGuideSourceSummary {
+    /**
+     *
+     * @type {boolean}
+     * @memberof StudyGuideSourceSummary
+     */
+    canvasItemText: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof StudyGuideSourceSummary
+     */
+    syllabus: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof StudyGuideSourceSummary
+     */
+    learnerContext: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideSourceSummary
+     */
+    attachmentCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof StudyGuideSourceSummary
+     */
+    objectiveConceptCount: number;
+}
+/**
+ * Check if a given object implements the StudyGuideSourceSummary interface.
+ */
+export declare function instanceOfStudyGuideSourceSummary(value: object): value is StudyGuideSourceSummary;
+export declare function StudyGuideSourceSummaryFromJSON(json: any): StudyGuideSourceSummary;
+export declare function StudyGuideSourceSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideSourceSummary;
+export declare function StudyGuideSourceSummaryToJSON(json: any): StudyGuideSourceSummary;
+export declare function StudyGuideSourceSummaryToJSONTyped(value?: StudyGuideSourceSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyGuideSourceSummary.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 StudyGuideSourceSummary interface.
+ */
+export function instanceOfStudyGuideSourceSummary(value) {
+    if (!('canvasItemText' in value) || value['canvasItemText'] === undefined)
+        return false;
+    if (!('syllabus' in value) || value['syllabus'] === undefined)
+        return false;
+    if (!('learnerContext' in value) || value['learnerContext'] === undefined)
+        return false;
+    if (!('attachmentCount' in value) || value['attachmentCount'] === undefined)
+        return false;
+    if (!('objectiveConceptCount' in value) || value['objectiveConceptCount'] === undefined)
+        return false;
+    return true;
+}
+export function StudyGuideSourceSummaryFromJSON(json) {
+    return StudyGuideSourceSummaryFromJSONTyped(json, false);
+}
+export function StudyGuideSourceSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canvasItemText': json['canvasItemText'],
+        'syllabus': json['syllabus'],
+        'learnerContext': json['learnerContext'],
+        'attachmentCount': json['attachmentCount'],
+        'objectiveConceptCount': json['objectiveConceptCount'],
+    };
+}
+export function StudyGuideSourceSummaryToJSON(json) {
+    return StudyGuideSourceSummaryToJSONTyped(json, false);
+}
+export function StudyGuideSourceSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canvasItemText': value['canvasItemText'],
+        'syllabus': value['syllabus'],
+        'learnerContext': value['learnerContext'],
+        'attachmentCount': value['attachmentCount'],
+        'objectiveConceptCount': value['objectiveConceptCount'],
+    };
+}

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

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

package/dist/esm/models/UserFileAssociation.js

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

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

@@ -105,6 +105,8 @@ export * from './CreateMessagesResponse';
 export * from './CreateObjectiveResourceDto';
 export * from './CreatePlanDto';
 export * from './CreatePracticeQuizRequest';
+export * from './CreateStudyGuideQuizRequest';
+export * from './CreateStudyGuideRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
 export * from './CreateStudyObjectiveDtoCanvasObject';
@@ -140,6 +142,7 @@ export * from './PaginatedObjectiveResources';
 export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedResources';
+export * from './PaginatedStudyGuides';
 export * from './PaginatedStudyObjectives';
 export * from './PaginatedTaxonomies';
 export * from './PaginatedUserConcepts';
@@ -161,6 +164,7 @@ export * from './QuizSessionSummary';
 export * from './QuizSharing';
 export * from './QuizWithQuestions';
 export * from './RecordQuizQuestionViewRequest';
+export * from './RegenerateStudyGuideRequest';
 export * from './ResourceActivity';
 export * from './ResourceChat';
 export * from './ResourceListItem';
@@ -173,6 +177,12 @@ export * from './Score';
 export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SharedQuiz';
+export * from './StudyGuide';
+export * from './StudyGuideConcept';
+export * from './StudyGuideFile';
+export * from './StudyGuideListItem';
+export * from './StudyGuideQuiz';
+export * from './StudyGuideSourceSummary';
 export * from './StudyObjective';
 export * from './StudyObjectiveAccess';
 export * from './StudyObjectiveCanvasDocument';

package/dist/esm/models/index.js

@@ -107,6 +107,8 @@ export * from './CreateMessagesResponse';
 export * from './CreateObjectiveResourceDto';
 export * from './CreatePlanDto';
 export * from './CreatePracticeQuizRequest';
+export * from './CreateStudyGuideQuizRequest';
+export * from './CreateStudyGuideRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
 export * from './CreateStudyObjectiveDtoCanvasObject';
@@ -142,6 +144,7 @@ export * from './PaginatedObjectiveResources';
 export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedResources';
+export * from './PaginatedStudyGuides';
 export * from './PaginatedStudyObjectives';
 export * from './PaginatedTaxonomies';
 export * from './PaginatedUserConcepts';
@@ -163,6 +166,7 @@ export * from './QuizSessionSummary';
 export * from './QuizSharing';
 export * from './QuizWithQuestions';
 export * from './RecordQuizQuestionViewRequest';
+export * from './RegenerateStudyGuideRequest';
 export * from './ResourceActivity';
 export * from './ResourceChat';
 export * from './ResourceListItem';
@@ -175,6 +179,12 @@ export * from './Score';
 export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SharedQuiz';
+export * from './StudyGuide';
+export * from './StudyGuideConcept';
+export * from './StudyGuideFile';
+export * from './StudyGuideListItem';
+export * from './StudyGuideQuiz';
+export * from './StudyGuideSourceSummary';
 export * from './StudyObjective';
 export * from './StudyObjectiveAccess';
 export * from './StudyObjectiveCanvasDocument';

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

@@ -26,7 +26,8 @@ exports.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/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/models/CreateStudyGuideQuizRequest.js

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