@instructure/athena-api-client 4.6.0 → 4.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 (13) hide show
  1. package/dist/esm/models/StudyObjective.d.ts +6 -0
  2. package/dist/esm/models/StudyObjective.js +4 -0
  3. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +14 -0
  4. package/dist/esm/models/StudyObjectiveConceptAttachment.js +11 -0
  5. package/dist/esm/models/UpcomingStudyObjective.d.ts +6 -0
  6. package/dist/esm/models/UpcomingStudyObjective.js +4 -0
  7. package/dist/models/StudyObjective.d.ts +6 -0
  8. package/dist/models/StudyObjective.js +4 -0
  9. package/dist/models/StudyObjectiveConceptAttachment.d.ts +14 -0
  10. package/dist/models/StudyObjectiveConceptAttachment.js +12 -1
  11. package/dist/models/UpcomingStudyObjective.d.ts +6 -0
  12. package/dist/models/UpcomingStudyObjective.js +4 -0
  13. package/package.json +1 -1
package/dist/esm/models/StudyObjective.d.ts CHANGED
@@ -72,6 +72,12 @@ export interface StudyObjective {
72
72
  * @memberof StudyObjective
73
73
  */
74
74
  title: string;
75
+ /**
76
+ * Whether this objective's own title names a subject (a word other than an assessment's form, its place in a course, its attempt kind or its delivery: 'Quiz 1: Descriptive Statistics' does, 'Test 2' and 'Chapter 3 Quiz' don't). Read from the title on every response, never stored. A client shows a Canvas item's `no-evidence` reason only when this is false, so a title the learner sees naming a subject is never called bare.
77
+ * @type {boolean}
78
+ * @memberof StudyObjective
79
+ */
80
+ titleNamesSubject: boolean;
75
81
  /**
76
82
  *
77
83
  * @type {string}
package/dist/esm/models/StudyObjective.js CHANGED
@@ -52,6 +52,8 @@ export function instanceOfStudyObjective(value) {
52
52
  return false;
53
53
  if (!('title' in value) || value['title'] === undefined)
54
54
  return false;
55
+ if (!('titleNamesSubject' in value) || value['titleNamesSubject'] === undefined)
56
+ return false;
55
57
  if (!('notes' in value) || value['notes'] === undefined)
56
58
  return false;
57
59
  if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
@@ -85,6 +87,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
85
87
  'source': json['source'],
86
88
  'templateKey': json['templateKey'],
87
89
  'title': json['title'],
90
+ 'titleNamesSubject': json['titleNamesSubject'],
88
91
  'notes': json['notes'],
89
92
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
90
93
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
@@ -114,6 +117,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
114
117
  'source': value['source'],
115
118
  'templateKey': value['templateKey'],
116
119
  'title': value['title'],
120
+ 'titleNamesSubject': value['titleNamesSubject'],
117
121
  'notes': value['notes'],
118
122
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
119
123
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts CHANGED
@@ -40,6 +40,12 @@ export interface StudyObjectiveConceptAttachment {
40
40
  * @memberof StudyObjectiveConceptAttachment
41
41
  */
42
42
  lastError: string | null;
43
+ /**
44
+ * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction would read (title, description, supporting material, syllabus) names a subject, so the model was not asked. `agent-empty`: the model was asked and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
45
+ * @type {string}
46
+ * @memberof StudyObjectiveConceptAttachment
47
+ */
48
+ emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
43
49
  /**
44
50
  *
45
51
  * @type {Array<StudyObjectiveConceptSummary>}
@@ -66,6 +72,14 @@ export declare const StudyObjectiveConceptAttachmentStatusEnum: {
66
72
  readonly Missing: "missing";
67
73
  };
68
74
  export type StudyObjectiveConceptAttachmentStatusEnum = typeof StudyObjectiveConceptAttachmentStatusEnum[keyof typeof StudyObjectiveConceptAttachmentStatusEnum];
75
+ /**
76
+ * @export
77
+ */
78
+ export declare const StudyObjectiveConceptAttachmentEmptyReasonEnum: {
79
+ readonly NoEvidence: "no-evidence";
80
+ readonly AgentEmpty: "agent-empty";
81
+ };
82
+ export type StudyObjectiveConceptAttachmentEmptyReasonEnum = typeof StudyObjectiveConceptAttachmentEmptyReasonEnum[keyof typeof StudyObjectiveConceptAttachmentEmptyReasonEnum];
69
83
  /**
70
84
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
71
85
  */
package/dist/esm/models/StudyObjectiveConceptAttachment.js CHANGED
@@ -29,6 +29,13 @@ export const StudyObjectiveConceptAttachmentStatusEnum = {
29
29
  Failed: 'failed',
30
30
  Missing: 'missing'
31
31
  };
32
+ /**
33
+ * @export
34
+ */
35
+ export const StudyObjectiveConceptAttachmentEmptyReasonEnum = {
36
+ NoEvidence: 'no-evidence',
37
+ AgentEmpty: 'agent-empty'
38
+ };
32
39
  /**
33
40
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
34
41
  */
@@ -41,6 +48,8 @@ export function instanceOfStudyObjectiveConceptAttachment(value) {
41
48
  return false;
42
49
  if (!('lastError' in value) || value['lastError'] === undefined)
43
50
  return false;
51
+ if (!('emptyReason' in value) || value['emptyReason'] === undefined)
52
+ return false;
44
53
  if (!('concepts' in value) || value['concepts'] === undefined)
45
54
  return false;
46
55
  return true;
@@ -57,6 +66,7 @@ export function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscrim
57
66
  'kind': json['kind'],
58
67
  'status': json['status'],
59
68
  'lastError': json['lastError'],
69
+ 'emptyReason': json['emptyReason'],
60
70
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummaryFromJSON)),
61
71
  };
62
72
  }
@@ -72,6 +82,7 @@ export function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscrimi
72
82
  'kind': value['kind'],
73
83
  'status': value['status'],
74
84
  'lastError': value['lastError'],
85
+ 'emptyReason': value['emptyReason'],
75
86
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummaryToJSON)),
76
87
  };
77
88
  }
package/dist/esm/models/UpcomingStudyObjective.d.ts CHANGED
@@ -72,6 +72,12 @@ export interface UpcomingStudyObjective {
72
72
  * @memberof UpcomingStudyObjective
73
73
  */
74
74
  title: string;
75
+ /**
76
+ * Whether this objective's own title names a subject (a word other than an assessment's form, its place in a course, its attempt kind or its delivery: 'Quiz 1: Descriptive Statistics' does, 'Test 2' and 'Chapter 3 Quiz' don't). Read from the title on every response, never stored. A client shows a Canvas item's `no-evidence` reason only when this is false, so a title the learner sees naming a subject is never called bare.
77
+ * @type {boolean}
78
+ * @memberof UpcomingStudyObjective
79
+ */
80
+ titleNamesSubject: boolean;
75
81
  /**
76
82
  *
77
83
  * @type {string}
package/dist/esm/models/UpcomingStudyObjective.js CHANGED
@@ -52,6 +52,8 @@ export function instanceOfUpcomingStudyObjective(value) {
52
52
  return false;
53
53
  if (!('title' in value) || value['title'] === undefined)
54
54
  return false;
55
+ if (!('titleNamesSubject' in value) || value['titleNamesSubject'] === undefined)
56
+ return false;
55
57
  if (!('notes' in value) || value['notes'] === undefined)
56
58
  return false;
57
59
  if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
@@ -87,6 +89,7 @@ export function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
87
89
  'source': json['source'],
88
90
  'templateKey': json['templateKey'],
89
91
  'title': json['title'],
92
+ 'titleNamesSubject': json['titleNamesSubject'],
90
93
  'notes': json['notes'],
91
94
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
92
95
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
@@ -117,6 +120,7 @@ export function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = f
117
120
  'source': value['source'],
118
121
  'templateKey': value['templateKey'],
119
122
  'title': value['title'],
123
+ 'titleNamesSubject': value['titleNamesSubject'],
120
124
  'notes': value['notes'],
121
125
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
122
126
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
package/dist/models/StudyObjective.d.ts CHANGED
@@ -72,6 +72,12 @@ export interface StudyObjective {
72
72
  * @memberof StudyObjective
73
73
  */
74
74
  title: string;
75
+ /**
76
+ * Whether this objective's own title names a subject (a word other than an assessment's form, its place in a course, its attempt kind or its delivery: 'Quiz 1: Descriptive Statistics' does, 'Test 2' and 'Chapter 3 Quiz' don't). Read from the title on every response, never stored. A client shows a Canvas item's `no-evidence` reason only when this is false, so a title the learner sees naming a subject is never called bare.
77
+ * @type {boolean}
78
+ * @memberof StudyObjective
79
+ */
80
+ titleNamesSubject: boolean;
75
81
  /**
76
82
  *
77
83
  * @type {string}
package/dist/models/StudyObjective.js CHANGED
@@ -60,6 +60,8 @@ function instanceOfStudyObjective(value) {
60
60
  return false;
61
61
  if (!('title' in value) || value['title'] === undefined)
62
62
  return false;
63
+ if (!('titleNamesSubject' in value) || value['titleNamesSubject'] === undefined)
64
+ return false;
63
65
  if (!('notes' in value) || value['notes'] === undefined)
64
66
  return false;
65
67
  if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
@@ -93,6 +95,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
93
95
  'source': json['source'],
94
96
  'templateKey': json['templateKey'],
95
97
  'title': json['title'],
98
+ 'titleNamesSubject': json['titleNamesSubject'],
96
99
  'notes': json['notes'],
97
100
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
98
101
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
@@ -122,6 +125,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
122
125
  'source': value['source'],
123
126
  'templateKey': value['templateKey'],
124
127
  'title': value['title'],
128
+ 'titleNamesSubject': value['titleNamesSubject'],
125
129
  'notes': value['notes'],
126
130
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
127
131
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
package/dist/models/StudyObjectiveConceptAttachment.d.ts CHANGED
@@ -40,6 +40,12 @@ export interface StudyObjectiveConceptAttachment {
40
40
  * @memberof StudyObjectiveConceptAttachment
41
41
  */
42
42
  lastError: string | null;
43
+ /**
44
+ * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction would read (title, description, supporting material, syllabus) names a subject, so the model was not asked. `agent-empty`: the model was asked and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
45
+ * @type {string}
46
+ * @memberof StudyObjectiveConceptAttachment
47
+ */
48
+ emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
43
49
  /**
44
50
  *
45
51
  * @type {Array<StudyObjectiveConceptSummary>}
@@ -66,6 +72,14 @@ export declare const StudyObjectiveConceptAttachmentStatusEnum: {
66
72
  readonly Missing: "missing";
67
73
  };
68
74
  export type StudyObjectiveConceptAttachmentStatusEnum = typeof StudyObjectiveConceptAttachmentStatusEnum[keyof typeof StudyObjectiveConceptAttachmentStatusEnum];
75
+ /**
76
+ * @export
77
+ */
78
+ export declare const StudyObjectiveConceptAttachmentEmptyReasonEnum: {
79
+ readonly NoEvidence: "no-evidence";
80
+ readonly AgentEmpty: "agent-empty";
81
+ };
82
+ export type StudyObjectiveConceptAttachmentEmptyReasonEnum = typeof StudyObjectiveConceptAttachmentEmptyReasonEnum[keyof typeof StudyObjectiveConceptAttachmentEmptyReasonEnum];
69
83
  /**
70
84
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
71
85
  */
package/dist/models/StudyObjectiveConceptAttachment.js CHANGED
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.StudyObjectiveConceptAttachmentStatusEnum = exports.StudyObjectiveConceptAttachmentKindEnum = void 0;
16
+ exports.StudyObjectiveConceptAttachmentEmptyReasonEnum = exports.StudyObjectiveConceptAttachmentStatusEnum = exports.StudyObjectiveConceptAttachmentKindEnum = void 0;
17
17
  exports.instanceOfStudyObjectiveConceptAttachment = instanceOfStudyObjectiveConceptAttachment;
18
18
  exports.StudyObjectiveConceptAttachmentFromJSON = StudyObjectiveConceptAttachmentFromJSON;
19
19
  exports.StudyObjectiveConceptAttachmentFromJSONTyped = StudyObjectiveConceptAttachmentFromJSONTyped;
@@ -37,6 +37,13 @@ exports.StudyObjectiveConceptAttachmentStatusEnum = {
37
37
  Failed: 'failed',
38
38
  Missing: 'missing'
39
39
  };
40
+ /**
41
+ * @export
42
+ */
43
+ exports.StudyObjectiveConceptAttachmentEmptyReasonEnum = {
44
+ NoEvidence: 'no-evidence',
45
+ AgentEmpty: 'agent-empty'
46
+ };
40
47
  /**
41
48
  * Check if a given object implements the StudyObjectiveConceptAttachment interface.
42
49
  */
@@ -49,6 +56,8 @@ function instanceOfStudyObjectiveConceptAttachment(value) {
49
56
  return false;
50
57
  if (!('lastError' in value) || value['lastError'] === undefined)
51
58
  return false;
59
+ if (!('emptyReason' in value) || value['emptyReason'] === undefined)
60
+ return false;
52
61
  if (!('concepts' in value) || value['concepts'] === undefined)
53
62
  return false;
54
63
  return true;
@@ -65,6 +74,7 @@ function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscriminator)
65
74
  'kind': json['kind'],
66
75
  'status': json['status'],
67
76
  'lastError': json['lastError'],
77
+ 'emptyReason': json['emptyReason'],
68
78
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryFromJSON)),
69
79
  };
70
80
  }
@@ -80,6 +90,7 @@ function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscriminator =
80
90
  'kind': value['kind'],
81
91
  'status': value['status'],
82
92
  'lastError': value['lastError'],
93
+ 'emptyReason': value['emptyReason'],
83
94
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryToJSON)),
84
95
  };
85
96
  }
package/dist/models/UpcomingStudyObjective.d.ts CHANGED
@@ -72,6 +72,12 @@ export interface UpcomingStudyObjective {
72
72
  * @memberof UpcomingStudyObjective
73
73
  */
74
74
  title: string;
75
+ /**
76
+ * Whether this objective's own title names a subject (a word other than an assessment's form, its place in a course, its attempt kind or its delivery: 'Quiz 1: Descriptive Statistics' does, 'Test 2' and 'Chapter 3 Quiz' don't). Read from the title on every response, never stored. A client shows a Canvas item's `no-evidence` reason only when this is false, so a title the learner sees naming a subject is never called bare.
77
+ * @type {boolean}
78
+ * @memberof UpcomingStudyObjective
79
+ */
80
+ titleNamesSubject: boolean;
75
81
  /**
76
82
  *
77
83
  * @type {string}
package/dist/models/UpcomingStudyObjective.js CHANGED
@@ -60,6 +60,8 @@ function instanceOfUpcomingStudyObjective(value) {
60
60
  return false;
61
61
  if (!('title' in value) || value['title'] === undefined)
62
62
  return false;
63
+ if (!('titleNamesSubject' in value) || value['titleNamesSubject'] === undefined)
64
+ return false;
63
65
  if (!('notes' in value) || value['notes'] === undefined)
64
66
  return false;
65
67
  if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
@@ -95,6 +97,7 @@ function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
95
97
  'source': json['source'],
96
98
  'templateKey': json['templateKey'],
97
99
  'title': json['title'],
100
+ 'titleNamesSubject': json['titleNamesSubject'],
98
101
  'notes': json['notes'],
99
102
  'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
100
103
  'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
@@ -125,6 +128,7 @@ function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
125
128
  'source': value['source'],
126
129
  'templateKey': value['templateKey'],
127
130
  'title': value['title'],
131
+ 'titleNamesSubject': value['titleNamesSubject'],
128
132
  'notes': value['notes'],
129
133
  'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
130
134
  'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "4.6.0",
4
+ "version": "4.7.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {