@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
@@ -60,6 +60,8 @@ export function instanceOfAdminConceptImageDetail(value) {
60
60
  return false;
61
61
  if (!('approvedBy' in value) || value['approvedBy'] === undefined)
62
62
  return false;
63
+ if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
64
+ return false;
63
65
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
64
66
  return false;
65
67
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -121,6 +123,7 @@ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator)
121
123
  'hiddenByFlag': json['hiddenByFlag'],
122
124
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
123
125
  'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
126
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
124
127
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
125
128
  'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
126
129
  'model': json['model'],
@@ -163,6 +166,7 @@ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator =
163
166
  'hiddenByFlag': value['hiddenByFlag'],
164
167
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
165
168
  'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
169
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
166
170
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
167
171
  'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
168
172
  '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}
@@ -60,6 +60,8 @@ export function instanceOfAdminShownConceptDiagram(value) {
60
60
  return false;
61
61
  if (!('approvedBy' in value) || value['approvedBy'] === undefined)
62
62
  return false;
63
+ if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
64
+ return false;
63
65
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
64
66
  return false;
65
67
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -119,6 +121,7 @@ export function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator)
119
121
  'hiddenByFlag': json['hiddenByFlag'],
120
122
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
121
123
  'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
124
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
122
125
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
123
126
  'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
124
127
  'model': json['model'],
@@ -160,6 +163,7 @@ export function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator =
160
163
  'hiddenByFlag': value['hiddenByFlag'],
161
164
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
162
165
  'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
166
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
163
167
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
164
168
  'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
165
169
  'model': value['model'],
@@ -86,7 +86,7 @@ export interface AdminShownConceptImage {
86
86
  */
87
87
  hiddenByFlag: boolean;
88
88
  /**
89
- * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
89
+ * When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
90
90
  * @type {Date}
91
91
  * @memberof AdminShownConceptImage
92
92
  */
@@ -97,6 +97,12 @@ export interface AdminShownConceptImage {
97
97
  * @memberof AdminShownConceptImage
98
98
  */
99
99
  approvedBy: AdminConceptMediaActor | null;
100
+ /**
101
+ * When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
102
+ * @type {Date}
103
+ * @memberof AdminShownConceptImage
104
+ */
105
+ flaggedAfterApprovalAt: Date | null;
100
106
  /**
101
107
  *
102
108
  * @type {Date}
@@ -60,6 +60,8 @@ export function instanceOfAdminShownConceptImage(value) {
60
60
  return false;
61
61
  if (!('approvedBy' in value) || value['approvedBy'] === undefined)
62
62
  return false;
63
+ if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
64
+ return false;
63
65
  if (!('deletedAt' in value) || value['deletedAt'] === undefined)
64
66
  return false;
65
67
  if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -125,6 +127,7 @@ export function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
125
127
  'hiddenByFlag': json['hiddenByFlag'],
126
128
  'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
127
129
  'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
130
+ 'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
128
131
  'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
129
132
  'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
130
133
  'model': json['model'],
@@ -169,6 +172,7 @@ export function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = f
169
172
  'hiddenByFlag': value['hiddenByFlag'],
170
173
  'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
171
174
  'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
175
+ 'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
172
176
  'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
173
177
  'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
174
178
  'model': value['model'],
@@ -36,6 +36,7 @@ export declare const AssociateUserFileRequestKindEnum: {
36
36
  readonly Message: "message";
37
37
  readonly StudyObjective: "study_objective";
38
38
  readonly ObjectiveResource: "objective_resource";
39
+ readonly StudyGuide: "study_guide";
39
40
  };
40
41
  export type AssociateUserFileRequestKindEnum = typeof AssociateUserFileRequestKindEnum[keyof typeof AssociateUserFileRequestKindEnum];
41
42
  /**
@@ -18,7 +18,8 @@ export const AssociateUserFileRequestKindEnum = {
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 AssociateUserFileRequest interface.
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface ConceptMediaFlagResult {
18
18
  /**
19
- * True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible.
19
+ * True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible (and queued it for admin re-review).
20
20
  * @type {boolean}
21
21
  * @memberof ConceptMediaFlagResult
22
22
  */
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreateStudyGuideQuizRequest
16
+ */
17
+ export interface CreateStudyGuideQuizRequest {
18
+ /**
19
+ * 'quiz' for a graded practice quiz, 'flashcards' for a deck.
20
+ * @type {string}
21
+ * @memberof CreateStudyGuideQuizRequest
22
+ */
23
+ mode?: CreateStudyGuideQuizRequestModeEnum;
24
+ /**
25
+ * Concepts on the guide to build from. Omit for the whole guide (the 'Take Practice Quiz' button). Ids not on the guide are ignored.
26
+ * @type {Array<string>}
27
+ * @memberof CreateStudyGuideQuizRequest
28
+ */
29
+ conceptIds?: Array<string>;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const CreateStudyGuideQuizRequestModeEnum: {
35
+ readonly Quiz: "quiz";
36
+ readonly Flashcards: "flashcards";
37
+ };
38
+ export type CreateStudyGuideQuizRequestModeEnum = typeof CreateStudyGuideQuizRequestModeEnum[keyof typeof CreateStudyGuideQuizRequestModeEnum];
39
+ /**
40
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
41
+ */
42
+ export declare function instanceOfCreateStudyGuideQuizRequest(value: object): value is CreateStudyGuideQuizRequest;
43
+ export declare function CreateStudyGuideQuizRequestFromJSON(json: any): CreateStudyGuideQuizRequest;
44
+ export declare function CreateStudyGuideQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideQuizRequest;
45
+ export declare function CreateStudyGuideQuizRequestToJSON(json: any): CreateStudyGuideQuizRequest;
46
+ export declare function CreateStudyGuideQuizRequestToJSONTyped(value?: CreateStudyGuideQuizRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
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 CreateStudyGuideQuizRequestModeEnum = {
18
+ Quiz: 'quiz',
19
+ Flashcards: 'flashcards'
20
+ };
21
+ /**
22
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
23
+ */
24
+ export function instanceOfCreateStudyGuideQuizRequest(value) {
25
+ return true;
26
+ }
27
+ export function CreateStudyGuideQuizRequestFromJSON(json) {
28
+ return CreateStudyGuideQuizRequestFromJSONTyped(json, false);
29
+ }
30
+ export function CreateStudyGuideQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'mode': json['mode'] == null ? undefined : json['mode'],
36
+ 'conceptIds': json['conceptIds'] == null ? undefined : json['conceptIds'],
37
+ };
38
+ }
39
+ export function CreateStudyGuideQuizRequestToJSON(json) {
40
+ return CreateStudyGuideQuizRequestToJSONTyped(json, false);
41
+ }
42
+ export function CreateStudyGuideQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'mode': value['mode'],
48
+ 'conceptIds': value['conceptIds'],
49
+ };
50
+ }
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreateStudyGuideRequest
16
+ */
17
+ export interface CreateStudyGuideRequest {
18
+ /**
19
+ * Study objective the guide is for. Its course, study space, Canvas link, due date, notes, attachments and extracted concepts all feed generation. When set, courseId/studySpaceId/canvasObjectRef are taken from it.
20
+ * @type {string}
21
+ * @memberof CreateStudyGuideRequest
22
+ */
23
+ studyObjectiveId?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CreateStudyGuideRequest
28
+ */
29
+ studySpaceId?: string;
30
+ /**
31
+ * Canvas course id, when the guide is for a Canvas course.
32
+ * @type {string}
33
+ * @memberof CreateStudyGuideRequest
34
+ */
35
+ courseId?: string;
36
+ /**
37
+ * The Canvas assessment formatted '{type}:{local_id}' (e.g. 'quiz:123'). Read live (title, description, points, due date) when Canvas credentials are sent.
38
+ * @type {string}
39
+ * @memberof CreateStudyGuideRequest
40
+ */
41
+ canvasObjectRef?: string;
42
+ /**
43
+ * The chat the guide was requested from, if any.
44
+ * @type {string}
45
+ * @memberof CreateStudyGuideRequest
46
+ */
47
+ chatId?: string;
48
+ /**
49
+ * The assessment's name as the learner gave it, used when there is no Canvas item or objective to read it from.
50
+ * @type {string}
51
+ * @memberof CreateStudyGuideRequest
52
+ */
53
+ assessmentTitle?: string;
54
+ /**
55
+ * What the learner says is on the assessment, in their own words (chapters, topics, 'everything since the midterm'). The generator treats it as evidence of scope.
56
+ * @type {string}
57
+ * @memberof CreateStudyGuideRequest
58
+ */
59
+ learnerContext?: string;
60
+ /**
61
+ * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
62
+ * @type {Array<string>}
63
+ * @memberof CreateStudyGuideRequest
64
+ */
65
+ userFileIds?: Array<string>;
66
+ }
67
+ /**
68
+ * Check if a given object implements the CreateStudyGuideRequest interface.
69
+ */
70
+ export declare function instanceOfCreateStudyGuideRequest(value: object): value is CreateStudyGuideRequest;
71
+ export declare function CreateStudyGuideRequestFromJSON(json: any): CreateStudyGuideRequest;
72
+ export declare function CreateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideRequest;
73
+ export declare function CreateStudyGuideRequestToJSON(json: any): CreateStudyGuideRequest;
74
+ export declare function CreateStudyGuideRequestToJSONTyped(value?: CreateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
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 CreateStudyGuideRequest interface.
16
+ */
17
+ export function instanceOfCreateStudyGuideRequest(value) {
18
+ return true;
19
+ }
20
+ export function CreateStudyGuideRequestFromJSON(json) {
21
+ return CreateStudyGuideRequestFromJSONTyped(json, false);
22
+ }
23
+ export function CreateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
29
+ 'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
30
+ 'courseId': json['courseId'] == null ? undefined : json['courseId'],
31
+ 'canvasObjectRef': json['canvasObjectRef'] == null ? undefined : json['canvasObjectRef'],
32
+ 'chatId': json['chatId'] == null ? undefined : json['chatId'],
33
+ 'assessmentTitle': json['assessmentTitle'] == null ? undefined : json['assessmentTitle'],
34
+ 'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
35
+ 'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
36
+ };
37
+ }
38
+ export function CreateStudyGuideRequestToJSON(json) {
39
+ return CreateStudyGuideRequestToJSONTyped(json, false);
40
+ }
41
+ export function CreateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'studyObjectiveId': value['studyObjectiveId'],
47
+ 'studySpaceId': value['studySpaceId'],
48
+ 'courseId': value['courseId'],
49
+ 'canvasObjectRef': value['canvasObjectRef'],
50
+ 'chatId': value['chatId'],
51
+ 'assessmentTitle': value['assessmentTitle'],
52
+ 'learnerContext': value['learnerContext'],
53
+ 'userFileIds': value['userFileIds'],
54
+ };
55
+ }
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { StudyGuideListItem } from './StudyGuideListItem';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PaginatedStudyGuides
17
+ */
18
+ export interface PaginatedStudyGuides {
19
+ /**
20
+ *
21
+ * @type {Array<StudyGuideListItem>}
22
+ * @memberof PaginatedStudyGuides
23
+ */
24
+ data: Array<StudyGuideListItem>;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof PaginatedStudyGuides
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the PaginatedStudyGuides interface.
34
+ */
35
+ export declare function instanceOfPaginatedStudyGuides(value: object): value is PaginatedStudyGuides;
36
+ export declare function PaginatedStudyGuidesFromJSON(json: any): PaginatedStudyGuides;
37
+ export declare function PaginatedStudyGuidesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStudyGuides;
38
+ export declare function PaginatedStudyGuidesToJSON(json: any): PaginatedStudyGuides;
39
+ export declare function PaginatedStudyGuidesToJSONTyped(value?: PaginatedStudyGuides | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
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
+ import { StudyGuideListItemFromJSON, StudyGuideListItemToJSON, } from './StudyGuideListItem';
15
+ /**
16
+ * Check if a given object implements the PaginatedStudyGuides interface.
17
+ */
18
+ export function instanceOfPaginatedStudyGuides(value) {
19
+ if (!('data' in value) || value['data'] === undefined)
20
+ return false;
21
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function PaginatedStudyGuidesFromJSON(json) {
26
+ return PaginatedStudyGuidesFromJSONTyped(json, false);
27
+ }
28
+ export function PaginatedStudyGuidesFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'data': (json['data'].map(StudyGuideListItemFromJSON)),
34
+ 'nextCursor': json['nextCursor'],
35
+ };
36
+ }
37
+ export function PaginatedStudyGuidesToJSON(json) {
38
+ return PaginatedStudyGuidesToJSONTyped(json, false);
39
+ }
40
+ export function PaginatedStudyGuidesToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'data': (value['data'].map(StudyGuideListItemToJSON)),
46
+ 'nextCursor': value['nextCursor'],
47
+ };
48
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RegenerateStudyGuideRequest
16
+ */
17
+ export interface RegenerateStudyGuideRequest {
18
+ /**
19
+ * Additional context, appended to what the learner already said. Omit to retry with the same inputs.
20
+ * @type {string}
21
+ * @memberof RegenerateStudyGuideRequest
22
+ */
23
+ learnerContext?: string;
24
+ /**
25
+ * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
26
+ * @type {Array<string>}
27
+ * @memberof RegenerateStudyGuideRequest
28
+ */
29
+ userFileIds?: Array<string>;
30
+ }
31
+ /**
32
+ * Check if a given object implements the RegenerateStudyGuideRequest interface.
33
+ */
34
+ export declare function instanceOfRegenerateStudyGuideRequest(value: object): value is RegenerateStudyGuideRequest;
35
+ export declare function RegenerateStudyGuideRequestFromJSON(json: any): RegenerateStudyGuideRequest;
36
+ export declare function RegenerateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegenerateStudyGuideRequest;
37
+ export declare function RegenerateStudyGuideRequestToJSON(json: any): RegenerateStudyGuideRequest;
38
+ export declare function RegenerateStudyGuideRequestToJSONTyped(value?: RegenerateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
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 RegenerateStudyGuideRequest interface.
16
+ */
17
+ export function instanceOfRegenerateStudyGuideRequest(value) {
18
+ return true;
19
+ }
20
+ export function RegenerateStudyGuideRequestFromJSON(json) {
21
+ return RegenerateStudyGuideRequestFromJSONTyped(json, false);
22
+ }
23
+ export function RegenerateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
29
+ 'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
30
+ };
31
+ }
32
+ export function RegenerateStudyGuideRequestToJSON(json) {
33
+ return RegenerateStudyGuideRequestToJSONTyped(json, false);
34
+ }
35
+ export function RegenerateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
36
+ if (value == null) {
37
+ return value;
38
+ }
39
+ return {
40
+ 'learnerContext': value['learnerContext'],
41
+ 'userFileIds': value['userFileIds'],
42
+ };
43
+ }