@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
@@ -25,6 +25,7 @@ export * from './StudyObjectiveConceptsApi';
25
25
  export * from './StudyObjectivesApi';
26
26
  export * from './StudyPlansApi';
27
27
  export * from './StudyPrepApi';
28
+ export * from './StudySpaceTemplatesApi';
28
29
  export * from './StudySpacesApi';
29
30
  export * from './SyllabusAnalysisApi';
30
31
  export * from './TagsApi';
@@ -27,6 +27,7 @@ export * from './StudyObjectiveConceptsApi';
27
27
  export * from './StudyObjectivesApi';
28
28
  export * from './StudyPlansApi';
29
29
  export * from './StudyPrepApi';
30
+ export * from './StudySpaceTemplatesApi';
30
31
  export * from './StudySpacesApi';
31
32
  export * from './SyllabusAnalysisApi';
32
33
  export * from './TagsApi';
@@ -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' or 'custom' based on source
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
  /**
@@ -24,7 +24,8 @@ export const AdminStudyObjectiveListItemOriginEnum = {
24
24
  */
25
25
  export const AdminStudyObjectiveListItemSourceEnum = {
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 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,45 @@
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 CreateStudySpaceFromTemplateDto interface.
16
+ */
17
+ export function instanceOfCreateStudySpaceFromTemplateDto(value) {
18
+ if (!('startIndex' in value) || value['startIndex'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function CreateStudySpaceFromTemplateDtoFromJSON(json) {
23
+ return CreateStudySpaceFromTemplateDtoFromJSONTyped(json, false);
24
+ }
25
+ export function CreateStudySpaceFromTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'name': json['name'] == null ? undefined : json['name'],
31
+ 'startIndex': json['startIndex'],
32
+ };
33
+ }
34
+ export function CreateStudySpaceFromTemplateDtoToJSON(json) {
35
+ return CreateStudySpaceFromTemplateDtoToJSONTyped(json, false);
36
+ }
37
+ export function CreateStudySpaceFromTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'name': value['name'],
43
+ 'startIndex': value['startIndex'],
44
+ };
45
+ }
@@ -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,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 ScheduleStudySpaceTemplateDto interface.
16
+ */
17
+ export function instanceOfScheduleStudySpaceTemplateDto(value) {
18
+ if (!('startIndex' in value) || value['startIndex'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function ScheduleStudySpaceTemplateDtoFromJSON(json) {
23
+ return ScheduleStudySpaceTemplateDtoFromJSONTyped(json, false);
24
+ }
25
+ export function ScheduleStudySpaceTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'startIndex': json['startIndex'],
31
+ };
32
+ }
33
+ export function ScheduleStudySpaceTemplateDtoToJSON(json) {
34
+ return ScheduleStudySpaceTemplateDtoToJSONTyped(json, false);
35
+ }
36
+ export function ScheduleStudySpaceTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'startIndex': value['startIndex'],
42
+ };
43
+ }
@@ -54,11 +54,17 @@ export interface StudyObjective {
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 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
  /**
@@ -18,7 +18,8 @@ import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSO
18
18
  */
19
19
  export const StudyObjectiveSourceEnum = {
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 StudyObjective interface.
@@ -38,6 +39,8 @@ export function instanceOfStudyObjective(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)
@@ -71,6 +74,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
71
74
  'canvasObjectId': json['canvasObjectId'],
72
75
  'canvasObjectRef': json['canvasObjectRef'],
73
76
  'source': json['source'],
77
+ 'templateKey': json['templateKey'],
74
78
  'title': json['title'],
75
79
  'notes': json['notes'],
76
80
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
@@ -96,6 +100,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
96
100
  'canvasObjectId': value['canvasObjectId'],
97
101
  'canvasObjectRef': value['canvasObjectRef'],
98
102
  'source': value['source'],
103
+ 'templateKey': value['templateKey'],
99
104
  'title': value['title'],
100
105
  'notes': value['notes'],
101
106
  'fileAttachments': (value['fileAttachments'].map(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}
@@ -21,6 +21,10 @@ export function instanceOfStudySpace(value) {
21
21
  return false;
22
22
  if (!('title' in value) || value['title'] === undefined)
23
23
  return false;
24
+ if (!('templateSlug' in value) || value['templateSlug'] === undefined)
25
+ return false;
26
+ if (!('templateVersion' in value) || value['templateVersion'] === undefined)
27
+ return false;
24
28
  if (!('activeObjectiveCount' in value) || value['activeObjectiveCount'] === undefined)
25
29
  return false;
26
30
  if (!('createdAt' in value) || value['createdAt'] === undefined)
@@ -40,6 +44,8 @@ export function StudySpaceFromJSONTyped(json, ignoreDiscriminator) {
40
44
  'id': json['id'],
41
45
  'courseId': json['courseId'],
42
46
  'title': json['title'],
47
+ 'templateSlug': json['templateSlug'],
48
+ 'templateVersion': json['templateVersion'],
43
49
  'activeObjectiveCount': json['activeObjectiveCount'],
44
50
  'createdAt': (new Date(json['createdAt'])),
45
51
  'updatedAt': (new Date(json['updatedAt'])),
@@ -56,6 +62,8 @@ export function StudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
56
62
  'id': value['id'],
57
63
  'courseId': value['courseId'],
58
64
  'title': value['title'],
65
+ 'templateSlug': value['templateSlug'],
66
+ 'templateVersion': value['templateVersion'],
59
67
  'activeObjectiveCount': value['activeObjectiveCount'],
60
68
  'createdAt': value['createdAt'].toISOString(),
61
69
  '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;
@@ -0,0 +1,49 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { StudySpaceFromJSON, StudySpaceToJSON, } from './StudySpace';
15
+ import { StudyObjectiveFromJSON, StudyObjectiveToJSON, } from './StudyObjective';
16
+ /**
17
+ * Check if a given object implements the StudySpaceFromTemplate interface.
18
+ */
19
+ export function instanceOfStudySpaceFromTemplate(value) {
20
+ if (!('space' in value) || value['space'] === undefined)
21
+ return false;
22
+ if (!('objectives' in value) || value['objectives'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function StudySpaceFromTemplateFromJSON(json) {
27
+ return StudySpaceFromTemplateFromJSONTyped(json, false);
28
+ }
29
+ export function StudySpaceFromTemplateFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'space': StudySpaceFromJSON(json['space']),
35
+ 'objectives': (json['objectives'].map(StudyObjectiveFromJSON)),
36
+ };
37
+ }
38
+ export function StudySpaceFromTemplateToJSON(json) {
39
+ return StudySpaceFromTemplateToJSONTyped(json, false);
40
+ }
41
+ export function StudySpaceFromTemplateToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'space': StudySpaceToJSON(value['space']),
47
+ 'objectives': (value['objectives'].map(StudyObjectiveToJSON)),
48
+ };
49
+ }
@@ -0,0 +1,117 @@
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 { StudySpaceTemplateProvenance } from './StudySpaceTemplateProvenance';
13
+ import type { StudySpaceTemplateConfirm } from './StudySpaceTemplateConfirm';
14
+ import type { StudySpaceTemplateLegal } from './StudySpaceTemplateLegal';
15
+ import type { StudySpaceTemplateSchedule } from './StudySpaceTemplateSchedule';
16
+ import type { StudySpaceTemplateObjective } from './StudySpaceTemplateObjective';
17
+ import type { StudySpaceTemplateAnchor } from './StudySpaceTemplateAnchor';
18
+ import type { StudySpaceTemplateLink } from './StudySpaceTemplateLink';
19
+ /**
20
+ *
21
+ * @export
22
+ * @interface StudySpaceTemplate
23
+ */
24
+ export interface StudySpaceTemplate {
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof StudySpaceTemplate
29
+ */
30
+ slug: string;
31
+ /**
32
+ * Content version of the package
33
+ * @type {string}
34
+ * @memberof StudySpaceTemplate
35
+ */
36
+ version: string;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof StudySpaceTemplate
41
+ */
42
+ title: string;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof StudySpaceTemplate
47
+ */
48
+ tagline: string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof StudySpaceTemplate
53
+ */
54
+ scopeNote: string | null;
55
+ /**
56
+ *
57
+ * @type {Array<StudySpaceTemplateLink>}
58
+ * @memberof StudySpaceTemplate
59
+ */
60
+ links: Array<StudySpaceTemplateLink>;
61
+ /**
62
+ *
63
+ * @type {StudySpaceTemplateLegal}
64
+ * @memberof StudySpaceTemplate
65
+ */
66
+ legal: StudySpaceTemplateLegal | null;
67
+ /**
68
+ *
69
+ * @type {StudySpaceTemplateProvenance}
70
+ * @memberof StudySpaceTemplate
71
+ */
72
+ provenance: StudySpaceTemplateProvenance;
73
+ /**
74
+ *
75
+ * @type {StudySpaceTemplateAnchor}
76
+ * @memberof StudySpaceTemplate
77
+ */
78
+ anchor: StudySpaceTemplateAnchor;
79
+ /**
80
+ *
81
+ * @type {StudySpaceTemplateSchedule}
82
+ * @memberof StudySpaceTemplate
83
+ */
84
+ schedule: StudySpaceTemplateSchedule;
85
+ /**
86
+ * The objectives the template creates, in course order
87
+ * @type {Array<StudySpaceTemplateObjective>}
88
+ * @memberof StudySpaceTemplate
89
+ */
90
+ objectives: Array<StudySpaceTemplateObjective>;
91
+ /**
92
+ * Distinct concepts across the units, counted by name as the template lists them
93
+ * @type {number}
94
+ * @memberof StudySpaceTemplate
95
+ */
96
+ conceptCount: number;
97
+ /**
98
+ *
99
+ * @type {StudySpaceTemplateConfirm}
100
+ * @memberof StudySpaceTemplate
101
+ */
102
+ confirm: StudySpaceTemplateConfirm;
103
+ /**
104
+ * The caller's newest space created from this template, if any — creating another is still allowed
105
+ * @type {string}
106
+ * @memberof StudySpaceTemplate
107
+ */
108
+ existingSpaceId: string | null;
109
+ }
110
+ /**
111
+ * Check if a given object implements the StudySpaceTemplate interface.
112
+ */
113
+ export declare function instanceOfStudySpaceTemplate(value: object): value is StudySpaceTemplate;
114
+ export declare function StudySpaceTemplateFromJSON(json: any): StudySpaceTemplate;
115
+ export declare function StudySpaceTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplate;
116
+ export declare function StudySpaceTemplateToJSON(json: any): StudySpaceTemplate;
117
+ export declare function StudySpaceTemplateToJSONTyped(value?: StudySpaceTemplate | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,102 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { StudySpaceTemplateProvenanceFromJSON, StudySpaceTemplateProvenanceToJSON, } from './StudySpaceTemplateProvenance';
15
+ import { StudySpaceTemplateConfirmFromJSON, StudySpaceTemplateConfirmToJSON, } from './StudySpaceTemplateConfirm';
16
+ import { StudySpaceTemplateLegalFromJSON, StudySpaceTemplateLegalToJSON, } from './StudySpaceTemplateLegal';
17
+ import { StudySpaceTemplateScheduleFromJSON, StudySpaceTemplateScheduleToJSON, } from './StudySpaceTemplateSchedule';
18
+ import { StudySpaceTemplateObjectiveFromJSON, StudySpaceTemplateObjectiveToJSON, } from './StudySpaceTemplateObjective';
19
+ import { StudySpaceTemplateAnchorFromJSON, StudySpaceTemplateAnchorToJSON, } from './StudySpaceTemplateAnchor';
20
+ import { StudySpaceTemplateLinkFromJSON, StudySpaceTemplateLinkToJSON, } from './StudySpaceTemplateLink';
21
+ /**
22
+ * Check if a given object implements the StudySpaceTemplate interface.
23
+ */
24
+ export function instanceOfStudySpaceTemplate(value) {
25
+ if (!('slug' in value) || value['slug'] === undefined)
26
+ return false;
27
+ if (!('version' in value) || value['version'] === undefined)
28
+ return false;
29
+ if (!('title' in value) || value['title'] === undefined)
30
+ return false;
31
+ if (!('tagline' in value) || value['tagline'] === undefined)
32
+ return false;
33
+ if (!('scopeNote' in value) || value['scopeNote'] === undefined)
34
+ return false;
35
+ if (!('links' in value) || value['links'] === undefined)
36
+ return false;
37
+ if (!('legal' in value) || value['legal'] === undefined)
38
+ return false;
39
+ if (!('provenance' in value) || value['provenance'] === undefined)
40
+ return false;
41
+ if (!('anchor' in value) || value['anchor'] === undefined)
42
+ return false;
43
+ if (!('schedule' in value) || value['schedule'] === undefined)
44
+ return false;
45
+ if (!('objectives' in value) || value['objectives'] === undefined)
46
+ return false;
47
+ if (!('conceptCount' in value) || value['conceptCount'] === undefined)
48
+ return false;
49
+ if (!('confirm' in value) || value['confirm'] === undefined)
50
+ return false;
51
+ if (!('existingSpaceId' in value) || value['existingSpaceId'] === undefined)
52
+ return false;
53
+ return true;
54
+ }
55
+ export function StudySpaceTemplateFromJSON(json) {
56
+ return StudySpaceTemplateFromJSONTyped(json, false);
57
+ }
58
+ export function StudySpaceTemplateFromJSONTyped(json, ignoreDiscriminator) {
59
+ if (json == null) {
60
+ return json;
61
+ }
62
+ return {
63
+ 'slug': json['slug'],
64
+ 'version': json['version'],
65
+ 'title': json['title'],
66
+ 'tagline': json['tagline'],
67
+ 'scopeNote': json['scopeNote'],
68
+ 'links': (json['links'].map(StudySpaceTemplateLinkFromJSON)),
69
+ 'legal': StudySpaceTemplateLegalFromJSON(json['legal']),
70
+ 'provenance': StudySpaceTemplateProvenanceFromJSON(json['provenance']),
71
+ 'anchor': StudySpaceTemplateAnchorFromJSON(json['anchor']),
72
+ 'schedule': StudySpaceTemplateScheduleFromJSON(json['schedule']),
73
+ 'objectives': (json['objectives'].map(StudySpaceTemplateObjectiveFromJSON)),
74
+ 'conceptCount': json['conceptCount'],
75
+ 'confirm': StudySpaceTemplateConfirmFromJSON(json['confirm']),
76
+ 'existingSpaceId': json['existingSpaceId'],
77
+ };
78
+ }
79
+ export function StudySpaceTemplateToJSON(json) {
80
+ return StudySpaceTemplateToJSONTyped(json, false);
81
+ }
82
+ export function StudySpaceTemplateToJSONTyped(value, ignoreDiscriminator = false) {
83
+ if (value == null) {
84
+ return value;
85
+ }
86
+ return {
87
+ 'slug': value['slug'],
88
+ 'version': value['version'],
89
+ 'title': value['title'],
90
+ 'tagline': value['tagline'],
91
+ 'scopeNote': value['scopeNote'],
92
+ 'links': (value['links'].map(StudySpaceTemplateLinkToJSON)),
93
+ 'legal': StudySpaceTemplateLegalToJSON(value['legal']),
94
+ 'provenance': StudySpaceTemplateProvenanceToJSON(value['provenance']),
95
+ 'anchor': StudySpaceTemplateAnchorToJSON(value['anchor']),
96
+ 'schedule': StudySpaceTemplateScheduleToJSON(value['schedule']),
97
+ 'objectives': (value['objectives'].map(StudySpaceTemplateObjectiveToJSON)),
98
+ 'conceptCount': value['conceptCount'],
99
+ 'confirm': StudySpaceTemplateConfirmToJSON(value['confirm']),
100
+ 'existingSpaceId': value['existingSpaceId'],
101
+ };
102
+ }
@@ -0,0 +1,44 @@
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 StudySpaceTemplateAnchor
16
+ */
17
+ export interface StudySpaceTemplateAnchor {
18
+ /**
19
+ * Calendar date of the anchor (YYYY-MM-DD), read in the learner's timezone
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateAnchor
22
+ */
23
+ date: string;
24
+ /**
25
+ * Local time of the anchor on that date (HH:mm)
26
+ * @type {string}
27
+ * @memberof StudySpaceTemplateAnchor
28
+ */
29
+ timeLocal: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudySpaceTemplateAnchor
34
+ */
35
+ caption: string | null;
36
+ }
37
+ /**
38
+ * Check if a given object implements the StudySpaceTemplateAnchor interface.
39
+ */
40
+ export declare function instanceOfStudySpaceTemplateAnchor(value: object): value is StudySpaceTemplateAnchor;
41
+ export declare function StudySpaceTemplateAnchorFromJSON(json: any): StudySpaceTemplateAnchor;
42
+ export declare function StudySpaceTemplateAnchorFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateAnchor;
43
+ export declare function StudySpaceTemplateAnchorToJSON(json: any): StudySpaceTemplateAnchor;
44
+ export declare function StudySpaceTemplateAnchorToJSONTyped(value?: StudySpaceTemplateAnchor | null, ignoreDiscriminator?: boolean): any;