@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,59 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the StudyGuideFile interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfStudyGuideFile(value) {
|
|
18
|
+
if (!('userFileId' in value) || value['userFileId'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('previewUrl' in value) || value['previewUrl'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
export function StudyGuideFileFromJSON(json) {
|
|
31
|
+
return StudyGuideFileFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function StudyGuideFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'userFileId': json['userFileId'],
|
|
39
|
+
'name': json['name'],
|
|
40
|
+
'mimeType': json['mimeType'],
|
|
41
|
+
'sizeBytes': json['sizeBytes'],
|
|
42
|
+
'previewUrl': json['previewUrl'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
export function StudyGuideFileToJSON(json) {
|
|
46
|
+
return StudyGuideFileToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
export function StudyGuideFileToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'userFileId': value['userFileId'],
|
|
54
|
+
'name': value['name'],
|
|
55
|
+
'mimeType': value['mimeType'],
|
|
56
|
+
'sizeBytes': value['sizeBytes'],
|
|
57
|
+
'previewUrl': value['previewUrl'],
|
|
58
|
+
};
|
|
59
|
+
}
|
|
@@ -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,92 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const StudyGuideListItemStatusEnum = {
|
|
18
|
+
Generating: 'generating',
|
|
19
|
+
Ready: 'ready',
|
|
20
|
+
NeedsContext: 'needs-context',
|
|
21
|
+
Failed: 'failed'
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the StudyGuideListItem interface.
|
|
25
|
+
*/
|
|
26
|
+
export function instanceOfStudyGuideListItem(value) {
|
|
27
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('assessmentTitle' in value) || value['assessmentTitle'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('summary' in value) || value['summary'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('conceptCount' in value) || value['conceptCount'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
export function StudyGuideListItemFromJSON(json) {
|
|
52
|
+
return StudyGuideListItemFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
export function StudyGuideListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
55
|
+
if (json == null) {
|
|
56
|
+
return json;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'id': json['id'],
|
|
60
|
+
'studySpaceId': json['studySpaceId'],
|
|
61
|
+
'studyObjectiveId': json['studyObjectiveId'],
|
|
62
|
+
'courseId': json['courseId'],
|
|
63
|
+
'title': json['title'],
|
|
64
|
+
'assessmentTitle': json['assessmentTitle'],
|
|
65
|
+
'status': json['status'],
|
|
66
|
+
'summary': json['summary'],
|
|
67
|
+
'conceptCount': json['conceptCount'],
|
|
68
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
69
|
+
'updatedAt': (new Date(json['updatedAt'])),
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
export function StudyGuideListItemToJSON(json) {
|
|
73
|
+
return StudyGuideListItemToJSONTyped(json, false);
|
|
74
|
+
}
|
|
75
|
+
export function StudyGuideListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
76
|
+
if (value == null) {
|
|
77
|
+
return value;
|
|
78
|
+
}
|
|
79
|
+
return {
|
|
80
|
+
'id': value['id'],
|
|
81
|
+
'studySpaceId': value['studySpaceId'],
|
|
82
|
+
'studyObjectiveId': value['studyObjectiveId'],
|
|
83
|
+
'courseId': value['courseId'],
|
|
84
|
+
'title': value['title'],
|
|
85
|
+
'assessmentTitle': value['assessmentTitle'],
|
|
86
|
+
'status': value['status'],
|
|
87
|
+
'summary': value['summary'],
|
|
88
|
+
'conceptCount': value['conceptCount'],
|
|
89
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
90
|
+
'updatedAt': value['updatedAt'].toISOString(),
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -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,62 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const StudyGuideQuizModeEnum = {
|
|
18
|
+
Quiz: 'quiz',
|
|
19
|
+
Flashcards: 'flashcards'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the StudyGuideQuiz interface.
|
|
23
|
+
*/
|
|
24
|
+
export function instanceOfStudyGuideQuiz(value) {
|
|
25
|
+
if (!('quizId' in value) || value['quizId'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('mode' in value) || value['mode'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('questionCount' in value) || value['questionCount'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
export function StudyGuideQuizFromJSON(json) {
|
|
36
|
+
return StudyGuideQuizFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
export function StudyGuideQuizFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'quizId': json['quizId'],
|
|
44
|
+
'title': json['title'],
|
|
45
|
+
'mode': json['mode'],
|
|
46
|
+
'questionCount': json['questionCount'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
export function StudyGuideQuizToJSON(json) {
|
|
50
|
+
return StudyGuideQuizToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
export function StudyGuideQuizToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'quizId': value['quizId'],
|
|
58
|
+
'title': value['title'],
|
|
59
|
+
'mode': value['mode'],
|
|
60
|
+
'questionCount': value['questionCount'],
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -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,59 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the StudyGuideSourceSummary interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfStudyGuideSourceSummary(value) {
|
|
18
|
+
if (!('canvasItemText' in value) || value['canvasItemText'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('syllabus' in value) || value['syllabus'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('learnerContext' in value) || value['learnerContext'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('attachmentCount' in value) || value['attachmentCount'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('objectiveConceptCount' in value) || value['objectiveConceptCount'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
export function StudyGuideSourceSummaryFromJSON(json) {
|
|
31
|
+
return StudyGuideSourceSummaryFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function StudyGuideSourceSummaryFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'canvasItemText': json['canvasItemText'],
|
|
39
|
+
'syllabus': json['syllabus'],
|
|
40
|
+
'learnerContext': json['learnerContext'],
|
|
41
|
+
'attachmentCount': json['attachmentCount'],
|
|
42
|
+
'objectiveConceptCount': json['objectiveConceptCount'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
export function StudyGuideSourceSummaryToJSON(json) {
|
|
46
|
+
return StudyGuideSourceSummaryToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
export function StudyGuideSourceSummaryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'canvasItemText': value['canvasItemText'],
|
|
54
|
+
'syllabus': value['syllabus'],
|
|
55
|
+
'learnerContext': value['learnerContext'],
|
|
56
|
+
'attachmentCount': value['attachmentCount'],
|
|
57
|
+
'objectiveConceptCount': value['objectiveConceptCount'],
|
|
58
|
+
};
|
|
59
|
+
}
|
|
@@ -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
|
/**
|
|
@@ -18,7 +18,8 @@ export const UserFileAssociationKindEnum = {
|
|
|
18
18
|
Chat: 'chat',
|
|
19
19
|
Message: 'message',
|
|
20
20
|
StudyObjective: 'study_objective',
|
|
21
|
-
ObjectiveResource: 'objective_resource'
|
|
21
|
+
ObjectiveResource: 'objective_resource',
|
|
22
|
+
StudyGuide: 'study_guide'
|
|
22
23
|
};
|
|
23
24
|
/**
|
|
24
25
|
* Check if a given object implements the UserFileAssociation interface.
|
|
@@ -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/esm/models/index.js
CHANGED
|
@@ -97,6 +97,7 @@ export * from './ConceptChange';
|
|
|
97
97
|
export * from './ConceptDiagramDetail';
|
|
98
98
|
export * from './ConceptDiagramGalleryItem';
|
|
99
99
|
export * from './ConceptImageGalleryItem';
|
|
100
|
+
export * from './ConceptMediaFlagResult';
|
|
100
101
|
export * from './CreateAccountRequest';
|
|
101
102
|
export * from './CreateChatRequest';
|
|
102
103
|
export * from './CreateFeatureDto';
|
|
@@ -106,6 +107,8 @@ export * from './CreateMessagesResponse';
|
|
|
106
107
|
export * from './CreateObjectiveResourceDto';
|
|
107
108
|
export * from './CreatePlanDto';
|
|
108
109
|
export * from './CreatePracticeQuizRequest';
|
|
110
|
+
export * from './CreateStudyGuideQuizRequest';
|
|
111
|
+
export * from './CreateStudyGuideRequest';
|
|
109
112
|
export * from './CreateStudyObjectiveDto';
|
|
110
113
|
export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
|
|
111
114
|
export * from './CreateStudyObjectiveDtoCanvasObject';
|
|
@@ -141,6 +144,7 @@ export * from './PaginatedObjectiveResources';
|
|
|
141
144
|
export * from './PaginatedQuizSessions';
|
|
142
145
|
export * from './PaginatedQuizzes';
|
|
143
146
|
export * from './PaginatedResources';
|
|
147
|
+
export * from './PaginatedStudyGuides';
|
|
144
148
|
export * from './PaginatedStudyObjectives';
|
|
145
149
|
export * from './PaginatedTaxonomies';
|
|
146
150
|
export * from './PaginatedUserConcepts';
|
|
@@ -162,6 +166,7 @@ export * from './QuizSessionSummary';
|
|
|
162
166
|
export * from './QuizSharing';
|
|
163
167
|
export * from './QuizWithQuestions';
|
|
164
168
|
export * from './RecordQuizQuestionViewRequest';
|
|
169
|
+
export * from './RegenerateStudyGuideRequest';
|
|
165
170
|
export * from './ResourceActivity';
|
|
166
171
|
export * from './ResourceChat';
|
|
167
172
|
export * from './ResourceListItem';
|
|
@@ -174,6 +179,12 @@ export * from './Score';
|
|
|
174
179
|
export * from './ScoreByTypeValue';
|
|
175
180
|
export * from './ServiceToken';
|
|
176
181
|
export * from './SharedQuiz';
|
|
182
|
+
export * from './StudyGuide';
|
|
183
|
+
export * from './StudyGuideConcept';
|
|
184
|
+
export * from './StudyGuideFile';
|
|
185
|
+
export * from './StudyGuideListItem';
|
|
186
|
+
export * from './StudyGuideQuiz';
|
|
187
|
+
export * from './StudyGuideSourceSummary';
|
|
177
188
|
export * from './StudyObjective';
|
|
178
189
|
export * from './StudyObjectiveAccess';
|
|
179
190
|
export * from './StudyObjectiveCanvasDocument';
|
|
@@ -72,11 +72,29 @@ export interface AdminConceptDiagram {
|
|
|
72
72
|
*/
|
|
73
73
|
hiddenAt: Date | null;
|
|
74
74
|
/**
|
|
75
|
-
* Who hid it, when that account user is in the caller's account.
|
|
75
|
+
* Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
|
|
76
76
|
* @type {AdminConceptMediaActor}
|
|
77
77
|
* @memberof AdminConceptDiagram
|
|
78
78
|
*/
|
|
79
79
|
hiddenBy: AdminConceptMediaActor | null;
|
|
80
|
+
/**
|
|
81
|
+
* True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
|
|
82
|
+
* @type {boolean}
|
|
83
|
+
* @memberof AdminConceptDiagram
|
|
84
|
+
*/
|
|
85
|
+
hiddenByFlag: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* 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).
|
|
88
|
+
* @type {Date}
|
|
89
|
+
* @memberof AdminConceptDiagram
|
|
90
|
+
*/
|
|
91
|
+
approvedAt: Date | null;
|
|
92
|
+
/**
|
|
93
|
+
* Who approved it, when that account user is in the caller's account.
|
|
94
|
+
* @type {AdminConceptMediaActor}
|
|
95
|
+
* @memberof AdminConceptDiagram
|
|
96
|
+
*/
|
|
97
|
+
approvedBy: AdminConceptMediaActor | null;
|
|
80
98
|
/**
|
|
81
99
|
*
|
|
82
100
|
* @type {Date}
|
|
@@ -60,6 +60,12 @@ function instanceOfAdminConceptDiagram(value) {
|
|
|
60
60
|
return false;
|
|
61
61
|
if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
|
|
62
62
|
return false;
|
|
63
|
+
if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('approvedAt' in value) || value['approvedAt'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
if (!('approvedBy' in value) || value['approvedBy'] === undefined)
|
|
68
|
+
return false;
|
|
63
69
|
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
64
70
|
return false;
|
|
65
71
|
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
@@ -100,6 +106,9 @@ function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
100
106
|
'createdAt': (new Date(json['createdAt'])),
|
|
101
107
|
'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
|
|
102
108
|
'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['hiddenBy']),
|
|
109
|
+
'hiddenByFlag': json['hiddenByFlag'],
|
|
110
|
+
'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
|
|
111
|
+
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
|
|
103
112
|
'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
|
|
104
113
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
|
|
105
114
|
'model': json['model'],
|
|
@@ -130,6 +139,9 @@ function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
130
139
|
'createdAt': value['createdAt'].toISOString(),
|
|
131
140
|
'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
|
|
132
141
|
'hiddenBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['hiddenBy']),
|
|
142
|
+
'hiddenByFlag': value['hiddenByFlag'],
|
|
143
|
+
'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
|
|
144
|
+
'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
|
|
133
145
|
'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
|
|
134
146
|
'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
|
|
135
147
|
'model': value['model'],
|