@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.
Files changed (100) hide show
  1. package/README.md +16 -0
  2. package/dist/apis/AdminApi.d.ts +12 -12
  3. package/dist/apis/AdminApi.js +12 -12
  4. package/dist/apis/ConceptDiagramsApi.d.ts +2 -2
  5. package/dist/apis/ConceptDiagramsApi.js +2 -2
  6. package/dist/apis/ConceptImagesApi.d.ts +2 -2
  7. package/dist/apis/ConceptImagesApi.js +2 -2
  8. package/dist/apis/StudyGuidesApi.d.ts +112 -0
  9. package/dist/apis/StudyGuidesApi.js +312 -0
  10. package/dist/apis/index.d.ts +1 -0
  11. package/dist/apis/index.js +1 -0
  12. package/dist/esm/apis/AdminApi.d.ts +12 -12
  13. package/dist/esm/apis/AdminApi.js +12 -12
  14. package/dist/esm/apis/ConceptDiagramsApi.d.ts +2 -2
  15. package/dist/esm/apis/ConceptDiagramsApi.js +2 -2
  16. package/dist/esm/apis/ConceptImagesApi.d.ts +2 -2
  17. package/dist/esm/apis/ConceptImagesApi.js +2 -2
  18. package/dist/esm/apis/StudyGuidesApi.d.ts +112 -0
  19. package/dist/esm/apis/StudyGuidesApi.js +308 -0
  20. package/dist/esm/apis/index.d.ts +1 -0
  21. package/dist/esm/apis/index.js +1 -0
  22. package/dist/esm/models/AdminConceptDiagram.d.ts +7 -1
  23. package/dist/esm/models/AdminConceptDiagram.js +4 -0
  24. package/dist/esm/models/AdminConceptDiagramDetail.d.ts +7 -1
  25. package/dist/esm/models/AdminConceptDiagramDetail.js +4 -0
  26. package/dist/esm/models/AdminConceptImage.d.ts +7 -1
  27. package/dist/esm/models/AdminConceptImage.js +4 -0
  28. package/dist/esm/models/AdminConceptImageDetail.d.ts +7 -1
  29. package/dist/esm/models/AdminConceptImageDetail.js +4 -0
  30. package/dist/esm/models/AdminShownConceptDiagram.d.ts +7 -1
  31. package/dist/esm/models/AdminShownConceptDiagram.js +4 -0
  32. package/dist/esm/models/AdminShownConceptImage.d.ts +7 -1
  33. package/dist/esm/models/AdminShownConceptImage.js +4 -0
  34. package/dist/esm/models/AssociateUserFileRequest.d.ts +1 -0
  35. package/dist/esm/models/AssociateUserFileRequest.js +2 -1
  36. package/dist/esm/models/ConceptMediaFlagResult.d.ts +1 -1
  37. package/dist/esm/models/CreateStudyGuideQuizRequest.d.ts +46 -0
  38. package/dist/esm/models/CreateStudyGuideQuizRequest.js +50 -0
  39. package/dist/esm/models/CreateStudyGuideRequest.d.ts +74 -0
  40. package/dist/esm/models/CreateStudyGuideRequest.js +55 -0
  41. package/dist/esm/models/PaginatedStudyGuides.d.ts +39 -0
  42. package/dist/esm/models/PaginatedStudyGuides.js +48 -0
  43. package/dist/esm/models/RegenerateStudyGuideRequest.d.ts +38 -0
  44. package/dist/esm/models/RegenerateStudyGuideRequest.js +43 -0
  45. package/dist/esm/models/StudyGuide.d.ts +153 -0
  46. package/dist/esm/models/StudyGuide.js +127 -0
  47. package/dist/esm/models/StudyGuideConcept.d.ts +68 -0
  48. package/dist/esm/models/StudyGuideConcept.js +67 -0
  49. package/dist/esm/models/StudyGuideFile.d.ts +56 -0
  50. package/dist/esm/models/StudyGuideFile.js +59 -0
  51. package/dist/esm/models/StudyGuideListItem.d.ts +102 -0
  52. package/dist/esm/models/StudyGuideListItem.js +92 -0
  53. package/dist/esm/models/StudyGuideQuiz.d.ts +58 -0
  54. package/dist/esm/models/StudyGuideQuiz.js +62 -0
  55. package/dist/esm/models/StudyGuideSourceSummary.d.ts +56 -0
  56. package/dist/esm/models/StudyGuideSourceSummary.js +59 -0
  57. package/dist/esm/models/UserFileAssociation.d.ts +1 -0
  58. package/dist/esm/models/UserFileAssociation.js +2 -1
  59. package/dist/esm/models/index.d.ts +10 -0
  60. package/dist/esm/models/index.js +10 -0
  61. package/dist/models/AdminConceptDiagram.d.ts +7 -1
  62. package/dist/models/AdminConceptDiagram.js +4 -0
  63. package/dist/models/AdminConceptDiagramDetail.d.ts +7 -1
  64. package/dist/models/AdminConceptDiagramDetail.js +4 -0
  65. package/dist/models/AdminConceptImage.d.ts +7 -1
  66. package/dist/models/AdminConceptImage.js +4 -0
  67. package/dist/models/AdminConceptImageDetail.d.ts +7 -1
  68. package/dist/models/AdminConceptImageDetail.js +4 -0
  69. package/dist/models/AdminShownConceptDiagram.d.ts +7 -1
  70. package/dist/models/AdminShownConceptDiagram.js +4 -0
  71. package/dist/models/AdminShownConceptImage.d.ts +7 -1
  72. package/dist/models/AdminShownConceptImage.js +4 -0
  73. package/dist/models/AssociateUserFileRequest.d.ts +1 -0
  74. package/dist/models/AssociateUserFileRequest.js +2 -1
  75. package/dist/models/ConceptMediaFlagResult.d.ts +1 -1
  76. package/dist/models/CreateStudyGuideQuizRequest.d.ts +46 -0
  77. package/dist/models/CreateStudyGuideQuizRequest.js +58 -0
  78. package/dist/models/CreateStudyGuideRequest.d.ts +74 -0
  79. package/dist/models/CreateStudyGuideRequest.js +62 -0
  80. package/dist/models/PaginatedStudyGuides.d.ts +39 -0
  81. package/dist/models/PaginatedStudyGuides.js +55 -0
  82. package/dist/models/RegenerateStudyGuideRequest.d.ts +38 -0
  83. package/dist/models/RegenerateStudyGuideRequest.js +50 -0
  84. package/dist/models/StudyGuide.d.ts +153 -0
  85. package/dist/models/StudyGuide.js +135 -0
  86. package/dist/models/StudyGuideConcept.d.ts +68 -0
  87. package/dist/models/StudyGuideConcept.js +74 -0
  88. package/dist/models/StudyGuideFile.d.ts +56 -0
  89. package/dist/models/StudyGuideFile.js +66 -0
  90. package/dist/models/StudyGuideListItem.d.ts +102 -0
  91. package/dist/models/StudyGuideListItem.js +100 -0
  92. package/dist/models/StudyGuideQuiz.d.ts +58 -0
  93. package/dist/models/StudyGuideQuiz.js +70 -0
  94. package/dist/models/StudyGuideSourceSummary.d.ts +56 -0
  95. package/dist/models/StudyGuideSourceSummary.js +66 -0
  96. package/dist/models/UserFileAssociation.d.ts +1 -0
  97. package/dist/models/UserFileAssociation.js +2 -1
  98. package/dist/models/index.d.ts +10 -0
  99. package/dist/models/index.js +10 -0
  100. package/package.json +1 -1
@@ -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.
@@ -105,6 +105,8 @@ export * from './CreateMessagesResponse';
105
105
  export * from './CreateObjectiveResourceDto';
106
106
  export * from './CreatePlanDto';
107
107
  export * from './CreatePracticeQuizRequest';
108
+ export * from './CreateStudyGuideQuizRequest';
109
+ export * from './CreateStudyGuideRequest';
108
110
  export * from './CreateStudyObjectiveDto';
109
111
  export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
110
112
  export * from './CreateStudyObjectiveDtoCanvasObject';
@@ -140,6 +142,7 @@ export * from './PaginatedObjectiveResources';
140
142
  export * from './PaginatedQuizSessions';
141
143
  export * from './PaginatedQuizzes';
142
144
  export * from './PaginatedResources';
145
+ export * from './PaginatedStudyGuides';
143
146
  export * from './PaginatedStudyObjectives';
144
147
  export * from './PaginatedTaxonomies';
145
148
  export * from './PaginatedUserConcepts';
@@ -161,6 +164,7 @@ export * from './QuizSessionSummary';
161
164
  export * from './QuizSharing';
162
165
  export * from './QuizWithQuestions';
163
166
  export * from './RecordQuizQuestionViewRequest';
167
+ export * from './RegenerateStudyGuideRequest';
164
168
  export * from './ResourceActivity';
165
169
  export * from './ResourceChat';
166
170
  export * from './ResourceListItem';
@@ -173,6 +177,12 @@ export * from './Score';
173
177
  export * from './ScoreByTypeValue';
174
178
  export * from './ServiceToken';
175
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';
176
186
  export * from './StudyObjective';
177
187
  export * from './StudyObjectiveAccess';
178
188
  export * from './StudyObjectiveCanvasDocument';
@@ -107,6 +107,8 @@ export * from './CreateMessagesResponse';
107
107
  export * from './CreateObjectiveResourceDto';
108
108
  export * from './CreatePlanDto';
109
109
  export * from './CreatePracticeQuizRequest';
110
+ export * from './CreateStudyGuideQuizRequest';
111
+ export * from './CreateStudyGuideRequest';
110
112
  export * from './CreateStudyObjectiveDto';
111
113
  export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
112
114
  export * from './CreateStudyObjectiveDtoCanvasObject';
@@ -142,6 +144,7 @@ export * from './PaginatedObjectiveResources';
142
144
  export * from './PaginatedQuizSessions';
143
145
  export * from './PaginatedQuizzes';
144
146
  export * from './PaginatedResources';
147
+ export * from './PaginatedStudyGuides';
145
148
  export * from './PaginatedStudyObjectives';
146
149
  export * from './PaginatedTaxonomies';
147
150
  export * from './PaginatedUserConcepts';
@@ -163,6 +166,7 @@ export * from './QuizSessionSummary';
163
166
  export * from './QuizSharing';
164
167
  export * from './QuizWithQuestions';
165
168
  export * from './RecordQuizQuestionViewRequest';
169
+ export * from './RegenerateStudyGuideRequest';
166
170
  export * from './ResourceActivity';
167
171
  export * from './ResourceChat';
168
172
  export * from './ResourceListItem';
@@ -175,6 +179,12 @@ export * from './Score';
175
179
  export * from './ScoreByTypeValue';
176
180
  export * from './ServiceToken';
177
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';
178
188
  export * from './StudyObjective';
179
189
  export * from './StudyObjectiveAccess';
180
190
  export * from './StudyObjectiveCanvasDocument';
@@ -84,7 +84,7 @@ export interface AdminConceptDiagram {
84
84
  */
85
85
  hiddenByFlag: boolean;
86
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).
87
+ * 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).
88
88
  * @type {Date}
89
89
  * @memberof AdminConceptDiagram
90
90
  */
@@ -95,6 +95,12 @@ export interface AdminConceptDiagram {
95
95
  * @memberof AdminConceptDiagram
96
96
  */
97
97
  approvedBy: AdminConceptMediaActor | null;
98
+ /**
99
+ * 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.
100
+ * @type {Date}
101
+ * @memberof AdminConceptDiagram
102
+ */
103
+ flaggedAfterApprovalAt: Date | null;
98
104
  /**
99
105
  *
100
106
  * @type {Date}
@@ -66,6 +66,8 @@ function instanceOfAdminConceptDiagram(value) {
66
66
  return false;
67
67
  if (!('approvedBy' in value) || value['approvedBy'] === undefined)
68
68
  return false;
69
+ if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
70
+ return false;
69
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
70
72
  return false;
71
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -109,6 +111,7 @@ function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
109
111
  'hiddenByFlag': json['hiddenByFlag'],
110
112
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
111
113
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
114
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
112
115
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
113
116
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
114
117
  'model': json['model'],
@@ -142,6 +145,7 @@ function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
142
145
  'hiddenByFlag': value['hiddenByFlag'],
143
146
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
144
147
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
148
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
145
149
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
146
150
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
147
151
  'model': value['model'],
@@ -86,7 +86,7 @@ export interface AdminConceptDiagramDetail {
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 AdminConceptDiagramDetail
92
92
  */
@@ -97,6 +97,12 @@ export interface AdminConceptDiagramDetail {
97
97
  * @memberof AdminConceptDiagramDetail
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 AdminConceptDiagramDetail
104
+ */
105
+ flaggedAfterApprovalAt: Date | null;
100
106
  /**
101
107
  *
102
108
  * @type {Date}
@@ -68,6 +68,8 @@ function instanceOfAdminConceptDiagramDetail(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)
@@ -123,6 +125,7 @@ function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
123
125
  'hiddenByFlag': json['hiddenByFlag'],
124
126
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
125
127
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
128
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
126
129
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
127
130
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
128
131
  'model': json['model'],
@@ -162,6 +165,7 @@ function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false
162
165
  'hiddenByFlag': value['hiddenByFlag'],
163
166
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
164
167
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
168
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
165
169
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
166
170
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
167
171
  'model': value['model'],
@@ -84,7 +84,7 @@ export interface AdminConceptImage {
84
84
  */
85
85
  hiddenByFlag: boolean;
86
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).
87
+ * 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).
88
88
  * @type {Date}
89
89
  * @memberof AdminConceptImage
90
90
  */
@@ -95,6 +95,12 @@ export interface AdminConceptImage {
95
95
  * @memberof AdminConceptImage
96
96
  */
97
97
  approvedBy: AdminConceptMediaActor | null;
98
+ /**
99
+ * 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.
100
+ * @type {Date}
101
+ * @memberof AdminConceptImage
102
+ */
103
+ flaggedAfterApprovalAt: Date | null;
98
104
  /**
99
105
  *
100
106
  * @type {Date}
@@ -66,6 +66,8 @@ function instanceOfAdminConceptImage(value) {
66
66
  return false;
67
67
  if (!('approvedBy' in value) || value['approvedBy'] === undefined)
68
68
  return false;
69
+ if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
70
+ return false;
69
71
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
70
72
  return false;
71
73
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -115,6 +117,7 @@ function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
115
117
  'hiddenByFlag': json['hiddenByFlag'],
116
118
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
117
119
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
120
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
118
121
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
119
122
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
120
123
  'model': json['model'],
@@ -151,6 +154,7 @@ function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
151
154
  'hiddenByFlag': value['hiddenByFlag'],
152
155
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
153
156
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
157
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
154
158
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
155
159
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
156
160
  'model': value['model'],
@@ -86,7 +86,7 @@ export interface AdminConceptImageDetail {
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 AdminConceptImageDetail
92
92
  */
@@ -97,6 +97,12 @@ export interface AdminConceptImageDetail {
97
97
  * @memberof AdminConceptImageDetail
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 AdminConceptImageDetail
104
+ */
105
+ flaggedAfterApprovalAt: Date | null;
100
106
  /**
101
107
  *
102
108
  * @type {Date}
@@ -68,6 +68,8 @@ function instanceOfAdminConceptImageDetail(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)
@@ -129,6 +131,7 @@ function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator) {
129
131
  'hiddenByFlag': json['hiddenByFlag'],
130
132
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
131
133
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['approvedBy']),
134
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
132
135
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
133
136
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorFromJSON)(json['deletedBy']),
134
137
  'model': json['model'],
@@ -171,6 +174,7 @@ function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator = false)
171
174
  'hiddenByFlag': value['hiddenByFlag'],
172
175
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
173
176
  'approvedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['approvedBy']),
177
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
174
178
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
175
179
  'deletedBy': (0, AdminConceptMediaActor_1.AdminConceptMediaActorToJSON)(value['deletedBy']),
176
180
  'model': value['model'],
@@ -86,7 +86,7 @@ export interface AdminShownConceptDiagram {
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 AdminShownConceptDiagram
92
92
  */
@@ -97,6 +97,12 @@ export interface AdminShownConceptDiagram {
97
97
  * @memberof AdminShownConceptDiagram
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 AdminShownConceptDiagram
104
+ */
105
+ flaggedAfterApprovalAt: Date | null;
100
106
  /**
101
107
  *
102
108
  * @type {Date}