@instructure/athena-api-client 3.29.0 → 3.30.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.
@@ -105,6 +105,12 @@ export interface Chat {
105
105
  * @memberof Chat
106
106
  */
107
107
  courseId: string | null;
108
+ /**
109
+ * Canvas course this chat's activity should be attributed to, resolved at read time: the chat's own `courseId`, else the course of the study objective the chat was launched from, else the course of that objective's study space, else the course of the practice-quiz slot the chat was minted for. Null when none of them knows a course — the activity is genuinely unattributed. Unlike `courseId`, this field is reporting-only and never affects what the chat stream injects.
110
+ * @type {string}
111
+ * @memberof Chat
112
+ */
113
+ attributionCourseId: string | null;
108
114
  /**
109
115
  * Snapshot of the learner's strength (0..1) captured when a learning session chat was created. Only populated for chatType 'level-up' or 'quick-practice'; null otherwise.
110
116
  * @type {number}
@@ -52,6 +52,8 @@ export function instanceOfChat(value) {
52
52
  return false;
53
53
  if (!('courseId' in value) || value['courseId'] === undefined)
54
54
  return false;
55
+ if (!('attributionCourseId' in value) || value['attributionCourseId'] === undefined)
56
+ return false;
55
57
  if (!('initialStrength' in value) || value['initialStrength'] === undefined)
56
58
  return false;
57
59
  if (!('primaryConceptId' in value) || value['primaryConceptId'] === undefined)
@@ -83,6 +85,7 @@ export function ChatFromJSONTyped(json, ignoreDiscriminator) {
83
85
  'forReview': json['forReview'],
84
86
  'taxonomyId': json['taxonomyId'],
85
87
  'courseId': json['courseId'],
88
+ 'attributionCourseId': json['attributionCourseId'],
86
89
  'initialStrength': json['initialStrength'],
87
90
  'primaryConceptId': json['primaryConceptId'],
88
91
  'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
@@ -111,6 +114,7 @@ export function ChatToJSONTyped(value, ignoreDiscriminator = false) {
111
114
  'forReview': value['forReview'],
112
115
  'taxonomyId': value['taxonomyId'],
113
116
  'courseId': value['courseId'],
117
+ 'attributionCourseId': value['attributionCourseId'],
114
118
  'initialStrength': value['initialStrength'],
115
119
  'primaryConceptId': value['primaryConceptId'],
116
120
  'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
@@ -28,7 +28,7 @@ export interface QuizQuestionView {
28
28
  */
29
29
  viewCount: number;
30
30
  /**
31
- * Canvas course this view is attributable to, resolved from the quiz's chat (or, for a practice quiz, its Canvas object's course). Null when the quiz has no chat or the chat carries no course — the view is simply unattributed.
31
+ * Canvas course this view is attributable to, resolved from the quiz's chat: the chat's own course grounding, else the study objective the quiz was launched from, else that objective's study space, else the practice-quiz slot the chat was minted for. Null when none of them knows a course — the view is simply unattributed. Matches `Chat.attributionCourseId` for the same chat.
32
32
  * @type {string}
33
33
  * @memberof QuizQuestionView
34
34
  */
@@ -76,7 +76,7 @@ export interface SubmittedQuizResponse {
76
76
  */
77
77
  learningMomentCreated: boolean;
78
78
  /**
79
- * Canvas course this answer is attributable to, resolved from the quiz's chat (or, for a practice quiz, its Canvas object's course). Null when the quiz has no chat or the chat carries no course — the answer is simply unattributed.
79
+ * Canvas course this answer is attributable to, resolved from the quiz's chat: the chat's own course grounding, else the study objective the quiz was launched from, else that objective's study space, else the practice-quiz slot the chat was minted for. Null when none of them knows a course — the answer is simply unattributed. Matches `Chat.attributionCourseId` for the same chat.
80
80
  * @type {string}
81
81
  * @memberof SubmittedQuizResponse
82
82
  */
@@ -105,6 +105,12 @@ export interface Chat {
105
105
  * @memberof Chat
106
106
  */
107
107
  courseId: string | null;
108
+ /**
109
+ * Canvas course this chat's activity should be attributed to, resolved at read time: the chat's own `courseId`, else the course of the study objective the chat was launched from, else the course of that objective's study space, else the course of the practice-quiz slot the chat was minted for. Null when none of them knows a course — the activity is genuinely unattributed. Unlike `courseId`, this field is reporting-only and never affects what the chat stream injects.
110
+ * @type {string}
111
+ * @memberof Chat
112
+ */
113
+ attributionCourseId: string | null;
108
114
  /**
109
115
  * Snapshot of the learner's strength (0..1) captured when a learning session chat was created. Only populated for chatType 'level-up' or 'quick-practice'; null otherwise.
110
116
  * @type {number}
@@ -60,6 +60,8 @@ function instanceOfChat(value) {
60
60
  return false;
61
61
  if (!('courseId' in value) || value['courseId'] === undefined)
62
62
  return false;
63
+ if (!('attributionCourseId' in value) || value['attributionCourseId'] === undefined)
64
+ return false;
63
65
  if (!('initialStrength' in value) || value['initialStrength'] === undefined)
64
66
  return false;
65
67
  if (!('primaryConceptId' in value) || value['primaryConceptId'] === undefined)
@@ -91,6 +93,7 @@ function ChatFromJSONTyped(json, ignoreDiscriminator) {
91
93
  'forReview': json['forReview'],
92
94
  'taxonomyId': json['taxonomyId'],
93
95
  'courseId': json['courseId'],
96
+ 'attributionCourseId': json['attributionCourseId'],
94
97
  'initialStrength': json['initialStrength'],
95
98
  'primaryConceptId': json['primaryConceptId'],
96
99
  'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
@@ -119,6 +122,7 @@ function ChatToJSONTyped(value, ignoreDiscriminator = false) {
119
122
  'forReview': value['forReview'],
120
123
  'taxonomyId': value['taxonomyId'],
121
124
  'courseId': value['courseId'],
125
+ 'attributionCourseId': value['attributionCourseId'],
122
126
  'initialStrength': value['initialStrength'],
123
127
  'primaryConceptId': value['primaryConceptId'],
124
128
  'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
@@ -28,7 +28,7 @@ export interface QuizQuestionView {
28
28
  */
29
29
  viewCount: number;
30
30
  /**
31
- * Canvas course this view is attributable to, resolved from the quiz's chat (or, for a practice quiz, its Canvas object's course). Null when the quiz has no chat or the chat carries no course — the view is simply unattributed.
31
+ * Canvas course this view is attributable to, resolved from the quiz's chat: the chat's own course grounding, else the study objective the quiz was launched from, else that objective's study space, else the practice-quiz slot the chat was minted for. Null when none of them knows a course — the view is simply unattributed. Matches `Chat.attributionCourseId` for the same chat.
32
32
  * @type {string}
33
33
  * @memberof QuizQuestionView
34
34
  */
@@ -76,7 +76,7 @@ export interface SubmittedQuizResponse {
76
76
  */
77
77
  learningMomentCreated: boolean;
78
78
  /**
79
- * Canvas course this answer is attributable to, resolved from the quiz's chat (or, for a practice quiz, its Canvas object's course). Null when the quiz has no chat or the chat carries no course — the answer is simply unattributed.
79
+ * Canvas course this answer is attributable to, resolved from the quiz's chat: the chat's own course grounding, else the study objective the quiz was launched from, else that objective's study space, else the practice-quiz slot the chat was minted for. Null when none of them knows a course — the answer is simply unattributed. Matches `Chat.attributionCourseId` for the same chat.
80
80
  * @type {string}
81
81
  * @memberof SubmittedQuizResponse
82
82
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.29.0",
4
+ "version": "3.30.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {