@instructure/athena-api-client 3.32.0 → 3.33.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.
@@ -46,6 +46,18 @@ export interface StudyPlan {
46
46
  * @memberof StudyPlan
47
47
  */
48
48
  sourceToolCallId: string | null;
49
+ /**
50
+ * The learner's readiness for the plan's owner at the moment the plan was saved, as a raw score in `[0, 1]` — scale it for display. `null` means readiness could not be determined then (concepts unavailable, the owner's concept roster not active yet, or no concepts at all) and is distinct from `0`, which is a real "no mastery" reading.
51
+ * @type {number}
52
+ * @memberof StudyPlan
53
+ */
54
+ readinessBefore: number | null;
55
+ /**
56
+ * The learner's readiness the first time the plan became fully complete, as a raw score in `[0, 1]`. Stamped once and never re-stamped, so it stays a stable historical claim — un-completing an activity does not clear it. `null` means the plan has never been fully complete, or readiness could not be determined at that moment; as with `readinessBefore`, `null` is distinct from `0`.
57
+ * @type {number}
58
+ * @memberof StudyPlan
59
+ */
60
+ readinessAfter: number | null;
49
61
  /**
50
62
  *
51
63
  * @type {Date}
@@ -32,6 +32,10 @@ export function instanceOfStudyPlan(value) {
32
32
  return false;
33
33
  if (!('sourceToolCallId' in value) || value['sourceToolCallId'] === undefined)
34
34
  return false;
35
+ if (!('readinessBefore' in value) || value['readinessBefore'] === undefined)
36
+ return false;
37
+ if (!('readinessAfter' in value) || value['readinessAfter'] === undefined)
38
+ return false;
35
39
  if (!('createdAt' in value) || value['createdAt'] === undefined)
36
40
  return false;
37
41
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -53,6 +57,8 @@ export function StudyPlanFromJSONTyped(json, ignoreDiscriminator) {
53
57
  'ownerType': json['ownerType'],
54
58
  'ownerId': json['ownerId'],
55
59
  'sourceToolCallId': json['sourceToolCallId'],
60
+ 'readinessBefore': json['readinessBefore'],
61
+ 'readinessAfter': json['readinessAfter'],
56
62
  'createdAt': (new Date(json['createdAt'])),
57
63
  'updatedAt': (new Date(json['updatedAt'])),
58
64
  'activities': (json['activities'].map(StudyPlanActivityFromJSON)),
@@ -71,6 +77,8 @@ export function StudyPlanToJSONTyped(value, ignoreDiscriminator = false) {
71
77
  'ownerType': value['ownerType'],
72
78
  'ownerId': value['ownerId'],
73
79
  'sourceToolCallId': value['sourceToolCallId'],
80
+ 'readinessBefore': value['readinessBefore'],
81
+ 'readinessAfter': value['readinessAfter'],
74
82
  'createdAt': value['createdAt'].toISOString(),
75
83
  'updatedAt': value['updatedAt'].toISOString(),
76
84
  'activities': (value['activities'].map(StudyPlanActivityToJSON)),
@@ -46,6 +46,18 @@ export interface StudyPlan {
46
46
  * @memberof StudyPlan
47
47
  */
48
48
  sourceToolCallId: string | null;
49
+ /**
50
+ * The learner's readiness for the plan's owner at the moment the plan was saved, as a raw score in `[0, 1]` — scale it for display. `null` means readiness could not be determined then (concepts unavailable, the owner's concept roster not active yet, or no concepts at all) and is distinct from `0`, which is a real "no mastery" reading.
51
+ * @type {number}
52
+ * @memberof StudyPlan
53
+ */
54
+ readinessBefore: number | null;
55
+ /**
56
+ * The learner's readiness the first time the plan became fully complete, as a raw score in `[0, 1]`. Stamped once and never re-stamped, so it stays a stable historical claim — un-completing an activity does not clear it. `null` means the plan has never been fully complete, or readiness could not be determined at that moment; as with `readinessBefore`, `null` is distinct from `0`.
57
+ * @type {number}
58
+ * @memberof StudyPlan
59
+ */
60
+ readinessAfter: number | null;
49
61
  /**
50
62
  *
51
63
  * @type {Date}
@@ -40,6 +40,10 @@ function instanceOfStudyPlan(value) {
40
40
  return false;
41
41
  if (!('sourceToolCallId' in value) || value['sourceToolCallId'] === undefined)
42
42
  return false;
43
+ if (!('readinessBefore' in value) || value['readinessBefore'] === undefined)
44
+ return false;
45
+ if (!('readinessAfter' in value) || value['readinessAfter'] === undefined)
46
+ return false;
43
47
  if (!('createdAt' in value) || value['createdAt'] === undefined)
44
48
  return false;
45
49
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -61,6 +65,8 @@ function StudyPlanFromJSONTyped(json, ignoreDiscriminator) {
61
65
  'ownerType': json['ownerType'],
62
66
  'ownerId': json['ownerId'],
63
67
  'sourceToolCallId': json['sourceToolCallId'],
68
+ 'readinessBefore': json['readinessBefore'],
69
+ 'readinessAfter': json['readinessAfter'],
64
70
  'createdAt': (new Date(json['createdAt'])),
65
71
  'updatedAt': (new Date(json['updatedAt'])),
66
72
  'activities': (json['activities'].map(StudyPlanActivity_1.StudyPlanActivityFromJSON)),
@@ -79,6 +85,8 @@ function StudyPlanToJSONTyped(value, ignoreDiscriminator = false) {
79
85
  'ownerType': value['ownerType'],
80
86
  'ownerId': value['ownerId'],
81
87
  'sourceToolCallId': value['sourceToolCallId'],
88
+ 'readinessBefore': value['readinessBefore'],
89
+ 'readinessAfter': value['readinessAfter'],
82
90
  'createdAt': value['createdAt'].toISOString(),
83
91
  'updatedAt': value['updatedAt'].toISOString(),
84
92
  'activities': (value['activities'].map(StudyPlanActivity_1.StudyPlanActivityToJSON)),
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.32.0",
4
+ "version": "3.33.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {