@instructure/athena-api-client 2.2.3 → 2.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.
@@ -34,11 +34,17 @@ export interface LearningMoment {
34
34
  */
35
35
  chatId: string;
36
36
  /**
37
- * ID of the message that triggered the learning moment
37
+ * ID of the message that triggered the learning moment (null for quiz-sourced moments)
38
38
  * @type {string}
39
39
  * @memberof LearningMoment
40
40
  */
41
- messageId: string;
41
+ messageId: string | null;
42
+ /**
43
+ * ID of the quiz response that triggered the learning moment (null for chat-sourced moments)
44
+ * @type {string}
45
+ * @memberof LearningMoment
46
+ */
47
+ quizResponseId: string | null;
42
48
  /**
43
49
  * Learning signal label (e.g. 'yes', 'weak')
44
50
  * @type {string}
@@ -23,6 +23,8 @@ export function instanceOfLearningMoment(value) {
23
23
  return false;
24
24
  if (!('messageId' in value) || value['messageId'] === undefined)
25
25
  return false;
26
+ if (!('quizResponseId' in value) || value['quizResponseId'] === undefined)
27
+ return false;
26
28
  if (!('label' in value) || value['label'] === undefined)
27
29
  return false;
28
30
  if (!('confidence' in value) || value['confidence'] === undefined)
@@ -49,6 +51,7 @@ export function LearningMomentFromJSONTyped(json, ignoreDiscriminator) {
49
51
  'accountUserId': json['accountUserId'],
50
52
  'chatId': json['chatId'],
51
53
  'messageId': json['messageId'],
54
+ 'quizResponseId': json['quizResponseId'],
52
55
  'label': json['label'],
53
56
  'confidence': json['confidence'],
54
57
  'reason': json['reason'],
@@ -69,6 +72,7 @@ export function LearningMomentToJSONTyped(value, ignoreDiscriminator = false) {
69
72
  'accountUserId': value['accountUserId'],
70
73
  'chatId': value['chatId'],
71
74
  'messageId': value['messageId'],
75
+ 'quizResponseId': value['quizResponseId'],
72
76
  'label': value['label'],
73
77
  'confidence': value['confidence'],
74
78
  'reason': value['reason'],
@@ -69,6 +69,12 @@ export interface QuizResponse {
69
69
  * @memberof QuizResponse
70
70
  */
71
71
  createdAt: Date;
72
+ /**
73
+ * Whether a learning moment was created from this response
74
+ * @type {boolean}
75
+ * @memberof QuizResponse
76
+ */
77
+ learningMomentCreated: boolean;
72
78
  }
73
79
  /**
74
80
  * @export
@@ -48,6 +48,8 @@ export function instanceOfQuizResponse(value) {
48
48
  return false;
49
49
  if (!('createdAt' in value) || value['createdAt'] === undefined)
50
50
  return false;
51
+ if (!('learningMomentCreated' in value) || value['learningMomentCreated'] === undefined)
52
+ return false;
51
53
  return true;
52
54
  }
53
55
  export function QuizResponseFromJSON(json) {
@@ -67,6 +69,7 @@ export function QuizResponseFromJSONTyped(json, ignoreDiscriminator) {
67
69
  'grade': json['grade'],
68
70
  'feedback': json['feedback'],
69
71
  'createdAt': (new Date(json['createdAt'])),
72
+ 'learningMomentCreated': json['learningMomentCreated'],
70
73
  };
71
74
  }
72
75
  export function QuizResponseToJSON(json) {
@@ -86,5 +89,6 @@ export function QuizResponseToJSONTyped(value, ignoreDiscriminator = false) {
86
89
  'grade': value['grade'],
87
90
  'feedback': value['feedback'],
88
91
  'createdAt': value['createdAt'].toISOString(),
92
+ 'learningMomentCreated': value['learningMomentCreated'],
89
93
  };
90
94
  }
@@ -34,11 +34,17 @@ export interface LearningMoment {
34
34
  */
35
35
  chatId: string;
36
36
  /**
37
- * ID of the message that triggered the learning moment
37
+ * ID of the message that triggered the learning moment (null for quiz-sourced moments)
38
38
  * @type {string}
39
39
  * @memberof LearningMoment
40
40
  */
41
- messageId: string;
41
+ messageId: string | null;
42
+ /**
43
+ * ID of the quiz response that triggered the learning moment (null for chat-sourced moments)
44
+ * @type {string}
45
+ * @memberof LearningMoment
46
+ */
47
+ quizResponseId: string | null;
42
48
  /**
43
49
  * Learning signal label (e.g. 'yes', 'weak')
44
50
  * @type {string}
@@ -30,6 +30,8 @@ function instanceOfLearningMoment(value) {
30
30
  return false;
31
31
  if (!('messageId' in value) || value['messageId'] === undefined)
32
32
  return false;
33
+ if (!('quizResponseId' in value) || value['quizResponseId'] === undefined)
34
+ return false;
33
35
  if (!('label' in value) || value['label'] === undefined)
34
36
  return false;
35
37
  if (!('confidence' in value) || value['confidence'] === undefined)
@@ -56,6 +58,7 @@ function LearningMomentFromJSONTyped(json, ignoreDiscriminator) {
56
58
  'accountUserId': json['accountUserId'],
57
59
  'chatId': json['chatId'],
58
60
  'messageId': json['messageId'],
61
+ 'quizResponseId': json['quizResponseId'],
59
62
  'label': json['label'],
60
63
  'confidence': json['confidence'],
61
64
  'reason': json['reason'],
@@ -76,6 +79,7 @@ function LearningMomentToJSONTyped(value, ignoreDiscriminator = false) {
76
79
  'accountUserId': value['accountUserId'],
77
80
  'chatId': value['chatId'],
78
81
  'messageId': value['messageId'],
82
+ 'quizResponseId': value['quizResponseId'],
79
83
  'label': value['label'],
80
84
  'confidence': value['confidence'],
81
85
  'reason': value['reason'],
@@ -69,6 +69,12 @@ export interface QuizResponse {
69
69
  * @memberof QuizResponse
70
70
  */
71
71
  createdAt: Date;
72
+ /**
73
+ * Whether a learning moment was created from this response
74
+ * @type {boolean}
75
+ * @memberof QuizResponse
76
+ */
77
+ learningMomentCreated: boolean;
72
78
  }
73
79
  /**
74
80
  * @export
@@ -56,6 +56,8 @@ function instanceOfQuizResponse(value) {
56
56
  return false;
57
57
  if (!('createdAt' in value) || value['createdAt'] === undefined)
58
58
  return false;
59
+ if (!('learningMomentCreated' in value) || value['learningMomentCreated'] === undefined)
60
+ return false;
59
61
  return true;
60
62
  }
61
63
  function QuizResponseFromJSON(json) {
@@ -75,6 +77,7 @@ function QuizResponseFromJSONTyped(json, ignoreDiscriminator) {
75
77
  'grade': json['grade'],
76
78
  'feedback': json['feedback'],
77
79
  'createdAt': (new Date(json['createdAt'])),
80
+ 'learningMomentCreated': json['learningMomentCreated'],
78
81
  };
79
82
  }
80
83
  function QuizResponseToJSON(json) {
@@ -94,5 +97,6 @@ function QuizResponseToJSONTyped(value, ignoreDiscriminator = false) {
94
97
  'grade': value['grade'],
95
98
  'feedback': value['feedback'],
96
99
  'createdAt': value['createdAt'].toISOString(),
100
+ 'learningMomentCreated': value['learningMomentCreated'],
97
101
  };
98
102
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.2.3",
4
+ "version": "2.3.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {