@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.
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,51 @@
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 StudySpaceTemplateAnchor interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateAnchor(value) {
18
+ if (!('date' in value) || value['date'] === undefined)
19
+ return false;
20
+ if (!('timeLocal' in value) || value['timeLocal'] === undefined)
21
+ return false;
22
+ if (!('caption' in value) || value['caption'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function StudySpaceTemplateAnchorFromJSON(json) {
27
+ return StudySpaceTemplateAnchorFromJSONTyped(json, false);
28
+ }
29
+ export function StudySpaceTemplateAnchorFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'date': json['date'],
35
+ 'timeLocal': json['timeLocal'],
36
+ 'caption': json['caption'],
37
+ };
38
+ }
39
+ export function StudySpaceTemplateAnchorToJSON(json) {
40
+ return StudySpaceTemplateAnchorToJSONTyped(json, false);
41
+ }
42
+ export function StudySpaceTemplateAnchorToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'date': value['date'],
48
+ 'timeLocal': value['timeLocal'],
49
+ 'caption': value['caption'],
50
+ };
51
+ }
@@ -0,0 +1,33 @@
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 { StudySpaceTemplateNotice } from './StudySpaceTemplateNotice';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface StudySpaceTemplateConfirm
17
+ */
18
+ export interface StudySpaceTemplateConfirm {
19
+ /**
20
+ * Notices to show before the learner confirms; none means show nothing
21
+ * @type {Array<StudySpaceTemplateNotice>}
22
+ * @memberof StudySpaceTemplateConfirm
23
+ */
24
+ notices: Array<StudySpaceTemplateNotice>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the StudySpaceTemplateConfirm interface.
28
+ */
29
+ export declare function instanceOfStudySpaceTemplateConfirm(value: object): value is StudySpaceTemplateConfirm;
30
+ export declare function StudySpaceTemplateConfirmFromJSON(json: any): StudySpaceTemplateConfirm;
31
+ export declare function StudySpaceTemplateConfirmFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateConfirm;
32
+ export declare function StudySpaceTemplateConfirmToJSON(json: any): StudySpaceTemplateConfirm;
33
+ export declare function StudySpaceTemplateConfirmToJSONTyped(value?: StudySpaceTemplateConfirm | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,44 @@
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 { StudySpaceTemplateNoticeFromJSON, StudySpaceTemplateNoticeToJSON, } from './StudySpaceTemplateNotice';
15
+ /**
16
+ * Check if a given object implements the StudySpaceTemplateConfirm interface.
17
+ */
18
+ export function instanceOfStudySpaceTemplateConfirm(value) {
19
+ if (!('notices' in value) || value['notices'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function StudySpaceTemplateConfirmFromJSON(json) {
24
+ return StudySpaceTemplateConfirmFromJSONTyped(json, false);
25
+ }
26
+ export function StudySpaceTemplateConfirmFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'notices': (json['notices'].map(StudySpaceTemplateNoticeFromJSON)),
32
+ };
33
+ }
34
+ export function StudySpaceTemplateConfirmToJSON(json) {
35
+ return StudySpaceTemplateConfirmToJSONTyped(json, false);
36
+ }
37
+ export function StudySpaceTemplateConfirmToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'notices': (value['notices'].map(StudySpaceTemplateNoticeToJSON)),
43
+ };
44
+ }
@@ -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 StudySpaceTemplateLegal
16
+ */
17
+ export interface StudySpaceTemplateLegal {
18
+ /**
19
+ * Legal footnote to show with the template
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateLegal
22
+ */
23
+ footnote: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the StudySpaceTemplateLegal interface.
27
+ */
28
+ export declare function instanceOfStudySpaceTemplateLegal(value: object): value is StudySpaceTemplateLegal;
29
+ export declare function StudySpaceTemplateLegalFromJSON(json: any): StudySpaceTemplateLegal;
30
+ export declare function StudySpaceTemplateLegalFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateLegal;
31
+ export declare function StudySpaceTemplateLegalToJSON(json: any): StudySpaceTemplateLegal;
32
+ export declare function StudySpaceTemplateLegalToJSONTyped(value?: StudySpaceTemplateLegal | 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 StudySpaceTemplateLegal interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateLegal(value) {
18
+ if (!('footnote' in value) || value['footnote'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function StudySpaceTemplateLegalFromJSON(json) {
23
+ return StudySpaceTemplateLegalFromJSONTyped(json, false);
24
+ }
25
+ export function StudySpaceTemplateLegalFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'footnote': json['footnote'],
31
+ };
32
+ }
33
+ export function StudySpaceTemplateLegalToJSON(json) {
34
+ return StudySpaceTemplateLegalToJSONTyped(json, false);
35
+ }
36
+ export function StudySpaceTemplateLegalToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'footnote': value['footnote'],
42
+ };
43
+ }
@@ -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 StudySpaceTemplateLink
16
+ */
17
+ export interface StudySpaceTemplateLink {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateLink
22
+ */
23
+ label: string;
24
+ /**
25
+ * https URL
26
+ * @type {string}
27
+ * @memberof StudySpaceTemplateLink
28
+ */
29
+ url: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the StudySpaceTemplateLink interface.
33
+ */
34
+ export declare function instanceOfStudySpaceTemplateLink(value: object): value is StudySpaceTemplateLink;
35
+ export declare function StudySpaceTemplateLinkFromJSON(json: any): StudySpaceTemplateLink;
36
+ export declare function StudySpaceTemplateLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateLink;
37
+ export declare function StudySpaceTemplateLinkToJSON(json: any): StudySpaceTemplateLink;
38
+ export declare function StudySpaceTemplateLinkToJSONTyped(value?: StudySpaceTemplateLink | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
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 StudySpaceTemplateLink interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateLink(value) {
18
+ if (!('label' in value) || value['label'] === undefined)
19
+ return false;
20
+ if (!('url' in value) || value['url'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function StudySpaceTemplateLinkFromJSON(json) {
25
+ return StudySpaceTemplateLinkFromJSONTyped(json, false);
26
+ }
27
+ export function StudySpaceTemplateLinkFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'label': json['label'],
33
+ 'url': json['url'],
34
+ };
35
+ }
36
+ export function StudySpaceTemplateLinkToJSON(json) {
37
+ return StudySpaceTemplateLinkToJSONTyped(json, false);
38
+ }
39
+ export function StudySpaceTemplateLinkToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'label': value['label'],
45
+ 'url': value['url'],
46
+ };
47
+ }
@@ -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,47 @@
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 StudySpaceTemplateNotice interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateNotice(value) {
18
+ if (!('title' in value) || value['title'] === undefined)
19
+ return false;
20
+ if (!('body' in value) || value['body'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function StudySpaceTemplateNoticeFromJSON(json) {
25
+ return StudySpaceTemplateNoticeFromJSONTyped(json, false);
26
+ }
27
+ export function StudySpaceTemplateNoticeFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'title': json['title'],
33
+ 'body': json['body'],
34
+ };
35
+ }
36
+ export function StudySpaceTemplateNoticeToJSON(json) {
37
+ return StudySpaceTemplateNoticeToJSONTyped(json, false);
38
+ }
39
+ export function StudySpaceTemplateNoticeToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'title': value['title'],
45
+ 'body': value['body'],
46
+ };
47
+ }
@@ -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,58 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const StudySpaceTemplateObjectiveRoleEnum = {
18
+ Unit: 'unit',
19
+ Anchor: 'anchor'
20
+ };
21
+ /**
22
+ * Check if a given object implements the StudySpaceTemplateObjective interface.
23
+ */
24
+ export function instanceOfStudySpaceTemplateObjective(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 (!('role' in value) || value['role'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ export function StudySpaceTemplateObjectiveFromJSON(json) {
34
+ return StudySpaceTemplateObjectiveFromJSONTyped(json, false);
35
+ }
36
+ export function StudySpaceTemplateObjectiveFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'key': json['key'],
42
+ 'title': json['title'],
43
+ 'role': json['role'],
44
+ };
45
+ }
46
+ export function StudySpaceTemplateObjectiveToJSON(json) {
47
+ return StudySpaceTemplateObjectiveToJSONTyped(json, false);
48
+ }
49
+ export function StudySpaceTemplateObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'key': value['key'],
55
+ 'title': value['title'],
56
+ 'role': value['role'],
57
+ };
58
+ }
@@ -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,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the StudySpaceTemplateProvenance interface.
16
+ */
17
+ export function instanceOfStudySpaceTemplateProvenance(value) {
18
+ if (!('author' in value) || value['author'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function StudySpaceTemplateProvenanceFromJSON(json) {
23
+ return StudySpaceTemplateProvenanceFromJSONTyped(json, false);
24
+ }
25
+ export function StudySpaceTemplateProvenanceFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'author': json['author'],
31
+ };
32
+ }
33
+ export function StudySpaceTemplateProvenanceToJSON(json) {
34
+ return StudySpaceTemplateProvenanceToJSONTyped(json, false);
35
+ }
36
+ export function StudySpaceTemplateProvenanceToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'author': value['author'],
42
+ };
43
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface StudySpaceTemplateSchedule
16
+ */
17
+ export interface StudySpaceTemplateSchedule {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudySpaceTemplateSchedule
22
+ */
23
+ policy: StudySpaceTemplateSchedulePolicyEnum;
24
+ /**
25
+ * Whether the learner may say where they are in the course; when false, `startIndex` must be 0
26
+ * @type {boolean}
27
+ * @memberof StudySpaceTemplateSchedule
28
+ */
29
+ allowStartAt: boolean;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudySpaceTemplateSchedule
34
+ */
35
+ startSelectorLabel: string | null;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const StudySpaceTemplateSchedulePolicyEnum: {
41
+ readonly ProportionalToAnchor: "proportional_to_anchor";
42
+ };
43
+ export type StudySpaceTemplateSchedulePolicyEnum = typeof StudySpaceTemplateSchedulePolicyEnum[keyof typeof StudySpaceTemplateSchedulePolicyEnum];
44
+ /**
45
+ * Check if a given object implements the StudySpaceTemplateSchedule interface.
46
+ */
47
+ export declare function instanceOfStudySpaceTemplateSchedule(value: object): value is StudySpaceTemplateSchedule;
48
+ export declare function StudySpaceTemplateScheduleFromJSON(json: any): StudySpaceTemplateSchedule;
49
+ export declare function StudySpaceTemplateScheduleFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplateSchedule;
50
+ export declare function StudySpaceTemplateScheduleToJSON(json: any): StudySpaceTemplateSchedule;
51
+ export declare function StudySpaceTemplateScheduleToJSONTyped(value?: StudySpaceTemplateSchedule | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const StudySpaceTemplateSchedulePolicyEnum = {
18
+ ProportionalToAnchor: 'proportional_to_anchor'
19
+ };
20
+ /**
21
+ * Check if a given object implements the StudySpaceTemplateSchedule interface.
22
+ */
23
+ export function instanceOfStudySpaceTemplateSchedule(value) {
24
+ if (!('policy' in value) || value['policy'] === undefined)
25
+ return false;
26
+ if (!('allowStartAt' in value) || value['allowStartAt'] === undefined)
27
+ return false;
28
+ if (!('startSelectorLabel' in value) || value['startSelectorLabel'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function StudySpaceTemplateScheduleFromJSON(json) {
33
+ return StudySpaceTemplateScheduleFromJSONTyped(json, false);
34
+ }
35
+ export function StudySpaceTemplateScheduleFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'policy': json['policy'],
41
+ 'allowStartAt': json['allowStartAt'],
42
+ 'startSelectorLabel': json['startSelectorLabel'],
43
+ };
44
+ }
45
+ export function StudySpaceTemplateScheduleToJSON(json) {
46
+ return StudySpaceTemplateScheduleToJSONTyped(json, false);
47
+ }
48
+ export function StudySpaceTemplateScheduleToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'policy': value['policy'],
54
+ 'allowStartAt': value['allowStartAt'],
55
+ 'startSelectorLabel': value['startSelectorLabel'],
56
+ };
57
+ }