@easyedu/js-lsm-api 1.77.0 → 1.79.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 (86) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +18 -2
  3. package/dist/apis/CourseApi.d.ts +18 -0
  4. package/dist/apis/CourseApi.js +49 -0
  5. package/dist/apis/PortalApi.d.ts +67 -0
  6. package/dist/apis/PortalApi.js +177 -0
  7. package/dist/esm/apis/CourseApi.d.ts +18 -0
  8. package/dist/esm/apis/CourseApi.js +49 -0
  9. package/dist/esm/apis/PortalApi.d.ts +67 -0
  10. package/dist/esm/apis/PortalApi.js +177 -0
  11. package/dist/esm/models/GetPortalUserFieldValues.d.ts +53 -0
  12. package/dist/esm/models/GetPortalUserFieldValues.js +58 -0
  13. package/dist/esm/models/PortalUserFieldConfig.d.ts +40 -0
  14. package/dist/esm/models/PortalUserFieldConfig.js +49 -0
  15. package/dist/esm/models/PortalUserFieldDefinition.d.ts +108 -0
  16. package/dist/esm/models/PortalUserFieldDefinition.js +90 -0
  17. package/dist/esm/models/PortalUserFieldGroup.d.ts +62 -0
  18. package/dist/esm/models/PortalUserFieldGroup.js +59 -0
  19. package/dist/esm/models/PortalUserFieldMissingRequired.d.ts +56 -0
  20. package/dist/esm/models/PortalUserFieldMissingRequired.js +55 -0
  21. package/dist/esm/models/PortalUserFieldOption.d.ts +56 -0
  22. package/dist/esm/models/PortalUserFieldOption.js +57 -0
  23. package/dist/esm/models/PortalUserFieldValueField.d.ts +96 -0
  24. package/dist/esm/models/PortalUserFieldValueField.js +86 -0
  25. package/dist/esm/models/PortalUserFieldValueGroup.d.ts +57 -0
  26. package/dist/esm/models/PortalUserFieldValueGroup.js +60 -0
  27. package/dist/esm/models/PortalUserFieldValueInput.d.ts +38 -0
  28. package/dist/esm/models/PortalUserFieldValueInput.js +47 -0
  29. package/dist/esm/models/PostCourseResume.d.ts +93 -0
  30. package/dist/esm/models/PostCourseResume.js +82 -0
  31. package/dist/esm/models/PutPortalUserFieldValues.d.ts +33 -0
  32. package/dist/esm/models/PutPortalUserFieldValues.js +44 -0
  33. package/dist/esm/models/index.d.ts +11 -0
  34. package/dist/esm/models/index.js +11 -0
  35. package/dist/models/GetPortalUserFieldValues.d.ts +53 -0
  36. package/dist/models/GetPortalUserFieldValues.js +65 -0
  37. package/dist/models/PortalUserFieldConfig.d.ts +40 -0
  38. package/dist/models/PortalUserFieldConfig.js +56 -0
  39. package/dist/models/PortalUserFieldDefinition.d.ts +108 -0
  40. package/dist/models/PortalUserFieldDefinition.js +98 -0
  41. package/dist/models/PortalUserFieldGroup.d.ts +62 -0
  42. package/dist/models/PortalUserFieldGroup.js +66 -0
  43. package/dist/models/PortalUserFieldMissingRequired.d.ts +56 -0
  44. package/dist/models/PortalUserFieldMissingRequired.js +62 -0
  45. package/dist/models/PortalUserFieldOption.d.ts +56 -0
  46. package/dist/models/PortalUserFieldOption.js +64 -0
  47. package/dist/models/PortalUserFieldValueField.d.ts +96 -0
  48. package/dist/models/PortalUserFieldValueField.js +94 -0
  49. package/dist/models/PortalUserFieldValueGroup.d.ts +57 -0
  50. package/dist/models/PortalUserFieldValueGroup.js +67 -0
  51. package/dist/models/PortalUserFieldValueInput.d.ts +38 -0
  52. package/dist/models/PortalUserFieldValueInput.js +54 -0
  53. package/dist/models/PostCourseResume.d.ts +93 -0
  54. package/dist/models/PostCourseResume.js +89 -0
  55. package/dist/models/PutPortalUserFieldValues.d.ts +33 -0
  56. package/dist/models/PutPortalUserFieldValues.js +51 -0
  57. package/dist/models/index.d.ts +11 -0
  58. package/dist/models/index.js +11 -0
  59. package/docs/CourseApi.md +72 -0
  60. package/docs/GetPortalUserFieldValues.md +40 -0
  61. package/docs/PortalApi.md +287 -0
  62. package/docs/PortalUserFieldConfig.md +36 -0
  63. package/docs/PortalUserFieldDefinition.md +54 -0
  64. package/docs/PortalUserFieldGroup.md +44 -0
  65. package/docs/PortalUserFieldMissingRequired.md +42 -0
  66. package/docs/PortalUserFieldOption.md +42 -0
  67. package/docs/PortalUserFieldValueField.md +50 -0
  68. package/docs/PortalUserFieldValueGroup.md +42 -0
  69. package/docs/PortalUserFieldValueInput.md +36 -0
  70. package/docs/PostCourseResume.md +55 -0
  71. package/docs/PutPortalUserFieldValues.md +34 -0
  72. package/package.json +1 -1
  73. package/src/apis/CourseApi.ts +63 -0
  74. package/src/apis/PortalApi.ts +251 -0
  75. package/src/models/GetPortalUserFieldValues.ts +115 -0
  76. package/src/models/PortalUserFieldConfig.ts +90 -0
  77. package/src/models/PortalUserFieldDefinition.ts +178 -0
  78. package/src/models/PortalUserFieldGroup.ts +109 -0
  79. package/src/models/PortalUserFieldMissingRequired.ts +100 -0
  80. package/src/models/PortalUserFieldOption.ts +101 -0
  81. package/src/models/PortalUserFieldValueField.ts +162 -0
  82. package/src/models/PortalUserFieldValueGroup.ts +110 -0
  83. package/src/models/PortalUserFieldValueInput.ts +75 -0
  84. package/src/models/PostCourseResume.ts +165 -0
  85. package/src/models/PutPortalUserFieldValues.ts +74 -0
  86. package/src/models/index.ts +11 -0
@@ -0,0 +1,165 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
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
+ import { mapValues } from '../runtime';
16
+ import type { ContentLaunchMode } from './ContentLaunchMode';
17
+ import {
18
+ ContentLaunchModeFromJSON,
19
+ ContentLaunchModeFromJSONTyped,
20
+ ContentLaunchModeToJSON,
21
+ ContentLaunchModeToJSONTyped,
22
+ } from './ContentLaunchMode';
23
+
24
+ /**
25
+ * Launch-ready course resume target for the current learner.
26
+ * @export
27
+ * @interface PostCourseResume
28
+ */
29
+ export interface PostCourseResume {
30
+ /**
31
+ * The external ID of the course.
32
+ * @type {string}
33
+ * @memberof PostCourseResume
34
+ */
35
+ courseId: string;
36
+ /**
37
+ * The external ID of the module containing the resume content.
38
+ * @type {string}
39
+ * @memberof PostCourseResume
40
+ */
41
+ moduleId: string;
42
+ /**
43
+ * The external ID of the selected content.
44
+ * @type {string}
45
+ * @memberof PostCourseResume
46
+ */
47
+ contentId: string;
48
+ /**
49
+ * The external ID of the content session used for launch.
50
+ * @type {string}
51
+ * @memberof PostCourseResume
52
+ */
53
+ contentSessionId: string;
54
+ /**
55
+ * The URL to open for the selected content.
56
+ * @type {string}
57
+ * @memberof PostCourseResume
58
+ */
59
+ launchUrl: string;
60
+ /**
61
+ *
62
+ * @type {ContentLaunchMode}
63
+ * @memberof PostCourseResume
64
+ */
65
+ launchMode: ContentLaunchMode;
66
+ /**
67
+ * The date and time the content session was created.
68
+ * @type {number}
69
+ * @memberof PostCourseResume
70
+ */
71
+ createdAt: number;
72
+ /**
73
+ * The player session ID, when a content-specific player session exists.
74
+ * @type {string}
75
+ * @memberof PostCourseResume
76
+ */
77
+ playerSessionId?: string | null;
78
+ /**
79
+ * The learner attempt number for this content session.
80
+ * @type {number}
81
+ * @memberof PostCourseResume
82
+ */
83
+ attemptNumber: number;
84
+ /**
85
+ * Whether this is the current attempt used for learner progress display.
86
+ * @type {boolean}
87
+ * @memberof PostCourseResume
88
+ */
89
+ isCurrent: boolean;
90
+ /**
91
+ * Why this content was selected. Values are resume_incomplete_session or start_next_content.
92
+ * @type {string}
93
+ * @memberof PostCourseResume
94
+ */
95
+ selectionReason: string;
96
+ }
97
+
98
+
99
+
100
+ /**
101
+ * Check if a given object implements the PostCourseResume interface.
102
+ */
103
+ export function instanceOfPostCourseResume(value: object): value is PostCourseResume {
104
+ if (!('courseId' in value) || value['courseId'] === undefined) return false;
105
+ if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
106
+ if (!('contentId' in value) || value['contentId'] === undefined) return false;
107
+ if (!('contentSessionId' in value) || value['contentSessionId'] === undefined) return false;
108
+ if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
109
+ if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
110
+ if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
111
+ if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
112
+ if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
113
+ if (!('selectionReason' in value) || value['selectionReason'] === undefined) return false;
114
+ return true;
115
+ }
116
+
117
+ export function PostCourseResumeFromJSON(json: any): PostCourseResume {
118
+ return PostCourseResumeFromJSONTyped(json, false);
119
+ }
120
+
121
+ export function PostCourseResumeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseResume {
122
+ if (json == null) {
123
+ return json;
124
+ }
125
+ return {
126
+
127
+ 'courseId': json['course_id'],
128
+ 'moduleId': json['module_id'],
129
+ 'contentId': json['content_id'],
130
+ 'contentSessionId': json['content_session_id'],
131
+ 'launchUrl': json['launch_url'],
132
+ 'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
133
+ 'createdAt': json['created_at'],
134
+ 'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
135
+ 'attemptNumber': json['attempt_number'],
136
+ 'isCurrent': json['is_current'],
137
+ 'selectionReason': json['selection_reason'],
138
+ };
139
+ }
140
+
141
+ export function PostCourseResumeToJSON(json: any): PostCourseResume {
142
+ return PostCourseResumeToJSONTyped(json, false);
143
+ }
144
+
145
+ export function PostCourseResumeToJSONTyped(value?: PostCourseResume | null, ignoreDiscriminator: boolean = false): any {
146
+ if (value == null) {
147
+ return value;
148
+ }
149
+
150
+ return {
151
+
152
+ 'course_id': value['courseId'],
153
+ 'module_id': value['moduleId'],
154
+ 'content_id': value['contentId'],
155
+ 'content_session_id': value['contentSessionId'],
156
+ 'launch_url': value['launchUrl'],
157
+ 'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
158
+ 'created_at': value['createdAt'],
159
+ 'player_session_id': value['playerSessionId'],
160
+ 'attempt_number': value['attemptNumber'],
161
+ 'is_current': value['isCurrent'],
162
+ 'selection_reason': value['selectionReason'],
163
+ };
164
+ }
165
+
@@ -0,0 +1,74 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
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
+ import { mapValues } from '../runtime';
16
+ import type { PortalUserFieldValueInput } from './PortalUserFieldValueInput';
17
+ import {
18
+ PortalUserFieldValueInputFromJSON,
19
+ PortalUserFieldValueInputFromJSONTyped,
20
+ PortalUserFieldValueInputToJSON,
21
+ PortalUserFieldValueInputToJSONTyped,
22
+ } from './PortalUserFieldValueInput';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface PutPortalUserFieldValues
28
+ */
29
+ export interface PutPortalUserFieldValues {
30
+ /**
31
+ *
32
+ * @type {Array<PortalUserFieldValueInput>}
33
+ * @memberof PutPortalUserFieldValues
34
+ */
35
+ values: Array<PortalUserFieldValueInput>;
36
+ }
37
+
38
+ /**
39
+ * Check if a given object implements the PutPortalUserFieldValues interface.
40
+ */
41
+ export function instanceOfPutPortalUserFieldValues(value: object): value is PutPortalUserFieldValues {
42
+ if (!('values' in value) || value['values'] === undefined) return false;
43
+ return true;
44
+ }
45
+
46
+ export function PutPortalUserFieldValuesFromJSON(json: any): PutPortalUserFieldValues {
47
+ return PutPortalUserFieldValuesFromJSONTyped(json, false);
48
+ }
49
+
50
+ export function PutPortalUserFieldValuesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalUserFieldValues {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+
56
+ 'values': ((json['values'] as Array<any>).map(PortalUserFieldValueInputFromJSON)),
57
+ };
58
+ }
59
+
60
+ export function PutPortalUserFieldValuesToJSON(json: any): PutPortalUserFieldValues {
61
+ return PutPortalUserFieldValuesToJSONTyped(json, false);
62
+ }
63
+
64
+ export function PutPortalUserFieldValuesToJSONTyped(value?: PutPortalUserFieldValues | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'values': ((value['values'] as Array<any>).map(PortalUserFieldValueInputToJSON)),
72
+ };
73
+ }
74
+
@@ -86,6 +86,7 @@ export * from './GetPortalStudentReporting';
86
86
  export * from './GetPortalStudentReportingCertificates';
87
87
  export * from './GetPortalStudentReportingPortalInfo';
88
88
  export * from './GetPortalUser';
89
+ export * from './GetPortalUserFieldValues';
89
90
  export * from './GetPortalUserList';
90
91
  export * from './GetPublicPortalBranding';
91
92
  export * from './GetQuestion';
@@ -174,6 +175,14 @@ export * from './MultipleAnswer1';
174
175
  export * from './NoAnswer';
175
176
  export * from './Paginated';
176
177
  export * from './PortalSublicense';
178
+ export * from './PortalUserFieldConfig';
179
+ export * from './PortalUserFieldDefinition';
180
+ export * from './PortalUserFieldGroup';
181
+ export * from './PortalUserFieldMissingRequired';
182
+ export * from './PortalUserFieldOption';
183
+ export * from './PortalUserFieldValueField';
184
+ export * from './PortalUserFieldValueGroup';
185
+ export * from './PortalUserFieldValueInput';
177
186
  export * from './PostCertificate';
178
187
  export * from './PostCertificateConfig';
179
188
  export * from './PostContentQuiz';
@@ -188,6 +197,7 @@ export * from './PostCourse';
188
197
  export * from './PostCourseCatalog';
189
198
  export * from './PostCourseEnrollment';
190
199
  export * from './PostCourseExport';
200
+ export * from './PostCourseResume';
191
201
  export * from './PostDuplicate';
192
202
  export * from './PostDuplicate1';
193
203
  export * from './PostDuplicate2';
@@ -241,6 +251,7 @@ export * from './PutModule';
241
251
  export * from './PutModuleReorder';
242
252
  export * from './PutPortalBranding';
243
253
  export * from './PutPortalSublicense';
254
+ export * from './PutPortalUserFieldValues';
244
255
  export * from './PutQuestion';
245
256
  export * from './PutQuestionAnswerChoicesInner';
246
257
  export * from './PutQuiz';