@instructure/athena-api-client 3.39.3 → 3.41.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 (142) hide show
  1. package/README.md +28 -0
  2. package/dist/apis/AdminApi.d.ts +17 -1
  3. package/dist/apis/AdminApi.js +47 -0
  4. package/dist/apis/QuizzesApi.d.ts +30 -1
  5. package/dist/apis/QuizzesApi.js +87 -0
  6. package/dist/apis/ResourcesApi.d.ts +11 -2
  7. package/dist/apis/ResourcesApi.js +13 -3
  8. package/dist/apis/SharedQuizzesApi.d.ts +46 -0
  9. package/dist/apis/SharedQuizzesApi.js +115 -0
  10. package/dist/apis/StudyObjectivesApi.d.ts +2 -2
  11. package/dist/apis/StudyObjectivesApi.js +2 -2
  12. package/dist/apis/StudySpaceTemplatesApi.d.ts +61 -0
  13. package/dist/apis/StudySpaceTemplatesApi.js +162 -0
  14. package/dist/apis/index.d.ts +2 -0
  15. package/dist/apis/index.js +2 -0
  16. package/dist/esm/apis/AdminApi.d.ts +17 -1
  17. package/dist/esm/apis/AdminApi.js +48 -1
  18. package/dist/esm/apis/QuizzesApi.d.ts +30 -1
  19. package/dist/esm/apis/QuizzesApi.js +88 -1
  20. package/dist/esm/apis/ResourcesApi.d.ts +11 -2
  21. package/dist/esm/apis/ResourcesApi.js +12 -2
  22. package/dist/esm/apis/SharedQuizzesApi.d.ts +46 -0
  23. package/dist/esm/apis/SharedQuizzesApi.js +111 -0
  24. package/dist/esm/apis/StudyObjectivesApi.d.ts +2 -2
  25. package/dist/esm/apis/StudyObjectivesApi.js +2 -2
  26. package/dist/esm/apis/StudySpaceTemplatesApi.d.ts +61 -0
  27. package/dist/esm/apis/StudySpaceTemplatesApi.js +158 -0
  28. package/dist/esm/apis/index.d.ts +2 -0
  29. package/dist/esm/apis/index.js +2 -0
  30. package/dist/esm/models/AdminPaginatedQuizParticipantSessions.d.ts +39 -0
  31. package/dist/esm/models/AdminPaginatedQuizParticipantSessions.js +48 -0
  32. package/dist/esm/models/AdminQuizParticipantSessionListItem.d.ts +84 -0
  33. package/dist/esm/models/AdminQuizParticipantSessionListItem.js +80 -0
  34. package/dist/esm/models/AdminQuizParticipantSessionScore.d.ts +44 -0
  35. package/dist/esm/models/AdminQuizParticipantSessionScore.js +51 -0
  36. package/dist/esm/models/AdminStudyObjectiveListItem.d.ts +2 -1
  37. package/dist/esm/models/AdminStudyObjectiveListItem.js +2 -1
  38. package/dist/esm/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
  39. package/dist/esm/models/CreateStudySpaceFromTemplateDto.js +45 -0
  40. package/dist/esm/models/QuizSharing.d.ts +50 -0
  41. package/dist/esm/models/QuizSharing.js +55 -0
  42. package/dist/esm/models/ResourceListItem.d.ts +16 -3
  43. package/dist/esm/models/ResourceListItem.js +9 -0
  44. package/dist/esm/models/ResourceSharing.d.ts +44 -0
  45. package/dist/esm/models/ResourceSharing.js +51 -0
  46. package/dist/esm/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
  47. package/dist/esm/models/ScheduleStudySpaceTemplateDto.js +43 -0
  48. package/dist/esm/models/SharedQuiz.d.ts +97 -0
  49. package/dist/esm/models/SharedQuiz.js +90 -0
  50. package/dist/esm/models/StudyObjective.d.ts +8 -1
  51. package/dist/esm/models/StudyObjective.js +6 -1
  52. package/dist/esm/models/StudySpace.d.ts +12 -0
  53. package/dist/esm/models/StudySpace.js +8 -0
  54. package/dist/esm/models/StudySpaceFromTemplate.d.ts +40 -0
  55. package/dist/esm/models/StudySpaceFromTemplate.js +49 -0
  56. package/dist/esm/models/StudySpaceTemplate.d.ts +117 -0
  57. package/dist/esm/models/StudySpaceTemplate.js +102 -0
  58. package/dist/esm/models/StudySpaceTemplateAnchor.d.ts +44 -0
  59. package/dist/esm/models/StudySpaceTemplateAnchor.js +51 -0
  60. package/dist/esm/models/StudySpaceTemplateConfirm.d.ts +33 -0
  61. package/dist/esm/models/StudySpaceTemplateConfirm.js +44 -0
  62. package/dist/esm/models/StudySpaceTemplateLegal.d.ts +32 -0
  63. package/dist/esm/models/StudySpaceTemplateLegal.js +43 -0
  64. package/dist/esm/models/StudySpaceTemplateLink.d.ts +38 -0
  65. package/dist/esm/models/StudySpaceTemplateLink.js +47 -0
  66. package/dist/esm/models/StudySpaceTemplateNotice.d.ts +38 -0
  67. package/dist/esm/models/StudySpaceTemplateNotice.js +47 -0
  68. package/dist/esm/models/StudySpaceTemplateObjective.d.ts +52 -0
  69. package/dist/esm/models/StudySpaceTemplateObjective.js +58 -0
  70. package/dist/esm/models/StudySpaceTemplateProvenance.d.ts +32 -0
  71. package/dist/esm/models/StudySpaceTemplateProvenance.js +43 -0
  72. package/dist/esm/models/StudySpaceTemplateSchedule.d.ts +51 -0
  73. package/dist/esm/models/StudySpaceTemplateSchedule.js +57 -0
  74. package/dist/esm/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
  75. package/dist/esm/models/StudySpaceTemplateScheduleItem.js +55 -0
  76. package/dist/esm/models/SyllabusAnalysisObjective.d.ts +1 -0
  77. package/dist/esm/models/SyllabusAnalysisObjective.js +2 -1
  78. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
  79. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
  80. package/dist/esm/models/UpcomingStudyObjective.d.ts +8 -1
  81. package/dist/esm/models/UpcomingStudyObjective.js +6 -1
  82. package/dist/esm/models/UpdateQuizSharingRequest.d.ts +32 -0
  83. package/dist/esm/models/UpdateQuizSharingRequest.js +43 -0
  84. package/dist/esm/models/index.d.ts +20 -0
  85. package/dist/esm/models/index.js +20 -0
  86. package/dist/models/AdminPaginatedQuizParticipantSessions.d.ts +39 -0
  87. package/dist/models/AdminPaginatedQuizParticipantSessions.js +55 -0
  88. package/dist/models/AdminQuizParticipantSessionListItem.d.ts +84 -0
  89. package/dist/models/AdminQuizParticipantSessionListItem.js +88 -0
  90. package/dist/models/AdminQuizParticipantSessionScore.d.ts +44 -0
  91. package/dist/models/AdminQuizParticipantSessionScore.js +58 -0
  92. package/dist/models/AdminStudyObjectiveListItem.d.ts +2 -1
  93. package/dist/models/AdminStudyObjectiveListItem.js +2 -1
  94. package/dist/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
  95. package/dist/models/CreateStudySpaceFromTemplateDto.js +52 -0
  96. package/dist/models/QuizSharing.d.ts +50 -0
  97. package/dist/models/QuizSharing.js +62 -0
  98. package/dist/models/ResourceListItem.d.ts +16 -3
  99. package/dist/models/ResourceListItem.js +9 -0
  100. package/dist/models/ResourceSharing.d.ts +44 -0
  101. package/dist/models/ResourceSharing.js +58 -0
  102. package/dist/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
  103. package/dist/models/ScheduleStudySpaceTemplateDto.js +50 -0
  104. package/dist/models/SharedQuiz.d.ts +97 -0
  105. package/dist/models/SharedQuiz.js +98 -0
  106. package/dist/models/StudyObjective.d.ts +8 -1
  107. package/dist/models/StudyObjective.js +6 -1
  108. package/dist/models/StudySpace.d.ts +12 -0
  109. package/dist/models/StudySpace.js +8 -0
  110. package/dist/models/StudySpaceFromTemplate.d.ts +40 -0
  111. package/dist/models/StudySpaceFromTemplate.js +56 -0
  112. package/dist/models/StudySpaceTemplate.d.ts +117 -0
  113. package/dist/models/StudySpaceTemplate.js +109 -0
  114. package/dist/models/StudySpaceTemplateAnchor.d.ts +44 -0
  115. package/dist/models/StudySpaceTemplateAnchor.js +58 -0
  116. package/dist/models/StudySpaceTemplateConfirm.d.ts +33 -0
  117. package/dist/models/StudySpaceTemplateConfirm.js +51 -0
  118. package/dist/models/StudySpaceTemplateLegal.d.ts +32 -0
  119. package/dist/models/StudySpaceTemplateLegal.js +50 -0
  120. package/dist/models/StudySpaceTemplateLink.d.ts +38 -0
  121. package/dist/models/StudySpaceTemplateLink.js +54 -0
  122. package/dist/models/StudySpaceTemplateNotice.d.ts +38 -0
  123. package/dist/models/StudySpaceTemplateNotice.js +54 -0
  124. package/dist/models/StudySpaceTemplateObjective.d.ts +52 -0
  125. package/dist/models/StudySpaceTemplateObjective.js +66 -0
  126. package/dist/models/StudySpaceTemplateProvenance.d.ts +32 -0
  127. package/dist/models/StudySpaceTemplateProvenance.js +50 -0
  128. package/dist/models/StudySpaceTemplateSchedule.d.ts +51 -0
  129. package/dist/models/StudySpaceTemplateSchedule.js +65 -0
  130. package/dist/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
  131. package/dist/models/StudySpaceTemplateScheduleItem.js +62 -0
  132. package/dist/models/SyllabusAnalysisObjective.d.ts +1 -0
  133. package/dist/models/SyllabusAnalysisObjective.js +2 -1
  134. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
  135. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
  136. package/dist/models/UpcomingStudyObjective.d.ts +8 -1
  137. package/dist/models/UpcomingStudyObjective.js +6 -1
  138. package/dist/models/UpdateQuizSharingRequest.d.ts +32 -0
  139. package/dist/models/UpdateQuizSharingRequest.js +50 -0
  140. package/dist/models/index.d.ts +20 -0
  141. package/dist/models/index.js +20 -0
  142. package/package.json +1 -1
@@ -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 StudySpaceTemplateProvenance interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateProvenance(value) {
18
+ if (!('author' in value) || value['author'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function StudySpaceTemplateProvenanceFromJSON(json) {
23
+ return StudySpaceTemplateProvenanceFromJSONTyped(json, false);
24
+ }
25
+ export function StudySpaceTemplateProvenanceFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'author': json['author'],
31
+ };
32
+ }
33
+ export function StudySpaceTemplateProvenanceToJSON(json) {
34
+ return StudySpaceTemplateProvenanceToJSONTyped(json, false);
35
+ }
36
+ export function StudySpaceTemplateProvenanceToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'author': value['author'],
42
+ };
43
+ }
@@ -0,0 +1,51 @@
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 StudySpaceTemplateSchedule
16
+ */
17
+ export interface StudySpaceTemplateSchedule {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateSchedule
22
+ */
23
+ policy: StudySpaceTemplateSchedulePolicyEnum;
24
+ /**
25
+ * Whether the learner may say where they are in the course; when false, `startIndex` must be 0
26
+ * @type {boolean}
27
+ * @memberof StudySpaceTemplateSchedule
28
+ */
29
+ allowStartAt: boolean;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudySpaceTemplateSchedule
34
+ */
35
+ startSelectorLabel: string | null;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const StudySpaceTemplateSchedulePolicyEnum: {
41
+ readonly ProportionalToAnchor: "proportional_to_anchor";
42
+ };
43
+ export type StudySpaceTemplateSchedulePolicyEnum = typeof StudySpaceTemplateSchedulePolicyEnum[keyof typeof StudySpaceTemplateSchedulePolicyEnum];
44
+ /**
45
+ * Check if a given object implements the StudySpaceTemplateSchedule interface.
46
+ */
47
+ export declare function instanceOfStudySpaceTemplateSchedule(value: object): value is StudySpaceTemplateSchedule;
48
+ export declare function StudySpaceTemplateScheduleFromJSON(json: any): StudySpaceTemplateSchedule;
49
+ export declare function StudySpaceTemplateScheduleFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateSchedule;
50
+ export declare function StudySpaceTemplateScheduleToJSON(json: any): StudySpaceTemplateSchedule;
51
+ export declare function StudySpaceTemplateScheduleToJSONTyped(value?: StudySpaceTemplateSchedule | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
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 StudySpaceTemplateSchedulePolicyEnum = {
18
+ ProportionalToAnchor: 'proportional_to_anchor'
19
+ };
20
+ /**
21
+ * Check if a given object implements the StudySpaceTemplateSchedule interface.
22
+ */
23
+ export function instanceOfStudySpaceTemplateSchedule(value) {
24
+ if (!('policy' in value) || value['policy'] === undefined)
25
+ return false;
26
+ if (!('allowStartAt' in value) || value['allowStartAt'] === undefined)
27
+ return false;
28
+ if (!('startSelectorLabel' in value) || value['startSelectorLabel'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function StudySpaceTemplateScheduleFromJSON(json) {
33
+ return StudySpaceTemplateScheduleFromJSONTyped(json, false);
34
+ }
35
+ export function StudySpaceTemplateScheduleFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'policy': json['policy'],
41
+ 'allowStartAt': json['allowStartAt'],
42
+ 'startSelectorLabel': json['startSelectorLabel'],
43
+ };
44
+ }
45
+ export function StudySpaceTemplateScheduleToJSON(json) {
46
+ return StudySpaceTemplateScheduleToJSONTyped(json, false);
47
+ }
48
+ export function StudySpaceTemplateScheduleToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'policy': value['policy'],
54
+ 'allowStartAt': value['allowStartAt'],
55
+ 'startSelectorLabel': value['startSelectorLabel'],
56
+ };
57
+ }
@@ -0,0 +1,50 @@
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 StudySpaceTemplateScheduleItem
16
+ */
17
+ export interface StudySpaceTemplateScheduleItem {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateScheduleItem
22
+ */
23
+ key: string;
24
+ /**
25
+ * Objective title as it will be created
26
+ * @type {string}
27
+ * @memberof StudySpaceTemplateScheduleItem
28
+ */
29
+ title: string;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof StudySpaceTemplateScheduleItem
34
+ */
35
+ dueAt: Date;
36
+ /**
37
+ * A unit the learner has already covered, placed as review
38
+ * @type {boolean}
39
+ * @memberof StudySpaceTemplateScheduleItem
40
+ */
41
+ isReview: boolean;
42
+ }
43
+ /**
44
+ * Check if a given object implements the StudySpaceTemplateScheduleItem interface.
45
+ */
46
+ export declare function instanceOfStudySpaceTemplateScheduleItem(value: object): value is StudySpaceTemplateScheduleItem;
47
+ export declare function StudySpaceTemplateScheduleItemFromJSON(json: any): StudySpaceTemplateScheduleItem;
48
+ export declare function StudySpaceTemplateScheduleItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateScheduleItem;
49
+ export declare function StudySpaceTemplateScheduleItemToJSON(json: any): StudySpaceTemplateScheduleItem;
50
+ export declare function StudySpaceTemplateScheduleItemToJSONTyped(value?: StudySpaceTemplateScheduleItem | 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 StudySpaceTemplateScheduleItem interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateScheduleItem(value) {
18
+ if (!('key' in value) || value['key'] === undefined)
19
+ return false;
20
+ if (!('title' in value) || value['title'] === undefined)
21
+ return false;
22
+ if (!('dueAt' in value) || value['dueAt'] === undefined)
23
+ return false;
24
+ if (!('isReview' in value) || value['isReview'] === undefined)
25
+ return false;
26
+ return true;
27
+ }
28
+ export function StudySpaceTemplateScheduleItemFromJSON(json) {
29
+ return StudySpaceTemplateScheduleItemFromJSONTyped(json, false);
30
+ }
31
+ export function StudySpaceTemplateScheduleItemFromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'key': json['key'],
37
+ 'title': json['title'],
38
+ 'dueAt': (new Date(json['dueAt'])),
39
+ 'isReview': json['isReview'],
40
+ };
41
+ }
42
+ export function StudySpaceTemplateScheduleItemToJSON(json) {
43
+ return StudySpaceTemplateScheduleItemToJSONTyped(json, false);
44
+ }
45
+ export function StudySpaceTemplateScheduleItemToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'key': value['key'],
51
+ 'title': value['title'],
52
+ 'dueAt': value['dueAt'].toISOString(),
53
+ 'isReview': value['isReview'],
54
+ };
55
+ }
@@ -52,6 +52,7 @@ export interface SyllabusAnalysisObjective {
52
52
  export declare const SyllabusAnalysisObjectiveSourceEnum: {
53
53
  readonly User: "user";
54
54
  readonly Syllabus: "syllabus";
55
+ readonly Template: "template";
55
56
  };
56
57
  export type SyllabusAnalysisObjectiveSourceEnum = typeof SyllabusAnalysisObjectiveSourceEnum[keyof typeof SyllabusAnalysisObjectiveSourceEnum];
57
58
  /**
@@ -16,7 +16,8 @@
16
16
  */
17
17
  export const SyllabusAnalysisObjectiveSourceEnum = {
18
18
  User: 'user',
19
- Syllabus: 'syllabus'
19
+ Syllabus: 'syllabus',
20
+ Template: 'template'
20
21
  };
21
22
  /**
22
23
  * Check if a given object implements the SyllabusAnalysisObjective interface.
@@ -28,7 +28,7 @@ export interface TriggerStudyObjectiveConceptExtractionItemStatus {
28
28
  */
29
29
  kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
30
30
  /**
31
- * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas-sourced only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every objective when the kill switch is off. `not-found` means the objective isn't owned by the caller, so no sidecar was created.
31
+ * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas-sourced only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every objective when the kill switch is off. `skipped-template` means the objective was created from a study-space template: its concepts came with the template and are never re-extracted, so nothing was reset or enqueued. `not-found` means the objective isn't owned by the caller, so no sidecar was created.
32
32
  * @type {string}
33
33
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
34
34
  */
@@ -52,6 +52,7 @@ export declare const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum:
52
52
  readonly Failed: "failed";
53
53
  readonly CoolingDown: "cooling-down";
54
54
  readonly SkippedDisabled: "skipped-disabled";
55
+ readonly SkippedTemplate: "skipped-template";
55
56
  readonly NotFound: "not-found";
56
57
  };
57
58
  export type TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum];
@@ -28,6 +28,7 @@ export const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
28
28
  Failed: 'failed',
29
29
  CoolingDown: 'cooling-down',
30
30
  SkippedDisabled: 'skipped-disabled',
31
+ SkippedTemplate: 'skipped-template',
31
32
  NotFound: 'not-found'
32
33
  };
33
34
  /**
@@ -54,11 +54,17 @@ export interface UpcomingStudyObjective {
54
54
  */
55
55
  canvasObjectRef: string | null;
56
56
  /**
57
- * Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
57
+ * Origin of the objective: 'user' (client-created), 'syllabus' (derived internally) or 'template' (copied from a study-space template when the space was created; edits like 'user'). Read-only.
58
58
  * @type {string}
59
59
  * @memberof UpcomingStudyObjective
60
60
  */
61
61
  source: UpcomingStudyObjectiveSourceEnum;
62
+ /**
63
+ * For a 'template' objective, `<template slug>/<objective key>` of the package entry it was copied from; null for every other source. Read-only.
64
+ * @type {string}
65
+ * @memberof UpcomingStudyObjective
66
+ */
67
+ templateKey: string | null;
62
68
  /**
63
69
  *
64
70
  * @type {string}
@@ -120,6 +126,7 @@ export interface UpcomingStudyObjective {
120
126
  export declare const UpcomingStudyObjectiveSourceEnum: {
121
127
  readonly User: "user";
122
128
  readonly Syllabus: "syllabus";
129
+ readonly Template: "template";
123
130
  };
124
131
  export type UpcomingStudyObjectiveSourceEnum = typeof UpcomingStudyObjectiveSourceEnum[keyof typeof UpcomingStudyObjectiveSourceEnum];
125
132
  /**
@@ -18,7 +18,8 @@ import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSO
18
18
  */
19
19
  export const UpcomingStudyObjectiveSourceEnum = {
20
20
  User: 'user',
21
- Syllabus: 'syllabus'
21
+ Syllabus: 'syllabus',
22
+ Template: 'template'
22
23
  };
23
24
  /**
24
25
  * Check if a given object implements the UpcomingStudyObjective interface.
@@ -38,6 +39,8 @@ export function instanceOfUpcomingStudyObjective(value) {
38
39
  return false;
39
40
  if (!('source' in value) || value['source'] === undefined)
40
41
  return false;
42
+ if (!('templateKey' in value) || value['templateKey'] === undefined)
43
+ return false;
41
44
  if (!('title' in value) || value['title'] === undefined)
42
45
  return false;
43
46
  if (!('notes' in value) || value['notes'] === undefined)
@@ -73,6 +76,7 @@ export function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
73
76
  'canvasObjectId': json['canvasObjectId'],
74
77
  'canvasObjectRef': json['canvasObjectRef'],
75
78
  'source': json['source'],
79
+ 'templateKey': json['templateKey'],
76
80
  'title': json['title'],
77
81
  'notes': json['notes'],
78
82
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
@@ -99,6 +103,7 @@ export function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = f
99
103
  'canvasObjectId': value['canvasObjectId'],
100
104
  'canvasObjectRef': value['canvasObjectRef'],
101
105
  'source': value['source'],
106
+ 'templateKey': value['templateKey'],
102
107
  'title': value['title'],
103
108
  'notes': value['notes'],
104
109
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
@@ -0,0 +1,32 @@
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 UpdateQuizSharingRequest
16
+ */
17
+ export interface UpdateQuizSharingRequest {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof UpdateQuizSharingRequest
22
+ */
23
+ enabled: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the UpdateQuizSharingRequest interface.
27
+ */
28
+ export declare function instanceOfUpdateQuizSharingRequest(value: object): value is UpdateQuizSharingRequest;
29
+ export declare function UpdateQuizSharingRequestFromJSON(json: any): UpdateQuizSharingRequest;
30
+ export declare function UpdateQuizSharingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateQuizSharingRequest;
31
+ export declare function UpdateQuizSharingRequestToJSON(json: any): UpdateQuizSharingRequest;
32
+ export declare function UpdateQuizSharingRequestToJSONTyped(value?: UpdateQuizSharingRequest | 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 UpdateQuizSharingRequest interface.
16
+ */
17
+ export function instanceOfUpdateQuizSharingRequest(value) {
18
+ if (!('enabled' in value) || value['enabled'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function UpdateQuizSharingRequestFromJSON(json) {
23
+ return UpdateQuizSharingRequestFromJSONTyped(json, false);
24
+ }
25
+ export function UpdateQuizSharingRequestFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'enabled': json['enabled'],
31
+ };
32
+ }
33
+ export function UpdateQuizSharingRequestToJSON(json) {
34
+ return UpdateQuizSharingRequestToJSONTyped(json, false);
35
+ }
36
+ export function UpdateQuizSharingRequestToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'enabled': value['enabled'],
42
+ };
43
+ }
@@ -23,12 +23,15 @@ export * from './AdminLastExchange';
23
23
  export * from './AdminPaginatedActiveStreaks';
24
24
  export * from './AdminPaginatedChats';
25
25
  export * from './AdminPaginatedLastExchanges';
26
+ export * from './AdminPaginatedQuizParticipantSessions';
26
27
  export * from './AdminPaginatedQuizSessions';
27
28
  export * from './AdminPaginatedStudyObjectiveUserCounts';
28
29
  export * from './AdminPaginatedStudyObjectives';
29
30
  export * from './AdminPaginatedTaxonomyEnrollments';
30
31
  export * from './AdminQuizGeneration';
31
32
  export * from './AdminQuizGenerationInput';
33
+ export * from './AdminQuizParticipantSessionListItem';
34
+ export * from './AdminQuizParticipantSessionScore';
32
35
  export * from './AdminQuizSessionListItem';
33
36
  export * from './AdminQuizSessionScore';
34
37
  export * from './AdminQuizSourceFile';
@@ -85,6 +88,7 @@ export * from './CreateStudyObjectiveDtoCanvasObject';
85
88
  export * from './CreateStudyPlanDto';
86
89
  export * from './CreateStudyPlanDtoActivitiesInner';
87
90
  export * from './CreateStudySpaceDto';
91
+ export * from './CreateStudySpaceFromTemplateDto';
88
92
  export * from './CreateTokenRequest';
89
93
  export * from './CreateTokenResponse';
90
94
  export * from './DailyQuizStatus';
@@ -127,17 +131,21 @@ export * from './QuizSession';
127
131
  export * from './QuizSessionListItem';
128
132
  export * from './QuizSessionScore';
129
133
  export * from './QuizSessionSummary';
134
+ export * from './QuizSharing';
130
135
  export * from './QuizWithQuestions';
131
136
  export * from './RecordQuizQuestionViewRequest';
132
137
  export * from './ResourceActivity';
133
138
  export * from './ResourceChat';
134
139
  export * from './ResourceListItem';
135
140
  export * from './ResourceSession';
141
+ export * from './ResourceSharing';
136
142
  export * from './ResourceStudyObjective';
137
143
  export * from './ResourceStudySpace';
144
+ export * from './ScheduleStudySpaceTemplateDto';
138
145
  export * from './Score';
139
146
  export * from './ScoreByTypeValue';
140
147
  export * from './ServiceToken';
148
+ export * from './SharedQuiz';
141
149
  export * from './StudyObjective';
142
150
  export * from './StudyObjectiveCanvasDocument';
143
151
  export * from './StudyObjectiveConceptAttachment';
@@ -147,6 +155,17 @@ export * from './StudyObjectiveFileAttachment';
147
155
  export * from './StudyPlan';
148
156
  export * from './StudyPlanActivity';
149
157
  export * from './StudySpace';
158
+ export * from './StudySpaceFromTemplate';
159
+ export * from './StudySpaceTemplate';
160
+ export * from './StudySpaceTemplateAnchor';
161
+ export * from './StudySpaceTemplateConfirm';
162
+ export * from './StudySpaceTemplateLegal';
163
+ export * from './StudySpaceTemplateLink';
164
+ export * from './StudySpaceTemplateNotice';
165
+ export * from './StudySpaceTemplateObjective';
166
+ export * from './StudySpaceTemplateProvenance';
167
+ export * from './StudySpaceTemplateSchedule';
168
+ export * from './StudySpaceTemplateScheduleItem';
150
169
  export * from './SubmitQuizResponseRequest';
151
170
  export * from './SubmittedQuizResponse';
152
171
  export * from './SyllabusAnalysisObjective';
@@ -174,6 +193,7 @@ export * from './UpdateChatRequest';
174
193
  export * from './UpdateFeatureDto';
175
194
  export * from './UpdatePlanDto';
176
195
  export * from './UpdateQuizSessionRequest';
196
+ export * from './UpdateQuizSharingRequest';
177
197
  export * from './UpdateStudyObjectiveDto';
178
198
  export * from './UpdateStudySpaceDto';
179
199
  export * from './UpdateTokenRequest';
@@ -25,12 +25,15 @@ export * from './AdminLastExchange';
25
25
  export * from './AdminPaginatedActiveStreaks';
26
26
  export * from './AdminPaginatedChats';
27
27
  export * from './AdminPaginatedLastExchanges';
28
+ export * from './AdminPaginatedQuizParticipantSessions';
28
29
  export * from './AdminPaginatedQuizSessions';
29
30
  export * from './AdminPaginatedStudyObjectiveUserCounts';
30
31
  export * from './AdminPaginatedStudyObjectives';
31
32
  export * from './AdminPaginatedTaxonomyEnrollments';
32
33
  export * from './AdminQuizGeneration';
33
34
  export * from './AdminQuizGenerationInput';
35
+ export * from './AdminQuizParticipantSessionListItem';
36
+ export * from './AdminQuizParticipantSessionScore';
34
37
  export * from './AdminQuizSessionListItem';
35
38
  export * from './AdminQuizSessionScore';
36
39
  export * from './AdminQuizSourceFile';
@@ -87,6 +90,7 @@ export * from './CreateStudyObjectiveDtoCanvasObject';
87
90
  export * from './CreateStudyPlanDto';
88
91
  export * from './CreateStudyPlanDtoActivitiesInner';
89
92
  export * from './CreateStudySpaceDto';
93
+ export * from './CreateStudySpaceFromTemplateDto';
90
94
  export * from './CreateTokenRequest';
91
95
  export * from './CreateTokenResponse';
92
96
  export * from './DailyQuizStatus';
@@ -129,17 +133,21 @@ export * from './QuizSession';
129
133
  export * from './QuizSessionListItem';
130
134
  export * from './QuizSessionScore';
131
135
  export * from './QuizSessionSummary';
136
+ export * from './QuizSharing';
132
137
  export * from './QuizWithQuestions';
133
138
  export * from './RecordQuizQuestionViewRequest';
134
139
  export * from './ResourceActivity';
135
140
  export * from './ResourceChat';
136
141
  export * from './ResourceListItem';
137
142
  export * from './ResourceSession';
143
+ export * from './ResourceSharing';
138
144
  export * from './ResourceStudyObjective';
139
145
  export * from './ResourceStudySpace';
146
+ export * from './ScheduleStudySpaceTemplateDto';
140
147
  export * from './Score';
141
148
  export * from './ScoreByTypeValue';
142
149
  export * from './ServiceToken';
150
+ export * from './SharedQuiz';
143
151
  export * from './StudyObjective';
144
152
  export * from './StudyObjectiveCanvasDocument';
145
153
  export * from './StudyObjectiveConceptAttachment';
@@ -149,6 +157,17 @@ export * from './StudyObjectiveFileAttachment';
149
157
  export * from './StudyPlan';
150
158
  export * from './StudyPlanActivity';
151
159
  export * from './StudySpace';
160
+ export * from './StudySpaceFromTemplate';
161
+ export * from './StudySpaceTemplate';
162
+ export * from './StudySpaceTemplateAnchor';
163
+ export * from './StudySpaceTemplateConfirm';
164
+ export * from './StudySpaceTemplateLegal';
165
+ export * from './StudySpaceTemplateLink';
166
+ export * from './StudySpaceTemplateNotice';
167
+ export * from './StudySpaceTemplateObjective';
168
+ export * from './StudySpaceTemplateProvenance';
169
+ export * from './StudySpaceTemplateSchedule';
170
+ export * from './StudySpaceTemplateScheduleItem';
152
171
  export * from './SubmitQuizResponseRequest';
153
172
  export * from './SubmittedQuizResponse';
154
173
  export * from './SyllabusAnalysisObjective';
@@ -176,6 +195,7 @@ export * from './UpdateChatRequest';
176
195
  export * from './UpdateFeatureDto';
177
196
  export * from './UpdatePlanDto';
178
197
  export * from './UpdateQuizSessionRequest';
198
+ export * from './UpdateQuizSharingRequest';
179
199
  export * from './UpdateStudyObjectiveDto';
180
200
  export * from './UpdateStudySpaceDto';
181
201
  export * from './UpdateTokenRequest';
@@ -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 { AdminQuizParticipantSessionListItem } from './AdminQuizParticipantSessionListItem';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminPaginatedQuizParticipantSessions
17
+ */
18
+ export interface AdminPaginatedQuizParticipantSessions {
19
+ /**
20
+ *
21
+ * @type {Array<AdminQuizParticipantSessionListItem>}
22
+ * @memberof AdminPaginatedQuizParticipantSessions
23
+ */
24
+ data: Array<AdminQuizParticipantSessionListItem>;
25
+ /**
26
+ * Opaque cursor for fetching the next page. Null when there are no more results.
27
+ * @type {string}
28
+ * @memberof AdminPaginatedQuizParticipantSessions
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
34
+ */
35
+ export declare function instanceOfAdminPaginatedQuizParticipantSessions(value: object): value is AdminPaginatedQuizParticipantSessions;
36
+ export declare function AdminPaginatedQuizParticipantSessionsFromJSON(json: any): AdminPaginatedQuizParticipantSessions;
37
+ export declare function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedQuizParticipantSessions;
38
+ export declare function AdminPaginatedQuizParticipantSessionsToJSON(json: any): AdminPaginatedQuizParticipantSessions;
39
+ export declare function AdminPaginatedQuizParticipantSessionsToJSONTyped(value?: AdminPaginatedQuizParticipantSessions | null, ignoreDiscriminator?: boolean): any;