@instructure/athena-api-client 4.7.5 → 4.8.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 (5) hide show
  1. package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts +12 -0
  2. package/dist/esm/models/StudyObjectiveConceptAttachment.js +8 -0
  3. package/dist/models/StudyObjectiveConceptAttachment.d.ts +12 -0
  4. package/dist/models/StudyObjectiveConceptAttachment.js +8 -0
  5. package/package.json +1 -1
package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts CHANGED
@@ -46,6 +46,18 @@ export interface StudyObjectiveConceptAttachment {
46
46
  * @memberof StudyObjectiveConceptAttachment
47
47
  */
48
48
  emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
49
+ /**
50
+ * When a Canvas read made with a learner's own token last stored this Canvas item's facts: the access read a routine trigger runs (a Study Space visit, or staff refreshing a course for that learner). Null for an item never read and for custom objectives. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`). The item's row is shared by every learner on it, so a read for any of them moves it.
51
+ * @type {Date}
52
+ * @memberof StudyObjectiveConceptAttachment
53
+ */
54
+ accessReadAt: Date | null;
55
+ /**
56
+ * The reader version that derived this Canvas item's course-structure facts. Null while none are derived: an assignment or quiz not read since they shipped, a page, or a custom objective. A routine trigger reads an item again when its version is earlier than the current one. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`).
57
+ * @type {string}
58
+ * @memberof StudyObjectiveConceptAttachment
59
+ */
60
+ structureReaderVersion: string | null;
49
61
  /**
50
62
  *
51
63
  * @type {Array<StudyObjectiveConceptSummary>}
package/dist/esm/models/StudyObjectiveConceptAttachment.js CHANGED
@@ -50,6 +50,10 @@ export function instanceOfStudyObjectiveConceptAttachment(value) {
50
50
  return false;
51
51
  if (!('emptyReason' in value) || value['emptyReason'] === undefined)
52
52
  return false;
53
+ if (!('accessReadAt' in value) || value['accessReadAt'] === undefined)
54
+ return false;
55
+ if (!('structureReaderVersion' in value) || value['structureReaderVersion'] === undefined)
56
+ return false;
53
57
  if (!('concepts' in value) || value['concepts'] === undefined)
54
58
  return false;
55
59
  return true;
@@ -67,6 +71,8 @@ export function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscrim
67
71
  'status': json['status'],
68
72
  'lastError': json['lastError'],
69
73
  'emptyReason': json['emptyReason'],
74
+ 'accessReadAt': (json['accessReadAt'] == null ? null : new Date(json['accessReadAt'])),
75
+ 'structureReaderVersion': json['structureReaderVersion'],
70
76
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummaryFromJSON)),
71
77
  };
72
78
  }
@@ -83,6 +89,8 @@ export function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscrimi
83
89
  'status': value['status'],
84
90
  'lastError': value['lastError'],
85
91
  'emptyReason': value['emptyReason'],
92
+ 'accessReadAt': value['accessReadAt'] == null ? value['accessReadAt'] : value['accessReadAt'].toISOString(),
93
+ 'structureReaderVersion': value['structureReaderVersion'],
86
94
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummaryToJSON)),
87
95
  };
88
96
  }
package/dist/models/StudyObjectiveConceptAttachment.d.ts CHANGED
@@ -46,6 +46,18 @@ export interface StudyObjectiveConceptAttachment {
46
46
  * @memberof StudyObjectiveConceptAttachment
47
47
  */
48
48
  emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
49
+ /**
50
+ * When a Canvas read made with a learner's own token last stored this Canvas item's facts: the access read a routine trigger runs (a Study Space visit, or staff refreshing a course for that learner). Null for an item never read and for custom objectives. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`). The item's row is shared by every learner on it, so a read for any of them moves it.
51
+ * @type {Date}
52
+ * @memberof StudyObjectiveConceptAttachment
53
+ */
54
+ accessReadAt: Date | null;
55
+ /**
56
+ * The reader version that derived this Canvas item's course-structure facts. Null while none are derived: an assignment or quiz not read since they shipped, a page, or a custom objective. A routine trigger reads an item again when its version is earlier than the current one. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`).
57
+ * @type {string}
58
+ * @memberof StudyObjectiveConceptAttachment
59
+ */
60
+ structureReaderVersion: string | null;
49
61
  /**
50
62
  *
51
63
  * @type {Array<StudyObjectiveConceptSummary>}
package/dist/models/StudyObjectiveConceptAttachment.js CHANGED
@@ -58,6 +58,10 @@ function instanceOfStudyObjectiveConceptAttachment(value) {
58
58
  return false;
59
59
  if (!('emptyReason' in value) || value['emptyReason'] === undefined)
60
60
  return false;
61
+ if (!('accessReadAt' in value) || value['accessReadAt'] === undefined)
62
+ return false;
63
+ if (!('structureReaderVersion' in value) || value['structureReaderVersion'] === undefined)
64
+ return false;
61
65
  if (!('concepts' in value) || value['concepts'] === undefined)
62
66
  return false;
63
67
  return true;
@@ -75,6 +79,8 @@ function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscriminator)
75
79
  'status': json['status'],
76
80
  'lastError': json['lastError'],
77
81
  'emptyReason': json['emptyReason'],
82
+ 'accessReadAt': (json['accessReadAt'] == null ? null : new Date(json['accessReadAt'])),
83
+ 'structureReaderVersion': json['structureReaderVersion'],
78
84
  'concepts': (json['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryFromJSON)),
79
85
  };
80
86
  }
@@ -91,6 +97,8 @@ function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscriminator =
91
97
  'status': value['status'],
92
98
  'lastError': value['lastError'],
93
99
  'emptyReason': value['emptyReason'],
100
+ 'accessReadAt': value['accessReadAt'] == null ? value['accessReadAt'] : value['accessReadAt'].toISOString(),
101
+ 'structureReaderVersion': value['structureReaderVersion'],
94
102
  'concepts': (value['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryToJSON)),
95
103
  };
96
104
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "4.7.5",
4
+ "version": "4.8.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {