@instructure/athena-api-client 4.0.1 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist/apis/AdminApi.d.ts +12 -12
- package/dist/apis/AdminApi.js +12 -12
- package/dist/apis/ConceptDiagramsApi.d.ts +2 -2
- package/dist/apis/ConceptDiagramsApi.js +2 -2
- package/dist/apis/ConceptImagesApi.d.ts +2 -2
- package/dist/apis/ConceptImagesApi.js +2 -2
- package/dist/apis/StudyGuidesApi.d.ts +112 -0
- package/dist/apis/StudyGuidesApi.js +312 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AdminApi.d.ts +12 -12
- package/dist/esm/apis/AdminApi.js +12 -12
- package/dist/esm/apis/ConceptDiagramsApi.d.ts +2 -2
- package/dist/esm/apis/ConceptDiagramsApi.js +2 -2
- package/dist/esm/apis/ConceptImagesApi.d.ts +2 -2
- package/dist/esm/apis/ConceptImagesApi.js +2 -2
- package/dist/esm/apis/StudyGuidesApi.d.ts +112 -0
- package/dist/esm/apis/StudyGuidesApi.js +308 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/AdminConceptDiagram.d.ts +7 -1
- package/dist/esm/models/AdminConceptDiagram.js +4 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +7 -1
- package/dist/esm/models/AdminConceptDiagramDetail.js +4 -0
- package/dist/esm/models/AdminConceptImage.d.ts +7 -1
- package/dist/esm/models/AdminConceptImage.js +4 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +7 -1
- package/dist/esm/models/AdminConceptImageDetail.js +4 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +7 -1
- package/dist/esm/models/AdminShownConceptDiagram.js +4 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +7 -1
- package/dist/esm/models/AdminShownConceptImage.js +4 -0
- package/dist/esm/models/AssociateUserFileRequest.d.ts +1 -0
- package/dist/esm/models/AssociateUserFileRequest.js +2 -1
- package/dist/esm/models/ConceptMediaFlagResult.d.ts +1 -1
- package/dist/esm/models/CreateStudyGuideQuizRequest.d.ts +46 -0
- package/dist/esm/models/CreateStudyGuideQuizRequest.js +50 -0
- package/dist/esm/models/CreateStudyGuideRequest.d.ts +74 -0
- package/dist/esm/models/CreateStudyGuideRequest.js +55 -0
- package/dist/esm/models/PaginatedStudyGuides.d.ts +39 -0
- package/dist/esm/models/PaginatedStudyGuides.js +48 -0
- package/dist/esm/models/RegenerateStudyGuideRequest.d.ts +38 -0
- package/dist/esm/models/RegenerateStudyGuideRequest.js +43 -0
- package/dist/esm/models/StudyGuide.d.ts +153 -0
- package/dist/esm/models/StudyGuide.js +127 -0
- package/dist/esm/models/StudyGuideConcept.d.ts +68 -0
- package/dist/esm/models/StudyGuideConcept.js +67 -0
- package/dist/esm/models/StudyGuideFile.d.ts +56 -0
- package/dist/esm/models/StudyGuideFile.js +59 -0
- package/dist/esm/models/StudyGuideListItem.d.ts +102 -0
- package/dist/esm/models/StudyGuideListItem.js +92 -0
- package/dist/esm/models/StudyGuideQuiz.d.ts +58 -0
- package/dist/esm/models/StudyGuideQuiz.js +62 -0
- package/dist/esm/models/StudyGuideSourceSummary.d.ts +56 -0
- package/dist/esm/models/StudyGuideSourceSummary.js +59 -0
- package/dist/esm/models/UserFileAssociation.d.ts +1 -0
- package/dist/esm/models/UserFileAssociation.js +2 -1
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/models/AdminConceptDiagram.d.ts +7 -1
- package/dist/models/AdminConceptDiagram.js +4 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +7 -1
- package/dist/models/AdminConceptDiagramDetail.js +4 -0
- package/dist/models/AdminConceptImage.d.ts +7 -1
- package/dist/models/AdminConceptImage.js +4 -0
- package/dist/models/AdminConceptImageDetail.d.ts +7 -1
- package/dist/models/AdminConceptImageDetail.js +4 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +7 -1
- package/dist/models/AdminShownConceptDiagram.js +4 -0
- package/dist/models/AdminShownConceptImage.d.ts +7 -1
- package/dist/models/AdminShownConceptImage.js +4 -0
- package/dist/models/AssociateUserFileRequest.d.ts +1 -0
- package/dist/models/AssociateUserFileRequest.js +2 -1
- package/dist/models/ConceptMediaFlagResult.d.ts +1 -1
- package/dist/models/CreateStudyGuideQuizRequest.d.ts +46 -0
- package/dist/models/CreateStudyGuideQuizRequest.js +58 -0
- package/dist/models/CreateStudyGuideRequest.d.ts +74 -0
- package/dist/models/CreateStudyGuideRequest.js +62 -0
- package/dist/models/PaginatedStudyGuides.d.ts +39 -0
- package/dist/models/PaginatedStudyGuides.js +55 -0
- package/dist/models/RegenerateStudyGuideRequest.d.ts +38 -0
- package/dist/models/RegenerateStudyGuideRequest.js +50 -0
- package/dist/models/StudyGuide.d.ts +153 -0
- package/dist/models/StudyGuide.js +135 -0
- package/dist/models/StudyGuideConcept.d.ts +68 -0
- package/dist/models/StudyGuideConcept.js +74 -0
- package/dist/models/StudyGuideFile.d.ts +56 -0
- package/dist/models/StudyGuideFile.js +66 -0
- package/dist/models/StudyGuideListItem.d.ts +102 -0
- package/dist/models/StudyGuideListItem.js +100 -0
- package/dist/models/StudyGuideQuiz.d.ts +58 -0
- package/dist/models/StudyGuideQuiz.js +70 -0
- package/dist/models/StudyGuideSourceSummary.d.ts +56 -0
- package/dist/models/StudyGuideSourceSummary.js +66 -0
- package/dist/models/UserFileAssociation.d.ts +1 -0
- package/dist/models/UserFileAssociation.js +2 -1
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/package.json +1 -1
|
@@ -68,6 +68,8 @@ function instanceOfAdminShownConceptDiagram(value) {
|
|
|
68
68
|
return false;
|
|
69
69
|
if (!('approvedBy' in value) || value['approvedBy'] === undefined)
|
|
70
70
|
return false;
|
|
71
|
+
if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
|
|
72
|
+
return false;
|
|
71
73
|
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
72
74
|
return false;
|
|
73
75
|
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
@@ -127,6 +129,7 @@ function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
127
129
|
'hiddenByFlag': json['hiddenByFlag'],
|
|
128
130
|
'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
|
|
129
131
|
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
|
|
132
|
+
'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
|
|
130
133
|
'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
|
|
131
134
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
|
|
132
135
|
'model': json['model'],
|
|
@@ -168,6 +171,7 @@ function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
168
171
|
'hiddenByFlag': value['hiddenByFlag'],
|
|
169
172
|
'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
|
|
170
173
|
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
|
|
174
|
+
'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
|
|
171
175
|
'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
|
|
172
176
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
|
|
173
177
|
'model': value['model'],
|
|
@@ -86,7 +86,7 @@ export interface AdminShownConceptImage {
|
|
|
86
86
|
*/
|
|
87
87
|
hiddenByFlag: boolean;
|
|
88
88
|
/**
|
|
89
|
-
* When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
|
|
89
|
+
* When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
|
|
90
90
|
* @type {Date}
|
|
91
91
|
* @memberof AdminShownConceptImage
|
|
92
92
|
*/
|
|
@@ -97,6 +97,12 @@ export interface AdminShownConceptImage {
|
|
|
97
97
|
* @memberof AdminShownConceptImage
|
|
98
98
|
*/
|
|
99
99
|
approvedBy: AdminConceptMediaActor | null;
|
|
100
|
+
/**
|
|
101
|
+
* When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
|
|
102
|
+
* @type {Date}
|
|
103
|
+
* @memberof AdminShownConceptImage
|
|
104
|
+
*/
|
|
105
|
+
flaggedAfterApprovalAt: Date | null;
|
|
100
106
|
/**
|
|
101
107
|
*
|
|
102
108
|
* @type {Date}
|
|
@@ -68,6 +68,8 @@ function instanceOfAdminShownConceptImage(value) {
|
|
|
68
68
|
return false;
|
|
69
69
|
if (!('approvedBy' in value) || value['approvedBy'] === undefined)
|
|
70
70
|
return false;
|
|
71
|
+
if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
|
|
72
|
+
return false;
|
|
71
73
|
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
72
74
|
return false;
|
|
73
75
|
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
@@ -133,6 +135,7 @@ function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
133
135
|
'hiddenByFlag': json['hiddenByFlag'],
|
|
134
136
|
'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
|
|
135
137
|
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
|
|
138
|
+
'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
|
|
136
139
|
'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
|
|
137
140
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
|
|
138
141
|
'model': json['model'],
|
|
@@ -177,6 +180,7 @@ function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
177
180
|
'hiddenByFlag': value['hiddenByFlag'],
|
|
178
181
|
'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
|
|
179
182
|
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
|
|
183
|
+
'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
|
|
180
184
|
'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
|
|
181
185
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
|
|
182
186
|
'model': value['model'],
|
|
@@ -36,6 +36,7 @@ export declare const AssociateUserFileRequestKindEnum: {
|
|
|
36
36
|
readonly Message: "message";
|
|
37
37
|
readonly StudyObjective: "study_objective";
|
|
38
38
|
readonly ObjectiveResource: "objective_resource";
|
|
39
|
+
readonly StudyGuide: "study_guide";
|
|
39
40
|
};
|
|
40
41
|
export type AssociateUserFileRequestKindEnum = typeof AssociateUserFileRequestKindEnum[keyof typeof AssociateUserFileRequestKindEnum];
|
|
41
42
|
/**
|
|
@@ -26,7 +26,8 @@ exports.AssociateUserFileRequestKindEnum = {
|
|
|
26
26
|
Chat: 'chat',
|
|
27
27
|
Message: 'message',
|
|
28
28
|
StudyObjective: 'study_objective',
|
|
29
|
-
ObjectiveResource: 'objective_resource'
|
|
29
|
+
ObjectiveResource: 'objective_resource',
|
|
30
|
+
StudyGuide: 'study_guide'
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
33
|
* Check if a given object implements the AssociateUserFileRequest interface.
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface ConceptMediaFlagResult {
|
|
18
18
|
/**
|
|
19
|
-
* True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible.
|
|
19
|
+
* True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible (and queued it for admin re-review).
|
|
20
20
|
* @type {boolean}
|
|
21
21
|
* @memberof ConceptMediaFlagResult
|
|
22
22
|
*/
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CreateStudyGuideQuizRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateStudyGuideQuizRequest {
|
|
18
|
+
/**
|
|
19
|
+
* 'quiz' for a graded practice quiz, 'flashcards' for a deck.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CreateStudyGuideQuizRequest
|
|
22
|
+
*/
|
|
23
|
+
mode?: CreateStudyGuideQuizRequestModeEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Concepts on the guide to build from. Omit for the whole guide (the 'Take Practice Quiz' button). Ids not on the guide are ignored.
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof CreateStudyGuideQuizRequest
|
|
28
|
+
*/
|
|
29
|
+
conceptIds?: Array<string>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @export
|
|
33
|
+
*/
|
|
34
|
+
export declare const CreateStudyGuideQuizRequestModeEnum: {
|
|
35
|
+
readonly Quiz: "quiz";
|
|
36
|
+
readonly Flashcards: "flashcards";
|
|
37
|
+
};
|
|
38
|
+
export type CreateStudyGuideQuizRequestModeEnum = typeof CreateStudyGuideQuizRequestModeEnum[keyof typeof CreateStudyGuideQuizRequestModeEnum];
|
|
39
|
+
/**
|
|
40
|
+
* Check if a given object implements the CreateStudyGuideQuizRequest interface.
|
|
41
|
+
*/
|
|
42
|
+
export declare function instanceOfCreateStudyGuideQuizRequest(value: object): value is CreateStudyGuideQuizRequest;
|
|
43
|
+
export declare function CreateStudyGuideQuizRequestFromJSON(json: any): CreateStudyGuideQuizRequest;
|
|
44
|
+
export declare function CreateStudyGuideQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideQuizRequest;
|
|
45
|
+
export declare function CreateStudyGuideQuizRequestToJSON(json: any): CreateStudyGuideQuizRequest;
|
|
46
|
+
export declare function CreateStudyGuideQuizRequestToJSONTyped(value?: CreateStudyGuideQuizRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateStudyGuideQuizRequestModeEnum = void 0;
|
|
17
|
+
exports.instanceOfCreateStudyGuideQuizRequest = instanceOfCreateStudyGuideQuizRequest;
|
|
18
|
+
exports.CreateStudyGuideQuizRequestFromJSON = CreateStudyGuideQuizRequestFromJSON;
|
|
19
|
+
exports.CreateStudyGuideQuizRequestFromJSONTyped = CreateStudyGuideQuizRequestFromJSONTyped;
|
|
20
|
+
exports.CreateStudyGuideQuizRequestToJSON = CreateStudyGuideQuizRequestToJSON;
|
|
21
|
+
exports.CreateStudyGuideQuizRequestToJSONTyped = CreateStudyGuideQuizRequestToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.CreateStudyGuideQuizRequestModeEnum = {
|
|
26
|
+
Quiz: 'quiz',
|
|
27
|
+
Flashcards: 'flashcards'
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Check if a given object implements the CreateStudyGuideQuizRequest interface.
|
|
31
|
+
*/
|
|
32
|
+
function instanceOfCreateStudyGuideQuizRequest(value) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
function CreateStudyGuideQuizRequestFromJSON(json) {
|
|
36
|
+
return CreateStudyGuideQuizRequestFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
function CreateStudyGuideQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'mode': json['mode'] == null ? undefined : json['mode'],
|
|
44
|
+
'conceptIds': json['conceptIds'] == null ? undefined : json['conceptIds'],
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
function CreateStudyGuideQuizRequestToJSON(json) {
|
|
48
|
+
return CreateStudyGuideQuizRequestToJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
function CreateStudyGuideQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
51
|
+
if (value == null) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'mode': value['mode'],
|
|
56
|
+
'conceptIds': value['conceptIds'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CreateStudyGuideRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateStudyGuideRequest {
|
|
18
|
+
/**
|
|
19
|
+
* 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.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CreateStudyGuideRequest
|
|
22
|
+
*/
|
|
23
|
+
studyObjectiveId?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof CreateStudyGuideRequest
|
|
28
|
+
*/
|
|
29
|
+
studySpaceId?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Canvas course id, when the guide is for a Canvas course.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof CreateStudyGuideRequest
|
|
34
|
+
*/
|
|
35
|
+
courseId?: string;
|
|
36
|
+
/**
|
|
37
|
+
* The Canvas assessment formatted '{type}:{local_id}' (e.g. 'quiz:123'). Read live (title, description, points, due date) when Canvas credentials are sent.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof CreateStudyGuideRequest
|
|
40
|
+
*/
|
|
41
|
+
canvasObjectRef?: string;
|
|
42
|
+
/**
|
|
43
|
+
* The chat the guide was requested from, if any.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof CreateStudyGuideRequest
|
|
46
|
+
*/
|
|
47
|
+
chatId?: string;
|
|
48
|
+
/**
|
|
49
|
+
* The assessment's name as the learner gave it, used when there is no Canvas item or objective to read it from.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof CreateStudyGuideRequest
|
|
52
|
+
*/
|
|
53
|
+
assessmentTitle?: string;
|
|
54
|
+
/**
|
|
55
|
+
* 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.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof CreateStudyGuideRequest
|
|
58
|
+
*/
|
|
59
|
+
learnerContext?: string;
|
|
60
|
+
/**
|
|
61
|
+
* 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'.
|
|
62
|
+
* @type {Array<string>}
|
|
63
|
+
* @memberof CreateStudyGuideRequest
|
|
64
|
+
*/
|
|
65
|
+
userFileIds?: Array<string>;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Check if a given object implements the CreateStudyGuideRequest interface.
|
|
69
|
+
*/
|
|
70
|
+
export declare function instanceOfCreateStudyGuideRequest(value: object): value is CreateStudyGuideRequest;
|
|
71
|
+
export declare function CreateStudyGuideRequestFromJSON(json: any): CreateStudyGuideRequest;
|
|
72
|
+
export declare function CreateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideRequest;
|
|
73
|
+
export declare function CreateStudyGuideRequestToJSON(json: any): CreateStudyGuideRequest;
|
|
74
|
+
export declare function CreateStudyGuideRequestToJSONTyped(value?: CreateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfCreateStudyGuideRequest = instanceOfCreateStudyGuideRequest;
|
|
17
|
+
exports.CreateStudyGuideRequestFromJSON = CreateStudyGuideRequestFromJSON;
|
|
18
|
+
exports.CreateStudyGuideRequestFromJSONTyped = CreateStudyGuideRequestFromJSONTyped;
|
|
19
|
+
exports.CreateStudyGuideRequestToJSON = CreateStudyGuideRequestToJSON;
|
|
20
|
+
exports.CreateStudyGuideRequestToJSONTyped = CreateStudyGuideRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the CreateStudyGuideRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfCreateStudyGuideRequest(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function CreateStudyGuideRequestFromJSON(json) {
|
|
28
|
+
return CreateStudyGuideRequestFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function CreateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
|
|
36
|
+
'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
|
|
37
|
+
'courseId': json['courseId'] == null ? undefined : json['courseId'],
|
|
38
|
+
'canvasObjectRef': json['canvasObjectRef'] == null ? undefined : json['canvasObjectRef'],
|
|
39
|
+
'chatId': json['chatId'] == null ? undefined : json['chatId'],
|
|
40
|
+
'assessmentTitle': json['assessmentTitle'] == null ? undefined : json['assessmentTitle'],
|
|
41
|
+
'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
|
|
42
|
+
'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function CreateStudyGuideRequestToJSON(json) {
|
|
46
|
+
return CreateStudyGuideRequestToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function CreateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'studyObjectiveId': value['studyObjectiveId'],
|
|
54
|
+
'studySpaceId': value['studySpaceId'],
|
|
55
|
+
'courseId': value['courseId'],
|
|
56
|
+
'canvasObjectRef': value['canvasObjectRef'],
|
|
57
|
+
'chatId': value['chatId'],
|
|
58
|
+
'assessmentTitle': value['assessmentTitle'],
|
|
59
|
+
'learnerContext': value['learnerContext'],
|
|
60
|
+
'userFileIds': value['userFileIds'],
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { StudyGuideListItem } from './StudyGuideListItem';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PaginatedStudyGuides
|
|
17
|
+
*/
|
|
18
|
+
export interface PaginatedStudyGuides {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<StudyGuideListItem>}
|
|
22
|
+
* @memberof PaginatedStudyGuides
|
|
23
|
+
*/
|
|
24
|
+
data: Array<StudyGuideListItem>;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof PaginatedStudyGuides
|
|
29
|
+
*/
|
|
30
|
+
nextCursor: string | null;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the PaginatedStudyGuides interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfPaginatedStudyGuides(value: object): value is PaginatedStudyGuides;
|
|
36
|
+
export declare function PaginatedStudyGuidesFromJSON(json: any): PaginatedStudyGuides;
|
|
37
|
+
export declare function PaginatedStudyGuidesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStudyGuides;
|
|
38
|
+
export declare function PaginatedStudyGuidesToJSON(json: any): PaginatedStudyGuides;
|
|
39
|
+
export declare function PaginatedStudyGuidesToJSONTyped(value?: PaginatedStudyGuides | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfPaginatedStudyGuides = instanceOfPaginatedStudyGuides;
|
|
17
|
+
exports.PaginatedStudyGuidesFromJSON = PaginatedStudyGuidesFromJSON;
|
|
18
|
+
exports.PaginatedStudyGuidesFromJSONTyped = PaginatedStudyGuidesFromJSONTyped;
|
|
19
|
+
exports.PaginatedStudyGuidesToJSON = PaginatedStudyGuidesToJSON;
|
|
20
|
+
exports.PaginatedStudyGuidesToJSONTyped = PaginatedStudyGuidesToJSONTyped;
|
|
21
|
+
const StudyGuideListItem_1 = require("./StudyGuideListItem");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the PaginatedStudyGuides interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfPaginatedStudyGuides(value) {
|
|
26
|
+
if (!('data' in value) || value['data'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('nextCursor' in value) || value['nextCursor'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function PaginatedStudyGuidesFromJSON(json) {
|
|
33
|
+
return PaginatedStudyGuidesFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
function PaginatedStudyGuidesFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'data': (json['data'].map(StudyGuideListItem_1.StudyGuideListItemFromJSON)),
|
|
41
|
+
'nextCursor': json['nextCursor'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function PaginatedStudyGuidesToJSON(json) {
|
|
45
|
+
return PaginatedStudyGuidesToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function PaginatedStudyGuidesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'data': (value['data'].map(StudyGuideListItem_1.StudyGuideListItemToJSON)),
|
|
53
|
+
'nextCursor': value['nextCursor'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface RegenerateStudyGuideRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface RegenerateStudyGuideRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Additional context, appended to what the learner already said. Omit to retry with the same inputs.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof RegenerateStudyGuideRequest
|
|
22
|
+
*/
|
|
23
|
+
learnerContext?: string;
|
|
24
|
+
/**
|
|
25
|
+
* 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'.
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof RegenerateStudyGuideRequest
|
|
28
|
+
*/
|
|
29
|
+
userFileIds?: Array<string>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the RegenerateStudyGuideRequest interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfRegenerateStudyGuideRequest(value: object): value is RegenerateStudyGuideRequest;
|
|
35
|
+
export declare function RegenerateStudyGuideRequestFromJSON(json: any): RegenerateStudyGuideRequest;
|
|
36
|
+
export declare function RegenerateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegenerateStudyGuideRequest;
|
|
37
|
+
export declare function RegenerateStudyGuideRequestToJSON(json: any): RegenerateStudyGuideRequest;
|
|
38
|
+
export declare function RegenerateStudyGuideRequestToJSONTyped(value?: RegenerateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfRegenerateStudyGuideRequest = instanceOfRegenerateStudyGuideRequest;
|
|
17
|
+
exports.RegenerateStudyGuideRequestFromJSON = RegenerateStudyGuideRequestFromJSON;
|
|
18
|
+
exports.RegenerateStudyGuideRequestFromJSONTyped = RegenerateStudyGuideRequestFromJSONTyped;
|
|
19
|
+
exports.RegenerateStudyGuideRequestToJSON = RegenerateStudyGuideRequestToJSON;
|
|
20
|
+
exports.RegenerateStudyGuideRequestToJSONTyped = RegenerateStudyGuideRequestToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the RegenerateStudyGuideRequest interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfRegenerateStudyGuideRequest(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function RegenerateStudyGuideRequestFromJSON(json) {
|
|
28
|
+
return RegenerateStudyGuideRequestFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function RegenerateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
|
|
36
|
+
'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
function RegenerateStudyGuideRequestToJSON(json) {
|
|
40
|
+
return RegenerateStudyGuideRequestToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
function RegenerateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'learnerContext': value['learnerContext'],
|
|
48
|
+
'userFileIds': value['userFileIds'],
|
|
49
|
+
};
|
|
50
|
+
}
|