@instructure/athena-api-client 3.39.2 → 3.40.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 (58) hide show
  1. package/README.md +12 -0
  2. package/dist/apis/AdminApi.d.ts +17 -1
  3. package/dist/apis/AdminApi.js +47 -0
  4. package/dist/apis/QuizzesApi.d.ts +30 -1
  5. package/dist/apis/QuizzesApi.js +87 -0
  6. package/dist/apis/ResourcesApi.d.ts +11 -2
  7. package/dist/apis/ResourcesApi.js +13 -3
  8. package/dist/apis/SharedQuizzesApi.d.ts +46 -0
  9. package/dist/apis/SharedQuizzesApi.js +115 -0
  10. package/dist/apis/index.d.ts +1 -0
  11. package/dist/apis/index.js +1 -0
  12. package/dist/esm/apis/AdminApi.d.ts +17 -1
  13. package/dist/esm/apis/AdminApi.js +48 -1
  14. package/dist/esm/apis/QuizzesApi.d.ts +30 -1
  15. package/dist/esm/apis/QuizzesApi.js +88 -1
  16. package/dist/esm/apis/ResourcesApi.d.ts +11 -2
  17. package/dist/esm/apis/ResourcesApi.js +12 -2
  18. package/dist/esm/apis/SharedQuizzesApi.d.ts +46 -0
  19. package/dist/esm/apis/SharedQuizzesApi.js +111 -0
  20. package/dist/esm/apis/index.d.ts +1 -0
  21. package/dist/esm/apis/index.js +1 -0
  22. package/dist/esm/models/AdminPaginatedQuizParticipantSessions.d.ts +39 -0
  23. package/dist/esm/models/AdminPaginatedQuizParticipantSessions.js +48 -0
  24. package/dist/esm/models/AdminQuizParticipantSessionListItem.d.ts +84 -0
  25. package/dist/esm/models/AdminQuizParticipantSessionListItem.js +80 -0
  26. package/dist/esm/models/AdminQuizParticipantSessionScore.d.ts +44 -0
  27. package/dist/esm/models/AdminQuizParticipantSessionScore.js +51 -0
  28. package/dist/esm/models/QuizSharing.d.ts +50 -0
  29. package/dist/esm/models/QuizSharing.js +55 -0
  30. package/dist/esm/models/ResourceListItem.d.ts +16 -3
  31. package/dist/esm/models/ResourceListItem.js +9 -0
  32. package/dist/esm/models/ResourceSharing.d.ts +44 -0
  33. package/dist/esm/models/ResourceSharing.js +51 -0
  34. package/dist/esm/models/SharedQuiz.d.ts +97 -0
  35. package/dist/esm/models/SharedQuiz.js +90 -0
  36. package/dist/esm/models/UpdateQuizSharingRequest.d.ts +32 -0
  37. package/dist/esm/models/UpdateQuizSharingRequest.js +43 -0
  38. package/dist/esm/models/index.d.ts +7 -0
  39. package/dist/esm/models/index.js +7 -0
  40. package/dist/models/AdminPaginatedQuizParticipantSessions.d.ts +39 -0
  41. package/dist/models/AdminPaginatedQuizParticipantSessions.js +55 -0
  42. package/dist/models/AdminQuizParticipantSessionListItem.d.ts +84 -0
  43. package/dist/models/AdminQuizParticipantSessionListItem.js +88 -0
  44. package/dist/models/AdminQuizParticipantSessionScore.d.ts +44 -0
  45. package/dist/models/AdminQuizParticipantSessionScore.js +58 -0
  46. package/dist/models/QuizSharing.d.ts +50 -0
  47. package/dist/models/QuizSharing.js +62 -0
  48. package/dist/models/ResourceListItem.d.ts +16 -3
  49. package/dist/models/ResourceListItem.js +9 -0
  50. package/dist/models/ResourceSharing.d.ts +44 -0
  51. package/dist/models/ResourceSharing.js +58 -0
  52. package/dist/models/SharedQuiz.d.ts +97 -0
  53. package/dist/models/SharedQuiz.js +98 -0
  54. package/dist/models/UpdateQuizSharingRequest.d.ts +32 -0
  55. package/dist/models/UpdateQuizSharingRequest.js +50 -0
  56. package/dist/models/index.d.ts +7 -0
  57. package/dist/models/index.js +7 -0
  58. package/package.json +1 -1
@@ -0,0 +1,90 @@
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 SharedQuizModeEnum = {
18
+ Quiz: 'quiz',
19
+ Flashcards: 'flashcards'
20
+ };
21
+ /**
22
+ * @export
23
+ */
24
+ export const SharedQuizGenerationStatusEnum = {
25
+ Generating: 'generating',
26
+ Ready: 'ready',
27
+ Failed: 'failed'
28
+ };
29
+ /**
30
+ * Check if a given object implements the SharedQuiz interface.
31
+ */
32
+ export function instanceOfSharedQuiz(value) {
33
+ if (!('id' in value) || value['id'] === undefined)
34
+ return false;
35
+ if (!('title' in value) || value['title'] === undefined)
36
+ return false;
37
+ if (!('topic' in value) || value['topic'] === undefined)
38
+ return false;
39
+ if (!('mode' in value) || value['mode'] === undefined)
40
+ return false;
41
+ if (!('generationStatus' in value) || value['generationStatus'] === undefined)
42
+ return false;
43
+ if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
44
+ return false;
45
+ if (!('questionCount' in value) || value['questionCount'] === undefined)
46
+ return false;
47
+ if (!('isOwner' in value) || value['isOwner'] === undefined)
48
+ return false;
49
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
50
+ return false;
51
+ return true;
52
+ }
53
+ export function SharedQuizFromJSON(json) {
54
+ return SharedQuizFromJSONTyped(json, false);
55
+ }
56
+ export function SharedQuizFromJSONTyped(json, ignoreDiscriminator) {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+ 'id': json['id'],
62
+ 'title': json['title'],
63
+ 'topic': json['topic'],
64
+ 'mode': json['mode'],
65
+ 'generationStatus': json['generationStatus'],
66
+ 'expectedQuestionCount': json['expectedQuestionCount'],
67
+ 'questionCount': json['questionCount'],
68
+ 'isOwner': json['isOwner'],
69
+ 'createdAt': (new Date(json['createdAt'])),
70
+ };
71
+ }
72
+ export function SharedQuizToJSON(json) {
73
+ return SharedQuizToJSONTyped(json, false);
74
+ }
75
+ export function SharedQuizToJSONTyped(value, ignoreDiscriminator = false) {
76
+ if (value == null) {
77
+ return value;
78
+ }
79
+ return {
80
+ 'id': value['id'],
81
+ 'title': value['title'],
82
+ 'topic': value['topic'],
83
+ 'mode': value['mode'],
84
+ 'generationStatus': value['generationStatus'],
85
+ 'expectedQuestionCount': value['expectedQuestionCount'],
86
+ 'questionCount': value['questionCount'],
87
+ 'isOwner': value['isOwner'],
88
+ 'createdAt': value['createdAt'].toISOString(),
89
+ };
90
+ }
@@ -0,0 +1,32 @@
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 UpdateQuizSharingRequest
16
+ */
17
+ export interface UpdateQuizSharingRequest {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof UpdateQuizSharingRequest
22
+ */
23
+ enabled: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the UpdateQuizSharingRequest interface.
27
+ */
28
+ export declare function instanceOfUpdateQuizSharingRequest(value: object): value is UpdateQuizSharingRequest;
29
+ export declare function UpdateQuizSharingRequestFromJSON(json: any): UpdateQuizSharingRequest;
30
+ export declare function UpdateQuizSharingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateQuizSharingRequest;
31
+ export declare function UpdateQuizSharingRequestToJSON(json: any): UpdateQuizSharingRequest;
32
+ export declare function UpdateQuizSharingRequestToJSONTyped(value?: UpdateQuizSharingRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,43 @@
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 UpdateQuizSharingRequest interface.
16
+ */
17
+ export function instanceOfUpdateQuizSharingRequest(value) {
18
+ if (!('enabled' in value) || value['enabled'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function UpdateQuizSharingRequestFromJSON(json) {
23
+ return UpdateQuizSharingRequestFromJSONTyped(json, false);
24
+ }
25
+ export function UpdateQuizSharingRequestFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'enabled': json['enabled'],
31
+ };
32
+ }
33
+ export function UpdateQuizSharingRequestToJSON(json) {
34
+ return UpdateQuizSharingRequestToJSONTyped(json, false);
35
+ }
36
+ export function UpdateQuizSharingRequestToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'enabled': value['enabled'],
42
+ };
43
+ }
@@ -23,12 +23,15 @@ export * from './AdminLastExchange';
23
23
  export * from './AdminPaginatedActiveStreaks';
24
24
  export * from './AdminPaginatedChats';
25
25
  export * from './AdminPaginatedLastExchanges';
26
+ export * from './AdminPaginatedQuizParticipantSessions';
26
27
  export * from './AdminPaginatedQuizSessions';
27
28
  export * from './AdminPaginatedStudyObjectiveUserCounts';
28
29
  export * from './AdminPaginatedStudyObjectives';
29
30
  export * from './AdminPaginatedTaxonomyEnrollments';
30
31
  export * from './AdminQuizGeneration';
31
32
  export * from './AdminQuizGenerationInput';
33
+ export * from './AdminQuizParticipantSessionListItem';
34
+ export * from './AdminQuizParticipantSessionScore';
32
35
  export * from './AdminQuizSessionListItem';
33
36
  export * from './AdminQuizSessionScore';
34
37
  export * from './AdminQuizSourceFile';
@@ -127,17 +130,20 @@ export * from './QuizSession';
127
130
  export * from './QuizSessionListItem';
128
131
  export * from './QuizSessionScore';
129
132
  export * from './QuizSessionSummary';
133
+ export * from './QuizSharing';
130
134
  export * from './QuizWithQuestions';
131
135
  export * from './RecordQuizQuestionViewRequest';
132
136
  export * from './ResourceActivity';
133
137
  export * from './ResourceChat';
134
138
  export * from './ResourceListItem';
135
139
  export * from './ResourceSession';
140
+ export * from './ResourceSharing';
136
141
  export * from './ResourceStudyObjective';
137
142
  export * from './ResourceStudySpace';
138
143
  export * from './Score';
139
144
  export * from './ScoreByTypeValue';
140
145
  export * from './ServiceToken';
146
+ export * from './SharedQuiz';
141
147
  export * from './StudyObjective';
142
148
  export * from './StudyObjectiveCanvasDocument';
143
149
  export * from './StudyObjectiveConceptAttachment';
@@ -174,6 +180,7 @@ export * from './UpdateChatRequest';
174
180
  export * from './UpdateFeatureDto';
175
181
  export * from './UpdatePlanDto';
176
182
  export * from './UpdateQuizSessionRequest';
183
+ export * from './UpdateQuizSharingRequest';
177
184
  export * from './UpdateStudyObjectiveDto';
178
185
  export * from './UpdateStudySpaceDto';
179
186
  export * from './UpdateTokenRequest';
@@ -25,12 +25,15 @@ export * from './AdminLastExchange';
25
25
  export * from './AdminPaginatedActiveStreaks';
26
26
  export * from './AdminPaginatedChats';
27
27
  export * from './AdminPaginatedLastExchanges';
28
+ export * from './AdminPaginatedQuizParticipantSessions';
28
29
  export * from './AdminPaginatedQuizSessions';
29
30
  export * from './AdminPaginatedStudyObjectiveUserCounts';
30
31
  export * from './AdminPaginatedStudyObjectives';
31
32
  export * from './AdminPaginatedTaxonomyEnrollments';
32
33
  export * from './AdminQuizGeneration';
33
34
  export * from './AdminQuizGenerationInput';
35
+ export * from './AdminQuizParticipantSessionListItem';
36
+ export * from './AdminQuizParticipantSessionScore';
34
37
  export * from './AdminQuizSessionListItem';
35
38
  export * from './AdminQuizSessionScore';
36
39
  export * from './AdminQuizSourceFile';
@@ -129,17 +132,20 @@ export * from './QuizSession';
129
132
  export * from './QuizSessionListItem';
130
133
  export * from './QuizSessionScore';
131
134
  export * from './QuizSessionSummary';
135
+ export * from './QuizSharing';
132
136
  export * from './QuizWithQuestions';
133
137
  export * from './RecordQuizQuestionViewRequest';
134
138
  export * from './ResourceActivity';
135
139
  export * from './ResourceChat';
136
140
  export * from './ResourceListItem';
137
141
  export * from './ResourceSession';
142
+ export * from './ResourceSharing';
138
143
  export * from './ResourceStudyObjective';
139
144
  export * from './ResourceStudySpace';
140
145
  export * from './Score';
141
146
  export * from './ScoreByTypeValue';
142
147
  export * from './ServiceToken';
148
+ export * from './SharedQuiz';
143
149
  export * from './StudyObjective';
144
150
  export * from './StudyObjectiveCanvasDocument';
145
151
  export * from './StudyObjectiveConceptAttachment';
@@ -176,6 +182,7 @@ export * from './UpdateChatRequest';
176
182
  export * from './UpdateFeatureDto';
177
183
  export * from './UpdatePlanDto';
178
184
  export * from './UpdateQuizSessionRequest';
185
+ export * from './UpdateQuizSharingRequest';
179
186
  export * from './UpdateStudyObjectiveDto';
180
187
  export * from './UpdateStudySpaceDto';
181
188
  export * from './UpdateTokenRequest';
@@ -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 { AdminQuizParticipantSessionListItem } from './AdminQuizParticipantSessionListItem';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminPaginatedQuizParticipantSessions
17
+ */
18
+ export interface AdminPaginatedQuizParticipantSessions {
19
+ /**
20
+ *
21
+ * @type {Array<AdminQuizParticipantSessionListItem>}
22
+ * @memberof AdminPaginatedQuizParticipantSessions
23
+ */
24
+ data: Array<AdminQuizParticipantSessionListItem>;
25
+ /**
26
+ * Opaque cursor for fetching the next page. Null when there are no more results.
27
+ * @type {string}
28
+ * @memberof AdminPaginatedQuizParticipantSessions
29
+ */
30
+ nextCursor: string | null;
31
+ }
32
+ /**
33
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
34
+ */
35
+ export declare function instanceOfAdminPaginatedQuizParticipantSessions(value: object): value is AdminPaginatedQuizParticipantSessions;
36
+ export declare function AdminPaginatedQuizParticipantSessionsFromJSON(json: any): AdminPaginatedQuizParticipantSessions;
37
+ export declare function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedQuizParticipantSessions;
38
+ export declare function AdminPaginatedQuizParticipantSessionsToJSON(json: any): AdminPaginatedQuizParticipantSessions;
39
+ export declare function AdminPaginatedQuizParticipantSessionsToJSONTyped(value?: AdminPaginatedQuizParticipantSessions | 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.instanceOfAdminPaginatedQuizParticipantSessions = instanceOfAdminPaginatedQuizParticipantSessions;
17
+ exports.AdminPaginatedQuizParticipantSessionsFromJSON = AdminPaginatedQuizParticipantSessionsFromJSON;
18
+ exports.AdminPaginatedQuizParticipantSessionsFromJSONTyped = AdminPaginatedQuizParticipantSessionsFromJSONTyped;
19
+ exports.AdminPaginatedQuizParticipantSessionsToJSON = AdminPaginatedQuizParticipantSessionsToJSON;
20
+ exports.AdminPaginatedQuizParticipantSessionsToJSONTyped = AdminPaginatedQuizParticipantSessionsToJSONTyped;
21
+ const AdminQuizParticipantSessionListItem_1 = require("./AdminQuizParticipantSessionListItem");
22
+ /**
23
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
24
+ */
25
+ function instanceOfAdminPaginatedQuizParticipantSessions(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 AdminPaginatedQuizParticipantSessionsFromJSON(json) {
33
+ return AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, false);
34
+ }
35
+ function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'data': (json['data'].map(AdminQuizParticipantSessionListItem_1.AdminQuizParticipantSessionListItemFromJSON)),
41
+ 'nextCursor': json['nextCursor'],
42
+ };
43
+ }
44
+ function AdminPaginatedQuizParticipantSessionsToJSON(json) {
45
+ return AdminPaginatedQuizParticipantSessionsToJSONTyped(json, false);
46
+ }
47
+ function AdminPaginatedQuizParticipantSessionsToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'data': (value['data'].map(AdminQuizParticipantSessionListItem_1.AdminQuizParticipantSessionListItemToJSON)),
53
+ 'nextCursor': value['nextCursor'],
54
+ };
55
+ }
@@ -0,0 +1,84 @@
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 { AdminQuizParticipantSessionScore } from './AdminQuizParticipantSessionScore';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminQuizParticipantSessionListItem
17
+ */
18
+ export interface AdminQuizParticipantSessionListItem {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AdminQuizParticipantSessionListItem
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof AdminQuizParticipantSessionListItem
29
+ */
30
+ quizId: string;
31
+ /**
32
+ * External identifier of the learner who owns the session.
33
+ * @type {string}
34
+ * @memberof AdminQuizParticipantSessionListItem
35
+ */
36
+ userId: string | null;
37
+ /**
38
+ * True for the quiz owner's own sessions, false for a learner who opened the quiz through its share link.
39
+ * @type {boolean}
40
+ * @memberof AdminQuizParticipantSessionListItem
41
+ */
42
+ isOwner: boolean;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof AdminQuizParticipantSessionListItem
47
+ */
48
+ status: AdminQuizParticipantSessionListItemStatusEnum;
49
+ /**
50
+ *
51
+ * @type {Date}
52
+ * @memberof AdminQuizParticipantSessionListItem
53
+ */
54
+ startedAt: Date;
55
+ /**
56
+ *
57
+ * @type {Date}
58
+ * @memberof AdminQuizParticipantSessionListItem
59
+ */
60
+ completedAt: Date | null;
61
+ /**
62
+ *
63
+ * @type {AdminQuizParticipantSessionScore}
64
+ * @memberof AdminQuizParticipantSessionListItem
65
+ */
66
+ score: AdminQuizParticipantSessionScore;
67
+ }
68
+ /**
69
+ * @export
70
+ */
71
+ export declare const AdminQuizParticipantSessionListItemStatusEnum: {
72
+ readonly Active: "active";
73
+ readonly Completed: "completed";
74
+ readonly Abandoned: "abandoned";
75
+ };
76
+ export type AdminQuizParticipantSessionListItemStatusEnum = typeof AdminQuizParticipantSessionListItemStatusEnum[keyof typeof AdminQuizParticipantSessionListItemStatusEnum];
77
+ /**
78
+ * Check if a given object implements the AdminQuizParticipantSessionListItem interface.
79
+ */
80
+ export declare function instanceOfAdminQuizParticipantSessionListItem(value: object): value is AdminQuizParticipantSessionListItem;
81
+ export declare function AdminQuizParticipantSessionListItemFromJSON(json: any): AdminQuizParticipantSessionListItem;
82
+ export declare function AdminQuizParticipantSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminQuizParticipantSessionListItem;
83
+ export declare function AdminQuizParticipantSessionListItemToJSON(json: any): AdminQuizParticipantSessionListItem;
84
+ export declare function AdminQuizParticipantSessionListItemToJSONTyped(value?: AdminQuizParticipantSessionListItem | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,88 @@
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.AdminQuizParticipantSessionListItemStatusEnum = void 0;
17
+ exports.instanceOfAdminQuizParticipantSessionListItem = instanceOfAdminQuizParticipantSessionListItem;
18
+ exports.AdminQuizParticipantSessionListItemFromJSON = AdminQuizParticipantSessionListItemFromJSON;
19
+ exports.AdminQuizParticipantSessionListItemFromJSONTyped = AdminQuizParticipantSessionListItemFromJSONTyped;
20
+ exports.AdminQuizParticipantSessionListItemToJSON = AdminQuizParticipantSessionListItemToJSON;
21
+ exports.AdminQuizParticipantSessionListItemToJSONTyped = AdminQuizParticipantSessionListItemToJSONTyped;
22
+ const AdminQuizParticipantSessionScore_1 = require("./AdminQuizParticipantSessionScore");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.AdminQuizParticipantSessionListItemStatusEnum = {
27
+ Active: 'active',
28
+ Completed: 'completed',
29
+ Abandoned: 'abandoned'
30
+ };
31
+ /**
32
+ * Check if a given object implements the AdminQuizParticipantSessionListItem interface.
33
+ */
34
+ function instanceOfAdminQuizParticipantSessionListItem(value) {
35
+ if (!('id' in value) || value['id'] === undefined)
36
+ return false;
37
+ if (!('quizId' in value) || value['quizId'] === undefined)
38
+ return false;
39
+ if (!('userId' in value) || value['userId'] === undefined)
40
+ return false;
41
+ if (!('isOwner' in value) || value['isOwner'] === undefined)
42
+ return false;
43
+ if (!('status' in value) || value['status'] === undefined)
44
+ return false;
45
+ if (!('startedAt' in value) || value['startedAt'] === undefined)
46
+ return false;
47
+ if (!('completedAt' in value) || value['completedAt'] === undefined)
48
+ return false;
49
+ if (!('score' in value) || value['score'] === undefined)
50
+ return false;
51
+ return true;
52
+ }
53
+ function AdminQuizParticipantSessionListItemFromJSON(json) {
54
+ return AdminQuizParticipantSessionListItemFromJSONTyped(json, false);
55
+ }
56
+ function AdminQuizParticipantSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+ 'id': json['id'],
62
+ 'quizId': json['quizId'],
63
+ 'userId': json['userId'],
64
+ 'isOwner': json['isOwner'],
65
+ 'status': json['status'],
66
+ 'startedAt': (new Date(json['startedAt'])),
67
+ 'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
68
+ 'score': (0, AdminQuizParticipantSessionScore_1.AdminQuizParticipantSessionScoreFromJSON)(json['score']),
69
+ };
70
+ }
71
+ function AdminQuizParticipantSessionListItemToJSON(json) {
72
+ return AdminQuizParticipantSessionListItemToJSONTyped(json, false);
73
+ }
74
+ function AdminQuizParticipantSessionListItemToJSONTyped(value, ignoreDiscriminator = false) {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+ return {
79
+ 'id': value['id'],
80
+ 'quizId': value['quizId'],
81
+ 'userId': value['userId'],
82
+ 'isOwner': value['isOwner'],
83
+ 'status': value['status'],
84
+ 'startedAt': value['startedAt'].toISOString(),
85
+ 'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
86
+ 'score': (0, AdminQuizParticipantSessionScore_1.AdminQuizParticipantSessionScoreToJSON)(value['score']),
87
+ };
88
+ }
@@ -0,0 +1,44 @@
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 AdminQuizParticipantSessionScore
16
+ */
17
+ export interface AdminQuizParticipantSessionScore {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof AdminQuizParticipantSessionScore
22
+ */
23
+ totalCorrect: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof AdminQuizParticipantSessionScore
28
+ */
29
+ totalQuestions: number;
30
+ /**
31
+ * Questions answered or rated in this session.
32
+ * @type {number}
33
+ * @memberof AdminQuizParticipantSessionScore
34
+ */
35
+ answeredCount: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the AdminQuizParticipantSessionScore interface.
39
+ */
40
+ export declare function instanceOfAdminQuizParticipantSessionScore(value: object): value is AdminQuizParticipantSessionScore;
41
+ export declare function AdminQuizParticipantSessionScoreFromJSON(json: any): AdminQuizParticipantSessionScore;
42
+ export declare function AdminQuizParticipantSessionScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminQuizParticipantSessionScore;
43
+ export declare function AdminQuizParticipantSessionScoreToJSON(json: any): AdminQuizParticipantSessionScore;
44
+ export declare function AdminQuizParticipantSessionScoreToJSONTyped(value?: AdminQuizParticipantSessionScore | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
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.instanceOfAdminQuizParticipantSessionScore = instanceOfAdminQuizParticipantSessionScore;
17
+ exports.AdminQuizParticipantSessionScoreFromJSON = AdminQuizParticipantSessionScoreFromJSON;
18
+ exports.AdminQuizParticipantSessionScoreFromJSONTyped = AdminQuizParticipantSessionScoreFromJSONTyped;
19
+ exports.AdminQuizParticipantSessionScoreToJSON = AdminQuizParticipantSessionScoreToJSON;
20
+ exports.AdminQuizParticipantSessionScoreToJSONTyped = AdminQuizParticipantSessionScoreToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AdminQuizParticipantSessionScore interface.
23
+ */
24
+ function instanceOfAdminQuizParticipantSessionScore(value) {
25
+ if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
26
+ return false;
27
+ if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
28
+ return false;
29
+ if (!('answeredCount' in value) || value['answeredCount'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function AdminQuizParticipantSessionScoreFromJSON(json) {
34
+ return AdminQuizParticipantSessionScoreFromJSONTyped(json, false);
35
+ }
36
+ function AdminQuizParticipantSessionScoreFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'totalCorrect': json['totalCorrect'],
42
+ 'totalQuestions': json['totalQuestions'],
43
+ 'answeredCount': json['answeredCount'],
44
+ };
45
+ }
46
+ function AdminQuizParticipantSessionScoreToJSON(json) {
47
+ return AdminQuizParticipantSessionScoreToJSONTyped(json, false);
48
+ }
49
+ function AdminQuizParticipantSessionScoreToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'totalCorrect': value['totalCorrect'],
55
+ 'totalQuestions': value['totalQuestions'],
56
+ 'answeredCount': value['answeredCount'],
57
+ };
58
+ }
@@ -0,0 +1,50 @@
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 QuizSharing
16
+ */
17
+ export interface QuizSharing {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof QuizSharing
22
+ */
23
+ quizId: string;
24
+ /**
25
+ * Whether other learners can currently open this quiz by link.
26
+ * @type {boolean}
27
+ * @memberof QuizSharing
28
+ */
29
+ isShared: boolean;
30
+ /**
31
+ * The link token other learners redeem through the shared-quizzes endpoints. Null while sharing is off. Re-enabling after a disable issues a new token; the old one stays dead.
32
+ * @type {string}
33
+ * @memberof QuizSharing
34
+ */
35
+ shareToken: string | null;
36
+ /**
37
+ * When the current link was issued. Null while sharing is off.
38
+ * @type {Date}
39
+ * @memberof QuizSharing
40
+ */
41
+ sharedAt: Date | null;
42
+ }
43
+ /**
44
+ * Check if a given object implements the QuizSharing interface.
45
+ */
46
+ export declare function instanceOfQuizSharing(value: object): value is QuizSharing;
47
+ export declare function QuizSharingFromJSON(json: any): QuizSharing;
48
+ export declare function QuizSharingFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSharing;
49
+ export declare function QuizSharingToJSON(json: any): QuizSharing;
50
+ export declare function QuizSharingToJSONTyped(value?: QuizSharing | null, ignoreDiscriminator?: boolean): any;