@instructure/athena-api-client 4.0.0 → 4.0.2

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 (102) hide show
  1. package/README.md +19 -0
  2. package/dist/apis/AdminApi.d.ts +14 -12
  3. package/dist/apis/AdminApi.js +14 -12
  4. package/dist/apis/ConceptDiagramsApi.d.ts +15 -1
  5. package/dist/apis/ConceptDiagramsApi.js +41 -0
  6. package/dist/apis/ConceptImagesApi.d.ts +15 -1
  7. package/dist/apis/ConceptImagesApi.js +41 -0
  8. package/dist/apis/StudyGuidesApi.d.ts +112 -0
  9. package/dist/apis/StudyGuidesApi.js +312 -0
  10. package/dist/apis/index.d.ts +1 -0
  11. package/dist/apis/index.js +1 -0
  12. package/dist/esm/apis/AdminApi.d.ts +14 -12
  13. package/dist/esm/apis/AdminApi.js +14 -12
  14. package/dist/esm/apis/ConceptDiagramsApi.d.ts +15 -1
  15. package/dist/esm/apis/ConceptDiagramsApi.js +42 -1
  16. package/dist/esm/apis/ConceptImagesApi.d.ts +15 -1
  17. package/dist/esm/apis/ConceptImagesApi.js +42 -1
  18. package/dist/esm/apis/StudyGuidesApi.d.ts +112 -0
  19. package/dist/esm/apis/StudyGuidesApi.js +308 -0
  20. package/dist/esm/apis/index.d.ts +1 -0
  21. package/dist/esm/apis/index.js +1 -0
  22. package/dist/esm/models/AdminConceptDiagram.d.ts +19 -1
  23. package/dist/esm/models/AdminConceptDiagram.js +12 -0
  24. package/dist/esm/models/AdminConceptDiagramDetail.d.ts +19 -1
  25. package/dist/esm/models/AdminConceptDiagramDetail.js +12 -0
  26. package/dist/esm/models/AdminConceptImage.d.ts +19 -1
  27. package/dist/esm/models/AdminConceptImage.js +12 -0
  28. package/dist/esm/models/AdminConceptImageDetail.d.ts +19 -1
  29. package/dist/esm/models/AdminConceptImageDetail.js +12 -0
  30. package/dist/esm/models/AdminShownConceptDiagram.d.ts +19 -1
  31. package/dist/esm/models/AdminShownConceptDiagram.js +12 -0
  32. package/dist/esm/models/AdminShownConceptImage.d.ts +19 -1
  33. package/dist/esm/models/AdminShownConceptImage.js +12 -0
  34. package/dist/esm/models/AssociateUserFileRequest.d.ts +1 -0
  35. package/dist/esm/models/AssociateUserFileRequest.js +2 -1
  36. package/dist/esm/models/ConceptMediaFlagResult.d.ts +32 -0
  37. package/dist/esm/models/ConceptMediaFlagResult.js +43 -0
  38. package/dist/esm/models/CreateStudyGuideQuizRequest.d.ts +46 -0
  39. package/dist/esm/models/CreateStudyGuideQuizRequest.js +50 -0
  40. package/dist/esm/models/CreateStudyGuideRequest.d.ts +74 -0
  41. package/dist/esm/models/CreateStudyGuideRequest.js +55 -0
  42. package/dist/esm/models/PaginatedStudyGuides.d.ts +39 -0
  43. package/dist/esm/models/PaginatedStudyGuides.js +48 -0
  44. package/dist/esm/models/RegenerateStudyGuideRequest.d.ts +38 -0
  45. package/dist/esm/models/RegenerateStudyGuideRequest.js +43 -0
  46. package/dist/esm/models/StudyGuide.d.ts +153 -0
  47. package/dist/esm/models/StudyGuide.js +127 -0
  48. package/dist/esm/models/StudyGuideConcept.d.ts +68 -0
  49. package/dist/esm/models/StudyGuideConcept.js +67 -0
  50. package/dist/esm/models/StudyGuideFile.d.ts +56 -0
  51. package/dist/esm/models/StudyGuideFile.js +59 -0
  52. package/dist/esm/models/StudyGuideListItem.d.ts +102 -0
  53. package/dist/esm/models/StudyGuideListItem.js +92 -0
  54. package/dist/esm/models/StudyGuideQuiz.d.ts +58 -0
  55. package/dist/esm/models/StudyGuideQuiz.js +62 -0
  56. package/dist/esm/models/StudyGuideSourceSummary.d.ts +56 -0
  57. package/dist/esm/models/StudyGuideSourceSummary.js +59 -0
  58. package/dist/esm/models/UserFileAssociation.d.ts +1 -0
  59. package/dist/esm/models/UserFileAssociation.js +2 -1
  60. package/dist/esm/models/index.d.ts +11 -0
  61. package/dist/esm/models/index.js +11 -0
  62. package/dist/models/AdminConceptDiagram.d.ts +19 -1
  63. package/dist/models/AdminConceptDiagram.js +12 -0
  64. package/dist/models/AdminConceptDiagramDetail.d.ts +19 -1
  65. package/dist/models/AdminConceptDiagramDetail.js +12 -0
  66. package/dist/models/AdminConceptImage.d.ts +19 -1
  67. package/dist/models/AdminConceptImage.js +12 -0
  68. package/dist/models/AdminConceptImageDetail.d.ts +19 -1
  69. package/dist/models/AdminConceptImageDetail.js +12 -0
  70. package/dist/models/AdminShownConceptDiagram.d.ts +19 -1
  71. package/dist/models/AdminShownConceptDiagram.js +12 -0
  72. package/dist/models/AdminShownConceptImage.d.ts +19 -1
  73. package/dist/models/AdminShownConceptImage.js +12 -0
  74. package/dist/models/AssociateUserFileRequest.d.ts +1 -0
  75. package/dist/models/AssociateUserFileRequest.js +2 -1
  76. package/dist/models/ConceptMediaFlagResult.d.ts +32 -0
  77. package/dist/models/ConceptMediaFlagResult.js +50 -0
  78. package/dist/models/CreateStudyGuideQuizRequest.d.ts +46 -0
  79. package/dist/models/CreateStudyGuideQuizRequest.js +58 -0
  80. package/dist/models/CreateStudyGuideRequest.d.ts +74 -0
  81. package/dist/models/CreateStudyGuideRequest.js +62 -0
  82. package/dist/models/PaginatedStudyGuides.d.ts +39 -0
  83. package/dist/models/PaginatedStudyGuides.js +55 -0
  84. package/dist/models/RegenerateStudyGuideRequest.d.ts +38 -0
  85. package/dist/models/RegenerateStudyGuideRequest.js +50 -0
  86. package/dist/models/StudyGuide.d.ts +153 -0
  87. package/dist/models/StudyGuide.js +135 -0
  88. package/dist/models/StudyGuideConcept.d.ts +68 -0
  89. package/dist/models/StudyGuideConcept.js +74 -0
  90. package/dist/models/StudyGuideFile.d.ts +56 -0
  91. package/dist/models/StudyGuideFile.js +66 -0
  92. package/dist/models/StudyGuideListItem.d.ts +102 -0
  93. package/dist/models/StudyGuideListItem.js +100 -0
  94. package/dist/models/StudyGuideQuiz.d.ts +58 -0
  95. package/dist/models/StudyGuideQuiz.js +70 -0
  96. package/dist/models/StudyGuideSourceSummary.d.ts +56 -0
  97. package/dist/models/StudyGuideSourceSummary.js +66 -0
  98. package/dist/models/UserFileAssociation.d.ts +1 -0
  99. package/dist/models/UserFileAssociation.js +2 -1
  100. package/dist/models/index.d.ts +11 -0
  101. package/dist/models/index.js +11 -0
  102. package/package.json +1 -1
@@ -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.instanceOfCreateStudyGuideRequest = instanceOfCreateStudyGuideRequest;
17
+ exports.CreateStudyGuideRequestFromJSON = CreateStudyGuideRequestFromJSON;
18
+ exports.CreateStudyGuideRequestFromJSONTyped = CreateStudyGuideRequestFromJSONTyped;
19
+ exports.CreateStudyGuideRequestToJSON = CreateStudyGuideRequestToJSON;
20
+ exports.CreateStudyGuideRequestToJSONTyped = CreateStudyGuideRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the CreateStudyGuideRequest interface.
23
+ */
24
+ function instanceOfCreateStudyGuideRequest(value) {
25
+ return true;
26
+ }
27
+ function CreateStudyGuideRequestFromJSON(json) {
28
+ return CreateStudyGuideRequestFromJSONTyped(json, false);
29
+ }
30
+ function CreateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
36
+ 'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
37
+ 'courseId': json['courseId'] == null ? undefined : json['courseId'],
38
+ 'canvasObjectRef': json['canvasObjectRef'] == null ? undefined : json['canvasObjectRef'],
39
+ 'chatId': json['chatId'] == null ? undefined : json['chatId'],
40
+ 'assessmentTitle': json['assessmentTitle'] == null ? undefined : json['assessmentTitle'],
41
+ 'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
42
+ 'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
43
+ };
44
+ }
45
+ function CreateStudyGuideRequestToJSON(json) {
46
+ return CreateStudyGuideRequestToJSONTyped(json, false);
47
+ }
48
+ function CreateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'studyObjectiveId': value['studyObjectiveId'],
54
+ 'studySpaceId': value['studySpaceId'],
55
+ 'courseId': value['courseId'],
56
+ 'canvasObjectRef': value['canvasObjectRef'],
57
+ 'chatId': value['chatId'],
58
+ 'assessmentTitle': value['assessmentTitle'],
59
+ 'learnerContext': value['learnerContext'],
60
+ 'userFileIds': value['userFileIds'],
61
+ };
62
+ }
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { StudyGuideListItem } from './StudyGuideListItem';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PaginatedStudyGuides
17
+ */
18
+ export interface PaginatedStudyGuides {
19
+ /**
20
+ *
21
+ * @type {Array<StudyGuideListItem>}
22
+ * @memberof PaginatedStudyGuides
23
+ */
24
+ data: Array<StudyGuideListItem>;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof PaginatedStudyGuides
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the PaginatedStudyGuides interface.
34
+ */
35
+ export declare function instanceOfPaginatedStudyGuides(value: object): value is PaginatedStudyGuides;
36
+ export declare function PaginatedStudyGuidesFromJSON(json: any): PaginatedStudyGuides;
37
+ export declare function PaginatedStudyGuidesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStudyGuides;
38
+ export declare function PaginatedStudyGuidesToJSON(json: any): PaginatedStudyGuides;
39
+ export declare function PaginatedStudyGuidesToJSONTyped(value?: PaginatedStudyGuides | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
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.instanceOfPaginatedStudyGuides = instanceOfPaginatedStudyGuides;
17
+ exports.PaginatedStudyGuidesFromJSON = PaginatedStudyGuidesFromJSON;
18
+ exports.PaginatedStudyGuidesFromJSONTyped = PaginatedStudyGuidesFromJSONTyped;
19
+ exports.PaginatedStudyGuidesToJSON = PaginatedStudyGuidesToJSON;
20
+ exports.PaginatedStudyGuidesToJSONTyped = PaginatedStudyGuidesToJSONTyped;
21
+ const StudyGuideListItem_1 = require("./StudyGuideListItem");
22
+ /**
23
+ * Check if a given object implements the PaginatedStudyGuides interface.
24
+ */
25
+ function instanceOfPaginatedStudyGuides(value) {
26
+ if (!('data' in value) || value['data'] === undefined)
27
+ return false;
28
+ if (!('nextCursor' in value) || value['nextCursor'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function PaginatedStudyGuidesFromJSON(json) {
33
+ return PaginatedStudyGuidesFromJSONTyped(json, false);
34
+ }
35
+ function PaginatedStudyGuidesFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'data': (json['data'].map(StudyGuideListItem_1.StudyGuideListItemFromJSON)),
41
+ 'nextCursor': json['nextCursor'],
42
+ };
43
+ }
44
+ function PaginatedStudyGuidesToJSON(json) {
45
+ return PaginatedStudyGuidesToJSONTyped(json, false);
46
+ }
47
+ function PaginatedStudyGuidesToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(StudyGuideListItem_1.StudyGuideListItemToJSON)),
53
+ 'nextCursor': value['nextCursor'],
54
+ };
55
+ }
@@ -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 RegenerateStudyGuideRequest
16
+ */
17
+ export interface RegenerateStudyGuideRequest {
18
+ /**
19
+ * Additional context, appended to what the learner already said. Omit to retry with the same inputs.
20
+ * @type {string}
21
+ * @memberof RegenerateStudyGuideRequest
22
+ */
23
+ learnerContext?: string;
24
+ /**
25
+ * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
26
+ * @type {Array<string>}
27
+ * @memberof RegenerateStudyGuideRequest
28
+ */
29
+ userFileIds?: Array<string>;
30
+ }
31
+ /**
32
+ * Check if a given object implements the RegenerateStudyGuideRequest interface.
33
+ */
34
+ export declare function instanceOfRegenerateStudyGuideRequest(value: object): value is RegenerateStudyGuideRequest;
35
+ export declare function RegenerateStudyGuideRequestFromJSON(json: any): RegenerateStudyGuideRequest;
36
+ export declare function RegenerateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegenerateStudyGuideRequest;
37
+ export declare function RegenerateStudyGuideRequestToJSON(json: any): RegenerateStudyGuideRequest;
38
+ export declare function RegenerateStudyGuideRequestToJSONTyped(value?: RegenerateStudyGuideRequest | 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.instanceOfRegenerateStudyGuideRequest = instanceOfRegenerateStudyGuideRequest;
17
+ exports.RegenerateStudyGuideRequestFromJSON = RegenerateStudyGuideRequestFromJSON;
18
+ exports.RegenerateStudyGuideRequestFromJSONTyped = RegenerateStudyGuideRequestFromJSONTyped;
19
+ exports.RegenerateStudyGuideRequestToJSON = RegenerateStudyGuideRequestToJSON;
20
+ exports.RegenerateStudyGuideRequestToJSONTyped = RegenerateStudyGuideRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the RegenerateStudyGuideRequest interface.
23
+ */
24
+ function instanceOfRegenerateStudyGuideRequest(value) {
25
+ return true;
26
+ }
27
+ function RegenerateStudyGuideRequestFromJSON(json) {
28
+ return RegenerateStudyGuideRequestFromJSONTyped(json, false);
29
+ }
30
+ function RegenerateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
36
+ 'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
37
+ };
38
+ }
39
+ function RegenerateStudyGuideRequestToJSON(json) {
40
+ return RegenerateStudyGuideRequestToJSONTyped(json, false);
41
+ }
42
+ function RegenerateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'learnerContext': value['learnerContext'],
48
+ 'userFileIds': value['userFileIds'],
49
+ };
50
+ }
@@ -0,0 +1,153 @@
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 { StudyGuideFile } from './StudyGuideFile';
13
+ import type { StudyGuideSourceSummary } from './StudyGuideSourceSummary';
14
+ import type { StudyGuideConcept } from './StudyGuideConcept';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface StudyGuide
19
+ */
20
+ export interface StudyGuide {
21
+ /**
22
+ *
23
+ * @type {string}
24
+ * @memberof StudyGuide
25
+ */
26
+ id: string;
27
+ /**
28
+ *
29
+ * @type {string}
30
+ * @memberof StudyGuide
31
+ */
32
+ accountUserId: string;
33
+ /**
34
+ *
35
+ * @type {string}
36
+ * @memberof StudyGuide
37
+ */
38
+ studySpaceId: string | null;
39
+ /**
40
+ *
41
+ * @type {string}
42
+ * @memberof StudyGuide
43
+ */
44
+ studyObjectiveId: string | null;
45
+ /**
46
+ *
47
+ * @type {string}
48
+ * @memberof StudyGuide
49
+ */
50
+ chatId: string | null;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof StudyGuide
55
+ */
56
+ courseId: string | null;
57
+ /**
58
+ *
59
+ * @type {string}
60
+ * @memberof StudyGuide
61
+ */
62
+ canvasObjectRef: string | null;
63
+ /**
64
+ *
65
+ * @type {string}
66
+ * @memberof StudyGuide
67
+ */
68
+ title: string;
69
+ /**
70
+ *
71
+ * @type {string}
72
+ * @memberof StudyGuide
73
+ */
74
+ assessmentTitle: string | null;
75
+ /**
76
+ *
77
+ * @type {string}
78
+ * @memberof StudyGuide
79
+ */
80
+ learnerContext: string | null;
81
+ /**
82
+ * 'generating' while the generator runs (poll); 'ready' with concepts; 'needs-context' when Athena could not tell what the assessment covers (see refusalReason and missingContext, then regenerate with more); 'failed' on an infrastructure error.
83
+ * @type {string}
84
+ * @memberof StudyGuide
85
+ */
86
+ status: StudyGuideStatusEnum;
87
+ /**
88
+ *
89
+ * @type {string}
90
+ * @memberof StudyGuide
91
+ */
92
+ refusalReason: string | null;
93
+ /**
94
+ *
95
+ * @type {Array<string>}
96
+ * @memberof StudyGuide
97
+ */
98
+ missingContext: Array<string> | null;
99
+ /**
100
+ *
101
+ * @type {string}
102
+ * @memberof StudyGuide
103
+ */
104
+ summary: string | null;
105
+ /**
106
+ *
107
+ * @type {StudyGuideSourceSummary}
108
+ * @memberof StudyGuide
109
+ */
110
+ sourceSummary: StudyGuideSourceSummary | null;
111
+ /**
112
+ *
113
+ * @type {Array<StudyGuideConcept>}
114
+ * @memberof StudyGuide
115
+ */
116
+ concepts: Array<StudyGuideConcept>;
117
+ /**
118
+ *
119
+ * @type {Array<StudyGuideFile>}
120
+ * @memberof StudyGuide
121
+ */
122
+ files: Array<StudyGuideFile>;
123
+ /**
124
+ *
125
+ * @type {Date}
126
+ * @memberof StudyGuide
127
+ */
128
+ createdAt: Date;
129
+ /**
130
+ *
131
+ * @type {Date}
132
+ * @memberof StudyGuide
133
+ */
134
+ updatedAt: Date;
135
+ }
136
+ /**
137
+ * @export
138
+ */
139
+ export declare const StudyGuideStatusEnum: {
140
+ readonly Generating: "generating";
141
+ readonly Ready: "ready";
142
+ readonly NeedsContext: "needs-context";
143
+ readonly Failed: "failed";
144
+ };
145
+ export type StudyGuideStatusEnum = typeof StudyGuideStatusEnum[keyof typeof StudyGuideStatusEnum];
146
+ /**
147
+ * Check if a given object implements the StudyGuide interface.
148
+ */
149
+ export declare function instanceOfStudyGuide(value: object): value is StudyGuide;
150
+ export declare function StudyGuideFromJSON(json: any): StudyGuide;
151
+ export declare function StudyGuideFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuide;
152
+ export declare function StudyGuideToJSON(json: any): StudyGuide;
153
+ export declare function StudyGuideToJSONTyped(value?: StudyGuide | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,135 @@
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.StudyGuideStatusEnum = void 0;
17
+ exports.instanceOfStudyGuide = instanceOfStudyGuide;
18
+ exports.StudyGuideFromJSON = StudyGuideFromJSON;
19
+ exports.StudyGuideFromJSONTyped = StudyGuideFromJSONTyped;
20
+ exports.StudyGuideToJSON = StudyGuideToJSON;
21
+ exports.StudyGuideToJSONTyped = StudyGuideToJSONTyped;
22
+ const StudyGuideFile_1 = require("./StudyGuideFile");
23
+ const StudyGuideSourceSummary_1 = require("./StudyGuideSourceSummary");
24
+ const StudyGuideConcept_1 = require("./StudyGuideConcept");
25
+ /**
26
+ * @export
27
+ */
28
+ exports.StudyGuideStatusEnum = {
29
+ Generating: 'generating',
30
+ Ready: 'ready',
31
+ NeedsContext: 'needs-context',
32
+ Failed: 'failed'
33
+ };
34
+ /**
35
+ * Check if a given object implements the StudyGuide interface.
36
+ */
37
+ function instanceOfStudyGuide(value) {
38
+ if (!('id' in value) || value['id'] === undefined)
39
+ return false;
40
+ if (!('accountUserId' in value) || value['accountUserId'] === undefined)
41
+ return false;
42
+ if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
43
+ return false;
44
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
45
+ return false;
46
+ if (!('chatId' in value) || value['chatId'] === undefined)
47
+ return false;
48
+ if (!('courseId' in value) || value['courseId'] === undefined)
49
+ return false;
50
+ if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
51
+ return false;
52
+ if (!('title' in value) || value['title'] === undefined)
53
+ return false;
54
+ if (!('assessmentTitle' in value) || value['assessmentTitle'] === undefined)
55
+ return false;
56
+ if (!('learnerContext' in value) || value['learnerContext'] === undefined)
57
+ return false;
58
+ if (!('status' in value) || value['status'] === undefined)
59
+ return false;
60
+ if (!('refusalReason' in value) || value['refusalReason'] === undefined)
61
+ return false;
62
+ if (!('missingContext' in value) || value['missingContext'] === undefined)
63
+ return false;
64
+ if (!('summary' in value) || value['summary'] === undefined)
65
+ return false;
66
+ if (!('sourceSummary' in value) || value['sourceSummary'] === undefined)
67
+ return false;
68
+ if (!('concepts' in value) || value['concepts'] === undefined)
69
+ return false;
70
+ if (!('files' in value) || value['files'] === undefined)
71
+ return false;
72
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
73
+ return false;
74
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
75
+ return false;
76
+ return true;
77
+ }
78
+ function StudyGuideFromJSON(json) {
79
+ return StudyGuideFromJSONTyped(json, false);
80
+ }
81
+ function StudyGuideFromJSONTyped(json, ignoreDiscriminator) {
82
+ if (json == null) {
83
+ return json;
84
+ }
85
+ return {
86
+ 'id': json['id'],
87
+ 'accountUserId': json['accountUserId'],
88
+ 'studySpaceId': json['studySpaceId'],
89
+ 'studyObjectiveId': json['studyObjectiveId'],
90
+ 'chatId': json['chatId'],
91
+ 'courseId': json['courseId'],
92
+ 'canvasObjectRef': json['canvasObjectRef'],
93
+ 'title': json['title'],
94
+ 'assessmentTitle': json['assessmentTitle'],
95
+ 'learnerContext': json['learnerContext'],
96
+ 'status': json['status'],
97
+ 'refusalReason': json['refusalReason'],
98
+ 'missingContext': json['missingContext'] == null ? null : json['missingContext'],
99
+ 'summary': json['summary'],
100
+ 'sourceSummary': (0, StudyGuideSourceSummary_1.StudyGuideSourceSummaryFromJSON)(json['sourceSummary']),
101
+ 'concepts': (json['concepts'].map(StudyGuideConcept_1.StudyGuideConceptFromJSON)),
102
+ 'files': (json['files'].map(StudyGuideFile_1.StudyGuideFileFromJSON)),
103
+ 'createdAt': (new Date(json['createdAt'])),
104
+ 'updatedAt': (new Date(json['updatedAt'])),
105
+ };
106
+ }
107
+ function StudyGuideToJSON(json) {
108
+ return StudyGuideToJSONTyped(json, false);
109
+ }
110
+ function StudyGuideToJSONTyped(value, ignoreDiscriminator = false) {
111
+ if (value == null) {
112
+ return value;
113
+ }
114
+ return {
115
+ 'id': value['id'],
116
+ 'accountUserId': value['accountUserId'],
117
+ 'studySpaceId': value['studySpaceId'],
118
+ 'studyObjectiveId': value['studyObjectiveId'],
119
+ 'chatId': value['chatId'],
120
+ 'courseId': value['courseId'],
121
+ 'canvasObjectRef': value['canvasObjectRef'],
122
+ 'title': value['title'],
123
+ 'assessmentTitle': value['assessmentTitle'],
124
+ 'learnerContext': value['learnerContext'],
125
+ 'status': value['status'],
126
+ 'refusalReason': value['refusalReason'],
127
+ 'missingContext': value['missingContext'],
128
+ 'summary': value['summary'],
129
+ 'sourceSummary': (0, StudyGuideSourceSummary_1.StudyGuideSourceSummaryToJSON)(value['sourceSummary']),
130
+ 'concepts': (value['concepts'].map(StudyGuideConcept_1.StudyGuideConceptToJSON)),
131
+ 'files': (value['files'].map(StudyGuideFile_1.StudyGuideFileToJSON)),
132
+ 'createdAt': value['createdAt'].toISOString(),
133
+ 'updatedAt': value['updatedAt'].toISOString(),
134
+ };
135
+ }
@@ -0,0 +1,68 @@
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 StudyGuideConcept
16
+ */
17
+ export interface StudyGuideConcept {
18
+ /**
19
+ * Row id.
20
+ * @type {string}
21
+ * @memberof StudyGuideConcept
22
+ */
23
+ id: string;
24
+ /**
25
+ * Shared concept id, usable with the quiz and tutoring surfaces.
26
+ * @type {string}
27
+ * @memberof StudyGuideConcept
28
+ */
29
+ conceptId: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudyGuideConcept
34
+ */
35
+ name: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof StudyGuideConcept
40
+ */
41
+ shortName: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof StudyGuideConcept
46
+ */
47
+ description: string;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof StudyGuideConcept
52
+ */
53
+ displayOrder: number;
54
+ /**
55
+ * Why this concept is on the assessment and what to focus on, as read from the sources.
56
+ * @type {string}
57
+ * @memberof StudyGuideConcept
58
+ */
59
+ focusNote: string | null;
60
+ }
61
+ /**
62
+ * Check if a given object implements the StudyGuideConcept interface.
63
+ */
64
+ export declare function instanceOfStudyGuideConcept(value: object): value is StudyGuideConcept;
65
+ export declare function StudyGuideConceptFromJSON(json: any): StudyGuideConcept;
66
+ export declare function StudyGuideConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyGuideConcept;
67
+ export declare function StudyGuideConceptToJSON(json: any): StudyGuideConcept;
68
+ export declare function StudyGuideConceptToJSONTyped(value?: StudyGuideConcept | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,74 @@
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.instanceOfStudyGuideConcept = instanceOfStudyGuideConcept;
17
+ exports.StudyGuideConceptFromJSON = StudyGuideConceptFromJSON;
18
+ exports.StudyGuideConceptFromJSONTyped = StudyGuideConceptFromJSONTyped;
19
+ exports.StudyGuideConceptToJSON = StudyGuideConceptToJSON;
20
+ exports.StudyGuideConceptToJSONTyped = StudyGuideConceptToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the StudyGuideConcept interface.
23
+ */
24
+ function instanceOfStudyGuideConcept(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('conceptId' in value) || value['conceptId'] === undefined)
28
+ return false;
29
+ if (!('name' in value) || value['name'] === undefined)
30
+ return false;
31
+ if (!('shortName' in value) || value['shortName'] === undefined)
32
+ return false;
33
+ if (!('description' in value) || value['description'] === undefined)
34
+ return false;
35
+ if (!('displayOrder' in value) || value['displayOrder'] === undefined)
36
+ return false;
37
+ if (!('focusNote' in value) || value['focusNote'] === undefined)
38
+ return false;
39
+ return true;
40
+ }
41
+ function StudyGuideConceptFromJSON(json) {
42
+ return StudyGuideConceptFromJSONTyped(json, false);
43
+ }
44
+ function StudyGuideConceptFromJSONTyped(json, ignoreDiscriminator) {
45
+ if (json == null) {
46
+ return json;
47
+ }
48
+ return {
49
+ 'id': json['id'],
50
+ 'conceptId': json['conceptId'],
51
+ 'name': json['name'],
52
+ 'shortName': json['shortName'],
53
+ 'description': json['description'],
54
+ 'displayOrder': json['displayOrder'],
55
+ 'focusNote': json['focusNote'],
56
+ };
57
+ }
58
+ function StudyGuideConceptToJSON(json) {
59
+ return StudyGuideConceptToJSONTyped(json, false);
60
+ }
61
+ function StudyGuideConceptToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'id': value['id'],
67
+ 'conceptId': value['conceptId'],
68
+ 'name': value['name'],
69
+ 'shortName': value['shortName'],
70
+ 'description': value['description'],
71
+ 'displayOrder': value['displayOrder'],
72
+ 'focusNote': value['focusNote'],
73
+ };
74
+ }