@instructure/athena-api-client 3.0.3 → 3.0.4

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 (134) hide show
  1. package/README.md +39 -0
  2. package/dist/apis/ChatsApi.d.ts +2 -0
  3. package/dist/apis/ChatsApi.js +6 -0
  4. package/dist/apis/DailyQuizApi.d.ts +1 -0
  5. package/dist/apis/DailyQuizApi.js +3 -0
  6. package/dist/apis/MessagesApi.d.ts +1 -0
  7. package/dist/apis/MessagesApi.js +3 -0
  8. package/dist/apis/PracticeQuizzesApi.d.ts +1 -0
  9. package/dist/apis/PracticeQuizzesApi.js +3 -0
  10. package/dist/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  11. package/dist/apis/StudyObjectiveConceptsApi.js +133 -0
  12. package/dist/apis/StudyObjectivesApi.d.ts +127 -0
  13. package/dist/apis/StudyObjectivesApi.js +378 -0
  14. package/dist/apis/UserFilesApi.d.ts +90 -0
  15. package/dist/apis/UserFilesApi.js +246 -0
  16. package/dist/apis/index.d.ts +3 -0
  17. package/dist/apis/index.js +3 -0
  18. package/dist/esm/apis/ChatsApi.d.ts +2 -0
  19. package/dist/esm/apis/ChatsApi.js +6 -0
  20. package/dist/esm/apis/DailyQuizApi.d.ts +1 -0
  21. package/dist/esm/apis/DailyQuizApi.js +3 -0
  22. package/dist/esm/apis/MessagesApi.d.ts +1 -0
  23. package/dist/esm/apis/MessagesApi.js +3 -0
  24. package/dist/esm/apis/PracticeQuizzesApi.d.ts +1 -0
  25. package/dist/esm/apis/PracticeQuizzesApi.js +3 -0
  26. package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +50 -0
  27. package/dist/esm/apis/StudyObjectiveConceptsApi.js +129 -0
  28. package/dist/esm/apis/StudyObjectivesApi.d.ts +127 -0
  29. package/dist/esm/apis/StudyObjectivesApi.js +374 -0
  30. package/dist/esm/apis/UserFilesApi.d.ts +90 -0
  31. package/dist/esm/apis/UserFilesApi.js +242 -0
  32. package/dist/esm/apis/index.d.ts +3 -0
  33. package/dist/esm/apis/index.js +3 -0
  34. package/dist/esm/models/AssociateUserFileRequest.d.ts +48 -0
  35. package/dist/esm/models/AssociateUserFileRequest.js +56 -0
  36. package/dist/esm/models/CreateObjectiveResourceDto.d.ts +47 -0
  37. package/dist/esm/models/CreateObjectiveResourceDto.js +55 -0
  38. package/dist/esm/models/CreateStudyObjectiveDto.d.ts +57 -0
  39. package/dist/esm/models/CreateStudyObjectiveDto.js +54 -0
  40. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  41. package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +55 -0
  42. package/dist/esm/models/ObjectiveResource.d.ts +71 -0
  43. package/dist/esm/models/ObjectiveResource.js +71 -0
  44. package/dist/esm/models/PaginatedObjectiveResources.d.ts +39 -0
  45. package/dist/esm/models/PaginatedObjectiveResources.js +48 -0
  46. package/dist/esm/models/PaginatedStudyObjectives.d.ts +39 -0
  47. package/dist/esm/models/PaginatedStudyObjectives.js +48 -0
  48. package/dist/esm/models/StudyObjective.d.ts +88 -0
  49. package/dist/esm/models/StudyObjective.js +81 -0
  50. package/dist/esm/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  51. package/dist/esm/models/StudyObjectiveCanvasDocument.js +55 -0
  52. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  53. package/dist/esm/models/StudyObjectiveConceptAttachment.js +77 -0
  54. package/dist/esm/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  55. package/dist/esm/models/StudyObjectiveConceptAttachmentList.js +44 -0
  56. package/dist/esm/models/StudyObjectiveConceptSummary.d.ts +56 -0
  57. package/dist/esm/models/StudyObjectiveConceptSummary.js +59 -0
  58. package/dist/esm/models/StudyObjectiveFileAttachment.d.ts +56 -0
  59. package/dist/esm/models/StudyObjectiveFileAttachment.js +59 -0
  60. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  61. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +58 -0
  62. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  63. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +48 -0
  64. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  65. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +43 -0
  66. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  67. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.js +44 -0
  68. package/dist/esm/models/UpdateStudyObjectiveDto.d.ts +51 -0
  69. package/dist/esm/models/UpdateStudyObjectiveDto.js +48 -0
  70. package/dist/esm/models/UserFile.d.ts +75 -0
  71. package/dist/esm/models/UserFile.js +72 -0
  72. package/dist/esm/models/UserFileAssociation.d.ts +60 -0
  73. package/dist/esm/models/UserFileAssociation.js +64 -0
  74. package/dist/esm/models/UserFileUploadUrlFile.d.ts +56 -0
  75. package/dist/esm/models/UserFileUploadUrlFile.js +59 -0
  76. package/dist/esm/models/UserFileUploadUrlRequest.d.ts +33 -0
  77. package/dist/esm/models/UserFileUploadUrlRequest.js +44 -0
  78. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  79. package/dist/esm/models/UserFileUploadUrlRequestFilesInner.js +58 -0
  80. package/dist/esm/models/UserFileUploadUrlResponse.d.ts +33 -0
  81. package/dist/esm/models/UserFileUploadUrlResponse.js +44 -0
  82. package/dist/esm/models/index.d.ts +24 -0
  83. package/dist/esm/models/index.js +24 -0
  84. package/dist/models/AssociateUserFileRequest.d.ts +48 -0
  85. package/dist/models/AssociateUserFileRequest.js +64 -0
  86. package/dist/models/CreateObjectiveResourceDto.d.ts +47 -0
  87. package/dist/models/CreateObjectiveResourceDto.js +63 -0
  88. package/dist/models/CreateStudyObjectiveDto.d.ts +57 -0
  89. package/dist/models/CreateStudyObjectiveDto.js +61 -0
  90. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.d.ts +50 -0
  91. package/dist/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js +62 -0
  92. package/dist/models/ObjectiveResource.d.ts +71 -0
  93. package/dist/models/ObjectiveResource.js +79 -0
  94. package/dist/models/PaginatedObjectiveResources.d.ts +39 -0
  95. package/dist/models/PaginatedObjectiveResources.js +55 -0
  96. package/dist/models/PaginatedStudyObjectives.d.ts +39 -0
  97. package/dist/models/PaginatedStudyObjectives.js +55 -0
  98. package/dist/models/StudyObjective.d.ts +88 -0
  99. package/dist/models/StudyObjective.js +88 -0
  100. package/dist/models/StudyObjectiveCanvasDocument.d.ts +50 -0
  101. package/dist/models/StudyObjectiveCanvasDocument.js +62 -0
  102. package/dist/models/StudyObjectiveConceptAttachment.d.ts +76 -0
  103. package/dist/models/StudyObjectiveConceptAttachment.js +85 -0
  104. package/dist/models/StudyObjectiveConceptAttachmentList.d.ts +33 -0
  105. package/dist/models/StudyObjectiveConceptAttachmentList.js +51 -0
  106. package/dist/models/StudyObjectiveConceptSummary.d.ts +56 -0
  107. package/dist/models/StudyObjectiveConceptSummary.js +66 -0
  108. package/dist/models/StudyObjectiveFileAttachment.d.ts +56 -0
  109. package/dist/models/StudyObjectiveFileAttachment.js +66 -0
  110. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +50 -0
  111. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +66 -0
  112. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +39 -0
  113. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +55 -0
  114. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +32 -0
  115. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +50 -0
  116. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +33 -0
  117. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.js +51 -0
  118. package/dist/models/UpdateStudyObjectiveDto.d.ts +51 -0
  119. package/dist/models/UpdateStudyObjectiveDto.js +55 -0
  120. package/dist/models/UserFile.d.ts +75 -0
  121. package/dist/models/UserFile.js +79 -0
  122. package/dist/models/UserFileAssociation.d.ts +60 -0
  123. package/dist/models/UserFileAssociation.js +72 -0
  124. package/dist/models/UserFileUploadUrlFile.d.ts +56 -0
  125. package/dist/models/UserFileUploadUrlFile.js +66 -0
  126. package/dist/models/UserFileUploadUrlRequest.d.ts +33 -0
  127. package/dist/models/UserFileUploadUrlRequest.js +51 -0
  128. package/dist/models/UserFileUploadUrlRequestFilesInner.d.ts +52 -0
  129. package/dist/models/UserFileUploadUrlRequestFilesInner.js +66 -0
  130. package/dist/models/UserFileUploadUrlResponse.d.ts +33 -0
  131. package/dist/models/UserFileUploadUrlResponse.js +51 -0
  132. package/dist/models/index.d.ts +24 -0
  133. package/dist/models/index.js +24 -0
  134. package/package.json +1 -1
@@ -0,0 +1,76 @@
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 { StudyObjectiveConceptSummary } from './StudyObjectiveConceptSummary';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface StudyObjectiveConceptAttachment
17
+ */
18
+ export interface StudyObjectiveConceptAttachment {
19
+ /**
20
+ * Identifies which target shape the attachment row carries. `canvas_object` rows are keyed by `(canvasDomain, canvasCourseId, canvasObjectId)`; `study_objective` rows are keyed by the study-objective UUID.
21
+ * @type {string}
22
+ * @memberof StudyObjectiveConceptAttachment
23
+ */
24
+ kind: StudyObjectiveConceptAttachmentKindEnum;
25
+ /**
26
+ * Stable identifier within the kind. For `canvas_object`, the Canvas object id (e.g. 'assignment:67890'); for `study_objective`, the objective UUID. The list endpoint returns one attachment per (kind, key) requested.
27
+ * @type {string}
28
+ * @memberof StudyObjectiveConceptAttachment
29
+ */
30
+ key: string;
31
+ /**
32
+ * Sidecar status snapshot. `missing` is returned for ids that have no sidecar row yet (kill switch off, first call, or trigger soft-failed).
33
+ * @type {string}
34
+ * @memberof StudyObjectiveConceptAttachment
35
+ */
36
+ status: StudyObjectiveConceptAttachmentStatusEnum;
37
+ /**
38
+ * Last recorded error message when status is `failed`.
39
+ * @type {string}
40
+ * @memberof StudyObjectiveConceptAttachment
41
+ */
42
+ lastError: string | null;
43
+ /**
44
+ *
45
+ * @type {Array<StudyObjectiveConceptSummary>}
46
+ * @memberof StudyObjectiveConceptAttachment
47
+ */
48
+ concepts: Array<StudyObjectiveConceptSummary>;
49
+ }
50
+ /**
51
+ * @export
52
+ */
53
+ export declare const StudyObjectiveConceptAttachmentKindEnum: {
54
+ readonly CanvasObject: "canvas_object";
55
+ readonly StudyObjective: "study_objective";
56
+ };
57
+ export type StudyObjectiveConceptAttachmentKindEnum = typeof StudyObjectiveConceptAttachmentKindEnum[keyof typeof StudyObjectiveConceptAttachmentKindEnum];
58
+ /**
59
+ * @export
60
+ */
61
+ export declare const StudyObjectiveConceptAttachmentStatusEnum: {
62
+ readonly Pending: "pending";
63
+ readonly Running: "running";
64
+ readonly Active: "active";
65
+ readonly Failed: "failed";
66
+ readonly Missing: "missing";
67
+ };
68
+ export type StudyObjectiveConceptAttachmentStatusEnum = typeof StudyObjectiveConceptAttachmentStatusEnum[keyof typeof StudyObjectiveConceptAttachmentStatusEnum];
69
+ /**
70
+ * Check if a given object implements the StudyObjectiveConceptAttachment interface.
71
+ */
72
+ export declare function instanceOfStudyObjectiveConceptAttachment(value: object): value is StudyObjectiveConceptAttachment;
73
+ export declare function StudyObjectiveConceptAttachmentFromJSON(json: any): StudyObjectiveConceptAttachment;
74
+ export declare function StudyObjectiveConceptAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveConceptAttachment;
75
+ export declare function StudyObjectiveConceptAttachmentToJSON(json: any): StudyObjectiveConceptAttachment;
76
+ export declare function StudyObjectiveConceptAttachmentToJSONTyped(value?: StudyObjectiveConceptAttachment | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,77 @@
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 { StudyObjectiveConceptSummaryFromJSON, StudyObjectiveConceptSummaryToJSON, } from './StudyObjectiveConceptSummary';
15
+ /**
16
+ * @export
17
+ */
18
+ export const StudyObjectiveConceptAttachmentKindEnum = {
19
+ CanvasObject: 'canvas_object',
20
+ StudyObjective: 'study_objective'
21
+ };
22
+ /**
23
+ * @export
24
+ */
25
+ export const StudyObjectiveConceptAttachmentStatusEnum = {
26
+ Pending: 'pending',
27
+ Running: 'running',
28
+ Active: 'active',
29
+ Failed: 'failed',
30
+ Missing: 'missing'
31
+ };
32
+ /**
33
+ * Check if a given object implements the StudyObjectiveConceptAttachment interface.
34
+ */
35
+ export function instanceOfStudyObjectiveConceptAttachment(value) {
36
+ if (!('kind' in value) || value['kind'] === undefined)
37
+ return false;
38
+ if (!('key' in value) || value['key'] === undefined)
39
+ return false;
40
+ if (!('status' in value) || value['status'] === undefined)
41
+ return false;
42
+ if (!('lastError' in value) || value['lastError'] === undefined)
43
+ return false;
44
+ if (!('concepts' in value) || value['concepts'] === undefined)
45
+ return false;
46
+ return true;
47
+ }
48
+ export function StudyObjectiveConceptAttachmentFromJSON(json) {
49
+ return StudyObjectiveConceptAttachmentFromJSONTyped(json, false);
50
+ }
51
+ export function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscriminator) {
52
+ if (json == null) {
53
+ return json;
54
+ }
55
+ return {
56
+ 'kind': json['kind'],
57
+ 'key': json['key'],
58
+ 'status': json['status'],
59
+ 'lastError': json['lastError'],
60
+ 'concepts': (json['concepts'].map(StudyObjectiveConceptSummaryFromJSON)),
61
+ };
62
+ }
63
+ export function StudyObjectiveConceptAttachmentToJSON(json) {
64
+ return StudyObjectiveConceptAttachmentToJSONTyped(json, false);
65
+ }
66
+ export function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+ 'kind': value['kind'],
72
+ 'key': value['key'],
73
+ 'status': value['status'],
74
+ 'lastError': value['lastError'],
75
+ 'concepts': (value['concepts'].map(StudyObjectiveConceptSummaryToJSON)),
76
+ };
77
+ }
@@ -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 { StudyObjectiveConceptAttachment } from './StudyObjectiveConceptAttachment';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface StudyObjectiveConceptAttachmentList
17
+ */
18
+ export interface StudyObjectiveConceptAttachmentList {
19
+ /**
20
+ *
21
+ * @type {Array<StudyObjectiveConceptAttachment>}
22
+ * @memberof StudyObjectiveConceptAttachmentList
23
+ */
24
+ items: Array<StudyObjectiveConceptAttachment>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the StudyObjectiveConceptAttachmentList interface.
28
+ */
29
+ export declare function instanceOfStudyObjectiveConceptAttachmentList(value: object): value is StudyObjectiveConceptAttachmentList;
30
+ export declare function StudyObjectiveConceptAttachmentListFromJSON(json: any): StudyObjectiveConceptAttachmentList;
31
+ export declare function StudyObjectiveConceptAttachmentListFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveConceptAttachmentList;
32
+ export declare function StudyObjectiveConceptAttachmentListToJSON(json: any): StudyObjectiveConceptAttachmentList;
33
+ export declare function StudyObjectiveConceptAttachmentListToJSONTyped(value?: StudyObjectiveConceptAttachmentList | 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 { StudyObjectiveConceptAttachmentFromJSON, StudyObjectiveConceptAttachmentToJSON, } from './StudyObjectiveConceptAttachment';
15
+ /**
16
+ * Check if a given object implements the StudyObjectiveConceptAttachmentList interface.
17
+ */
18
+ export function instanceOfStudyObjectiveConceptAttachmentList(value) {
19
+ if (!('items' in value) || value['items'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function StudyObjectiveConceptAttachmentListFromJSON(json) {
24
+ return StudyObjectiveConceptAttachmentListFromJSONTyped(json, false);
25
+ }
26
+ export function StudyObjectiveConceptAttachmentListFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'items': (json['items'].map(StudyObjectiveConceptAttachmentFromJSON)),
32
+ };
33
+ }
34
+ export function StudyObjectiveConceptAttachmentListToJSON(json) {
35
+ return StudyObjectiveConceptAttachmentListToJSONTyped(json, false);
36
+ }
37
+ export function StudyObjectiveConceptAttachmentListToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'items': (value['items'].map(StudyObjectiveConceptAttachmentToJSON)),
43
+ };
44
+ }
@@ -0,0 +1,56 @@
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 StudyObjectiveConceptSummary
16
+ */
17
+ export interface StudyObjectiveConceptSummary {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof StudyObjectiveConceptSummary
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof StudyObjectiveConceptSummary
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudyObjectiveConceptSummary
34
+ */
35
+ shortName: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof StudyObjectiveConceptSummary
40
+ */
41
+ description: string;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof StudyObjectiveConceptSummary
46
+ */
47
+ displayOrder: number | null;
48
+ }
49
+ /**
50
+ * Check if a given object implements the StudyObjectiveConceptSummary interface.
51
+ */
52
+ export declare function instanceOfStudyObjectiveConceptSummary(value: object): value is StudyObjectiveConceptSummary;
53
+ export declare function StudyObjectiveConceptSummaryFromJSON(json: any): StudyObjectiveConceptSummary;
54
+ export declare function StudyObjectiveConceptSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveConceptSummary;
55
+ export declare function StudyObjectiveConceptSummaryToJSON(json: any): StudyObjectiveConceptSummary;
56
+ export declare function StudyObjectiveConceptSummaryToJSONTyped(value?: StudyObjectiveConceptSummary | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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 StudyObjectiveConceptSummary interface.
16
+ */
17
+ export function instanceOfStudyObjectiveConceptSummary(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('shortName' in value) || value['shortName'] === undefined)
23
+ return false;
24
+ if (!('description' in value) || value['description'] === undefined)
25
+ return false;
26
+ if (!('displayOrder' in value) || value['displayOrder'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function StudyObjectiveConceptSummaryFromJSON(json) {
31
+ return StudyObjectiveConceptSummaryFromJSONTyped(json, false);
32
+ }
33
+ export function StudyObjectiveConceptSummaryFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'id': json['id'],
39
+ 'name': json['name'],
40
+ 'shortName': json['shortName'],
41
+ 'description': json['description'],
42
+ 'displayOrder': json['displayOrder'],
43
+ };
44
+ }
45
+ export function StudyObjectiveConceptSummaryToJSON(json) {
46
+ return StudyObjectiveConceptSummaryToJSONTyped(json, false);
47
+ }
48
+ export function StudyObjectiveConceptSummaryToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'id': value['id'],
54
+ 'name': value['name'],
55
+ 'shortName': value['shortName'],
56
+ 'description': value['description'],
57
+ 'displayOrder': value['displayOrder'],
58
+ };
59
+ }
@@ -0,0 +1,56 @@
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 StudyObjectiveFileAttachment
16
+ */
17
+ export interface StudyObjectiveFileAttachment {
18
+ /**
19
+ * user_files.id — durable reference to the uploaded file.
20
+ * @type {string}
21
+ * @memberof StudyObjectiveFileAttachment
22
+ */
23
+ userFileId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof StudyObjectiveFileAttachment
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof StudyObjectiveFileAttachment
34
+ */
35
+ mimeType: string;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof StudyObjectiveFileAttachment
40
+ */
41
+ sizeBytes: number;
42
+ /**
43
+ * Freshly-signed S3 GET URL (~30 min TTL). Regenerated on every read; do not persist.
44
+ * @type {string}
45
+ * @memberof StudyObjectiveFileAttachment
46
+ */
47
+ previewUrl: string;
48
+ }
49
+ /**
50
+ * Check if a given object implements the StudyObjectiveFileAttachment interface.
51
+ */
52
+ export declare function instanceOfStudyObjectiveFileAttachment(value: object): value is StudyObjectiveFileAttachment;
53
+ export declare function StudyObjectiveFileAttachmentFromJSON(json: any): StudyObjectiveFileAttachment;
54
+ export declare function StudyObjectiveFileAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveFileAttachment;
55
+ export declare function StudyObjectiveFileAttachmentToJSON(json: any): StudyObjectiveFileAttachment;
56
+ export declare function StudyObjectiveFileAttachmentToJSONTyped(value?: StudyObjectiveFileAttachment | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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 StudyObjectiveFileAttachment interface.
16
+ */
17
+ export function instanceOfStudyObjectiveFileAttachment(value) {
18
+ if (!('userFileId' in value) || value['userFileId'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('mimeType' in value) || value['mimeType'] === undefined)
23
+ return false;
24
+ if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
25
+ return false;
26
+ if (!('previewUrl' in value) || value['previewUrl'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function StudyObjectiveFileAttachmentFromJSON(json) {
31
+ return StudyObjectiveFileAttachmentFromJSONTyped(json, false);
32
+ }
33
+ export function StudyObjectiveFileAttachmentFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'userFileId': json['userFileId'],
39
+ 'name': json['name'],
40
+ 'mimeType': json['mimeType'],
41
+ 'sizeBytes': json['sizeBytes'],
42
+ 'previewUrl': json['previewUrl'],
43
+ };
44
+ }
45
+ export function StudyObjectiveFileAttachmentToJSON(json) {
46
+ return StudyObjectiveFileAttachmentToJSONTyped(json, false);
47
+ }
48
+ export function StudyObjectiveFileAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'userFileId': value['userFileId'],
54
+ 'name': value['name'],
55
+ 'mimeType': value['mimeType'],
56
+ 'sizeBytes': value['sizeBytes'],
57
+ 'previewUrl': value['previewUrl'],
58
+ };
59
+ }
@@ -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 TriggerStudyObjectiveConceptExtractionItemStatus
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionItemStatus {
18
+ /**
19
+ * Canvas object id from the request (formatted '{type}:{local_id}').
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
22
+ */
23
+ canvasObjectId: string;
24
+ /**
25
+ * Sidecar status snapshot at the moment the trigger returned. `cooling-down` is returned when the row's `cooldown_until` is still in the future (most commonly after a Canvas 429) — the row remains in `pending` lifecycle state, but the trigger does not spawn the assembly coroutine. `skipped-disabled` is returned for every item when the kill switch is off.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
+ */
29
+ status: TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum: {
35
+ readonly Pending: "pending";
36
+ readonly Running: "running";
37
+ readonly Active: "active";
38
+ readonly Failed: "failed";
39
+ readonly CoolingDown: "cooling-down";
40
+ readonly SkippedDisabled: "skipped-disabled";
41
+ };
42
+ export type TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum];
43
+ /**
44
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
45
+ */
46
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value: object): value is TriggerStudyObjectiveConceptExtractionItemStatus;
47
+ export declare function TriggerStudyObjectiveConceptExtractionItemStatusFromJSON(json: any): TriggerStudyObjectiveConceptExtractionItemStatus;
48
+ export declare function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionItemStatus;
49
+ export declare function TriggerStudyObjectiveConceptExtractionItemStatusToJSON(json: any): TriggerStudyObjectiveConceptExtractionItemStatus;
50
+ export declare function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionItemStatus | 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 TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
18
+ Pending: 'pending',
19
+ Running: 'running',
20
+ Active: 'active',
21
+ Failed: 'failed',
22
+ CoolingDown: 'cooling-down',
23
+ SkippedDisabled: 'skipped-disabled'
24
+ };
25
+ /**
26
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
27
+ */
28
+ export function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value) {
29
+ if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
30
+ return false;
31
+ if (!('status' in value) || value['status'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ export function TriggerStudyObjectiveConceptExtractionItemStatusFromJSON(json) {
36
+ return TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(json, false);
37
+ }
38
+ export function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'canvasObjectId': json['canvasObjectId'],
44
+ 'status': json['status'],
45
+ };
46
+ }
47
+ export function TriggerStudyObjectiveConceptExtractionItemStatusToJSON(json) {
48
+ return TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(json, false);
49
+ }
50
+ export function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ 'canvasObjectId': value['canvasObjectId'],
56
+ 'status': value['status'],
57
+ };
58
+ }
@@ -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 { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TriggerStudyObjectiveConceptExtractionRequest
17
+ */
18
+ export interface TriggerStudyObjectiveConceptExtractionRequest {
19
+ /**
20
+ * Canvas local course id (e.g. '587077'). Scopes the extraction request.
21
+ * @type {string}
22
+ * @memberof TriggerStudyObjectiveConceptExtractionRequest
23
+ */
24
+ canvasCourseId: string;
25
+ /**
26
+ * One to fifty Canvas objects whose study-objective concepts should be extracted.
27
+ * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}
28
+ * @memberof TriggerStudyObjectiveConceptExtractionRequest
29
+ */
30
+ items: Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>;
31
+ }
32
+ /**
33
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
34
+ */
35
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value: object): value is TriggerStudyObjectiveConceptExtractionRequest;
36
+ export declare function TriggerStudyObjectiveConceptExtractionRequestFromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequest;
37
+ export declare function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequest;
38
+ export declare function TriggerStudyObjectiveConceptExtractionRequestToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequest;
39
+ export declare function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
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 { TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON, TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON, } from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
15
+ /**
16
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
17
+ */
18
+ export function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value) {
19
+ if (!('canvasCourseId' in value) || value['canvasCourseId'] === undefined)
20
+ return false;
21
+ if (!('items' in value) || value['items'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function TriggerStudyObjectiveConceptExtractionRequestFromJSON(json) {
26
+ return TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, false);
27
+ }
28
+ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'canvasCourseId': json['canvasCourseId'],
34
+ 'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
35
+ };
36
+ }
37
+ export function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
38
+ return TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(json, false);
39
+ }
40
+ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'canvasCourseId': value['canvasCourseId'],
46
+ 'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON)),
47
+ };
48
+ }