@instructure/athena-api-client 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +0 -3
  2. package/dist/apis/StudyObjectiveConceptsApi.d.ts +5 -7
  3. package/dist/apis/StudyObjectiveConceptsApi.js +7 -10
  4. package/dist/apis/StudyObjectivesApi.d.ts +10 -0
  5. package/dist/apis/StudyObjectivesApi.js +12 -1
  6. package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +5 -7
  7. package/dist/esm/apis/StudyObjectiveConceptsApi.js +7 -10
  8. package/dist/esm/apis/StudyObjectivesApi.d.ts +10 -0
  9. package/dist/esm/apis/StudyObjectivesApi.js +11 -0
  10. package/dist/esm/models/StudyObjective.d.ts +6 -0
  11. package/dist/esm/models/StudyObjective.js +4 -0
  12. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +4 -4
  13. package/dist/esm/models/StudyObjectiveConceptAttachment.js +4 -4
  14. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +5 -11
  15. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +4 -4
  16. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +8 -13
  17. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +5 -8
  18. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +1 -1
  19. package/dist/esm/models/UpdateStudyObjectiveDto.d.ts +6 -0
  20. package/dist/esm/models/UpdateStudyObjectiveDto.js +2 -0
  21. package/dist/esm/models/index.d.ts +0 -3
  22. package/dist/esm/models/index.js +0 -3
  23. package/dist/models/StudyObjective.d.ts +6 -0
  24. package/dist/models/StudyObjective.js +4 -0
  25. package/dist/models/StudyObjectiveConceptAttachment.d.ts +4 -4
  26. package/dist/models/StudyObjectiveConceptAttachment.js +4 -4
  27. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +5 -11
  28. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +4 -4
  29. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +8 -13
  30. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +5 -8
  31. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +1 -1
  32. package/dist/models/UpdateStudyObjectiveDto.d.ts +6 -0
  33. package/dist/models/UpdateStudyObjectiveDto.js +2 -0
  34. package/dist/models/index.d.ts +0 -3
  35. package/dist/models/index.js +0 -3
  36. package/package.json +1 -1
package/README.md CHANGED
@@ -270,9 +270,6 @@ All URIs are relative to *http://localhost:3000*
270
270
  - [TaxonomySummary](docs/TaxonomySummary.md)
271
271
  - [TriggerStudyObjectiveConceptExtractionItemStatus](docs/TriggerStudyObjectiveConceptExtractionItemStatus.md)
272
272
  - [TriggerStudyObjectiveConceptExtractionRequest](docs/TriggerStudyObjectiveConceptExtractionRequest.md)
273
- - [TriggerStudyObjectiveConceptExtractionRequestItemsInner](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInner.md)
274
- - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.md)
275
- - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.md)
276
273
  - [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md)
277
274
  - [TriggerSyllabusAnalysisRequest](docs/TriggerSyllabusAnalysisRequest.md)
278
275
  - [TriggerSyllabusAnalysisRequestFile](docs/TriggerSyllabusAnalysisRequestFile.md)
@@ -12,10 +12,8 @@
12
12
  import * as runtime from '../runtime';
13
13
  import type { StudyObjectiveConceptAttachmentList, TriggerStudyObjectiveConceptExtractionRequest, TriggerStudyObjectiveConceptExtractionResponse } from '../models/index';
14
14
  export interface ListStudyObjectiveConceptsRequest {
15
+ studyObjectiveIds: Array<string>;
15
16
  xUserId: string;
16
- canvasCourseId?: string;
17
- canvasObjectIds?: Array<string>;
18
- studyObjectiveIds?: Array<string>;
19
17
  }
20
18
  export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
21
19
  xUserId: string;
@@ -28,22 +26,22 @@ export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
28
26
  */
29
27
  export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
30
28
  /**
31
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
29
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
32
30
  * List study-objective concept attachments
33
31
  */
34
32
  listStudyObjectiveConceptsRaw(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjectiveConceptAttachmentList>>;
35
33
  /**
36
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
34
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
37
35
  * List study-objective concept attachments
38
36
  */
39
37
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
40
38
  /**
41
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
39
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
42
40
  * Trigger study-objective concept extraction
43
41
  */
44
42
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
45
43
  /**
46
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
44
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
47
45
  * Trigger study-objective concept extraction
48
46
  */
49
47
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -30,21 +30,18 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class StudyObjectiveConceptsApi extends runtime.BaseAPI {
32
32
  /**
33
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
33
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
34
34
  * List study-objective concept attachments
35
35
  */
36
36
  listStudyObjectiveConceptsRaw(requestParameters, initOverrides) {
37
37
  return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters['studyObjectiveIds'] == null) {
39
+ throw new runtime.RequiredError('studyObjectiveIds', 'Required parameter "studyObjectiveIds" was null or undefined when calling listStudyObjectiveConcepts().');
40
+ }
38
41
  if (requestParameters['xUserId'] == null) {
39
42
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listStudyObjectiveConcepts().');
40
43
  }
41
44
  const queryParameters = {};
42
- if (requestParameters['canvasCourseId'] != null) {
43
- queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
44
- }
45
- if (requestParameters['canvasObjectIds'] != null) {
46
- queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
47
- }
48
45
  if (requestParameters['studyObjectiveIds'] != null) {
49
46
  queryParameters['studyObjectiveIds'] = requestParameters['studyObjectiveIds'];
50
47
  }
@@ -66,7 +63,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
66
63
  });
67
64
  }
68
65
  /**
69
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
66
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
70
67
  * List study-objective concept attachments
71
68
  */
72
69
  listStudyObjectiveConcepts(requestParameters, initOverrides) {
@@ -76,7 +73,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
76
73
  });
77
74
  }
78
75
  /**
79
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
76
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
80
77
  * Trigger study-objective concept extraction
81
78
  */
82
79
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -114,7 +111,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
114
111
  });
115
112
  }
116
113
  /**
117
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
114
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
118
115
  * Trigger study-objective concept extraction
119
116
  */
120
117
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -45,6 +45,7 @@ export interface ListStudyObjectivesRequest {
45
45
  courseId: string;
46
46
  limit?: number;
47
47
  cursor?: string;
48
+ status?: ListStudyObjectivesStatusEnum;
48
49
  }
49
50
  export interface UpdateStudyObjectiveRequest {
50
51
  xUserId: string;
@@ -128,3 +129,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
128
129
  */
129
130
  updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
130
131
  }
132
+ /**
133
+ * @export
134
+ */
135
+ export declare const ListStudyObjectivesStatusEnum: {
136
+ readonly Active: "active";
137
+ readonly Archived: "archived";
138
+ readonly All: "all";
139
+ };
140
+ export type ListStudyObjectivesStatusEnum = typeof ListStudyObjectivesStatusEnum[keyof typeof ListStudyObjectivesStatusEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.StudyObjectivesApi = void 0;
25
+ exports.ListStudyObjectivesStatusEnum = exports.StudyObjectivesApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const index_1 = require("../models/index");
28
28
  /**
@@ -308,6 +308,9 @@ class StudyObjectivesApi extends runtime.BaseAPI {
308
308
  if (requestParameters['courseId'] != null) {
309
309
  queryParameters['courseId'] = requestParameters['courseId'];
310
310
  }
311
+ if (requestParameters['status'] != null) {
312
+ queryParameters['status'] = requestParameters['status'];
313
+ }
311
314
  const headerParameters = {};
312
315
  if (requestParameters['xUserId'] != null) {
313
316
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -381,3 +384,11 @@ class StudyObjectivesApi extends runtime.BaseAPI {
381
384
  }
382
385
  }
383
386
  exports.StudyObjectivesApi = StudyObjectivesApi;
387
+ /**
388
+ * @export
389
+ */
390
+ exports.ListStudyObjectivesStatusEnum = {
391
+ Active: 'active',
392
+ Archived: 'archived',
393
+ All: 'all'
394
+ };
@@ -12,10 +12,8 @@
12
12
  import * as runtime from '../runtime';
13
13
  import type { StudyObjectiveConceptAttachmentList, TriggerStudyObjectiveConceptExtractionRequest, TriggerStudyObjectiveConceptExtractionResponse } from '../models/index';
14
14
  export interface ListStudyObjectiveConceptsRequest {
15
+ studyObjectiveIds: Array<string>;
15
16
  xUserId: string;
16
- canvasCourseId?: string;
17
- canvasObjectIds?: Array<string>;
18
- studyObjectiveIds?: Array<string>;
19
17
  }
20
18
  export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
21
19
  xUserId: string;
@@ -28,22 +26,22 @@ export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
28
26
  */
29
27
  export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
30
28
  /**
31
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
29
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
32
30
  * List study-objective concept attachments
33
31
  */
34
32
  listStudyObjectiveConceptsRaw(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjectiveConceptAttachmentList>>;
35
33
  /**
36
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
34
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
37
35
  * List study-objective concept attachments
38
36
  */
39
37
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
40
38
  /**
41
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
39
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
42
40
  * Trigger study-objective concept extraction
43
41
  */
44
42
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
45
43
  /**
46
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
44
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
47
45
  * Trigger study-objective concept extraction
48
46
  */
49
47
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -27,21 +27,18 @@ import { StudyObjectiveConceptAttachmentListFromJSON, TriggerStudyObjectiveConce
27
27
  */
28
28
  export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
29
29
  /**
30
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
30
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
31
31
  * List study-objective concept attachments
32
32
  */
33
33
  listStudyObjectiveConceptsRaw(requestParameters, initOverrides) {
34
34
  return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['studyObjectiveIds'] == null) {
36
+ throw new runtime.RequiredError('studyObjectiveIds', 'Required parameter "studyObjectiveIds" was null or undefined when calling listStudyObjectiveConcepts().');
37
+ }
35
38
  if (requestParameters['xUserId'] == null) {
36
39
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listStudyObjectiveConcepts().');
37
40
  }
38
41
  const queryParameters = {};
39
- if (requestParameters['canvasCourseId'] != null) {
40
- queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
41
- }
42
- if (requestParameters['canvasObjectIds'] != null) {
43
- queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
44
- }
45
42
  if (requestParameters['studyObjectiveIds'] != null) {
46
43
  queryParameters['studyObjectiveIds'] = requestParameters['studyObjectiveIds'];
47
44
  }
@@ -63,7 +60,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
63
60
  });
64
61
  }
65
62
  /**
66
- * Batch read of concept attachments for the current account, scoped by either `(canvasCourseId, canvasObjectIds[])` for Canvas-derived items or `studyObjectiveIds[]` for user-defined objectives. Returns one entry per requested key with a status snapshot, last error (if any), and the attached concepts. Canvas-derived results are filtered by `account_id = currentAccountId` to prevent cross-tenant probing.
63
+ * Batch read of concept attachments for the caller\'s study objectives, identified by id. Returns one entry per requested objective with a status snapshot, last error (if any), and the attached concepts — read from the shared Canvas-object store for canvas-sourced objectives and from the per-objective store for custom objectives. Ownership is enforced: objectives the caller doesn\'t own return a `missing` status with no concepts.
67
64
  * List study-objective concept attachments
68
65
  */
69
66
  listStudyObjectiveConcepts(requestParameters, initOverrides) {
@@ -73,7 +70,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
73
70
  });
74
71
  }
75
72
  /**
76
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
73
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
77
74
  * Trigger study-objective concept extraction
78
75
  */
79
76
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -111,7 +108,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
111
108
  });
112
109
  }
113
110
  /**
114
- * Begins content assembly and LLM-driven concept extraction for one or more items Canvas objects (assignments, quizzes, pages, module items) and/or user-defined study objectives. Returns 202 with a per-item status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body): required when the request includes canvas_object items, and used for study_objective items only to resolve referenced Canvas-document content.
111
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
115
112
  * Trigger study-objective concept extraction
116
113
  */
117
114
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -45,6 +45,7 @@ export interface ListStudyObjectivesRequest {
45
45
  courseId: string;
46
46
  limit?: number;
47
47
  cursor?: string;
48
+ status?: ListStudyObjectivesStatusEnum;
48
49
  }
49
50
  export interface UpdateStudyObjectiveRequest {
50
51
  xUserId: string;
@@ -128,3 +129,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
128
129
  */
129
130
  updateStudyObjective(requestParameters: UpdateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
130
131
  }
132
+ /**
133
+ * @export
134
+ */
135
+ export declare const ListStudyObjectivesStatusEnum: {
136
+ readonly Active: "active";
137
+ readonly Archived: "archived";
138
+ readonly All: "all";
139
+ };
140
+ export type ListStudyObjectivesStatusEnum = typeof ListStudyObjectivesStatusEnum[keyof typeof ListStudyObjectivesStatusEnum];
@@ -305,6 +305,9 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
305
305
  if (requestParameters['courseId'] != null) {
306
306
  queryParameters['courseId'] = requestParameters['courseId'];
307
307
  }
308
+ if (requestParameters['status'] != null) {
309
+ queryParameters['status'] = requestParameters['status'];
310
+ }
308
311
  const headerParameters = {};
309
312
  if (requestParameters['xUserId'] != null) {
310
313
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -377,3 +380,11 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
377
380
  });
378
381
  }
379
382
  }
383
+ /**
384
+ * @export
385
+ */
386
+ export const ListStudyObjectivesStatusEnum = {
387
+ Active: 'active',
388
+ Archived: 'archived',
389
+ All: 'all'
390
+ };
@@ -77,6 +77,12 @@ export interface StudyObjective {
77
77
  * @memberof StudyObjective
78
78
  */
79
79
  dueAt: Date | null;
80
+ /**
81
+ * When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
82
+ * @type {Date}
83
+ * @memberof StudyObjective
84
+ */
85
+ archivedAt: Date | null;
80
86
  /**
81
87
  *
82
88
  * @type {Date}
@@ -44,6 +44,8 @@ export function instanceOfStudyObjective(value) {
44
44
  return false;
45
45
  if (!('dueAt' in value) || value['dueAt'] === undefined)
46
46
  return false;
47
+ if (!('archivedAt' in value) || value['archivedAt'] === undefined)
48
+ return false;
47
49
  if (!('createdAt' in value) || value['createdAt'] === undefined)
48
50
  return false;
49
51
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -68,6 +70,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
68
70
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
69
71
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
70
72
  'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
73
+ 'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
71
74
  'createdAt': (new Date(json['createdAt'])),
72
75
  'updatedAt': (new Date(json['updatedAt'])),
73
76
  };
@@ -90,6 +93,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
90
93
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
91
94
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
92
95
  'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
96
+ 'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
93
97
  'createdAt': value['createdAt'].toISOString(),
94
98
  'updatedAt': value['updatedAt'].toISOString(),
95
99
  };
@@ -17,17 +17,17 @@ import type { StudyObjectiveConceptSummary } from './StudyObjectiveConceptSummar
17
17
  */
18
18
  export interface StudyObjectiveConceptAttachment {
19
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.
20
+ * The study objective this attachment is for. The list endpoint returns one attachment per requested objective id.
21
21
  * @type {string}
22
22
  * @memberof StudyObjectiveConceptAttachment
23
23
  */
24
- kind: StudyObjectiveConceptAttachmentKindEnum;
24
+ studyObjectiveId: string;
25
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.
26
+ * Which store served the concepts. `canvas_object` means the objective is canvas-sourced and its concepts are shared across the account via the linked Canvas object; `study_objective` means a custom objective with concepts private to it.
27
27
  * @type {string}
28
28
  * @memberof StudyObjectiveConceptAttachment
29
29
  */
30
- key: string;
30
+ kind: StudyObjectiveConceptAttachmentKindEnum;
31
31
  /**
32
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
33
  * @type {string}
@@ -33,9 +33,9 @@ export const StudyObjectiveConceptAttachmentStatusEnum = {
33
33
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
34
34
  */
35
35
  export function instanceOfStudyObjectiveConceptAttachment(value) {
36
- if (!('kind' in value) || value['kind'] === undefined)
36
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
37
37
  return false;
38
- if (!('key' in value) || value['key'] === undefined)
38
+ if (!('kind' in value) || value['kind'] === undefined)
39
39
  return false;
40
40
  if (!('status' in value) || value['status'] === undefined)
41
41
  return false;
@@ -53,8 +53,8 @@ export function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscrim
53
53
  return json;
54
54
  }
55
55
  return {
56
+ 'studyObjectiveId': json['studyObjectiveId'],
56
57
  'kind': json['kind'],
57
- 'key': json['key'],
58
58
  'status': json['status'],
59
59
  'lastError': json['lastError'],
60
60
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummaryFromJSON)),
@@ -68,8 +68,8 @@ export function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscrimi
68
68
  return value;
69
69
  }
70
70
  return {
71
+ 'studyObjectiveId': value['studyObjectiveId'],
71
72
  'kind': value['kind'],
72
- 'key': value['key'],
73
73
  'status': value['status'],
74
74
  'lastError': value['lastError'],
75
75
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummaryToJSON)),
@@ -16,25 +16,19 @@
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionItemStatus {
18
18
  /**
19
- * Discriminates which identity fields are populated.
19
+ * The requested study objective.
20
20
  * @type {string}
21
21
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
22
22
  */
23
- kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
24
- /**
25
- * Canvas object id from the request (present when kind = canvas_object).
26
- * @type {string}
27
- * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
- */
29
- canvasObjectId?: string;
23
+ studyObjectiveId: string;
30
24
  /**
31
- * Study objective id from the request (present when kind = study_objective).
25
+ * Which storage path the extraction took. `canvas_object` means the objective is canvas-sourced (concepts shared across the account via the linked Canvas object); `study_objective` means a custom objective tracked on its own.
32
26
  * @type {string}
33
27
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
34
28
  */
35
- studyObjectiveId?: string;
29
+ kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
36
30
  /**
37
- * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every item when the kill switch is off. `not-found` (study_objective only) means the objective isn't owned by the caller, so no sidecar was created.
31
+ * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas-sourced only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every objective when the kill switch is off. `not-found` means the objective isn't owned by the caller, so no sidecar was created.
38
32
  * @type {string}
39
33
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
40
34
  */
@@ -34,6 +34,8 @@ export const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
34
34
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
35
35
  */
36
36
  export function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value) {
37
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
38
+ return false;
37
39
  if (!('kind' in value) || value['kind'] === undefined)
38
40
  return false;
39
41
  if (!('status' in value) || value['status'] === undefined)
@@ -48,9 +50,8 @@ export function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(js
48
50
  return json;
49
51
  }
50
52
  return {
53
+ 'studyObjectiveId': json['studyObjectiveId'],
51
54
  'kind': json['kind'],
52
- 'canvasObjectId': json['canvasObjectId'] == null ? undefined : json['canvasObjectId'],
53
- 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
54
55
  'status': json['status'],
55
56
  };
56
57
  }
@@ -62,9 +63,8 @@ export function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(valu
62
63
  return value;
63
64
  }
64
65
  return {
65
- 'kind': value['kind'],
66
- 'canvasObjectId': value['canvasObjectId'],
67
66
  'studyObjectiveId': value['studyObjectiveId'],
67
+ 'kind': value['kind'],
68
68
  'status': value['status'],
69
69
  };
70
70
  }
@@ -9,7 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
13
12
  /**
14
13
  *
15
14
  * @export
@@ -17,23 +16,19 @@ import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './
17
16
  */
18
17
  export interface TriggerStudyObjectiveConceptExtractionRequest {
19
18
  /**
20
- * Canvas local course id. Required when the request includes any canvas_object item.
21
- * @type {string}
19
+ * One to fifty study-objective UUIDs (custom and/or canvas-sourced) owned by the caller, whose concepts should be extracted.
20
+ * @type {Array<string>}
22
21
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
23
22
  */
24
- canvasCourseId?: string;
23
+ studyObjectiveIds: Array<string>;
25
24
  /**
26
- *
27
- * @type {string}
25
+ * Course syllabus HTML/text keyed by Canvas local course id, applied to canvas-sourced objectives only.
26
+ * @type {{ [key: string]: string; }}
28
27
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
29
28
  */
30
- syllabusHtml?: string | null;
31
- /**
32
- * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
33
- * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}
34
- * @memberof TriggerStudyObjectiveConceptExtractionRequest
35
- */
36
- items: Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>;
29
+ syllabusHtmlByCanvasCourseId?: {
30
+ [key: string]: string;
31
+ };
37
32
  }
38
33
  /**
39
34
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
@@ -11,12 +11,11 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON, TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON, } from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
15
14
  /**
16
15
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
17
16
  */
18
17
  export function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value) {
19
- if (!('items' in value) || value['items'] === undefined)
18
+ if (!('studyObjectiveIds' in value) || value['studyObjectiveIds'] === undefined)
20
19
  return false;
21
20
  return true;
22
21
  }
@@ -28,9 +27,8 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
28
27
  return json;
29
28
  }
30
29
  return {
31
- 'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
32
- 'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
33
- 'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
30
+ 'studyObjectiveIds': json['studyObjectiveIds'],
31
+ 'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
34
32
  };
35
33
  }
36
34
  export function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -41,8 +39,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value,
41
39
  return value;
42
40
  }
43
41
  return {
44
- 'canvasCourseId': value['canvasCourseId'],
45
- 'syllabusHtml': value['syllabusHtml'],
46
- 'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON)),
42
+ 'studyObjectiveIds': value['studyObjectiveIds'],
43
+ 'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
47
44
  };
48
45
  }
@@ -17,7 +17,7 @@ import type { TriggerStudyObjectiveConceptExtractionItemStatus } from './Trigger
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionResponse {
19
19
  /**
20
- * One entry per requested item, in request order within kind.
20
+ * One entry per requested study objective, in request order.
21
21
  * @type {Array<TriggerStudyObjectiveConceptExtractionItemStatus>}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionResponse
23
23
  */
@@ -40,6 +40,12 @@ export interface UpdateStudyObjectiveDto {
40
40
  * @memberof UpdateStudyObjectiveDto
41
41
  */
42
42
  dueAt?: Date | null;
43
+ /**
44
+ *
45
+ * @type {boolean}
46
+ * @memberof UpdateStudyObjectiveDto
47
+ */
48
+ archived?: boolean;
43
49
  }
44
50
  /**
45
51
  * Check if a given object implements the UpdateStudyObjectiveDto interface.
@@ -30,6 +30,7 @@ export function UpdateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator)
30
30
  'notes': json['notes'] == null ? undefined : json['notes'],
31
31
  'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
32
32
  'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
33
+ 'archived': json['archived'] == null ? undefined : json['archived'],
33
34
  };
34
35
  }
35
36
  export function UpdateStudyObjectiveDtoToJSON(json) {
@@ -44,5 +45,6 @@ export function UpdateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator =
44
45
  'notes': value['notes'],
45
46
  'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
46
47
  'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
48
+ 'archived': value['archived'],
47
49
  };
48
50
  }
@@ -105,9 +105,6 @@ export * from './TaxonomyProgressNode';
105
105
  export * from './TaxonomySummary';
106
106
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
107
107
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
108
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
109
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
110
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
111
108
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
112
109
  export * from './TriggerSyllabusAnalysisRequest';
113
110
  export * from './TriggerSyllabusAnalysisRequestFile';
@@ -107,9 +107,6 @@ export * from './TaxonomyProgressNode';
107
107
  export * from './TaxonomySummary';
108
108
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
109
109
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
110
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
111
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
112
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
113
110
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
114
111
  export * from './TriggerSyllabusAnalysisRequest';
115
112
  export * from './TriggerSyllabusAnalysisRequestFile';
@@ -77,6 +77,12 @@ export interface StudyObjective {
77
77
  * @memberof StudyObjective
78
78
  */
79
79
  dueAt: Date | null;
80
+ /**
81
+ * When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
82
+ * @type {Date}
83
+ * @memberof StudyObjective
84
+ */
85
+ archivedAt: Date | null;
80
86
  /**
81
87
  *
82
88
  * @type {Date}
@@ -52,6 +52,8 @@ function instanceOfStudyObjective(value) {
52
52
  return false;
53
53
  if (!('dueAt' in value) || value['dueAt'] === undefined)
54
54
  return false;
55
+ if (!('archivedAt' in value) || value['archivedAt'] === undefined)
56
+ return false;
55
57
  if (!('createdAt' in value) || value['createdAt'] === undefined)
56
58
  return false;
57
59
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -76,6 +78,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
76
78
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
77
79
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
78
80
  'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
81
+ 'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
79
82
  'createdAt': (new Date(json['createdAt'])),
80
83
  'updatedAt': (new Date(json['updatedAt'])),
81
84
  };
@@ -98,6 +101,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
98
101
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
99
102
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
100
103
  'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
104
+ 'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
101
105
  'createdAt': value['createdAt'].toISOString(),
102
106
  'updatedAt': value['updatedAt'].toISOString(),
103
107
  };
@@ -17,17 +17,17 @@ import type { StudyObjectiveConceptSummary } from './StudyObjectiveConceptSummar
17
17
  */
18
18
  export interface StudyObjectiveConceptAttachment {
19
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.
20
+ * The study objective this attachment is for. The list endpoint returns one attachment per requested objective id.
21
21
  * @type {string}
22
22
  * @memberof StudyObjectiveConceptAttachment
23
23
  */
24
- kind: StudyObjectiveConceptAttachmentKindEnum;
24
+ studyObjectiveId: string;
25
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.
26
+ * Which store served the concepts. `canvas_object` means the objective is canvas-sourced and its concepts are shared across the account via the linked Canvas object; `study_objective` means a custom objective with concepts private to it.
27
27
  * @type {string}
28
28
  * @memberof StudyObjectiveConceptAttachment
29
29
  */
30
- key: string;
30
+ kind: StudyObjectiveConceptAttachmentKindEnum;
31
31
  /**
32
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
33
  * @type {string}
@@ -41,9 +41,9 @@ exports.StudyObjectiveConceptAttachmentStatusEnum = {
41
41
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
42
42
  */
43
43
  function instanceOfStudyObjectiveConceptAttachment(value) {
44
- if (!('kind' in value) || value['kind'] === undefined)
44
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
45
45
  return false;
46
- if (!('key' in value) || value['key'] === undefined)
46
+ if (!('kind' in value) || value['kind'] === undefined)
47
47
  return false;
48
48
  if (!('status' in value) || value['status'] === undefined)
49
49
  return false;
@@ -61,8 +61,8 @@ function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscriminator)
61
61
  return json;
62
62
  }
63
63
  return {
64
+ 'studyObjectiveId': json['studyObjectiveId'],
64
65
  'kind': json['kind'],
65
- 'key': json['key'],
66
66
  'status': json['status'],
67
67
  'lastError': json['lastError'],
68
68
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryFromJSON)),
@@ -76,8 +76,8 @@ function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscriminator =
76
76
  return value;
77
77
  }
78
78
  return {
79
+ 'studyObjectiveId': value['studyObjectiveId'],
79
80
  'kind': value['kind'],
80
- 'key': value['key'],
81
81
  'status': value['status'],
82
82
  'lastError': value['lastError'],
83
83
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryToJSON)),
@@ -16,25 +16,19 @@
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionItemStatus {
18
18
  /**
19
- * Discriminates which identity fields are populated.
19
+ * The requested study objective.
20
20
  * @type {string}
21
21
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
22
22
  */
23
- kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
24
- /**
25
- * Canvas object id from the request (present when kind = canvas_object).
26
- * @type {string}
27
- * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
- */
29
- canvasObjectId?: string;
23
+ studyObjectiveId: string;
30
24
  /**
31
- * Study objective id from the request (present when kind = study_objective).
25
+ * Which storage path the extraction took. `canvas_object` means the objective is canvas-sourced (concepts shared across the account via the linked Canvas object); `study_objective` means a custom objective tracked on its own.
32
26
  * @type {string}
33
27
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
34
28
  */
35
- studyObjectiveId?: string;
29
+ kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
36
30
  /**
37
- * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every item when the kill switch is off. `not-found` (study_objective only) means the objective isn't owned by the caller, so no sidecar was created.
31
+ * Sidecar status snapshot at the moment the trigger returned. `cooling-down` (canvas-sourced only) means a recent Canvas 429 set a cooldown. `skipped-disabled` is returned for every objective when the kill switch is off. `not-found` means the objective isn't owned by the caller, so no sidecar was created.
38
32
  * @type {string}
39
33
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
40
34
  */
@@ -42,6 +42,8 @@ exports.TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
42
42
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
43
43
  */
44
44
  function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value) {
45
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
46
+ return false;
45
47
  if (!('kind' in value) || value['kind'] === undefined)
46
48
  return false;
47
49
  if (!('status' in value) || value['status'] === undefined)
@@ -56,9 +58,8 @@ function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(json, ign
56
58
  return json;
57
59
  }
58
60
  return {
61
+ 'studyObjectiveId': json['studyObjectiveId'],
59
62
  'kind': json['kind'],
60
- 'canvasObjectId': json['canvasObjectId'] == null ? undefined : json['canvasObjectId'],
61
- 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
62
63
  'status': json['status'],
63
64
  };
64
65
  }
@@ -70,9 +71,8 @@ function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(value, igno
70
71
  return value;
71
72
  }
72
73
  return {
73
- 'kind': value['kind'],
74
- 'canvasObjectId': value['canvasObjectId'],
75
74
  'studyObjectiveId': value['studyObjectiveId'],
75
+ 'kind': value['kind'],
76
76
  'status': value['status'],
77
77
  };
78
78
  }
@@ -9,7 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
13
12
  /**
14
13
  *
15
14
  * @export
@@ -17,23 +16,19 @@ import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './
17
16
  */
18
17
  export interface TriggerStudyObjectiveConceptExtractionRequest {
19
18
  /**
20
- * Canvas local course id. Required when the request includes any canvas_object item.
21
- * @type {string}
19
+ * One to fifty study-objective UUIDs (custom and/or canvas-sourced) owned by the caller, whose concepts should be extracted.
20
+ * @type {Array<string>}
22
21
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
23
22
  */
24
- canvasCourseId?: string;
23
+ studyObjectiveIds: Array<string>;
25
24
  /**
26
- *
27
- * @type {string}
25
+ * Course syllabus HTML/text keyed by Canvas local course id, applied to canvas-sourced objectives only.
26
+ * @type {{ [key: string]: string; }}
28
27
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
29
28
  */
30
- syllabusHtml?: string | null;
31
- /**
32
- * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
33
- * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}
34
- * @memberof TriggerStudyObjectiveConceptExtractionRequest
35
- */
36
- items: Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>;
29
+ syllabusHtmlByCanvasCourseId?: {
30
+ [key: string]: string;
31
+ };
37
32
  }
38
33
  /**
39
34
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
@@ -18,12 +18,11 @@ exports.TriggerStudyObjectiveConceptExtractionRequestFromJSON = TriggerStudyObje
18
18
  exports.TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped = TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped;
19
19
  exports.TriggerStudyObjectiveConceptExtractionRequestToJSON = TriggerStudyObjectiveConceptExtractionRequestToJSON;
20
20
  exports.TriggerStudyObjectiveConceptExtractionRequestToJSONTyped = TriggerStudyObjectiveConceptExtractionRequestToJSONTyped;
21
- const TriggerStudyObjectiveConceptExtractionRequestItemsInner_1 = require("./TriggerStudyObjectiveConceptExtractionRequestItemsInner");
22
21
  /**
23
22
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
24
23
  */
25
24
  function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value) {
26
- if (!('items' in value) || value['items'] === undefined)
25
+ if (!('studyObjectiveIds' in value) || value['studyObjectiveIds'] === undefined)
27
26
  return false;
28
27
  return true;
29
28
  }
@@ -35,9 +34,8 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
35
34
  return json;
36
35
  }
37
36
  return {
38
- 'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
39
- 'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
40
- 'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInner_1.TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
37
+ 'studyObjectiveIds': json['studyObjectiveIds'],
38
+ 'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
41
39
  };
42
40
  }
43
41
  function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -48,8 +46,7 @@ function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreD
48
46
  return value;
49
47
  }
50
48
  return {
51
- 'canvasCourseId': value['canvasCourseId'],
52
- 'syllabusHtml': value['syllabusHtml'],
53
- 'items': (value['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInner_1.TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON)),
49
+ 'studyObjectiveIds': value['studyObjectiveIds'],
50
+ 'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
54
51
  };
55
52
  }
@@ -17,7 +17,7 @@ import type { TriggerStudyObjectiveConceptExtractionItemStatus } from './Trigger
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionResponse {
19
19
  /**
20
- * One entry per requested item, in request order within kind.
20
+ * One entry per requested study objective, in request order.
21
21
  * @type {Array<TriggerStudyObjectiveConceptExtractionItemStatus>}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionResponse
23
23
  */
@@ -40,6 +40,12 @@ export interface UpdateStudyObjectiveDto {
40
40
  * @memberof UpdateStudyObjectiveDto
41
41
  */
42
42
  dueAt?: Date | null;
43
+ /**
44
+ *
45
+ * @type {boolean}
46
+ * @memberof UpdateStudyObjectiveDto
47
+ */
48
+ archived?: boolean;
43
49
  }
44
50
  /**
45
51
  * Check if a given object implements the UpdateStudyObjectiveDto interface.
@@ -37,6 +37,7 @@ function UpdateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
37
37
  'notes': json['notes'] == null ? undefined : json['notes'],
38
38
  'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
39
39
  'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
40
+ 'archived': json['archived'] == null ? undefined : json['archived'],
40
41
  };
41
42
  }
42
43
  function UpdateStudyObjectiveDtoToJSON(json) {
@@ -51,5 +52,6 @@ function UpdateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator = false)
51
52
  'notes': value['notes'],
52
53
  'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
53
54
  'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
55
+ 'archived': value['archived'],
54
56
  };
55
57
  }
@@ -105,9 +105,6 @@ export * from './TaxonomyProgressNode';
105
105
  export * from './TaxonomySummary';
106
106
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
107
107
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
108
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
109
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
110
- export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
111
108
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
112
109
  export * from './TriggerSyllabusAnalysisRequest';
113
110
  export * from './TriggerSyllabusAnalysisRequestFile';
@@ -123,9 +123,6 @@ __exportStar(require("./TaxonomyProgressNode"), exports);
123
123
  __exportStar(require("./TaxonomySummary"), exports);
124
124
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionItemStatus"), exports);
125
125
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequest"), exports);
126
- __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInner"), exports);
127
- __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf"), exports);
128
- __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1"), exports);
129
126
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionResponse"), exports);
130
127
  __exportStar(require("./TriggerSyllabusAnalysisRequest"), exports);
131
128
  __exportStar(require("./TriggerSyllabusAnalysisRequestFile"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.6.0",
4
+ "version": "3.7.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {