@instructure/athena-api-client 3.40.0 → 3.41.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist/apis/StudyObjectivesApi.d.ts +2 -2
- package/dist/apis/StudyObjectivesApi.js +2 -2
- package/dist/apis/StudySpaceTemplatesApi.d.ts +61 -0
- package/dist/apis/StudySpaceTemplatesApi.js +162 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/StudyObjectivesApi.d.ts +2 -2
- package/dist/esm/apis/StudyObjectivesApi.js +2 -2
- package/dist/esm/apis/StudySpaceTemplatesApi.d.ts +61 -0
- package/dist/esm/apis/StudySpaceTemplatesApi.js +158 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/AdminStudyObjectiveListItem.d.ts +2 -1
- package/dist/esm/models/AdminStudyObjectiveListItem.js +2 -1
- package/dist/esm/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
- package/dist/esm/models/CreateStudySpaceFromTemplateDto.js +45 -0
- package/dist/esm/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
- package/dist/esm/models/ScheduleStudySpaceTemplateDto.js +43 -0
- package/dist/esm/models/StudyObjective.d.ts +8 -1
- package/dist/esm/models/StudyObjective.js +6 -1
- package/dist/esm/models/StudySpace.d.ts +12 -0
- package/dist/esm/models/StudySpace.js +8 -0
- package/dist/esm/models/StudySpaceFromTemplate.d.ts +40 -0
- package/dist/esm/models/StudySpaceFromTemplate.js +49 -0
- package/dist/esm/models/StudySpaceTemplate.d.ts +117 -0
- package/dist/esm/models/StudySpaceTemplate.js +102 -0
- package/dist/esm/models/StudySpaceTemplateAnchor.d.ts +44 -0
- package/dist/esm/models/StudySpaceTemplateAnchor.js +51 -0
- package/dist/esm/models/StudySpaceTemplateConfirm.d.ts +33 -0
- package/dist/esm/models/StudySpaceTemplateConfirm.js +44 -0
- package/dist/esm/models/StudySpaceTemplateLegal.d.ts +32 -0
- package/dist/esm/models/StudySpaceTemplateLegal.js +43 -0
- package/dist/esm/models/StudySpaceTemplateLink.d.ts +38 -0
- package/dist/esm/models/StudySpaceTemplateLink.js +47 -0
- package/dist/esm/models/StudySpaceTemplateNotice.d.ts +38 -0
- package/dist/esm/models/StudySpaceTemplateNotice.js +47 -0
- package/dist/esm/models/StudySpaceTemplateObjective.d.ts +52 -0
- package/dist/esm/models/StudySpaceTemplateObjective.js +58 -0
- package/dist/esm/models/StudySpaceTemplateProvenance.d.ts +32 -0
- package/dist/esm/models/StudySpaceTemplateProvenance.js +43 -0
- package/dist/esm/models/StudySpaceTemplateSchedule.d.ts +51 -0
- package/dist/esm/models/StudySpaceTemplateSchedule.js +57 -0
- package/dist/esm/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
- package/dist/esm/models/StudySpaceTemplateScheduleItem.js +55 -0
- package/dist/esm/models/SyllabusAnalysisObjective.d.ts +1 -0
- package/dist/esm/models/SyllabusAnalysisObjective.js +2 -1
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
- package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
- package/dist/esm/models/UpcomingStudyObjective.d.ts +8 -1
- package/dist/esm/models/UpcomingStudyObjective.js +6 -1
- package/dist/esm/models/index.d.ts +13 -0
- package/dist/esm/models/index.js +13 -0
- package/dist/models/AdminStudyObjectiveListItem.d.ts +2 -1
- package/dist/models/AdminStudyObjectiveListItem.js +2 -1
- package/dist/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
- package/dist/models/CreateStudySpaceFromTemplateDto.js +52 -0
- package/dist/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
- package/dist/models/ScheduleStudySpaceTemplateDto.js +50 -0
- package/dist/models/StudyObjective.d.ts +8 -1
- package/dist/models/StudyObjective.js +6 -1
- package/dist/models/StudySpace.d.ts +12 -0
- package/dist/models/StudySpace.js +8 -0
- package/dist/models/StudySpaceFromTemplate.d.ts +40 -0
- package/dist/models/StudySpaceFromTemplate.js +56 -0
- package/dist/models/StudySpaceTemplate.d.ts +117 -0
- package/dist/models/StudySpaceTemplate.js +109 -0
- package/dist/models/StudySpaceTemplateAnchor.d.ts +44 -0
- package/dist/models/StudySpaceTemplateAnchor.js +58 -0
- package/dist/models/StudySpaceTemplateConfirm.d.ts +33 -0
- package/dist/models/StudySpaceTemplateConfirm.js +51 -0
- package/dist/models/StudySpaceTemplateLegal.d.ts +32 -0
- package/dist/models/StudySpaceTemplateLegal.js +50 -0
- package/dist/models/StudySpaceTemplateLink.d.ts +38 -0
- package/dist/models/StudySpaceTemplateLink.js +54 -0
- package/dist/models/StudySpaceTemplateNotice.d.ts +38 -0
- package/dist/models/StudySpaceTemplateNotice.js +54 -0
- package/dist/models/StudySpaceTemplateObjective.d.ts +52 -0
- package/dist/models/StudySpaceTemplateObjective.js +66 -0
- package/dist/models/StudySpaceTemplateProvenance.d.ts +32 -0
- package/dist/models/StudySpaceTemplateProvenance.js +50 -0
- package/dist/models/StudySpaceTemplateSchedule.d.ts +51 -0
- package/dist/models/StudySpaceTemplateSchedule.js +65 -0
- package/dist/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
- package/dist/models/StudySpaceTemplateScheduleItem.js +62 -0
- package/dist/models/SyllabusAnalysisObjective.d.ts +1 -0
- package/dist/models/SyllabusAnalysisObjective.js +2 -1
- package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
- package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
- package/dist/models/UpcomingStudyObjective.d.ts +8 -1
- package/dist/models/UpcomingStudyObjective.js +6 -1
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/package.json +1 -1
|
@@ -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
|
/**
|
|
@@ -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];
|
|
@@ -54,11 +54,17 @@ export interface UpcomingStudyObjective {
|
|
|
54
54
|
*/
|
|
55
55
|
canvasObjectRef: string | null;
|
|
56
56
|
/**
|
|
57
|
-
* Origin of the objective: 'user' (client-created)
|
|
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)),
|
|
@@ -88,6 +88,7 @@ export * from './CreateStudyObjectiveDtoCanvasObject';
|
|
|
88
88
|
export * from './CreateStudyPlanDto';
|
|
89
89
|
export * from './CreateStudyPlanDtoActivitiesInner';
|
|
90
90
|
export * from './CreateStudySpaceDto';
|
|
91
|
+
export * from './CreateStudySpaceFromTemplateDto';
|
|
91
92
|
export * from './CreateTokenRequest';
|
|
92
93
|
export * from './CreateTokenResponse';
|
|
93
94
|
export * from './DailyQuizStatus';
|
|
@@ -140,6 +141,7 @@ export * from './ResourceSession';
|
|
|
140
141
|
export * from './ResourceSharing';
|
|
141
142
|
export * from './ResourceStudyObjective';
|
|
142
143
|
export * from './ResourceStudySpace';
|
|
144
|
+
export * from './ScheduleStudySpaceTemplateDto';
|
|
143
145
|
export * from './Score';
|
|
144
146
|
export * from './ScoreByTypeValue';
|
|
145
147
|
export * from './ServiceToken';
|
|
@@ -153,6 +155,17 @@ export * from './StudyObjectiveFileAttachment';
|
|
|
153
155
|
export * from './StudyPlan';
|
|
154
156
|
export * from './StudyPlanActivity';
|
|
155
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';
|
|
156
169
|
export * from './SubmitQuizResponseRequest';
|
|
157
170
|
export * from './SubmittedQuizResponse';
|
|
158
171
|
export * from './SyllabusAnalysisObjective';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -90,6 +90,7 @@ export * from './CreateStudyObjectiveDtoCanvasObject';
|
|
|
90
90
|
export * from './CreateStudyPlanDto';
|
|
91
91
|
export * from './CreateStudyPlanDtoActivitiesInner';
|
|
92
92
|
export * from './CreateStudySpaceDto';
|
|
93
|
+
export * from './CreateStudySpaceFromTemplateDto';
|
|
93
94
|
export * from './CreateTokenRequest';
|
|
94
95
|
export * from './CreateTokenResponse';
|
|
95
96
|
export * from './DailyQuizStatus';
|
|
@@ -142,6 +143,7 @@ export * from './ResourceSession';
|
|
|
142
143
|
export * from './ResourceSharing';
|
|
143
144
|
export * from './ResourceStudyObjective';
|
|
144
145
|
export * from './ResourceStudySpace';
|
|
146
|
+
export * from './ScheduleStudySpaceTemplateDto';
|
|
145
147
|
export * from './Score';
|
|
146
148
|
export * from './ScoreByTypeValue';
|
|
147
149
|
export * from './ServiceToken';
|
|
@@ -155,6 +157,17 @@ export * from './StudyObjectiveFileAttachment';
|
|
|
155
157
|
export * from './StudyPlan';
|
|
156
158
|
export * from './StudyPlanActivity';
|
|
157
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';
|
|
158
171
|
export * from './SubmitQuizResponseRequest';
|
|
159
172
|
export * from './SubmittedQuizResponse';
|
|
160
173
|
export * from './SyllabusAnalysisObjective';
|
|
@@ -34,7 +34,7 @@ export interface AdminStudyObjectiveListItem {
|
|
|
34
34
|
*/
|
|
35
35
|
userId: string | null;
|
|
36
36
|
/**
|
|
37
|
-
* Derived origin: 'canvas' if linked to a Canvas object, else 'syllabus'
|
|
37
|
+
* Derived origin: 'canvas' if linked to a Canvas object, else 'syllabus' for syllabus-derived and 'custom' for learner-created or template-created objectives
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof AdminStudyObjectiveListItem
|
|
40
40
|
*/
|
|
@@ -157,6 +157,7 @@ export type AdminStudyObjectiveListItemOriginEnum = typeof AdminStudyObjectiveLi
|
|
|
157
157
|
export declare const AdminStudyObjectiveListItemSourceEnum: {
|
|
158
158
|
readonly User: "user";
|
|
159
159
|
readonly Syllabus: "syllabus";
|
|
160
|
+
readonly Template: "template";
|
|
160
161
|
};
|
|
161
162
|
export type AdminStudyObjectiveListItemSourceEnum = typeof AdminStudyObjectiveListItemSourceEnum[keyof typeof AdminStudyObjectiveListItemSourceEnum];
|
|
162
163
|
/**
|
|
@@ -32,7 +32,8 @@ exports.AdminStudyObjectiveListItemOriginEnum = {
|
|
|
32
32
|
*/
|
|
33
33
|
exports.AdminStudyObjectiveListItemSourceEnum = {
|
|
34
34
|
User: 'user',
|
|
35
|
-
Syllabus: 'syllabus'
|
|
35
|
+
Syllabus: 'syllabus',
|
|
36
|
+
Template: 'template'
|
|
36
37
|
};
|
|
37
38
|
/**
|
|
38
39
|
* Check if a given object implements the AdminStudyObjectiveListItem interface.
|
|
@@ -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 CreateStudySpaceFromTemplateDto
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateStudySpaceFromTemplateDto {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CreateStudySpaceFromTemplateDto
|
|
22
|
+
*/
|
|
23
|
+
name?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof CreateStudySpaceFromTemplateDto
|
|
28
|
+
*/
|
|
29
|
+
startIndex: number | null;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the CreateStudySpaceFromTemplateDto interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfCreateStudySpaceFromTemplateDto(value: object): value is CreateStudySpaceFromTemplateDto;
|
|
35
|
+
export declare function CreateStudySpaceFromTemplateDtoFromJSON(json: any): CreateStudySpaceFromTemplateDto;
|
|
36
|
+
export declare function CreateStudySpaceFromTemplateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudySpaceFromTemplateDto;
|
|
37
|
+
export declare function CreateStudySpaceFromTemplateDtoToJSON(json: any): CreateStudySpaceFromTemplateDto;
|
|
38
|
+
export declare function CreateStudySpaceFromTemplateDtoToJSONTyped(value?: CreateStudySpaceFromTemplateDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfCreateStudySpaceFromTemplateDto = instanceOfCreateStudySpaceFromTemplateDto;
|
|
17
|
+
exports.CreateStudySpaceFromTemplateDtoFromJSON = CreateStudySpaceFromTemplateDtoFromJSON;
|
|
18
|
+
exports.CreateStudySpaceFromTemplateDtoFromJSONTyped = CreateStudySpaceFromTemplateDtoFromJSONTyped;
|
|
19
|
+
exports.CreateStudySpaceFromTemplateDtoToJSON = CreateStudySpaceFromTemplateDtoToJSON;
|
|
20
|
+
exports.CreateStudySpaceFromTemplateDtoToJSONTyped = CreateStudySpaceFromTemplateDtoToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the CreateStudySpaceFromTemplateDto interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfCreateStudySpaceFromTemplateDto(value) {
|
|
25
|
+
if (!('startIndex' in value) || value['startIndex'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function CreateStudySpaceFromTemplateDtoFromJSON(json) {
|
|
30
|
+
return CreateStudySpaceFromTemplateDtoFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function CreateStudySpaceFromTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
38
|
+
'startIndex': json['startIndex'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function CreateStudySpaceFromTemplateDtoToJSON(json) {
|
|
42
|
+
return CreateStudySpaceFromTemplateDtoToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function CreateStudySpaceFromTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'name': value['name'],
|
|
50
|
+
'startIndex': value['startIndex'],
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -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 ScheduleStudySpaceTemplateDto
|
|
16
|
+
*/
|
|
17
|
+
export interface ScheduleStudySpaceTemplateDto {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ScheduleStudySpaceTemplateDto
|
|
22
|
+
*/
|
|
23
|
+
startIndex: number | null;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the ScheduleStudySpaceTemplateDto interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfScheduleStudySpaceTemplateDto(value: object): value is ScheduleStudySpaceTemplateDto;
|
|
29
|
+
export declare function ScheduleStudySpaceTemplateDtoFromJSON(json: any): ScheduleStudySpaceTemplateDto;
|
|
30
|
+
export declare function ScheduleStudySpaceTemplateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleStudySpaceTemplateDto;
|
|
31
|
+
export declare function ScheduleStudySpaceTemplateDtoToJSON(json: any): ScheduleStudySpaceTemplateDto;
|
|
32
|
+
export declare function ScheduleStudySpaceTemplateDtoToJSONTyped(value?: ScheduleStudySpaceTemplateDto | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfScheduleStudySpaceTemplateDto = instanceOfScheduleStudySpaceTemplateDto;
|
|
17
|
+
exports.ScheduleStudySpaceTemplateDtoFromJSON = ScheduleStudySpaceTemplateDtoFromJSON;
|
|
18
|
+
exports.ScheduleStudySpaceTemplateDtoFromJSONTyped = ScheduleStudySpaceTemplateDtoFromJSONTyped;
|
|
19
|
+
exports.ScheduleStudySpaceTemplateDtoToJSON = ScheduleStudySpaceTemplateDtoToJSON;
|
|
20
|
+
exports.ScheduleStudySpaceTemplateDtoToJSONTyped = ScheduleStudySpaceTemplateDtoToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ScheduleStudySpaceTemplateDto interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfScheduleStudySpaceTemplateDto(value) {
|
|
25
|
+
if (!('startIndex' in value) || value['startIndex'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
function ScheduleStudySpaceTemplateDtoFromJSON(json) {
|
|
30
|
+
return ScheduleStudySpaceTemplateDtoFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
function ScheduleStudySpaceTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if (json == null) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'startIndex': json['startIndex'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
function ScheduleStudySpaceTemplateDtoToJSON(json) {
|
|
41
|
+
return ScheduleStudySpaceTemplateDtoToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function ScheduleStudySpaceTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'startIndex': value['startIndex'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
@@ -54,11 +54,17 @@ export interface StudyObjective {
|
|
|
54
54
|
*/
|
|
55
55
|
canvasObjectRef: string | null;
|
|
56
56
|
/**
|
|
57
|
-
* Origin of the objective: 'user' (client-created)
|
|
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 StudyObjective
|
|
60
60
|
*/
|
|
61
61
|
source: StudyObjectiveSourceEnum;
|
|
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 StudyObjective
|
|
66
|
+
*/
|
|
67
|
+
templateKey: string | null;
|
|
62
68
|
/**
|
|
63
69
|
*
|
|
64
70
|
* @type {string}
|
|
@@ -114,6 +120,7 @@ export interface StudyObjective {
|
|
|
114
120
|
export declare const StudyObjectiveSourceEnum: {
|
|
115
121
|
readonly User: "user";
|
|
116
122
|
readonly Syllabus: "syllabus";
|
|
123
|
+
readonly Template: "template";
|
|
117
124
|
};
|
|
118
125
|
export type StudyObjectiveSourceEnum = typeof StudyObjectiveSourceEnum[keyof typeof StudyObjectiveSourceEnum];
|
|
119
126
|
/**
|
|
@@ -26,7 +26,8 @@ const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument")
|
|
|
26
26
|
*/
|
|
27
27
|
exports.StudyObjectiveSourceEnum = {
|
|
28
28
|
User: 'user',
|
|
29
|
-
Syllabus: 'syllabus'
|
|
29
|
+
Syllabus: 'syllabus',
|
|
30
|
+
Template: 'template'
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
33
|
* Check if a given object implements the StudyObjective interface.
|
|
@@ -46,6 +47,8 @@ function instanceOfStudyObjective(value) {
|
|
|
46
47
|
return false;
|
|
47
48
|
if (!('source' in value) || value['source'] === undefined)
|
|
48
49
|
return false;
|
|
50
|
+
if (!('templateKey' in value) || value['templateKey'] === undefined)
|
|
51
|
+
return false;
|
|
49
52
|
if (!('title' in value) || value['title'] === undefined)
|
|
50
53
|
return false;
|
|
51
54
|
if (!('notes' in value) || value['notes'] === undefined)
|
|
@@ -79,6 +82,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
79
82
|
'canvasObjectId': json['canvasObjectId'],
|
|
80
83
|
'canvasObjectRef': json['canvasObjectRef'],
|
|
81
84
|
'source': json['source'],
|
|
85
|
+
'templateKey': json['templateKey'],
|
|
82
86
|
'title': json['title'],
|
|
83
87
|
'notes': json['notes'],
|
|
84
88
|
'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
|
|
@@ -104,6 +108,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
104
108
|
'canvasObjectId': value['canvasObjectId'],
|
|
105
109
|
'canvasObjectRef': value['canvasObjectRef'],
|
|
106
110
|
'source': value['source'],
|
|
111
|
+
'templateKey': value['templateKey'],
|
|
107
112
|
'title': value['title'],
|
|
108
113
|
'notes': value['notes'],
|
|
109
114
|
'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
|
|
@@ -33,6 +33,18 @@ export interface StudySpace {
|
|
|
33
33
|
* @memberof StudySpace
|
|
34
34
|
*/
|
|
35
35
|
title: string;
|
|
36
|
+
/**
|
|
37
|
+
* Slug of the study-space template this space was created from, or null for a space that wasn't created from a template.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof StudySpace
|
|
40
|
+
*/
|
|
41
|
+
templateSlug: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Version of the template package the space was copied from (a later version never changes an existing space), or null when templateSlug is null.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof StudySpace
|
|
46
|
+
*/
|
|
47
|
+
templateVersion: string | null;
|
|
36
48
|
/**
|
|
37
49
|
* Number of non-archived study objectives in this space.
|
|
38
50
|
* @type {number}
|
|
@@ -28,6 +28,10 @@ function instanceOfStudySpace(value) {
|
|
|
28
28
|
return false;
|
|
29
29
|
if (!('title' in value) || value['title'] === undefined)
|
|
30
30
|
return false;
|
|
31
|
+
if (!('templateSlug' in value) || value['templateSlug'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('templateVersion' in value) || value['templateVersion'] === undefined)
|
|
34
|
+
return false;
|
|
31
35
|
if (!('activeObjectiveCount' in value) || value['activeObjectiveCount'] === undefined)
|
|
32
36
|
return false;
|
|
33
37
|
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
@@ -47,6 +51,8 @@ function StudySpaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
51
|
'id': json['id'],
|
|
48
52
|
'courseId': json['courseId'],
|
|
49
53
|
'title': json['title'],
|
|
54
|
+
'templateSlug': json['templateSlug'],
|
|
55
|
+
'templateVersion': json['templateVersion'],
|
|
50
56
|
'activeObjectiveCount': json['activeObjectiveCount'],
|
|
51
57
|
'createdAt': (new Date(json['createdAt'])),
|
|
52
58
|
'updatedAt': (new Date(json['updatedAt'])),
|
|
@@ -63,6 +69,8 @@ function StudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
63
69
|
'id': value['id'],
|
|
64
70
|
'courseId': value['courseId'],
|
|
65
71
|
'title': value['title'],
|
|
72
|
+
'templateSlug': value['templateSlug'],
|
|
73
|
+
'templateVersion': value['templateVersion'],
|
|
66
74
|
'activeObjectiveCount': value['activeObjectiveCount'],
|
|
67
75
|
'createdAt': value['createdAt'].toISOString(),
|
|
68
76
|
'updatedAt': value['updatedAt'].toISOString(),
|
|
@@ -0,0 +1,40 @@
|
|
|
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 { StudySpace } from './StudySpace';
|
|
13
|
+
import type { StudyObjective } from './StudyObjective';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface StudySpaceFromTemplate
|
|
18
|
+
*/
|
|
19
|
+
export interface StudySpaceFromTemplate {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {StudySpace}
|
|
23
|
+
* @memberof StudySpaceFromTemplate
|
|
24
|
+
*/
|
|
25
|
+
space: StudySpace;
|
|
26
|
+
/**
|
|
27
|
+
* The space's objectives in schedule order
|
|
28
|
+
* @type {Array<StudyObjective>}
|
|
29
|
+
* @memberof StudySpaceFromTemplate
|
|
30
|
+
*/
|
|
31
|
+
objectives: Array<StudyObjective>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the StudySpaceFromTemplate interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfStudySpaceFromTemplate(value: object): value is StudySpaceFromTemplate;
|
|
37
|
+
export declare function StudySpaceFromTemplateFromJSON(json: any): StudySpaceFromTemplate;
|
|
38
|
+
export declare function StudySpaceFromTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceFromTemplate;
|
|
39
|
+
export declare function StudySpaceFromTemplateToJSON(json: any): StudySpaceFromTemplate;
|
|
40
|
+
export declare function StudySpaceFromTemplateToJSONTyped(value?: StudySpaceFromTemplate | null, ignoreDiscriminator?: boolean): any;
|