@instructure/athena-api-client 3.12.5 → 3.12.7
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.
- package/README.md +6 -0
- package/dist/apis/AdminApi.d.ts +51 -1
- package/dist/apis/AdminApi.js +109 -1
- package/dist/esm/apis/AdminApi.d.ts +51 -1
- package/dist/esm/apis/AdminApi.js +109 -1
- package/dist/esm/models/AdminPaginatedStudyObjectives.d.ts +39 -0
- package/dist/esm/models/AdminPaginatedStudyObjectives.js +48 -0
- package/dist/esm/models/AdminStudyObjectiveCanvasTypeCount.d.ts +38 -0
- package/dist/esm/models/AdminStudyObjectiveCanvasTypeCount.js +47 -0
- package/dist/esm/models/AdminStudyObjectiveListItem.d.ts +169 -0
- package/dist/esm/models/AdminStudyObjectiveListItem.js +138 -0
- package/dist/esm/models/AdminStudyObjectiveSummary.d.ts +93 -0
- package/dist/esm/models/AdminStudyObjectiveSummary.js +84 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/AdminPaginatedStudyObjectives.d.ts +39 -0
- package/dist/models/AdminPaginatedStudyObjectives.js +55 -0
- package/dist/models/AdminStudyObjectiveCanvasTypeCount.d.ts +38 -0
- package/dist/models/AdminStudyObjectiveCanvasTypeCount.js +54 -0
- package/dist/models/AdminStudyObjectiveListItem.d.ts +169 -0
- package/dist/models/AdminStudyObjectiveListItem.js +146 -0
- package/dist/models/AdminStudyObjectiveSummary.d.ts +93 -0
- package/dist/models/AdminStudyObjectiveSummary.js +91 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the AdminStudyObjectiveCanvasTypeCount interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfAdminStudyObjectiveCanvasTypeCount(value) {
|
|
18
|
+
if (!('objectType' in value) || value['objectType'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('count' in value) || value['count'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
export function AdminStudyObjectiveCanvasTypeCountFromJSON(json) {
|
|
25
|
+
return AdminStudyObjectiveCanvasTypeCountFromJSONTyped(json, false);
|
|
26
|
+
}
|
|
27
|
+
export function AdminStudyObjectiveCanvasTypeCountFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
|
+
if (json == null) {
|
|
29
|
+
return json;
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
'objectType': json['objectType'],
|
|
33
|
+
'count': json['count'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function AdminStudyObjectiveCanvasTypeCountToJSON(json) {
|
|
37
|
+
return AdminStudyObjectiveCanvasTypeCountToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function AdminStudyObjectiveCanvasTypeCountToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'objectType': value['objectType'],
|
|
45
|
+
'count': value['count'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AdminStudyObjectiveListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminStudyObjectiveListItem {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AdminStudyObjectiveListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AdminStudyObjectiveListItem
|
|
28
|
+
*/
|
|
29
|
+
accountUserId: string;
|
|
30
|
+
/**
|
|
31
|
+
* External identifier of the user who owns the objective
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof AdminStudyObjectiveListItem
|
|
34
|
+
*/
|
|
35
|
+
userId: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Derived origin: 'canvas' if linked to a Canvas object, else 'syllabus' or 'custom' based on source
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof AdminStudyObjectiveListItem
|
|
40
|
+
*/
|
|
41
|
+
origin: AdminStudyObjectiveListItemOriginEnum;
|
|
42
|
+
/**
|
|
43
|
+
* Stored source of the objective
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof AdminStudyObjectiveListItem
|
|
46
|
+
*/
|
|
47
|
+
source: AdminStudyObjectiveListItemSourceEnum;
|
|
48
|
+
/**
|
|
49
|
+
* External course identifier
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof AdminStudyObjectiveListItem
|
|
52
|
+
*/
|
|
53
|
+
courseId: string;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof AdminStudyObjectiveListItem
|
|
58
|
+
*/
|
|
59
|
+
studySpaceId: string | null;
|
|
60
|
+
/**
|
|
61
|
+
* Objective title
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof AdminStudyObjectiveListItem
|
|
64
|
+
*/
|
|
65
|
+
title: string;
|
|
66
|
+
/**
|
|
67
|
+
* User-authored notes on the objective
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof AdminStudyObjectiveListItem
|
|
70
|
+
*/
|
|
71
|
+
notes: string | null;
|
|
72
|
+
/**
|
|
73
|
+
* Type of the linked Canvas object, when Canvas-sourced
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof AdminStudyObjectiveListItem
|
|
76
|
+
*/
|
|
77
|
+
canvasObjectType: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* Title of the linked Canvas object, when Canvas-sourced
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof AdminStudyObjectiveListItem
|
|
82
|
+
*/
|
|
83
|
+
canvasObjectTitle: string | null;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {Date}
|
|
87
|
+
* @memberof AdminStudyObjectiveListItem
|
|
88
|
+
*/
|
|
89
|
+
dueAt: Date | null;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {Date}
|
|
93
|
+
* @memberof AdminStudyObjectiveListItem
|
|
94
|
+
*/
|
|
95
|
+
archivedAt: Date | null;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {Date}
|
|
99
|
+
* @memberof AdminStudyObjectiveListItem
|
|
100
|
+
*/
|
|
101
|
+
createdAt: Date;
|
|
102
|
+
/**
|
|
103
|
+
* Names of files associated with the objective — both uploaded attachments and Canvas-pulled documents (e.g. study-guide.pdf)
|
|
104
|
+
* @type {Array<string>}
|
|
105
|
+
* @memberof AdminStudyObjectiveListItem
|
|
106
|
+
*/
|
|
107
|
+
fileNames: Array<string>;
|
|
108
|
+
/**
|
|
109
|
+
* Linked chat resources
|
|
110
|
+
* @type {number}
|
|
111
|
+
* @memberof AdminStudyObjectiveListItem
|
|
112
|
+
*/
|
|
113
|
+
chatResourceCount: number;
|
|
114
|
+
/**
|
|
115
|
+
* Linked quiz resources
|
|
116
|
+
* @type {number}
|
|
117
|
+
* @memberof AdminStudyObjectiveListItem
|
|
118
|
+
*/
|
|
119
|
+
quizResourceCount: number;
|
|
120
|
+
/**
|
|
121
|
+
* Linked flashcard resources
|
|
122
|
+
* @type {number}
|
|
123
|
+
* @memberof AdminStudyObjectiveListItem
|
|
124
|
+
*/
|
|
125
|
+
flashcardResourceCount: number;
|
|
126
|
+
/**
|
|
127
|
+
* Concepts tagged on this objective
|
|
128
|
+
* @type {number}
|
|
129
|
+
* @memberof AdminStudyObjectiveListItem
|
|
130
|
+
*/
|
|
131
|
+
conceptCount: number;
|
|
132
|
+
/**
|
|
133
|
+
* Quiz sessions started on quizzes linked to this objective
|
|
134
|
+
* @type {number}
|
|
135
|
+
* @memberof AdminStudyObjectiveListItem
|
|
136
|
+
*/
|
|
137
|
+
quizSessionCount: number;
|
|
138
|
+
/**
|
|
139
|
+
* Quiz responses recorded on quizzes linked to this objective
|
|
140
|
+
* @type {number}
|
|
141
|
+
* @memberof AdminStudyObjectiveListItem
|
|
142
|
+
*/
|
|
143
|
+
quizResponseCount: number;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* @export
|
|
147
|
+
*/
|
|
148
|
+
export declare const AdminStudyObjectiveListItemOriginEnum: {
|
|
149
|
+
readonly Custom: "custom";
|
|
150
|
+
readonly Canvas: "canvas";
|
|
151
|
+
readonly Syllabus: "syllabus";
|
|
152
|
+
};
|
|
153
|
+
export type AdminStudyObjectiveListItemOriginEnum = typeof AdminStudyObjectiveListItemOriginEnum[keyof typeof AdminStudyObjectiveListItemOriginEnum];
|
|
154
|
+
/**
|
|
155
|
+
* @export
|
|
156
|
+
*/
|
|
157
|
+
export declare const AdminStudyObjectiveListItemSourceEnum: {
|
|
158
|
+
readonly User: "user";
|
|
159
|
+
readonly Syllabus: "syllabus";
|
|
160
|
+
};
|
|
161
|
+
export type AdminStudyObjectiveListItemSourceEnum = typeof AdminStudyObjectiveListItemSourceEnum[keyof typeof AdminStudyObjectiveListItemSourceEnum];
|
|
162
|
+
/**
|
|
163
|
+
* Check if a given object implements the AdminStudyObjectiveListItem interface.
|
|
164
|
+
*/
|
|
165
|
+
export declare function instanceOfAdminStudyObjectiveListItem(value: object): value is AdminStudyObjectiveListItem;
|
|
166
|
+
export declare function AdminStudyObjectiveListItemFromJSON(json: any): AdminStudyObjectiveListItem;
|
|
167
|
+
export declare function AdminStudyObjectiveListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveListItem;
|
|
168
|
+
export declare function AdminStudyObjectiveListItemToJSON(json: any): AdminStudyObjectiveListItem;
|
|
169
|
+
export declare function AdminStudyObjectiveListItemToJSONTyped(value?: AdminStudyObjectiveListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const AdminStudyObjectiveListItemOriginEnum = {
|
|
18
|
+
Custom: 'custom',
|
|
19
|
+
Canvas: 'canvas',
|
|
20
|
+
Syllabus: 'syllabus'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export const AdminStudyObjectiveListItemSourceEnum = {
|
|
26
|
+
User: 'user',
|
|
27
|
+
Syllabus: 'syllabus'
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Check if a given object implements the AdminStudyObjectiveListItem interface.
|
|
31
|
+
*/
|
|
32
|
+
export function instanceOfAdminStudyObjectiveListItem(value) {
|
|
33
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('accountUserId' in value) || value['accountUserId'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('origin' in value) || value['origin'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('notes' in value) || value['notes'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('canvasObjectType' in value) || value['canvasObjectType'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('canvasObjectTitle' in value) || value['canvasObjectTitle'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('dueAt' in value) || value['dueAt'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('archivedAt' in value) || value['archivedAt'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
60
|
+
return false;
|
|
61
|
+
if (!('fileNames' in value) || value['fileNames'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('chatResourceCount' in value) || value['chatResourceCount'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('quizResourceCount' in value) || value['quizResourceCount'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
if (!('flashcardResourceCount' in value) || value['flashcardResourceCount'] === undefined)
|
|
68
|
+
return false;
|
|
69
|
+
if (!('conceptCount' in value) || value['conceptCount'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('quizSessionCount' in value) || value['quizSessionCount'] === undefined)
|
|
72
|
+
return false;
|
|
73
|
+
if (!('quizResponseCount' in value) || value['quizResponseCount'] === undefined)
|
|
74
|
+
return false;
|
|
75
|
+
return true;
|
|
76
|
+
}
|
|
77
|
+
export function AdminStudyObjectiveListItemFromJSON(json) {
|
|
78
|
+
return AdminStudyObjectiveListItemFromJSONTyped(json, false);
|
|
79
|
+
}
|
|
80
|
+
export function AdminStudyObjectiveListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
81
|
+
if (json == null) {
|
|
82
|
+
return json;
|
|
83
|
+
}
|
|
84
|
+
return {
|
|
85
|
+
'id': json['id'],
|
|
86
|
+
'accountUserId': json['accountUserId'],
|
|
87
|
+
'userId': json['userId'],
|
|
88
|
+
'origin': json['origin'],
|
|
89
|
+
'source': json['source'],
|
|
90
|
+
'courseId': json['courseId'],
|
|
91
|
+
'studySpaceId': json['studySpaceId'],
|
|
92
|
+
'title': json['title'],
|
|
93
|
+
'notes': json['notes'],
|
|
94
|
+
'canvasObjectType': json['canvasObjectType'],
|
|
95
|
+
'canvasObjectTitle': json['canvasObjectTitle'],
|
|
96
|
+
'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
|
|
97
|
+
'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
|
|
98
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
99
|
+
'fileNames': json['fileNames'],
|
|
100
|
+
'chatResourceCount': json['chatResourceCount'],
|
|
101
|
+
'quizResourceCount': json['quizResourceCount'],
|
|
102
|
+
'flashcardResourceCount': json['flashcardResourceCount'],
|
|
103
|
+
'conceptCount': json['conceptCount'],
|
|
104
|
+
'quizSessionCount': json['quizSessionCount'],
|
|
105
|
+
'quizResponseCount': json['quizResponseCount'],
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
export function AdminStudyObjectiveListItemToJSON(json) {
|
|
109
|
+
return AdminStudyObjectiveListItemToJSONTyped(json, false);
|
|
110
|
+
}
|
|
111
|
+
export function AdminStudyObjectiveListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
112
|
+
if (value == null) {
|
|
113
|
+
return value;
|
|
114
|
+
}
|
|
115
|
+
return {
|
|
116
|
+
'id': value['id'],
|
|
117
|
+
'accountUserId': value['accountUserId'],
|
|
118
|
+
'userId': value['userId'],
|
|
119
|
+
'origin': value['origin'],
|
|
120
|
+
'source': value['source'],
|
|
121
|
+
'courseId': value['courseId'],
|
|
122
|
+
'studySpaceId': value['studySpaceId'],
|
|
123
|
+
'title': value['title'],
|
|
124
|
+
'notes': value['notes'],
|
|
125
|
+
'canvasObjectType': value['canvasObjectType'],
|
|
126
|
+
'canvasObjectTitle': value['canvasObjectTitle'],
|
|
127
|
+
'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
|
|
128
|
+
'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
|
|
129
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
130
|
+
'fileNames': value['fileNames'],
|
|
131
|
+
'chatResourceCount': value['chatResourceCount'],
|
|
132
|
+
'quizResourceCount': value['quizResourceCount'],
|
|
133
|
+
'flashcardResourceCount': value['flashcardResourceCount'],
|
|
134
|
+
'conceptCount': value['conceptCount'],
|
|
135
|
+
'quizSessionCount': value['quizSessionCount'],
|
|
136
|
+
'quizResponseCount': value['quizResponseCount'],
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { AdminStudyObjectiveCanvasTypeCount } from './AdminStudyObjectiveCanvasTypeCount';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AdminStudyObjectiveSummary
|
|
17
|
+
*/
|
|
18
|
+
export interface AdminStudyObjectiveSummary {
|
|
19
|
+
/**
|
|
20
|
+
* All study objectives
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof AdminStudyObjectiveSummary
|
|
23
|
+
*/
|
|
24
|
+
totalObjectives: number;
|
|
25
|
+
/**
|
|
26
|
+
* Objectives that are not archived
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof AdminStudyObjectiveSummary
|
|
29
|
+
*/
|
|
30
|
+
activeObjectives: number;
|
|
31
|
+
/**
|
|
32
|
+
* Objectives that are archived
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof AdminStudyObjectiveSummary
|
|
35
|
+
*/
|
|
36
|
+
archivedObjectives: number;
|
|
37
|
+
/**
|
|
38
|
+
* User-created objectives with no Canvas link (the workaround signal)
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof AdminStudyObjectiveSummary
|
|
41
|
+
*/
|
|
42
|
+
customObjectives: number;
|
|
43
|
+
/**
|
|
44
|
+
* Objectives linked to a mirrored Canvas object
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof AdminStudyObjectiveSummary
|
|
47
|
+
*/
|
|
48
|
+
canvasObjectives: number;
|
|
49
|
+
/**
|
|
50
|
+
* Objectives derived from syllabus analysis
|
|
51
|
+
* @type {number}
|
|
52
|
+
* @memberof AdminStudyObjectiveSummary
|
|
53
|
+
*/
|
|
54
|
+
syllabusObjectives: number;
|
|
55
|
+
/**
|
|
56
|
+
* Distinct users who own at least one objective
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof AdminStudyObjectiveSummary
|
|
59
|
+
*/
|
|
60
|
+
distinctUsers: number;
|
|
61
|
+
/**
|
|
62
|
+
* Distinct users who created at least one custom objective
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof AdminStudyObjectiveSummary
|
|
65
|
+
*/
|
|
66
|
+
usersWithCustomObjective: number;
|
|
67
|
+
/**
|
|
68
|
+
* Custom objectives that have at least one linked resource
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof AdminStudyObjectiveSummary
|
|
71
|
+
*/
|
|
72
|
+
customObjectivesWithResources: number;
|
|
73
|
+
/**
|
|
74
|
+
* Custom objectives that have at least one quiz or flashcard resource
|
|
75
|
+
* @type {number}
|
|
76
|
+
* @memberof AdminStudyObjectiveSummary
|
|
77
|
+
*/
|
|
78
|
+
customObjectivesWithQuiz: number;
|
|
79
|
+
/**
|
|
80
|
+
* Breakdown of Canvas-sourced objectives by the type of Canvas object they derive from
|
|
81
|
+
* @type {Array<AdminStudyObjectiveCanvasTypeCount>}
|
|
82
|
+
* @memberof AdminStudyObjectiveSummary
|
|
83
|
+
*/
|
|
84
|
+
canvasObjectivesByType: Array<AdminStudyObjectiveCanvasTypeCount>;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Check if a given object implements the AdminStudyObjectiveSummary interface.
|
|
88
|
+
*/
|
|
89
|
+
export declare function instanceOfAdminStudyObjectiveSummary(value: object): value is AdminStudyObjectiveSummary;
|
|
90
|
+
export declare function AdminStudyObjectiveSummaryFromJSON(json: any): AdminStudyObjectiveSummary;
|
|
91
|
+
export declare function AdminStudyObjectiveSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStudyObjectiveSummary;
|
|
92
|
+
export declare function AdminStudyObjectiveSummaryToJSON(json: any): AdminStudyObjectiveSummary;
|
|
93
|
+
export declare function AdminStudyObjectiveSummaryToJSONTyped(value?: AdminStudyObjectiveSummary | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { AdminStudyObjectiveCanvasTypeCountFromJSON, AdminStudyObjectiveCanvasTypeCountToJSON, } from './AdminStudyObjectiveCanvasTypeCount';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the AdminStudyObjectiveSummary interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfAdminStudyObjectiveSummary(value) {
|
|
19
|
+
if (!('totalObjectives' in value) || value['totalObjectives'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('activeObjectives' in value) || value['activeObjectives'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('archivedObjectives' in value) || value['archivedObjectives'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('customObjectives' in value) || value['customObjectives'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('canvasObjectives' in value) || value['canvasObjectives'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('syllabusObjectives' in value) || value['syllabusObjectives'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('distinctUsers' in value) || value['distinctUsers'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('usersWithCustomObjective' in value) || value['usersWithCustomObjective'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('customObjectivesWithResources' in value) || value['customObjectivesWithResources'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('customObjectivesWithQuiz' in value) || value['customObjectivesWithQuiz'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('canvasObjectivesByType' in value) || value['canvasObjectivesByType'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
export function AdminStudyObjectiveSummaryFromJSON(json) {
|
|
44
|
+
return AdminStudyObjectiveSummaryFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
export function AdminStudyObjectiveSummaryFromJSONTyped(json, ignoreDiscriminator) {
|
|
47
|
+
if (json == null) {
|
|
48
|
+
return json;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'totalObjectives': json['totalObjectives'],
|
|
52
|
+
'activeObjectives': json['activeObjectives'],
|
|
53
|
+
'archivedObjectives': json['archivedObjectives'],
|
|
54
|
+
'customObjectives': json['customObjectives'],
|
|
55
|
+
'canvasObjectives': json['canvasObjectives'],
|
|
56
|
+
'syllabusObjectives': json['syllabusObjectives'],
|
|
57
|
+
'distinctUsers': json['distinctUsers'],
|
|
58
|
+
'usersWithCustomObjective': json['usersWithCustomObjective'],
|
|
59
|
+
'customObjectivesWithResources': json['customObjectivesWithResources'],
|
|
60
|
+
'customObjectivesWithQuiz': json['customObjectivesWithQuiz'],
|
|
61
|
+
'canvasObjectivesByType': (json['canvasObjectivesByType'].map(AdminStudyObjectiveCanvasTypeCountFromJSON)),
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
export function AdminStudyObjectiveSummaryToJSON(json) {
|
|
65
|
+
return AdminStudyObjectiveSummaryToJSONTyped(json, false);
|
|
66
|
+
}
|
|
67
|
+
export function AdminStudyObjectiveSummaryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
68
|
+
if (value == null) {
|
|
69
|
+
return value;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
'totalObjectives': value['totalObjectives'],
|
|
73
|
+
'activeObjectives': value['activeObjectives'],
|
|
74
|
+
'archivedObjectives': value['archivedObjectives'],
|
|
75
|
+
'customObjectives': value['customObjectives'],
|
|
76
|
+
'canvasObjectives': value['canvasObjectives'],
|
|
77
|
+
'syllabusObjectives': value['syllabusObjectives'],
|
|
78
|
+
'distinctUsers': value['distinctUsers'],
|
|
79
|
+
'usersWithCustomObjective': value['usersWithCustomObjective'],
|
|
80
|
+
'customObjectivesWithResources': value['customObjectivesWithResources'],
|
|
81
|
+
'customObjectivesWithQuiz': value['customObjectivesWithQuiz'],
|
|
82
|
+
'canvasObjectivesByType': (value['canvasObjectivesByType'].map(AdminStudyObjectiveCanvasTypeCountToJSON)),
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -7,10 +7,14 @@ export * from './AdminCohortStats';
|
|
|
7
7
|
export * from './AdminPaginatedActiveStreaks';
|
|
8
8
|
export * from './AdminPaginatedChats';
|
|
9
9
|
export * from './AdminPaginatedQuizSessions';
|
|
10
|
+
export * from './AdminPaginatedStudyObjectives';
|
|
10
11
|
export * from './AdminPaginatedTaxonomyEnrollments';
|
|
11
12
|
export * from './AdminQuizSessionListItem';
|
|
12
13
|
export * from './AdminQuizSessionScore';
|
|
13
14
|
export * from './AdminStreak';
|
|
15
|
+
export * from './AdminStudyObjectiveCanvasTypeCount';
|
|
16
|
+
export * from './AdminStudyObjectiveListItem';
|
|
17
|
+
export * from './AdminStudyObjectiveSummary';
|
|
14
18
|
export * from './AdminTaxonomyEnrollment';
|
|
15
19
|
export * from './AdminTaxonomyEnrollmentTaxonomy';
|
|
16
20
|
export * from './AdminTriggerAnalysisResponse';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -9,10 +9,14 @@ export * from './AdminCohortStats';
|
|
|
9
9
|
export * from './AdminPaginatedActiveStreaks';
|
|
10
10
|
export * from './AdminPaginatedChats';
|
|
11
11
|
export * from './AdminPaginatedQuizSessions';
|
|
12
|
+
export * from './AdminPaginatedStudyObjectives';
|
|
12
13
|
export * from './AdminPaginatedTaxonomyEnrollments';
|
|
13
14
|
export * from './AdminQuizSessionListItem';
|
|
14
15
|
export * from './AdminQuizSessionScore';
|
|
15
16
|
export * from './AdminStreak';
|
|
17
|
+
export * from './AdminStudyObjectiveCanvasTypeCount';
|
|
18
|
+
export * from './AdminStudyObjectiveListItem';
|
|
19
|
+
export * from './AdminStudyObjectiveSummary';
|
|
16
20
|
export * from './AdminTaxonomyEnrollment';
|
|
17
21
|
export * from './AdminTaxonomyEnrollmentTaxonomy';
|
|
18
22
|
export * from './AdminTriggerAnalysisResponse';
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { AdminStudyObjectiveListItem } from './AdminStudyObjectiveListItem';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AdminPaginatedStudyObjectives
|
|
17
|
+
*/
|
|
18
|
+
export interface AdminPaginatedStudyObjectives {
|
|
19
|
+
/**
|
|
20
|
+
* Array of study objective objects
|
|
21
|
+
* @type {Array<AdminStudyObjectiveListItem>}
|
|
22
|
+
* @memberof AdminPaginatedStudyObjectives
|
|
23
|
+
*/
|
|
24
|
+
data: Array<AdminStudyObjectiveListItem>;
|
|
25
|
+
/**
|
|
26
|
+
* Opaque cursor for fetching the next page. Null when there are no more results.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof AdminPaginatedStudyObjectives
|
|
29
|
+
*/
|
|
30
|
+
nextCursor: string | null;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the AdminPaginatedStudyObjectives interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfAdminPaginatedStudyObjectives(value: object): value is AdminPaginatedStudyObjectives;
|
|
36
|
+
export declare function AdminPaginatedStudyObjectivesFromJSON(json: any): AdminPaginatedStudyObjectives;
|
|
37
|
+
export declare function AdminPaginatedStudyObjectivesFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedStudyObjectives;
|
|
38
|
+
export declare function AdminPaginatedStudyObjectivesToJSON(json: any): AdminPaginatedStudyObjectives;
|
|
39
|
+
export declare function AdminPaginatedStudyObjectivesToJSONTyped(value?: AdminPaginatedStudyObjectives | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfAdminPaginatedStudyObjectives = instanceOfAdminPaginatedStudyObjectives;
|
|
17
|
+
exports.AdminPaginatedStudyObjectivesFromJSON = AdminPaginatedStudyObjectivesFromJSON;
|
|
18
|
+
exports.AdminPaginatedStudyObjectivesFromJSONTyped = AdminPaginatedStudyObjectivesFromJSONTyped;
|
|
19
|
+
exports.AdminPaginatedStudyObjectivesToJSON = AdminPaginatedStudyObjectivesToJSON;
|
|
20
|
+
exports.AdminPaginatedStudyObjectivesToJSONTyped = AdminPaginatedStudyObjectivesToJSONTyped;
|
|
21
|
+
const AdminStudyObjectiveListItem_1 = require("./AdminStudyObjectiveListItem");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the AdminPaginatedStudyObjectives interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfAdminPaginatedStudyObjectives(value) {
|
|
26
|
+
if (!('data' in value) || value['data'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('nextCursor' in value) || value['nextCursor'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function AdminPaginatedStudyObjectivesFromJSON(json) {
|
|
33
|
+
return AdminPaginatedStudyObjectivesFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
function AdminPaginatedStudyObjectivesFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'data': (json['data'].map(AdminStudyObjectiveListItem_1.AdminStudyObjectiveListItemFromJSON)),
|
|
41
|
+
'nextCursor': json['nextCursor'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function AdminPaginatedStudyObjectivesToJSON(json) {
|
|
45
|
+
return AdminPaginatedStudyObjectivesToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function AdminPaginatedStudyObjectivesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'data': (value['data'].map(AdminStudyObjectiveListItem_1.AdminStudyObjectiveListItemToJSON)),
|
|
53
|
+
'nextCursor': value['nextCursor'],
|
|
54
|
+
};
|
|
55
|
+
}
|