@instructure/athena-api-client 3.40.0 → 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 (94) hide show
  1. package/README.md +16 -0
  2. package/dist/apis/StudyObjectivesApi.d.ts +2 -2
  3. package/dist/apis/StudyObjectivesApi.js +2 -2
  4. package/dist/apis/StudySpaceTemplatesApi.d.ts +61 -0
  5. package/dist/apis/StudySpaceTemplatesApi.js +162 -0
  6. package/dist/apis/index.d.ts +1 -0
  7. package/dist/apis/index.js +1 -0
  8. package/dist/esm/apis/StudyObjectivesApi.d.ts +2 -2
  9. package/dist/esm/apis/StudyObjectivesApi.js +2 -2
  10. package/dist/esm/apis/StudySpaceTemplatesApi.d.ts +61 -0
  11. package/dist/esm/apis/StudySpaceTemplatesApi.js +158 -0
  12. package/dist/esm/apis/index.d.ts +1 -0
  13. package/dist/esm/apis/index.js +1 -0
  14. package/dist/esm/models/AdminStudyObjectiveListItem.d.ts +2 -1
  15. package/dist/esm/models/AdminStudyObjectiveListItem.js +2 -1
  16. package/dist/esm/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
  17. package/dist/esm/models/CreateStudySpaceFromTemplateDto.js +45 -0
  18. package/dist/esm/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
  19. package/dist/esm/models/ScheduleStudySpaceTemplateDto.js +43 -0
  20. package/dist/esm/models/StudyObjective.d.ts +8 -1
  21. package/dist/esm/models/StudyObjective.js +6 -1
  22. package/dist/esm/models/StudySpace.d.ts +12 -0
  23. package/dist/esm/models/StudySpace.js +8 -0
  24. package/dist/esm/models/StudySpaceFromTemplate.d.ts +40 -0
  25. package/dist/esm/models/StudySpaceFromTemplate.js +49 -0
  26. package/dist/esm/models/StudySpaceTemplate.d.ts +117 -0
  27. package/dist/esm/models/StudySpaceTemplate.js +102 -0
  28. package/dist/esm/models/StudySpaceTemplateAnchor.d.ts +44 -0
  29. package/dist/esm/models/StudySpaceTemplateAnchor.js +51 -0
  30. package/dist/esm/models/StudySpaceTemplateConfirm.d.ts +33 -0
  31. package/dist/esm/models/StudySpaceTemplateConfirm.js +44 -0
  32. package/dist/esm/models/StudySpaceTemplateLegal.d.ts +32 -0
  33. package/dist/esm/models/StudySpaceTemplateLegal.js +43 -0
  34. package/dist/esm/models/StudySpaceTemplateLink.d.ts +38 -0
  35. package/dist/esm/models/StudySpaceTemplateLink.js +47 -0
  36. package/dist/esm/models/StudySpaceTemplateNotice.d.ts +38 -0
  37. package/dist/esm/models/StudySpaceTemplateNotice.js +47 -0
  38. package/dist/esm/models/StudySpaceTemplateObjective.d.ts +52 -0
  39. package/dist/esm/models/StudySpaceTemplateObjective.js +58 -0
  40. package/dist/esm/models/StudySpaceTemplateProvenance.d.ts +32 -0
  41. package/dist/esm/models/StudySpaceTemplateProvenance.js +43 -0
  42. package/dist/esm/models/StudySpaceTemplateSchedule.d.ts +51 -0
  43. package/dist/esm/models/StudySpaceTemplateSchedule.js +57 -0
  44. package/dist/esm/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
  45. package/dist/esm/models/StudySpaceTemplateScheduleItem.js +55 -0
  46. package/dist/esm/models/SyllabusAnalysisObjective.d.ts +1 -0
  47. package/dist/esm/models/SyllabusAnalysisObjective.js +2 -1
  48. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
  49. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
  50. package/dist/esm/models/UpcomingStudyObjective.d.ts +8 -1
  51. package/dist/esm/models/UpcomingStudyObjective.js +6 -1
  52. package/dist/esm/models/index.d.ts +13 -0
  53. package/dist/esm/models/index.js +13 -0
  54. package/dist/models/AdminStudyObjectiveListItem.d.ts +2 -1
  55. package/dist/models/AdminStudyObjectiveListItem.js +2 -1
  56. package/dist/models/CreateStudySpaceFromTemplateDto.d.ts +38 -0
  57. package/dist/models/CreateStudySpaceFromTemplateDto.js +52 -0
  58. package/dist/models/ScheduleStudySpaceTemplateDto.d.ts +32 -0
  59. package/dist/models/ScheduleStudySpaceTemplateDto.js +50 -0
  60. package/dist/models/StudyObjective.d.ts +8 -1
  61. package/dist/models/StudyObjective.js +6 -1
  62. package/dist/models/StudySpace.d.ts +12 -0
  63. package/dist/models/StudySpace.js +8 -0
  64. package/dist/models/StudySpaceFromTemplate.d.ts +40 -0
  65. package/dist/models/StudySpaceFromTemplate.js +56 -0
  66. package/dist/models/StudySpaceTemplate.d.ts +117 -0
  67. package/dist/models/StudySpaceTemplate.js +109 -0
  68. package/dist/models/StudySpaceTemplateAnchor.d.ts +44 -0
  69. package/dist/models/StudySpaceTemplateAnchor.js +58 -0
  70. package/dist/models/StudySpaceTemplateConfirm.d.ts +33 -0
  71. package/dist/models/StudySpaceTemplateConfirm.js +51 -0
  72. package/dist/models/StudySpaceTemplateLegal.d.ts +32 -0
  73. package/dist/models/StudySpaceTemplateLegal.js +50 -0
  74. package/dist/models/StudySpaceTemplateLink.d.ts +38 -0
  75. package/dist/models/StudySpaceTemplateLink.js +54 -0
  76. package/dist/models/StudySpaceTemplateNotice.d.ts +38 -0
  77. package/dist/models/StudySpaceTemplateNotice.js +54 -0
  78. package/dist/models/StudySpaceTemplateObjective.d.ts +52 -0
  79. package/dist/models/StudySpaceTemplateObjective.js +66 -0
  80. package/dist/models/StudySpaceTemplateProvenance.d.ts +32 -0
  81. package/dist/models/StudySpaceTemplateProvenance.js +50 -0
  82. package/dist/models/StudySpaceTemplateSchedule.d.ts +51 -0
  83. package/dist/models/StudySpaceTemplateSchedule.js +65 -0
  84. package/dist/models/StudySpaceTemplateScheduleItem.d.ts +50 -0
  85. package/dist/models/StudySpaceTemplateScheduleItem.js +62 -0
  86. package/dist/models/SyllabusAnalysisObjective.d.ts +1 -0
  87. package/dist/models/SyllabusAnalysisObjective.js +2 -1
  88. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +2 -1
  89. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +1 -0
  90. package/dist/models/UpcomingStudyObjective.d.ts +8 -1
  91. package/dist/models/UpcomingStudyObjective.js +6 -1
  92. package/dist/models/index.d.ts +13 -0
  93. package/dist/models/index.js +13 -0
  94. package/package.json +1 -1
@@ -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 StudySpaceTemplateNotice
16
+ */
17
+ export interface StudySpaceTemplateNotice {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateNotice
22
+ */
23
+ title: string | null;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof StudySpaceTemplateNotice
28
+ */
29
+ body: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the StudySpaceTemplateNotice interface.
33
+ */
34
+ export declare function instanceOfStudySpaceTemplateNotice(value: object): value is StudySpaceTemplateNotice;
35
+ export declare function StudySpaceTemplateNoticeFromJSON(json: any): StudySpaceTemplateNotice;
36
+ export declare function StudySpaceTemplateNoticeFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateNotice;
37
+ export declare function StudySpaceTemplateNoticeToJSON(json: any): StudySpaceTemplateNotice;
38
+ export declare function StudySpaceTemplateNoticeToJSONTyped(value?: StudySpaceTemplateNotice | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
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.instanceOfStudySpaceTemplateNotice = instanceOfStudySpaceTemplateNotice;
17
+ exports.StudySpaceTemplateNoticeFromJSON = StudySpaceTemplateNoticeFromJSON;
18
+ exports.StudySpaceTemplateNoticeFromJSONTyped = StudySpaceTemplateNoticeFromJSONTyped;
19
+ exports.StudySpaceTemplateNoticeToJSON = StudySpaceTemplateNoticeToJSON;
20
+ exports.StudySpaceTemplateNoticeToJSONTyped = StudySpaceTemplateNoticeToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the StudySpaceTemplateNotice interface.
23
+ */
24
+ function instanceOfStudySpaceTemplateNotice(value) {
25
+ if (!('title' in value) || value['title'] === undefined)
26
+ return false;
27
+ if (!('body' in value) || value['body'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function StudySpaceTemplateNoticeFromJSON(json) {
32
+ return StudySpaceTemplateNoticeFromJSONTyped(json, false);
33
+ }
34
+ function StudySpaceTemplateNoticeFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'title': json['title'],
40
+ 'body': json['body'],
41
+ };
42
+ }
43
+ function StudySpaceTemplateNoticeToJSON(json) {
44
+ return StudySpaceTemplateNoticeToJSONTyped(json, false);
45
+ }
46
+ function StudySpaceTemplateNoticeToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'title': value['title'],
52
+ 'body': value['body'],
53
+ };
54
+ }
@@ -0,0 +1,52 @@
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 StudySpaceTemplateObjective
16
+ */
17
+ export interface StudySpaceTemplateObjective {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateObjective
22
+ */
23
+ key: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof StudySpaceTemplateObjective
28
+ */
29
+ title: string;
30
+ /**
31
+ * `startIndex` counts the `unit` objectives in this order; the anchor comes last and is always created
32
+ * @type {string}
33
+ * @memberof StudySpaceTemplateObjective
34
+ */
35
+ role: StudySpaceTemplateObjectiveRoleEnum;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const StudySpaceTemplateObjectiveRoleEnum: {
41
+ readonly Unit: "unit";
42
+ readonly Anchor: "anchor";
43
+ };
44
+ export type StudySpaceTemplateObjectiveRoleEnum = typeof StudySpaceTemplateObjectiveRoleEnum[keyof typeof StudySpaceTemplateObjectiveRoleEnum];
45
+ /**
46
+ * Check if a given object implements the StudySpaceTemplateObjective interface.
47
+ */
48
+ export declare function instanceOfStudySpaceTemplateObjective(value: object): value is StudySpaceTemplateObjective;
49
+ export declare function StudySpaceTemplateObjectiveFromJSON(json: any): StudySpaceTemplateObjective;
50
+ export declare function StudySpaceTemplateObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateObjective;
51
+ export declare function StudySpaceTemplateObjectiveToJSON(json: any): StudySpaceTemplateObjective;
52
+ export declare function StudySpaceTemplateObjectiveToJSONTyped(value?: StudySpaceTemplateObjective | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,66 @@
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.StudySpaceTemplateObjectiveRoleEnum = void 0;
17
+ exports.instanceOfStudySpaceTemplateObjective = instanceOfStudySpaceTemplateObjective;
18
+ exports.StudySpaceTemplateObjectiveFromJSON = StudySpaceTemplateObjectiveFromJSON;
19
+ exports.StudySpaceTemplateObjectiveFromJSONTyped = StudySpaceTemplateObjectiveFromJSONTyped;
20
+ exports.StudySpaceTemplateObjectiveToJSON = StudySpaceTemplateObjectiveToJSON;
21
+ exports.StudySpaceTemplateObjectiveToJSONTyped = StudySpaceTemplateObjectiveToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.StudySpaceTemplateObjectiveRoleEnum = {
26
+ Unit: 'unit',
27
+ Anchor: 'anchor'
28
+ };
29
+ /**
30
+ * Check if a given object implements the StudySpaceTemplateObjective interface.
31
+ */
32
+ function instanceOfStudySpaceTemplateObjective(value) {
33
+ if (!('key' in value) || value['key'] === undefined)
34
+ return false;
35
+ if (!('title' in value) || value['title'] === undefined)
36
+ return false;
37
+ if (!('role' in value) || value['role'] === undefined)
38
+ return false;
39
+ return true;
40
+ }
41
+ function StudySpaceTemplateObjectiveFromJSON(json) {
42
+ return StudySpaceTemplateObjectiveFromJSONTyped(json, false);
43
+ }
44
+ function StudySpaceTemplateObjectiveFromJSONTyped(json, ignoreDiscriminator) {
45
+ if (json == null) {
46
+ return json;
47
+ }
48
+ return {
49
+ 'key': json['key'],
50
+ 'title': json['title'],
51
+ 'role': json['role'],
52
+ };
53
+ }
54
+ function StudySpaceTemplateObjectiveToJSON(json) {
55
+ return StudySpaceTemplateObjectiveToJSONTyped(json, false);
56
+ }
57
+ function StudySpaceTemplateObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ 'key': value['key'],
63
+ 'title': value['title'],
64
+ 'role': value['role'],
65
+ };
66
+ }
@@ -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 StudySpaceTemplateProvenance
16
+ */
17
+ export interface StudySpaceTemplateProvenance {
18
+ /**
19
+ * Who wrote the template's content
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateProvenance
22
+ */
23
+ author: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the StudySpaceTemplateProvenance interface.
27
+ */
28
+ export declare function instanceOfStudySpaceTemplateProvenance(value: object): value is StudySpaceTemplateProvenance;
29
+ export declare function StudySpaceTemplateProvenanceFromJSON(json: any): StudySpaceTemplateProvenance;
30
+ export declare function StudySpaceTemplateProvenanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateProvenance;
31
+ export declare function StudySpaceTemplateProvenanceToJSON(json: any): StudySpaceTemplateProvenance;
32
+ export declare function StudySpaceTemplateProvenanceToJSONTyped(value?: StudySpaceTemplateProvenance | 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.instanceOfStudySpaceTemplateProvenance = instanceOfStudySpaceTemplateProvenance;
17
+ exports.StudySpaceTemplateProvenanceFromJSON = StudySpaceTemplateProvenanceFromJSON;
18
+ exports.StudySpaceTemplateProvenanceFromJSONTyped = StudySpaceTemplateProvenanceFromJSONTyped;
19
+ exports.StudySpaceTemplateProvenanceToJSON = StudySpaceTemplateProvenanceToJSON;
20
+ exports.StudySpaceTemplateProvenanceToJSONTyped = StudySpaceTemplateProvenanceToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the StudySpaceTemplateProvenance interface.
23
+ */
24
+ function instanceOfStudySpaceTemplateProvenance(value) {
25
+ if (!('author' in value) || value['author'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function StudySpaceTemplateProvenanceFromJSON(json) {
30
+ return StudySpaceTemplateProvenanceFromJSONTyped(json, false);
31
+ }
32
+ function StudySpaceTemplateProvenanceFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'author': json['author'],
38
+ };
39
+ }
40
+ function StudySpaceTemplateProvenanceToJSON(json) {
41
+ return StudySpaceTemplateProvenanceToJSONTyped(json, false);
42
+ }
43
+ function StudySpaceTemplateProvenanceToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'author': value['author'],
49
+ };
50
+ }
@@ -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,65 @@
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.StudySpaceTemplateSchedulePolicyEnum = void 0;
17
+ exports.instanceOfStudySpaceTemplateSchedule = instanceOfStudySpaceTemplateSchedule;
18
+ exports.StudySpaceTemplateScheduleFromJSON = StudySpaceTemplateScheduleFromJSON;
19
+ exports.StudySpaceTemplateScheduleFromJSONTyped = StudySpaceTemplateScheduleFromJSONTyped;
20
+ exports.StudySpaceTemplateScheduleToJSON = StudySpaceTemplateScheduleToJSON;
21
+ exports.StudySpaceTemplateScheduleToJSONTyped = StudySpaceTemplateScheduleToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.StudySpaceTemplateSchedulePolicyEnum = {
26
+ ProportionalToAnchor: 'proportional_to_anchor'
27
+ };
28
+ /**
29
+ * Check if a given object implements the StudySpaceTemplateSchedule interface.
30
+ */
31
+ function instanceOfStudySpaceTemplateSchedule(value) {
32
+ if (!('policy' in value) || value['policy'] === undefined)
33
+ return false;
34
+ if (!('allowStartAt' in value) || value['allowStartAt'] === undefined)
35
+ return false;
36
+ if (!('startSelectorLabel' in value) || value['startSelectorLabel'] === undefined)
37
+ return false;
38
+ return true;
39
+ }
40
+ function StudySpaceTemplateScheduleFromJSON(json) {
41
+ return StudySpaceTemplateScheduleFromJSONTyped(json, false);
42
+ }
43
+ function StudySpaceTemplateScheduleFromJSONTyped(json, ignoreDiscriminator) {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+ 'policy': json['policy'],
49
+ 'allowStartAt': json['allowStartAt'],
50
+ 'startSelectorLabel': json['startSelectorLabel'],
51
+ };
52
+ }
53
+ function StudySpaceTemplateScheduleToJSON(json) {
54
+ return StudySpaceTemplateScheduleToJSONTyped(json, false);
55
+ }
56
+ function StudySpaceTemplateScheduleToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'policy': value['policy'],
62
+ 'allowStartAt': value['allowStartAt'],
63
+ 'startSelectorLabel': value['startSelectorLabel'],
64
+ };
65
+ }
@@ -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,62 @@
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.instanceOfStudySpaceTemplateScheduleItem = instanceOfStudySpaceTemplateScheduleItem;
17
+ exports.StudySpaceTemplateScheduleItemFromJSON = StudySpaceTemplateScheduleItemFromJSON;
18
+ exports.StudySpaceTemplateScheduleItemFromJSONTyped = StudySpaceTemplateScheduleItemFromJSONTyped;
19
+ exports.StudySpaceTemplateScheduleItemToJSON = StudySpaceTemplateScheduleItemToJSON;
20
+ exports.StudySpaceTemplateScheduleItemToJSONTyped = StudySpaceTemplateScheduleItemToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the StudySpaceTemplateScheduleItem interface.
23
+ */
24
+ function instanceOfStudySpaceTemplateScheduleItem(value) {
25
+ if (!('key' in value) || value['key'] === undefined)
26
+ return false;
27
+ if (!('title' in value) || value['title'] === undefined)
28
+ return false;
29
+ if (!('dueAt' in value) || value['dueAt'] === undefined)
30
+ return false;
31
+ if (!('isReview' in value) || value['isReview'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function StudySpaceTemplateScheduleItemFromJSON(json) {
36
+ return StudySpaceTemplateScheduleItemFromJSONTyped(json, false);
37
+ }
38
+ function StudySpaceTemplateScheduleItemFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'key': json['key'],
44
+ 'title': json['title'],
45
+ 'dueAt': (new Date(json['dueAt'])),
46
+ 'isReview': json['isReview'],
47
+ };
48
+ }
49
+ function StudySpaceTemplateScheduleItemToJSON(json) {
50
+ return StudySpaceTemplateScheduleItemToJSONTyped(json, false);
51
+ }
52
+ function StudySpaceTemplateScheduleItemToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'key': value['key'],
58
+ 'title': value['title'],
59
+ 'dueAt': value['dueAt'].toISOString(),
60
+ 'isReview': value['isReview'],
61
+ };
62
+ }
@@ -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
  /**
@@ -24,7 +24,8 @@ exports.SyllabusAnalysisObjectiveToJSONTyped = SyllabusAnalysisObjectiveToJSONTy
24
24
  */
25
25
  exports.SyllabusAnalysisObjectiveSourceEnum = {
26
26
  User: 'user',
27
- Syllabus: 'syllabus'
27
+ Syllabus: 'syllabus',
28
+ Template: 'template'
28
29
  };
29
30
  /**
30
31
  * 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];
@@ -36,6 +36,7 @@ exports.TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
36
36
  Failed: 'failed',
37
37
  CoolingDown: 'cooling-down',
38
38
  SkippedDisabled: 'skipped-disabled',
39
+ SkippedTemplate: 'skipped-template',
39
40
  NotFound: 'not-found'
40
41
  };
41
42
  /**
@@ -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
  /**
@@ -26,7 +26,8 @@ const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument")
26
26
  */
27
27
  exports.UpcomingStudyObjectiveSourceEnum = {
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 UpcomingStudyObjective interface.
@@ -46,6 +47,8 @@ function instanceOfUpcomingStudyObjective(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)
@@ -81,6 +84,7 @@ function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
81
84
  'canvasObjectId': json['canvasObjectId'],
82
85
  'canvasObjectRef': json['canvasObjectRef'],
83
86
  'source': json['source'],
87
+ 'templateKey': json['templateKey'],
84
88
  'title': json['title'],
85
89
  'notes': json['notes'],
86
90
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
@@ -107,6 +111,7 @@ function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
107
111
  'canvasObjectId': value['canvasObjectId'],
108
112
  'canvasObjectRef': value['canvasObjectRef'],
109
113
  'source': value['source'],
114
+ 'templateKey': value['templateKey'],
110
115
  'title': value['title'],
111
116
  'notes': value['notes'],
112
117
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.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';