@instructure/athena-api-client 4.0.0 → 4.0.2
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 +19 -0
- package/dist/apis/AdminApi.d.ts +14 -12
- package/dist/apis/AdminApi.js +14 -12
- package/dist/apis/ConceptDiagramsApi.d.ts +15 -1
- package/dist/apis/ConceptDiagramsApi.js +41 -0
- package/dist/apis/ConceptImagesApi.d.ts +15 -1
- package/dist/apis/ConceptImagesApi.js +41 -0
- 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 +14 -12
- package/dist/esm/apis/AdminApi.js +14 -12
- package/dist/esm/apis/ConceptDiagramsApi.d.ts +15 -1
- package/dist/esm/apis/ConceptDiagramsApi.js +42 -1
- package/dist/esm/apis/ConceptImagesApi.d.ts +15 -1
- package/dist/esm/apis/ConceptImagesApi.js +42 -1
- 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 +19 -1
- package/dist/esm/models/AdminConceptDiagram.js +12 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +19 -1
- package/dist/esm/models/AdminConceptDiagramDetail.js +12 -0
- package/dist/esm/models/AdminConceptImage.d.ts +19 -1
- package/dist/esm/models/AdminConceptImage.js +12 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +19 -1
- package/dist/esm/models/AdminConceptImageDetail.js +12 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +19 -1
- package/dist/esm/models/AdminShownConceptDiagram.js +12 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +19 -1
- package/dist/esm/models/AdminShownConceptImage.js +12 -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 +32 -0
- package/dist/esm/models/ConceptMediaFlagResult.js +43 -0
- 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 +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/models/AdminConceptDiagram.d.ts +19 -1
- package/dist/models/AdminConceptDiagram.js +12 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +19 -1
- package/dist/models/AdminConceptDiagramDetail.js +12 -0
- package/dist/models/AdminConceptImage.d.ts +19 -1
- package/dist/models/AdminConceptImage.js +12 -0
- package/dist/models/AdminConceptImageDetail.d.ts +19 -1
- package/dist/models/AdminConceptImageDetail.js +12 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +19 -1
- package/dist/models/AdminShownConceptDiagram.js +12 -0
- package/dist/models/AdminShownConceptImage.d.ts +19 -1
- package/dist/models/AdminShownConceptImage.js +12 -0
- package/dist/models/AssociateUserFileRequest.d.ts +1 -0
- package/dist/models/AssociateUserFileRequest.js +2 -1
- package/dist/models/ConceptMediaFlagResult.d.ts +32 -0
- package/dist/models/ConceptMediaFlagResult.js +50 -0
- 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 +11 -0
- package/dist/models/index.js +11 -0
- package/package.json +1 -1
|
@@ -0,0 +1,56 @@
|
|
|
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 StudyGuideFile
|
|
16
|
+
*/
|
|
17
|
+
export interface StudyGuideFile {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof StudyGuideFile
|
|
22
|
+
*/
|
|
23
|
+
userFileId: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof StudyGuideFile
|
|
28
|
+
*/
|
|
29
|
+
name: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof StudyGuideFile
|
|
34
|
+
*/
|
|
35
|
+
mimeType: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof StudyGuideFile
|
|
40
|
+
*/
|
|
41
|
+
sizeBytes: number;
|
|
42
|
+
/**
|
|
43
|
+
* Freshly-signed GET URL; do not persist.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof StudyGuideFile
|
|
46
|
+
*/
|
|
47
|
+
previewUrl: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the StudyGuideFile interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfStudyGuideFile(value: object): value is StudyGuideFile;
|
|
53
|
+
export declare function StudyGuideFileFromJSON(json: any): StudyGuideFile;
|
|
54
|
+
export declare function StudyGuideFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideFile;
|
|
55
|
+
export declare function StudyGuideFileToJSON(json: any): StudyGuideFile;
|
|
56
|
+
export declare function StudyGuideFileToJSONTyped(value?: StudyGuideFile | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
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.instanceOfStudyGuideFile = instanceOfStudyGuideFile;
|
|
17
|
+
exports.StudyGuideFileFromJSON = StudyGuideFileFromJSON;
|
|
18
|
+
exports.StudyGuideFileFromJSONTyped = StudyGuideFileFromJSONTyped;
|
|
19
|
+
exports.StudyGuideFileToJSON = StudyGuideFileToJSON;
|
|
20
|
+
exports.StudyGuideFileToJSONTyped = StudyGuideFileToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the StudyGuideFile interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfStudyGuideFile(value) {
|
|
25
|
+
if (!('userFileId' in value) || value['userFileId'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('previewUrl' in value) || value['previewUrl'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function StudyGuideFileFromJSON(json) {
|
|
38
|
+
return StudyGuideFileFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function StudyGuideFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'userFileId': json['userFileId'],
|
|
46
|
+
'name': json['name'],
|
|
47
|
+
'mimeType': json['mimeType'],
|
|
48
|
+
'sizeBytes': json['sizeBytes'],
|
|
49
|
+
'previewUrl': json['previewUrl'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
function StudyGuideFileToJSON(json) {
|
|
53
|
+
return StudyGuideFileToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
function StudyGuideFileToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'userFileId': value['userFileId'],
|
|
61
|
+
'name': value['name'],
|
|
62
|
+
'mimeType': value['mimeType'],
|
|
63
|
+
'sizeBytes': value['sizeBytes'],
|
|
64
|
+
'previewUrl': value['previewUrl'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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 StudyGuideListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface StudyGuideListItem {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof StudyGuideListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof StudyGuideListItem
|
|
28
|
+
*/
|
|
29
|
+
studySpaceId: string | null;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof StudyGuideListItem
|
|
34
|
+
*/
|
|
35
|
+
studyObjectiveId: string | null;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof StudyGuideListItem
|
|
40
|
+
*/
|
|
41
|
+
courseId: string | null;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof StudyGuideListItem
|
|
46
|
+
*/
|
|
47
|
+
title: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof StudyGuideListItem
|
|
52
|
+
*/
|
|
53
|
+
assessmentTitle: string | null;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof StudyGuideListItem
|
|
58
|
+
*/
|
|
59
|
+
status: StudyGuideListItemStatusEnum;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof StudyGuideListItem
|
|
64
|
+
*/
|
|
65
|
+
summary: string | null;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof StudyGuideListItem
|
|
70
|
+
*/
|
|
71
|
+
conceptCount: number;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {Date}
|
|
75
|
+
* @memberof StudyGuideListItem
|
|
76
|
+
*/
|
|
77
|
+
createdAt: Date;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {Date}
|
|
81
|
+
* @memberof StudyGuideListItem
|
|
82
|
+
*/
|
|
83
|
+
updatedAt: Date;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @export
|
|
87
|
+
*/
|
|
88
|
+
export declare const StudyGuideListItemStatusEnum: {
|
|
89
|
+
readonly Generating: "generating";
|
|
90
|
+
readonly Ready: "ready";
|
|
91
|
+
readonly NeedsContext: "needs-context";
|
|
92
|
+
readonly Failed: "failed";
|
|
93
|
+
};
|
|
94
|
+
export type StudyGuideListItemStatusEnum = typeof StudyGuideListItemStatusEnum[keyof typeof StudyGuideListItemStatusEnum];
|
|
95
|
+
/**
|
|
96
|
+
* Check if a given object implements the StudyGuideListItem interface.
|
|
97
|
+
*/
|
|
98
|
+
export declare function instanceOfStudyGuideListItem(value: object): value is StudyGuideListItem;
|
|
99
|
+
export declare function StudyGuideListItemFromJSON(json: any): StudyGuideListItem;
|
|
100
|
+
export declare function StudyGuideListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideListItem;
|
|
101
|
+
export declare function StudyGuideListItemToJSON(json: any): StudyGuideListItem;
|
|
102
|
+
export declare function StudyGuideListItemToJSONTyped(value?: StudyGuideListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,100 @@
|
|
|
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.StudyGuideListItemStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfStudyGuideListItem = instanceOfStudyGuideListItem;
|
|
18
|
+
exports.StudyGuideListItemFromJSON = StudyGuideListItemFromJSON;
|
|
19
|
+
exports.StudyGuideListItemFromJSONTyped = StudyGuideListItemFromJSONTyped;
|
|
20
|
+
exports.StudyGuideListItemToJSON = StudyGuideListItemToJSON;
|
|
21
|
+
exports.StudyGuideListItemToJSONTyped = StudyGuideListItemToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.StudyGuideListItemStatusEnum = {
|
|
26
|
+
Generating: 'generating',
|
|
27
|
+
Ready: 'ready',
|
|
28
|
+
NeedsContext: 'needs-context',
|
|
29
|
+
Failed: 'failed'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the StudyGuideListItem interface.
|
|
33
|
+
*/
|
|
34
|
+
function instanceOfStudyGuideListItem(value) {
|
|
35
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('assessmentTitle' in value) || value['assessmentTitle'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('summary' in value) || value['summary'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('conceptCount' in value) || value['conceptCount'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
return true;
|
|
58
|
+
}
|
|
59
|
+
function StudyGuideListItemFromJSON(json) {
|
|
60
|
+
return StudyGuideListItemFromJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
function StudyGuideListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
63
|
+
if (json == null) {
|
|
64
|
+
return json;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
'id': json['id'],
|
|
68
|
+
'studySpaceId': json['studySpaceId'],
|
|
69
|
+
'studyObjectiveId': json['studyObjectiveId'],
|
|
70
|
+
'courseId': json['courseId'],
|
|
71
|
+
'title': json['title'],
|
|
72
|
+
'assessmentTitle': json['assessmentTitle'],
|
|
73
|
+
'status': json['status'],
|
|
74
|
+
'summary': json['summary'],
|
|
75
|
+
'conceptCount': json['conceptCount'],
|
|
76
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
77
|
+
'updatedAt': (new Date(json['updatedAt'])),
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
function StudyGuideListItemToJSON(json) {
|
|
81
|
+
return StudyGuideListItemToJSONTyped(json, false);
|
|
82
|
+
}
|
|
83
|
+
function StudyGuideListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
84
|
+
if (value == null) {
|
|
85
|
+
return value;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
'id': value['id'],
|
|
89
|
+
'studySpaceId': value['studySpaceId'],
|
|
90
|
+
'studyObjectiveId': value['studyObjectiveId'],
|
|
91
|
+
'courseId': value['courseId'],
|
|
92
|
+
'title': value['title'],
|
|
93
|
+
'assessmentTitle': value['assessmentTitle'],
|
|
94
|
+
'status': value['status'],
|
|
95
|
+
'summary': value['summary'],
|
|
96
|
+
'conceptCount': value['conceptCount'],
|
|
97
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
98
|
+
'updatedAt': value['updatedAt'].toISOString(),
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
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 StudyGuideQuiz
|
|
16
|
+
*/
|
|
17
|
+
export interface StudyGuideQuiz {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof StudyGuideQuiz
|
|
22
|
+
*/
|
|
23
|
+
quizId: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof StudyGuideQuiz
|
|
28
|
+
*/
|
|
29
|
+
title: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof StudyGuideQuiz
|
|
34
|
+
*/
|
|
35
|
+
mode: StudyGuideQuizModeEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof StudyGuideQuiz
|
|
40
|
+
*/
|
|
41
|
+
questionCount: number;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export declare const StudyGuideQuizModeEnum: {
|
|
47
|
+
readonly Quiz: "quiz";
|
|
48
|
+
readonly Flashcards: "flashcards";
|
|
49
|
+
};
|
|
50
|
+
export type StudyGuideQuizModeEnum = typeof StudyGuideQuizModeEnum[keyof typeof StudyGuideQuizModeEnum];
|
|
51
|
+
/**
|
|
52
|
+
* Check if a given object implements the StudyGuideQuiz interface.
|
|
53
|
+
*/
|
|
54
|
+
export declare function instanceOfStudyGuideQuiz(value: object): value is StudyGuideQuiz;
|
|
55
|
+
export declare function StudyGuideQuizFromJSON(json: any): StudyGuideQuiz;
|
|
56
|
+
export declare function StudyGuideQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideQuiz;
|
|
57
|
+
export declare function StudyGuideQuizToJSON(json: any): StudyGuideQuiz;
|
|
58
|
+
export declare function StudyGuideQuizToJSONTyped(value?: StudyGuideQuiz | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,70 @@
|
|
|
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.StudyGuideQuizModeEnum = void 0;
|
|
17
|
+
exports.instanceOfStudyGuideQuiz = instanceOfStudyGuideQuiz;
|
|
18
|
+
exports.StudyGuideQuizFromJSON = StudyGuideQuizFromJSON;
|
|
19
|
+
exports.StudyGuideQuizFromJSONTyped = StudyGuideQuizFromJSONTyped;
|
|
20
|
+
exports.StudyGuideQuizToJSON = StudyGuideQuizToJSON;
|
|
21
|
+
exports.StudyGuideQuizToJSONTyped = StudyGuideQuizToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.StudyGuideQuizModeEnum = {
|
|
26
|
+
Quiz: 'quiz',
|
|
27
|
+
Flashcards: 'flashcards'
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Check if a given object implements the StudyGuideQuiz interface.
|
|
31
|
+
*/
|
|
32
|
+
function instanceOfStudyGuideQuiz(value) {
|
|
33
|
+
if (!('quizId' in value) || value['quizId'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('mode' in value) || value['mode'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('questionCount' in value) || value['questionCount'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
function StudyGuideQuizFromJSON(json) {
|
|
44
|
+
return StudyGuideQuizFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function StudyGuideQuizFromJSONTyped(json, ignoreDiscriminator) {
|
|
47
|
+
if (json == null) {
|
|
48
|
+
return json;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'quizId': json['quizId'],
|
|
52
|
+
'title': json['title'],
|
|
53
|
+
'mode': json['mode'],
|
|
54
|
+
'questionCount': json['questionCount'],
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
function StudyGuideQuizToJSON(json) {
|
|
58
|
+
return StudyGuideQuizToJSONTyped(json, false);
|
|
59
|
+
}
|
|
60
|
+
function StudyGuideQuizToJSONTyped(value, ignoreDiscriminator = false) {
|
|
61
|
+
if (value == null) {
|
|
62
|
+
return value;
|
|
63
|
+
}
|
|
64
|
+
return {
|
|
65
|
+
'quizId': value['quizId'],
|
|
66
|
+
'title': value['title'],
|
|
67
|
+
'mode': value['mode'],
|
|
68
|
+
'questionCount': value['questionCount'],
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
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 StudyGuideSourceSummary
|
|
16
|
+
*/
|
|
17
|
+
export interface StudyGuideSourceSummary {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof StudyGuideSourceSummary
|
|
22
|
+
*/
|
|
23
|
+
canvasItemText: boolean;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {boolean}
|
|
27
|
+
* @memberof StudyGuideSourceSummary
|
|
28
|
+
*/
|
|
29
|
+
syllabus: boolean;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {boolean}
|
|
33
|
+
* @memberof StudyGuideSourceSummary
|
|
34
|
+
*/
|
|
35
|
+
learnerContext: boolean;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof StudyGuideSourceSummary
|
|
40
|
+
*/
|
|
41
|
+
attachmentCount: number;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof StudyGuideSourceSummary
|
|
46
|
+
*/
|
|
47
|
+
objectiveConceptCount: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the StudyGuideSourceSummary interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfStudyGuideSourceSummary(value: object): value is StudyGuideSourceSummary;
|
|
53
|
+
export declare function StudyGuideSourceSummaryFromJSON(json: any): StudyGuideSourceSummary;
|
|
54
|
+
export declare function StudyGuideSourceSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideSourceSummary;
|
|
55
|
+
export declare function StudyGuideSourceSummaryToJSON(json: any): StudyGuideSourceSummary;
|
|
56
|
+
export declare function StudyGuideSourceSummaryToJSONTyped(value?: StudyGuideSourceSummary | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
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.instanceOfStudyGuideSourceSummary = instanceOfStudyGuideSourceSummary;
|
|
17
|
+
exports.StudyGuideSourceSummaryFromJSON = StudyGuideSourceSummaryFromJSON;
|
|
18
|
+
exports.StudyGuideSourceSummaryFromJSONTyped = StudyGuideSourceSummaryFromJSONTyped;
|
|
19
|
+
exports.StudyGuideSourceSummaryToJSON = StudyGuideSourceSummaryToJSON;
|
|
20
|
+
exports.StudyGuideSourceSummaryToJSONTyped = StudyGuideSourceSummaryToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the StudyGuideSourceSummary interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfStudyGuideSourceSummary(value) {
|
|
25
|
+
if (!('canvasItemText' in value) || value['canvasItemText'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('syllabus' in value) || value['syllabus'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('learnerContext' in value) || value['learnerContext'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('attachmentCount' in value) || value['attachmentCount'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('objectiveConceptCount' in value) || value['objectiveConceptCount'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function StudyGuideSourceSummaryFromJSON(json) {
|
|
38
|
+
return StudyGuideSourceSummaryFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function StudyGuideSourceSummaryFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'canvasItemText': json['canvasItemText'],
|
|
46
|
+
'syllabus': json['syllabus'],
|
|
47
|
+
'learnerContext': json['learnerContext'],
|
|
48
|
+
'attachmentCount': json['attachmentCount'],
|
|
49
|
+
'objectiveConceptCount': json['objectiveConceptCount'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
function StudyGuideSourceSummaryToJSON(json) {
|
|
53
|
+
return StudyGuideSourceSummaryToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
function StudyGuideSourceSummaryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'canvasItemText': value['canvasItemText'],
|
|
61
|
+
'syllabus': value['syllabus'],
|
|
62
|
+
'learnerContext': value['learnerContext'],
|
|
63
|
+
'attachmentCount': value['attachmentCount'],
|
|
64
|
+
'objectiveConceptCount': value['objectiveConceptCount'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -48,6 +48,7 @@ export declare const UserFileAssociationKindEnum: {
|
|
|
48
48
|
readonly Message: "message";
|
|
49
49
|
readonly StudyObjective: "study_objective";
|
|
50
50
|
readonly ObjectiveResource: "objective_resource";
|
|
51
|
+
readonly StudyGuide: "study_guide";
|
|
51
52
|
};
|
|
52
53
|
export type UserFileAssociationKindEnum = typeof UserFileAssociationKindEnum[keyof typeof UserFileAssociationKindEnum];
|
|
53
54
|
/**
|
|
@@ -26,7 +26,8 @@ exports.UserFileAssociationKindEnum = {
|
|
|
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 UserFileAssociation interface.
|
package/dist/models/index.d.ts
CHANGED
|
@@ -95,6 +95,7 @@ export * from './ConceptChange';
|
|
|
95
95
|
export * from './ConceptDiagramDetail';
|
|
96
96
|
export * from './ConceptDiagramGalleryItem';
|
|
97
97
|
export * from './ConceptImageGalleryItem';
|
|
98
|
+
export * from './ConceptMediaFlagResult';
|
|
98
99
|
export * from './CreateAccountRequest';
|
|
99
100
|
export * from './CreateChatRequest';
|
|
100
101
|
export * from './CreateFeatureDto';
|
|
@@ -104,6 +105,8 @@ export * from './CreateMessagesResponse';
|
|
|
104
105
|
export * from './CreateObjectiveResourceDto';
|
|
105
106
|
export * from './CreatePlanDto';
|
|
106
107
|
export * from './CreatePracticeQuizRequest';
|
|
108
|
+
export * from './CreateStudyGuideQuizRequest';
|
|
109
|
+
export * from './CreateStudyGuideRequest';
|
|
107
110
|
export * from './CreateStudyObjectiveDto';
|
|
108
111
|
export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
|
|
109
112
|
export * from './CreateStudyObjectiveDtoCanvasObject';
|
|
@@ -139,6 +142,7 @@ export * from './PaginatedObjectiveResources';
|
|
|
139
142
|
export * from './PaginatedQuizSessions';
|
|
140
143
|
export * from './PaginatedQuizzes';
|
|
141
144
|
export * from './PaginatedResources';
|
|
145
|
+
export * from './PaginatedStudyGuides';
|
|
142
146
|
export * from './PaginatedStudyObjectives';
|
|
143
147
|
export * from './PaginatedTaxonomies';
|
|
144
148
|
export * from './PaginatedUserConcepts';
|
|
@@ -160,6 +164,7 @@ export * from './QuizSessionSummary';
|
|
|
160
164
|
export * from './QuizSharing';
|
|
161
165
|
export * from './QuizWithQuestions';
|
|
162
166
|
export * from './RecordQuizQuestionViewRequest';
|
|
167
|
+
export * from './RegenerateStudyGuideRequest';
|
|
163
168
|
export * from './ResourceActivity';
|
|
164
169
|
export * from './ResourceChat';
|
|
165
170
|
export * from './ResourceListItem';
|
|
@@ -172,6 +177,12 @@ export * from './Score';
|
|
|
172
177
|
export * from './ScoreByTypeValue';
|
|
173
178
|
export * from './ServiceToken';
|
|
174
179
|
export * from './SharedQuiz';
|
|
180
|
+
export * from './StudyGuide';
|
|
181
|
+
export * from './StudyGuideConcept';
|
|
182
|
+
export * from './StudyGuideFile';
|
|
183
|
+
export * from './StudyGuideListItem';
|
|
184
|
+
export * from './StudyGuideQuiz';
|
|
185
|
+
export * from './StudyGuideSourceSummary';
|
|
175
186
|
export * from './StudyObjective';
|
|
176
187
|
export * from './StudyObjectiveAccess';
|
|
177
188
|
export * from './StudyObjectiveCanvasDocument';
|
package/dist/models/index.js
CHANGED
|
@@ -113,6 +113,7 @@ __exportStar(require("./ConceptChange"), exports);
|
|
|
113
113
|
__exportStar(require("./ConceptDiagramDetail"), exports);
|
|
114
114
|
__exportStar(require("./ConceptDiagramGalleryItem"), exports);
|
|
115
115
|
__exportStar(require("./ConceptImageGalleryItem"), exports);
|
|
116
|
+
__exportStar(require("./ConceptMediaFlagResult"), exports);
|
|
116
117
|
__exportStar(require("./CreateAccountRequest"), exports);
|
|
117
118
|
__exportStar(require("./CreateChatRequest"), exports);
|
|
118
119
|
__exportStar(require("./CreateFeatureDto"), exports);
|
|
@@ -122,6 +123,8 @@ __exportStar(require("./CreateMessagesResponse"), exports);
|
|
|
122
123
|
__exportStar(require("./CreateObjectiveResourceDto"), exports);
|
|
123
124
|
__exportStar(require("./CreatePlanDto"), exports);
|
|
124
125
|
__exportStar(require("./CreatePracticeQuizRequest"), exports);
|
|
126
|
+
__exportStar(require("./CreateStudyGuideQuizRequest"), exports);
|
|
127
|
+
__exportStar(require("./CreateStudyGuideRequest"), exports);
|
|
125
128
|
__exportStar(require("./CreateStudyObjectiveDto"), exports);
|
|
126
129
|
__exportStar(require("./CreateStudyObjectiveDtoCanvasDocumentsInner"), exports);
|
|
127
130
|
__exportStar(require("./CreateStudyObjectiveDtoCanvasObject"), exports);
|
|
@@ -157,6 +160,7 @@ __exportStar(require("./PaginatedObjectiveResources"), exports);
|
|
|
157
160
|
__exportStar(require("./PaginatedQuizSessions"), exports);
|
|
158
161
|
__exportStar(require("./PaginatedQuizzes"), exports);
|
|
159
162
|
__exportStar(require("./PaginatedResources"), exports);
|
|
163
|
+
__exportStar(require("./PaginatedStudyGuides"), exports);
|
|
160
164
|
__exportStar(require("./PaginatedStudyObjectives"), exports);
|
|
161
165
|
__exportStar(require("./PaginatedTaxonomies"), exports);
|
|
162
166
|
__exportStar(require("./PaginatedUserConcepts"), exports);
|
|
@@ -178,6 +182,7 @@ __exportStar(require("./QuizSessionSummary"), exports);
|
|
|
178
182
|
__exportStar(require("./QuizSharing"), exports);
|
|
179
183
|
__exportStar(require("./QuizWithQuestions"), exports);
|
|
180
184
|
__exportStar(require("./RecordQuizQuestionViewRequest"), exports);
|
|
185
|
+
__exportStar(require("./RegenerateStudyGuideRequest"), exports);
|
|
181
186
|
__exportStar(require("./ResourceActivity"), exports);
|
|
182
187
|
__exportStar(require("./ResourceChat"), exports);
|
|
183
188
|
__exportStar(require("./ResourceListItem"), exports);
|
|
@@ -190,6 +195,12 @@ __exportStar(require("./Score"), exports);
|
|
|
190
195
|
__exportStar(require("./ScoreByTypeValue"), exports);
|
|
191
196
|
__exportStar(require("./ServiceToken"), exports);
|
|
192
197
|
__exportStar(require("./SharedQuiz"), exports);
|
|
198
|
+
__exportStar(require("./StudyGuide"), exports);
|
|
199
|
+
__exportStar(require("./StudyGuideConcept"), exports);
|
|
200
|
+
__exportStar(require("./StudyGuideFile"), exports);
|
|
201
|
+
__exportStar(require("./StudyGuideListItem"), exports);
|
|
202
|
+
__exportStar(require("./StudyGuideQuiz"), exports);
|
|
203
|
+
__exportStar(require("./StudyGuideSourceSummary"), exports);
|
|
193
204
|
__exportStar(require("./StudyObjective"), exports);
|
|
194
205
|
__exportStar(require("./StudyObjectiveAccess"), exports);
|
|
195
206
|
__exportStar(require("./StudyObjectiveCanvasDocument"), exports);
|