@instructure/athena-api-client 3.2.0 → 3.3.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 (32) hide show
  1. package/README.md +2 -0
  2. package/dist/apis/StudyObjectiveConceptsApi.d.ts +4 -4
  3. package/dist/apis/StudyObjectiveConceptsApi.js +2 -8
  4. package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts +4 -4
  5. package/dist/esm/apis/StudyObjectiveConceptsApi.js +2 -8
  6. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +24 -3
  7. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +15 -3
  8. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +3 -3
  9. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js +1 -3
  10. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +19 -0
  11. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +14 -0
  12. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.d.ts +45 -0
  13. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.js +53 -0
  14. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.d.ts +45 -0
  15. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.js +51 -0
  16. package/dist/esm/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +1 -1
  17. package/dist/esm/models/index.d.ts +2 -0
  18. package/dist/esm/models/index.js +2 -0
  19. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.d.ts +24 -3
  20. package/dist/models/TriggerStudyObjectiveConceptExtractionItemStatus.js +16 -4
  21. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts +3 -3
  22. package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js +1 -3
  23. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.d.ts +19 -0
  24. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInner.js +15 -0
  25. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.d.ts +45 -0
  26. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.js +61 -0
  27. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.d.ts +45 -0
  28. package/dist/models/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.js +59 -0
  29. package/dist/models/TriggerStudyObjectiveConceptExtractionResponse.d.ts +1 -1
  30. package/dist/models/index.d.ts +2 -0
  31. package/dist/models/index.js +2 -0
  32. package/package.json +1 -1
package/README.md CHANGED
@@ -265,6 +265,8 @@ All URIs are relative to *http://localhost:3000*
265
265
  - [TriggerStudyObjectiveConceptExtractionItemStatus](docs/TriggerStudyObjectiveConceptExtractionItemStatus.md)
266
266
  - [TriggerStudyObjectiveConceptExtractionRequest](docs/TriggerStudyObjectiveConceptExtractionRequest.md)
267
267
  - [TriggerStudyObjectiveConceptExtractionRequestItemsInner](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInner.md)
268
+ - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf.md)
269
+ - [TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1](docs/TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1.md)
268
270
  - [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md)
269
271
  - [UpdateAccountDto](docs/UpdateAccountDto.md)
270
272
  - [UpdateChatRequest](docs/UpdateChatRequest.md)
@@ -18,10 +18,10 @@ export interface ListStudyObjectiveConceptsRequest {
18
18
  studyObjectiveIds?: Array<string>;
19
19
  }
20
20
  export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
21
- xCanvasDomain: string;
22
- xCanvasToken: string;
23
21
  xUserId: string;
24
22
  triggerStudyObjectiveConceptExtractionRequest: TriggerStudyObjectiveConceptExtractionRequest;
23
+ xCanvasDomain?: string;
24
+ xCanvasToken?: string;
25
25
  }
26
26
  /**
27
27
  *
@@ -38,12 +38,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
38
38
  */
39
39
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
40
40
  /**
41
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
42
42
  * Trigger study-objective concept extraction
43
43
  */
44
44
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
45
45
  /**
46
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
47
47
  * Trigger study-objective concept extraction
48
48
  */
49
49
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -76,17 +76,11 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
76
76
  });
77
77
  }
78
78
  /**
79
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
80
80
  * Trigger study-objective concept extraction
81
81
  */
82
82
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
83
83
  return __awaiter(this, void 0, void 0, function* () {
84
- if (requestParameters['xCanvasDomain'] == null) {
85
- throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
86
- }
87
- if (requestParameters['xCanvasToken'] == null) {
88
- throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
89
- }
90
84
  if (requestParameters['xUserId'] == null) {
91
85
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
92
86
  }
@@ -120,7 +114,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
120
114
  });
121
115
  }
122
116
  /**
123
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
124
118
  * Trigger study-objective concept extraction
125
119
  */
126
120
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -18,10 +18,10 @@ export interface ListStudyObjectiveConceptsRequest {
18
18
  studyObjectiveIds?: Array<string>;
19
19
  }
20
20
  export interface TriggerStudyObjectiveConceptExtractionOperationRequest {
21
- xCanvasDomain: string;
22
- xCanvasToken: string;
23
21
  xUserId: string;
24
22
  triggerStudyObjectiveConceptExtractionRequest: TriggerStudyObjectiveConceptExtractionRequest;
23
+ xCanvasDomain?: string;
24
+ xCanvasToken?: string;
25
25
  }
26
26
  /**
27
27
  *
@@ -38,12 +38,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
38
38
  */
39
39
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
40
40
  /**
41
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
42
42
  * Trigger study-objective concept extraction
43
43
  */
44
44
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
45
45
  /**
46
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
47
47
  * Trigger study-objective concept extraction
48
48
  */
49
49
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -73,17 +73,11 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
73
73
  });
74
74
  }
75
75
  /**
76
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
77
77
  * Trigger study-objective concept extraction
78
78
  */
79
79
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
80
80
  return __awaiter(this, void 0, void 0, function* () {
81
- if (requestParameters['xCanvasDomain'] == null) {
82
- throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
83
- }
84
- if (requestParameters['xCanvasToken'] == null) {
85
- throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
86
- }
87
81
  if (requestParameters['xUserId'] == null) {
88
82
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling triggerStudyObjectiveConceptExtraction().');
89
83
  }
@@ -117,7 +111,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
117
111
  });
118
112
  }
119
113
  /**
120
- * Begins Canvas content assembly and LLM-driven concept extraction for one or more Canvas objects (assignments, quizzes, pages, module items). The trigger returns 202 with a per-item status snapshot; the actual extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` and `X-Canvas-Domain` headers they are NEVER accepted in the body to keep the tenant identifier authoritative.
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.
121
115
  * Trigger study-objective concept extraction
122
116
  */
123
117
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -16,18 +16,38 @@
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionItemStatus {
18
18
  /**
19
- * Canvas object id from the request (formatted '{type}:{local_id}').
19
+ * Discriminates which identity fields are populated.
20
20
  * @type {string}
21
21
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
22
22
  */
23
- canvasObjectId: string;
23
+ kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
24
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.
25
+ * Canvas object id from the request (present when kind = canvas_object).
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
+ */
29
+ canvasObjectId?: string;
30
+ /**
31
+ * Study objective id from the request (present when kind = study_objective).
32
+ * @type {string}
33
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
34
+ */
35
+ studyObjectiveId?: string;
36
+ /**
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.
26
38
  * @type {string}
27
39
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
40
  */
29
41
  status: TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum;
30
42
  }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const TriggerStudyObjectiveConceptExtractionItemStatusKindEnum: {
47
+ readonly CanvasObject: "canvas_object";
48
+ readonly StudyObjective: "study_objective";
49
+ };
50
+ export type TriggerStudyObjectiveConceptExtractionItemStatusKindEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusKindEnum];
31
51
  /**
32
52
  * @export
33
53
  */
@@ -38,6 +58,7 @@ export declare const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum:
38
58
  readonly Failed: "failed";
39
59
  readonly CoolingDown: "cooling-down";
40
60
  readonly SkippedDisabled: "skipped-disabled";
61
+ readonly NotFound: "not-found";
41
62
  };
42
63
  export type TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum];
43
64
  /**
@@ -11,6 +11,13 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const TriggerStudyObjectiveConceptExtractionItemStatusKindEnum = {
18
+ CanvasObject: 'canvas_object',
19
+ StudyObjective: 'study_objective'
20
+ };
14
21
  /**
15
22
  * @export
16
23
  */
@@ -20,13 +27,14 @@ export const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
20
27
  Active: 'active',
21
28
  Failed: 'failed',
22
29
  CoolingDown: 'cooling-down',
23
- SkippedDisabled: 'skipped-disabled'
30
+ SkippedDisabled: 'skipped-disabled',
31
+ NotFound: 'not-found'
24
32
  };
25
33
  /**
26
34
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
27
35
  */
28
36
  export function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value) {
29
- if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
37
+ if (!('kind' in value) || value['kind'] === undefined)
30
38
  return false;
31
39
  if (!('status' in value) || value['status'] === undefined)
32
40
  return false;
@@ -40,7 +48,9 @@ export function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(js
40
48
  return json;
41
49
  }
42
50
  return {
43
- 'canvasObjectId': json['canvasObjectId'],
51
+ 'kind': json['kind'],
52
+ 'canvasObjectId': json['canvasObjectId'] == null ? undefined : json['canvasObjectId'],
53
+ 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
44
54
  'status': json['status'],
45
55
  };
46
56
  }
@@ -52,7 +62,9 @@ export function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(valu
52
62
  return value;
53
63
  }
54
64
  return {
65
+ 'kind': value['kind'],
55
66
  'canvasObjectId': value['canvasObjectId'],
67
+ 'studyObjectiveId': value['studyObjectiveId'],
56
68
  'status': value['status'],
57
69
  };
58
70
  }
@@ -17,13 +17,13 @@ import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionRequest {
19
19
  /**
20
- * Canvas local course id (e.g. '587077'). Scopes the extraction request.
20
+ * Canvas local course id. Required when the request includes any canvas_object item.
21
21
  * @type {string}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
23
23
  */
24
- canvasCourseId: string;
24
+ canvasCourseId?: string;
25
25
  /**
26
- * One to fifty Canvas objects whose study-objective concepts should be extracted.
26
+ * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
27
27
  * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}
28
28
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
29
29
  */
@@ -16,8 +16,6 @@ import { TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON, Trigge
16
16
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
17
17
  */
18
18
  export function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value) {
19
- if (!('canvasCourseId' in value) || value['canvasCourseId'] === undefined)
20
- return false;
21
19
  if (!('items' in value) || value['items'] === undefined)
22
20
  return false;
23
21
  return true;
@@ -30,7 +28,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
30
28
  return json;
31
29
  }
32
30
  return {
33
- 'canvasCourseId': json['canvasCourseId'],
31
+ 'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
34
32
  'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
35
33
  };
36
34
  }
@@ -15,6 +15,18 @@
15
15
  * @interface TriggerStudyObjectiveConceptExtractionRequestItemsInner
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionRequestItemsInner {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInner
22
+ */
23
+ kind: TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum;
24
+ /**
25
+ * Id of a user-defined study objective owned by the caller.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInner
28
+ */
29
+ studyObjectiveId: string;
18
30
  /**
19
31
  * Canvas object id formatted '{type}:{local_id}'.
20
32
  * @type {string}
@@ -22,6 +34,13 @@ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInner {
22
34
  */
23
35
  canvasObjectId: string;
24
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum: {
41
+ readonly CanvasObject: "canvas_object";
42
+ };
43
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum];
25
44
  /**
26
45
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
27
46
  */
@@ -11,10 +11,20 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum = {
18
+ CanvasObject: 'canvas_object'
19
+ };
14
20
  /**
15
21
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
16
22
  */
17
23
  export function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner(value) {
24
+ if (!('kind' in value) || value['kind'] === undefined)
25
+ return false;
26
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
27
+ return false;
18
28
  if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
19
29
  return false;
20
30
  return true;
@@ -27,6 +37,8 @@ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONT
27
37
  return json;
28
38
  }
29
39
  return {
40
+ 'kind': json['kind'],
41
+ 'studyObjectiveId': json['studyObjectiveId'],
30
42
  'canvasObjectId': json['canvasObjectId'],
31
43
  };
32
44
  }
@@ -38,6 +50,8 @@ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyp
38
50
  return value;
39
51
  }
40
52
  return {
53
+ 'kind': value['kind'],
54
+ 'studyObjectiveId': value['studyObjectiveId'],
41
55
  'canvasObjectId': value['canvasObjectId'],
42
56
  };
43
57
  }
@@ -0,0 +1,45 @@
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 TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
22
+ */
23
+ kind: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum;
24
+ /**
25
+ * Id of a user-defined study objective owned by the caller.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
28
+ */
29
+ studyObjectiveId: string;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum: {
35
+ readonly StudyObjective: "study_objective";
36
+ };
37
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum];
38
+ /**
39
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf interface.
40
+ */
41
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf(value: object): value is TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
42
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
43
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
44
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
45
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,53 @@
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 TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum = {
18
+ StudyObjective: 'study_objective'
19
+ };
20
+ /**
21
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf interface.
22
+ */
23
+ export function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf(value) {
24
+ if (!('kind' in value) || value['kind'] === undefined)
25
+ return false;
26
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON(json) {
31
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json, false);
32
+ }
33
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'kind': json['kind'],
39
+ 'studyObjectiveId': json['studyObjectiveId'],
40
+ };
41
+ }
42
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON(json) {
43
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(json, false);
44
+ }
45
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'kind': value['kind'],
51
+ 'studyObjectiveId': value['studyObjectiveId'],
52
+ };
53
+ }
@@ -0,0 +1,45 @@
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 TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
22
+ */
23
+ kind?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum;
24
+ /**
25
+ * Canvas object id formatted '{type}:{local_id}'.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
28
+ */
29
+ canvasObjectId: string;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum: {
35
+ readonly CanvasObject: "canvas_object";
36
+ };
37
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum];
38
+ /**
39
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 interface.
40
+ */
41
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1(value: object): value is TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
42
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
43
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
44
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
45
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum = {
18
+ CanvasObject: 'canvas_object'
19
+ };
20
+ /**
21
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 interface.
22
+ */
23
+ export function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1(value) {
24
+ if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
25
+ return false;
26
+ return true;
27
+ }
28
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON(json) {
29
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json, false);
30
+ }
31
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'kind': json['kind'] == null ? undefined : json['kind'],
37
+ 'canvasObjectId': json['canvasObjectId'],
38
+ };
39
+ }
40
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON(json) {
41
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(json, false);
42
+ }
43
+ export function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'kind': value['kind'],
49
+ 'canvasObjectId': value['canvasObjectId'],
50
+ };
51
+ }
@@ -17,7 +17,7 @@ import type { TriggerStudyObjectiveConceptExtractionItemStatus } from './Trigger
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionResponse {
19
19
  /**
20
- * One entry per Canvas object in the request, in the same order.
20
+ * One entry per requested item, in request order within kind.
21
21
  * @type {Array<TriggerStudyObjectiveConceptExtractionItemStatus>}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionResponse
23
23
  */
@@ -102,6 +102,8 @@ export * from './TaxonomySummary';
102
102
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
103
103
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
104
104
  export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
105
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
106
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
105
107
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
106
108
  export * from './UpdateAccountDto';
107
109
  export * from './UpdateChatRequest';
@@ -104,6 +104,8 @@ export * from './TaxonomySummary';
104
104
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
105
105
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
106
106
  export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
107
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
108
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
107
109
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
108
110
  export * from './UpdateAccountDto';
109
111
  export * from './UpdateChatRequest';
@@ -16,18 +16,38 @@
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionItemStatus {
18
18
  /**
19
- * Canvas object id from the request (formatted '{type}:{local_id}').
19
+ * Discriminates which identity fields are populated.
20
20
  * @type {string}
21
21
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
22
22
  */
23
- canvasObjectId: string;
23
+ kind: TriggerStudyObjectiveConceptExtractionItemStatusKindEnum;
24
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.
25
+ * Canvas object id from the request (present when kind = canvas_object).
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
+ */
29
+ canvasObjectId?: string;
30
+ /**
31
+ * Study objective id from the request (present when kind = study_objective).
32
+ * @type {string}
33
+ * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
34
+ */
35
+ studyObjectiveId?: string;
36
+ /**
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.
26
38
  * @type {string}
27
39
  * @memberof TriggerStudyObjectiveConceptExtractionItemStatus
28
40
  */
29
41
  status: TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum;
30
42
  }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const TriggerStudyObjectiveConceptExtractionItemStatusKindEnum: {
47
+ readonly CanvasObject: "canvas_object";
48
+ readonly StudyObjective: "study_objective";
49
+ };
50
+ export type TriggerStudyObjectiveConceptExtractionItemStatusKindEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusKindEnum];
31
51
  /**
32
52
  * @export
33
53
  */
@@ -38,6 +58,7 @@ export declare const TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum:
38
58
  readonly Failed: "failed";
39
59
  readonly CoolingDown: "cooling-down";
40
60
  readonly SkippedDisabled: "skipped-disabled";
61
+ readonly NotFound: "not-found";
41
62
  };
42
63
  export type TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum[keyof typeof TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum];
43
64
  /**
@@ -13,12 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = void 0;
16
+ exports.TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = exports.TriggerStudyObjectiveConceptExtractionItemStatusKindEnum = void 0;
17
17
  exports.instanceOfTriggerStudyObjectiveConceptExtractionItemStatus = instanceOfTriggerStudyObjectiveConceptExtractionItemStatus;
18
18
  exports.TriggerStudyObjectiveConceptExtractionItemStatusFromJSON = TriggerStudyObjectiveConceptExtractionItemStatusFromJSON;
19
19
  exports.TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped = TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped;
20
20
  exports.TriggerStudyObjectiveConceptExtractionItemStatusToJSON = TriggerStudyObjectiveConceptExtractionItemStatusToJSON;
21
21
  exports.TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped = TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.TriggerStudyObjectiveConceptExtractionItemStatusKindEnum = {
26
+ CanvasObject: 'canvas_object',
27
+ StudyObjective: 'study_objective'
28
+ };
22
29
  /**
23
30
  * @export
24
31
  */
@@ -28,13 +35,14 @@ exports.TriggerStudyObjectiveConceptExtractionItemStatusStatusEnum = {
28
35
  Active: 'active',
29
36
  Failed: 'failed',
30
37
  CoolingDown: 'cooling-down',
31
- SkippedDisabled: 'skipped-disabled'
38
+ SkippedDisabled: 'skipped-disabled',
39
+ NotFound: 'not-found'
32
40
  };
33
41
  /**
34
42
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionItemStatus interface.
35
43
  */
36
44
  function instanceOfTriggerStudyObjectiveConceptExtractionItemStatus(value) {
37
- if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
45
+ if (!('kind' in value) || value['kind'] === undefined)
38
46
  return false;
39
47
  if (!('status' in value) || value['status'] === undefined)
40
48
  return false;
@@ -48,7 +56,9 @@ function TriggerStudyObjectiveConceptExtractionItemStatusFromJSONTyped(json, ign
48
56
  return json;
49
57
  }
50
58
  return {
51
- 'canvasObjectId': json['canvasObjectId'],
59
+ 'kind': json['kind'],
60
+ 'canvasObjectId': json['canvasObjectId'] == null ? undefined : json['canvasObjectId'],
61
+ 'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
52
62
  'status': json['status'],
53
63
  };
54
64
  }
@@ -60,7 +70,9 @@ function TriggerStudyObjectiveConceptExtractionItemStatusToJSONTyped(value, igno
60
70
  return value;
61
71
  }
62
72
  return {
73
+ 'kind': value['kind'],
63
74
  'canvasObjectId': value['canvasObjectId'],
75
+ 'studyObjectiveId': value['studyObjectiveId'],
64
76
  'status': value['status'],
65
77
  };
66
78
  }
@@ -17,13 +17,13 @@ import type { TriggerStudyObjectiveConceptExtractionRequestItemsInner } from './
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionRequest {
19
19
  /**
20
- * Canvas local course id (e.g. '587077'). Scopes the extraction request.
20
+ * Canvas local course id. Required when the request includes any canvas_object item.
21
21
  * @type {string}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
23
23
  */
24
- canvasCourseId: string;
24
+ canvasCourseId?: string;
25
25
  /**
26
- * One to fifty Canvas objects whose study-objective concepts should be extracted.
26
+ * One to fifty items whose study-objective concepts should be extracted — Canvas objects and/or user-defined study objectives.
27
27
  * @type {Array<TriggerStudyObjectiveConceptExtractionRequestItemsInner>}
28
28
  * @memberof TriggerStudyObjectiveConceptExtractionRequest
29
29
  */
@@ -23,8 +23,6 @@ const TriggerStudyObjectiveConceptExtractionRequestItemsInner_1 = require("./Tri
23
23
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
24
24
  */
25
25
  function instanceOfTriggerStudyObjectiveConceptExtractionRequest(value) {
26
- if (!('canvasCourseId' in value) || value['canvasCourseId'] === undefined)
27
- return false;
28
26
  if (!('items' in value) || value['items'] === undefined)
29
27
  return false;
30
28
  return true;
@@ -37,7 +35,7 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
37
35
  return json;
38
36
  }
39
37
  return {
40
- 'canvasCourseId': json['canvasCourseId'],
38
+ 'canvasCourseId': json['canvasCourseId'] == null ? undefined : json['canvasCourseId'],
41
39
  'items': (json['items'].map(TriggerStudyObjectiveConceptExtractionRequestItemsInner_1.TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON)),
42
40
  };
43
41
  }
@@ -15,6 +15,18 @@
15
15
  * @interface TriggerStudyObjectiveConceptExtractionRequestItemsInner
16
16
  */
17
17
  export interface TriggerStudyObjectiveConceptExtractionRequestItemsInner {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInner
22
+ */
23
+ kind: TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum;
24
+ /**
25
+ * Id of a user-defined study objective owned by the caller.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInner
28
+ */
29
+ studyObjectiveId: string;
18
30
  /**
19
31
  * Canvas object id formatted '{type}:{local_id}'.
20
32
  * @type {string}
@@ -22,6 +34,13 @@ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInner {
22
34
  */
23
35
  canvasObjectId: string;
24
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum: {
41
+ readonly CanvasObject: "canvas_object";
42
+ };
43
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum];
25
44
  /**
26
45
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
27
46
  */
@@ -13,15 +13,26 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum = void 0;
16
17
  exports.instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner = instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner;
17
18
  exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSON;
18
19
  exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped;
19
20
  exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSON;
20
21
  exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerKindEnum = {
26
+ CanvasObject: 'canvas_object'
27
+ };
21
28
  /**
22
29
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInner interface.
23
30
  */
24
31
  function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInner(value) {
32
+ if (!('kind' in value) || value['kind'] === undefined)
33
+ return false;
34
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
35
+ return false;
25
36
  if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
26
37
  return false;
27
38
  return true;
@@ -34,6 +45,8 @@ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerFromJSONTyped(js
34
45
  return json;
35
46
  }
36
47
  return {
48
+ 'kind': json['kind'],
49
+ 'studyObjectiveId': json['studyObjectiveId'],
37
50
  'canvasObjectId': json['canvasObjectId'],
38
51
  };
39
52
  }
@@ -45,6 +58,8 @@ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerToJSONTyped(valu
45
58
  return value;
46
59
  }
47
60
  return {
61
+ 'kind': value['kind'],
62
+ 'studyObjectiveId': value['studyObjectiveId'],
48
63
  'canvasObjectId': value['canvasObjectId'],
49
64
  };
50
65
  }
@@ -0,0 +1,45 @@
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 TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
22
+ */
23
+ kind: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum;
24
+ /**
25
+ * Id of a user-defined study objective owned by the caller.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf
28
+ */
29
+ studyObjectiveId: string;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum: {
35
+ readonly StudyObjective: "study_objective";
36
+ };
37
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum];
38
+ /**
39
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf interface.
40
+ */
41
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf(value: object): value is TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
42
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
43
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
44
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
45
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum = void 0;
17
+ exports.instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf = instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf;
18
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON;
19
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped;
20
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON;
21
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfKindEnum = {
26
+ StudyObjective: 'study_objective'
27
+ };
28
+ /**
29
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf interface.
30
+ */
31
+ function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf(value) {
32
+ if (!('kind' in value) || value['kind'] === undefined)
33
+ return false;
34
+ if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
35
+ return false;
36
+ return true;
37
+ }
38
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSON(json) {
39
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json, false);
40
+ }
41
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfFromJSONTyped(json, ignoreDiscriminator) {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'kind': json['kind'],
47
+ 'studyObjectiveId': json['studyObjectiveId'],
48
+ };
49
+ }
50
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSON(json) {
51
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(json, false);
52
+ }
53
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOfToJSONTyped(value, ignoreDiscriminator = false) {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'kind': value['kind'],
59
+ 'studyObjectiveId': value['studyObjectiveId'],
60
+ };
61
+ }
@@ -0,0 +1,45 @@
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 TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
16
+ */
17
+ export interface TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
22
+ */
23
+ kind?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum;
24
+ /**
25
+ * Canvas object id formatted '{type}:{local_id}'.
26
+ * @type {string}
27
+ * @memberof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1
28
+ */
29
+ canvasObjectId: string;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum: {
35
+ readonly CanvasObject: "canvas_object";
36
+ };
37
+ export type TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum = typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum[keyof typeof TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum];
38
+ /**
39
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 interface.
40
+ */
41
+ export declare function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1(value: object): value is TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
42
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
43
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
44
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON(json: any): TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
45
+ export declare function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(value?: TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum = void 0;
17
+ exports.instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 = instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1;
18
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON;
19
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped;
20
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON;
21
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped = TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1KindEnum = {
26
+ CanvasObject: 'canvas_object'
27
+ };
28
+ /**
29
+ * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1 interface.
30
+ */
31
+ function instanceOfTriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1(value) {
32
+ if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSON(json) {
37
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json, false);
38
+ }
39
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1FromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'kind': json['kind'] == null ? undefined : json['kind'],
45
+ 'canvasObjectId': json['canvasObjectId'],
46
+ };
47
+ }
48
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSON(json) {
49
+ return TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(json, false);
50
+ }
51
+ function TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1ToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'kind': value['kind'],
57
+ 'canvasObjectId': value['canvasObjectId'],
58
+ };
59
+ }
@@ -17,7 +17,7 @@ import type { TriggerStudyObjectiveConceptExtractionItemStatus } from './Trigger
17
17
  */
18
18
  export interface TriggerStudyObjectiveConceptExtractionResponse {
19
19
  /**
20
- * One entry per Canvas object in the request, in the same order.
20
+ * One entry per requested item, in request order within kind.
21
21
  * @type {Array<TriggerStudyObjectiveConceptExtractionItemStatus>}
22
22
  * @memberof TriggerStudyObjectiveConceptExtractionResponse
23
23
  */
@@ -102,6 +102,8 @@ export * from './TaxonomySummary';
102
102
  export * from './TriggerStudyObjectiveConceptExtractionItemStatus';
103
103
  export * from './TriggerStudyObjectiveConceptExtractionRequest';
104
104
  export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
105
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
106
+ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
105
107
  export * from './TriggerStudyObjectiveConceptExtractionResponse';
106
108
  export * from './UpdateAccountDto';
107
109
  export * from './UpdateChatRequest';
@@ -120,6 +120,8 @@ __exportStar(require("./TaxonomySummary"), exports);
120
120
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionItemStatus"), exports);
121
121
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequest"), exports);
122
122
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInner"), exports);
123
+ __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf"), exports);
124
+ __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1"), exports);
123
125
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionResponse"), exports);
124
126
  __exportStar(require("./UpdateAccountDto"), exports);
125
127
  __exportStar(require("./UpdateChatRequest"), 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.2.0",
4
+ "version": "3.3.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {