@easyedu/js-lsm-api 1.110.0 → 1.111.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 (73) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +21 -2
  3. package/dist/apis/LearnerExperienceApi.d.ts +153 -0
  4. package/dist/apis/LearnerExperienceApi.js +401 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/esm/apis/LearnerExperienceApi.d.ts +153 -0
  8. package/dist/esm/apis/LearnerExperienceApi.js +397 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +1 -0
  11. package/dist/esm/models/GetEffectiveLearnerExperience.d.ts +62 -0
  12. package/dist/esm/models/GetEffectiveLearnerExperience.js +62 -0
  13. package/dist/esm/models/GetLearnerDashboard.d.ts +47 -0
  14. package/dist/esm/models/GetLearnerDashboard.js +54 -0
  15. package/dist/esm/models/GetLearnerDashboardCourseList.d.ts +39 -0
  16. package/dist/esm/models/GetLearnerDashboardCourseList.js +48 -0
  17. package/dist/esm/models/GetLearnerDashboardSummary.d.ts +56 -0
  18. package/dist/esm/models/GetLearnerDashboardSummary.js +59 -0
  19. package/dist/esm/models/GetLearnerExperience.d.ts +67 -0
  20. package/dist/esm/models/GetLearnerExperience.js +65 -0
  21. package/dist/esm/models/GetLearnerExperiencePreview.d.ts +40 -0
  22. package/dist/esm/models/GetLearnerExperiencePreview.js +47 -0
  23. package/dist/esm/models/LearnerExperienceVersion.d.ts +86 -0
  24. package/dist/esm/models/LearnerExperienceVersion.js +76 -0
  25. package/dist/esm/models/PostLearnerExperiencePreview.d.ts +40 -0
  26. package/dist/esm/models/PostLearnerExperiencePreview.js +45 -0
  27. package/dist/esm/models/PutLearnerExperienceDraft.d.ts +40 -0
  28. package/dist/esm/models/PutLearnerExperienceDraft.js +45 -0
  29. package/dist/esm/models/index.d.ts +9 -0
  30. package/dist/esm/models/index.js +9 -0
  31. package/dist/models/GetEffectiveLearnerExperience.d.ts +62 -0
  32. package/dist/models/GetEffectiveLearnerExperience.js +70 -0
  33. package/dist/models/GetLearnerDashboard.d.ts +47 -0
  34. package/dist/models/GetLearnerDashboard.js +61 -0
  35. package/dist/models/GetLearnerDashboardCourseList.d.ts +39 -0
  36. package/dist/models/GetLearnerDashboardCourseList.js +55 -0
  37. package/dist/models/GetLearnerDashboardSummary.d.ts +56 -0
  38. package/dist/models/GetLearnerDashboardSummary.js +66 -0
  39. package/dist/models/GetLearnerExperience.d.ts +67 -0
  40. package/dist/models/GetLearnerExperience.js +73 -0
  41. package/dist/models/GetLearnerExperiencePreview.d.ts +40 -0
  42. package/dist/models/GetLearnerExperiencePreview.js +54 -0
  43. package/dist/models/LearnerExperienceVersion.d.ts +86 -0
  44. package/dist/models/LearnerExperienceVersion.js +84 -0
  45. package/dist/models/PostLearnerExperiencePreview.d.ts +40 -0
  46. package/dist/models/PostLearnerExperiencePreview.js +52 -0
  47. package/dist/models/PutLearnerExperienceDraft.d.ts +40 -0
  48. package/dist/models/PutLearnerExperienceDraft.js +52 -0
  49. package/dist/models/index.d.ts +9 -0
  50. package/dist/models/index.js +9 -0
  51. package/docs/GetEffectiveLearnerExperience.md +40 -0
  52. package/docs/GetLearnerDashboard.md +38 -0
  53. package/docs/GetLearnerDashboardCourseList.md +36 -0
  54. package/docs/GetLearnerDashboardSummary.md +42 -0
  55. package/docs/GetLearnerExperience.md +42 -0
  56. package/docs/GetLearnerExperiencePreview.md +36 -0
  57. package/docs/LearnerExperienceApi.md +622 -0
  58. package/docs/LearnerExperienceVersion.md +48 -0
  59. package/docs/PostLearnerExperiencePreview.md +36 -0
  60. package/docs/PutLearnerExperienceDraft.md +36 -0
  61. package/package.json +1 -1
  62. package/src/apis/LearnerExperienceApi.ts +465 -0
  63. package/src/apis/index.ts +1 -0
  64. package/src/models/GetEffectiveLearnerExperience.ts +105 -0
  65. package/src/models/GetLearnerDashboard.ts +106 -0
  66. package/src/models/GetLearnerDashboardCourseList.ts +83 -0
  67. package/src/models/GetLearnerDashboardSummary.ts +102 -0
  68. package/src/models/GetLearnerExperience.ts +121 -0
  69. package/src/models/GetLearnerExperiencePreview.ts +75 -0
  70. package/src/models/LearnerExperienceVersion.ts +140 -0
  71. package/src/models/PostLearnerExperiencePreview.ts +74 -0
  72. package/src/models/PutLearnerExperienceDraft.ts +74 -0
  73. package/src/models/index.ts +9 -0
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
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.GetLearnerExperienceEffectiveSourceEnum = void 0;
17
+ exports.instanceOfGetLearnerExperience = instanceOfGetLearnerExperience;
18
+ exports.GetLearnerExperienceFromJSON = GetLearnerExperienceFromJSON;
19
+ exports.GetLearnerExperienceFromJSONTyped = GetLearnerExperienceFromJSONTyped;
20
+ exports.GetLearnerExperienceToJSON = GetLearnerExperienceToJSON;
21
+ exports.GetLearnerExperienceToJSONTyped = GetLearnerExperienceToJSONTyped;
22
+ const LearnerExperienceVersion_1 = require("./LearnerExperienceVersion");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.GetLearnerExperienceEffectiveSourceEnum = {
27
+ Portal: 'portal',
28
+ Ancestor: 'ancestor',
29
+ Platform: 'platform',
30
+ System: 'system'
31
+ };
32
+ /**
33
+ * Check if a given object implements the GetLearnerExperience interface.
34
+ */
35
+ function instanceOfGetLearnerExperience(value) {
36
+ if (!('effectiveSource' in value) || value['effectiveSource'] === undefined)
37
+ return false;
38
+ if (!('effectiveVersion' in value) || value['effectiveVersion'] === undefined)
39
+ return false;
40
+ if (!('versions' in value) || value['versions'] === undefined)
41
+ return false;
42
+ return true;
43
+ }
44
+ function GetLearnerExperienceFromJSON(json) {
45
+ return GetLearnerExperienceFromJSONTyped(json, false);
46
+ }
47
+ function GetLearnerExperienceFromJSONTyped(json, ignoreDiscriminator) {
48
+ if (json == null) {
49
+ return json;
50
+ }
51
+ return {
52
+ 'effectiveSource': json['effective_source'],
53
+ 'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
54
+ 'effectiveVersion': (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(json['effective_version']),
55
+ 'draftVersion': json['draft_version'] == null ? undefined : (0, LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)(json['draft_version']),
56
+ 'versions': (json['versions'].map(LearnerExperienceVersion_1.LearnerExperienceVersionFromJSON)),
57
+ };
58
+ }
59
+ function GetLearnerExperienceToJSON(json) {
60
+ return GetLearnerExperienceToJSONTyped(json, false);
61
+ }
62
+ function GetLearnerExperienceToJSONTyped(value, ignoreDiscriminator = false) {
63
+ if (value == null) {
64
+ return value;
65
+ }
66
+ return {
67
+ 'effective_source': value['effectiveSource'],
68
+ 'effective_source_portal_id': value['effectiveSourcePortalId'],
69
+ 'effective_version': (0, LearnerExperienceVersion_1.LearnerExperienceVersionToJSON)(value['effectiveVersion']),
70
+ 'draft_version': (0, LearnerExperienceVersion_1.LearnerExperienceVersionToJSON)(value['draftVersion']),
71
+ 'versions': (value['versions'].map(LearnerExperienceVersion_1.LearnerExperienceVersionToJSON)),
72
+ };
73
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
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 GetLearnerExperiencePreview
16
+ */
17
+ export interface GetLearnerExperiencePreview {
18
+ /**
19
+ *
20
+ * @type {{ [key: string]: any; }}
21
+ * @memberof GetLearnerExperiencePreview
22
+ */
23
+ designDocument: {
24
+ [key: string]: any;
25
+ };
26
+ /**
27
+ *
28
+ * @type {Array<string>}
29
+ * @memberof GetLearnerExperiencePreview
30
+ */
31
+ assetIds: Array<string>;
32
+ }
33
+ /**
34
+ * Check if a given object implements the GetLearnerExperiencePreview interface.
35
+ */
36
+ export declare function instanceOfGetLearnerExperiencePreview(value: object): value is GetLearnerExperiencePreview;
37
+ export declare function GetLearnerExperiencePreviewFromJSON(json: any): GetLearnerExperiencePreview;
38
+ export declare function GetLearnerExperiencePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLearnerExperiencePreview;
39
+ export declare function GetLearnerExperiencePreviewToJSON(json: any): GetLearnerExperiencePreview;
40
+ export declare function GetLearnerExperiencePreviewToJSONTyped(value?: GetLearnerExperiencePreview | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
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.instanceOfGetLearnerExperiencePreview = instanceOfGetLearnerExperiencePreview;
17
+ exports.GetLearnerExperiencePreviewFromJSON = GetLearnerExperiencePreviewFromJSON;
18
+ exports.GetLearnerExperiencePreviewFromJSONTyped = GetLearnerExperiencePreviewFromJSONTyped;
19
+ exports.GetLearnerExperiencePreviewToJSON = GetLearnerExperiencePreviewToJSON;
20
+ exports.GetLearnerExperiencePreviewToJSONTyped = GetLearnerExperiencePreviewToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the GetLearnerExperiencePreview interface.
23
+ */
24
+ function instanceOfGetLearnerExperiencePreview(value) {
25
+ if (!('designDocument' in value) || value['designDocument'] === undefined)
26
+ return false;
27
+ if (!('assetIds' in value) || value['assetIds'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function GetLearnerExperiencePreviewFromJSON(json) {
32
+ return GetLearnerExperiencePreviewFromJSONTyped(json, false);
33
+ }
34
+ function GetLearnerExperiencePreviewFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'designDocument': json['design_document'],
40
+ 'assetIds': json['asset_ids'],
41
+ };
42
+ }
43
+ function GetLearnerExperiencePreviewToJSON(json) {
44
+ return GetLearnerExperiencePreviewToJSONTyped(json, false);
45
+ }
46
+ function GetLearnerExperiencePreviewToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'design_document': value['designDocument'],
52
+ 'asset_ids': value['assetIds'],
53
+ };
54
+ }
@@ -0,0 +1,86 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
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 LearnerExperienceVersion
16
+ */
17
+ export interface LearnerExperienceVersion {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof LearnerExperienceVersion
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof LearnerExperienceVersion
28
+ */
29
+ versionNumber: number;
30
+ /**
31
+ *
32
+ * @type {LearnerExperienceVersionStatusEnum}
33
+ * @memberof LearnerExperienceVersion
34
+ */
35
+ status: LearnerExperienceVersionStatusEnum;
36
+ /**
37
+ * Validated learner-experience-v1 shell and dashboard document.
38
+ * @type {{ [key: string]: any; }}
39
+ * @memberof LearnerExperienceVersion
40
+ */
41
+ designDocument: {
42
+ [key: string]: any;
43
+ };
44
+ /**
45
+ *
46
+ * @type {string}
47
+ * @memberof LearnerExperienceVersion
48
+ */
49
+ changeNotes?: string | null;
50
+ /**
51
+ *
52
+ * @type {number}
53
+ * @memberof LearnerExperienceVersion
54
+ */
55
+ createdAt: number;
56
+ /**
57
+ *
58
+ * @type {number}
59
+ * @memberof LearnerExperienceVersion
60
+ */
61
+ updatedAt: number;
62
+ /**
63
+ *
64
+ * @type {number}
65
+ * @memberof LearnerExperienceVersion
66
+ */
67
+ publishedAt?: number | null;
68
+ }
69
+ /**
70
+ * @export
71
+ */
72
+ export declare const LearnerExperienceVersionStatusEnum: {
73
+ readonly Draft: "draft";
74
+ readonly Published: "published";
75
+ readonly Archived: "archived";
76
+ readonly System: "system";
77
+ };
78
+ export type LearnerExperienceVersionStatusEnum = typeof LearnerExperienceVersionStatusEnum[keyof typeof LearnerExperienceVersionStatusEnum];
79
+ /**
80
+ * Check if a given object implements the LearnerExperienceVersion interface.
81
+ */
82
+ export declare function instanceOfLearnerExperienceVersion(value: object): value is LearnerExperienceVersion;
83
+ export declare function LearnerExperienceVersionFromJSON(json: any): LearnerExperienceVersion;
84
+ export declare function LearnerExperienceVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearnerExperienceVersion;
85
+ export declare function LearnerExperienceVersionToJSON(json: any): LearnerExperienceVersion;
86
+ export declare function LearnerExperienceVersionToJSONTyped(value?: LearnerExperienceVersion | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
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.LearnerExperienceVersionStatusEnum = void 0;
17
+ exports.instanceOfLearnerExperienceVersion = instanceOfLearnerExperienceVersion;
18
+ exports.LearnerExperienceVersionFromJSON = LearnerExperienceVersionFromJSON;
19
+ exports.LearnerExperienceVersionFromJSONTyped = LearnerExperienceVersionFromJSONTyped;
20
+ exports.LearnerExperienceVersionToJSON = LearnerExperienceVersionToJSON;
21
+ exports.LearnerExperienceVersionToJSONTyped = LearnerExperienceVersionToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.LearnerExperienceVersionStatusEnum = {
26
+ Draft: 'draft',
27
+ Published: 'published',
28
+ Archived: 'archived',
29
+ System: 'system'
30
+ };
31
+ /**
32
+ * Check if a given object implements the LearnerExperienceVersion interface.
33
+ */
34
+ function instanceOfLearnerExperienceVersion(value) {
35
+ if (!('id' in value) || value['id'] === undefined)
36
+ return false;
37
+ if (!('versionNumber' in value) || value['versionNumber'] === undefined)
38
+ return false;
39
+ if (!('status' in value) || value['status'] === undefined)
40
+ return false;
41
+ if (!('designDocument' in value) || value['designDocument'] === undefined)
42
+ return false;
43
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
44
+ return false;
45
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
46
+ return false;
47
+ return true;
48
+ }
49
+ function LearnerExperienceVersionFromJSON(json) {
50
+ return LearnerExperienceVersionFromJSONTyped(json, false);
51
+ }
52
+ function LearnerExperienceVersionFromJSONTyped(json, ignoreDiscriminator) {
53
+ if (json == null) {
54
+ return json;
55
+ }
56
+ return {
57
+ 'id': json['id'],
58
+ 'versionNumber': json['version_number'],
59
+ 'status': json['status'],
60
+ 'designDocument': json['design_document'],
61
+ 'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
62
+ 'createdAt': json['created_at'],
63
+ 'updatedAt': json['updated_at'],
64
+ 'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
65
+ };
66
+ }
67
+ function LearnerExperienceVersionToJSON(json) {
68
+ return LearnerExperienceVersionToJSONTyped(json, false);
69
+ }
70
+ function LearnerExperienceVersionToJSONTyped(value, ignoreDiscriminator = false) {
71
+ if (value == null) {
72
+ return value;
73
+ }
74
+ return {
75
+ 'id': value['id'],
76
+ 'version_number': value['versionNumber'],
77
+ 'status': value['status'],
78
+ 'design_document': value['designDocument'],
79
+ 'change_notes': value['changeNotes'],
80
+ 'created_at': value['createdAt'],
81
+ 'updated_at': value['updatedAt'],
82
+ 'published_at': value['publishedAt'],
83
+ };
84
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
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 PostLearnerExperiencePreview
16
+ */
17
+ export interface PostLearnerExperiencePreview {
18
+ /**
19
+ *
20
+ * @type {{ [key: string]: any; }}
21
+ * @memberof PostLearnerExperiencePreview
22
+ */
23
+ designDocument: {
24
+ [key: string]: any;
25
+ };
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof PostLearnerExperiencePreview
30
+ */
31
+ changeNotes?: string | null;
32
+ }
33
+ /**
34
+ * Check if a given object implements the PostLearnerExperiencePreview interface.
35
+ */
36
+ export declare function instanceOfPostLearnerExperiencePreview(value: object): value is PostLearnerExperiencePreview;
37
+ export declare function PostLearnerExperiencePreviewFromJSON(json: any): PostLearnerExperiencePreview;
38
+ export declare function PostLearnerExperiencePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLearnerExperiencePreview;
39
+ export declare function PostLearnerExperiencePreviewToJSON(json: any): PostLearnerExperiencePreview;
40
+ export declare function PostLearnerExperiencePreviewToJSONTyped(value?: PostLearnerExperiencePreview | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
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.instanceOfPostLearnerExperiencePreview = instanceOfPostLearnerExperiencePreview;
17
+ exports.PostLearnerExperiencePreviewFromJSON = PostLearnerExperiencePreviewFromJSON;
18
+ exports.PostLearnerExperiencePreviewFromJSONTyped = PostLearnerExperiencePreviewFromJSONTyped;
19
+ exports.PostLearnerExperiencePreviewToJSON = PostLearnerExperiencePreviewToJSON;
20
+ exports.PostLearnerExperiencePreviewToJSONTyped = PostLearnerExperiencePreviewToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PostLearnerExperiencePreview interface.
23
+ */
24
+ function instanceOfPostLearnerExperiencePreview(value) {
25
+ if (!('designDocument' in value) || value['designDocument'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function PostLearnerExperiencePreviewFromJSON(json) {
30
+ return PostLearnerExperiencePreviewFromJSONTyped(json, false);
31
+ }
32
+ function PostLearnerExperiencePreviewFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'designDocument': json['design_document'],
38
+ 'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
39
+ };
40
+ }
41
+ function PostLearnerExperiencePreviewToJSON(json) {
42
+ return PostLearnerExperiencePreviewToJSONTyped(json, false);
43
+ }
44
+ function PostLearnerExperiencePreviewToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'design_document': value['designDocument'],
50
+ 'change_notes': value['changeNotes'],
51
+ };
52
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
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 PutLearnerExperienceDraft
16
+ */
17
+ export interface PutLearnerExperienceDraft {
18
+ /**
19
+ *
20
+ * @type {{ [key: string]: any; }}
21
+ * @memberof PutLearnerExperienceDraft
22
+ */
23
+ designDocument: {
24
+ [key: string]: any;
25
+ };
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof PutLearnerExperienceDraft
30
+ */
31
+ changeNotes?: string | null;
32
+ }
33
+ /**
34
+ * Check if a given object implements the PutLearnerExperienceDraft interface.
35
+ */
36
+ export declare function instanceOfPutLearnerExperienceDraft(value: object): value is PutLearnerExperienceDraft;
37
+ export declare function PutLearnerExperienceDraftFromJSON(json: any): PutLearnerExperienceDraft;
38
+ export declare function PutLearnerExperienceDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLearnerExperienceDraft;
39
+ export declare function PutLearnerExperienceDraftToJSON(json: any): PutLearnerExperienceDraft;
40
+ export declare function PutLearnerExperienceDraftToJSONTyped(value?: PutLearnerExperienceDraft | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
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.instanceOfPutLearnerExperienceDraft = instanceOfPutLearnerExperienceDraft;
17
+ exports.PutLearnerExperienceDraftFromJSON = PutLearnerExperienceDraftFromJSON;
18
+ exports.PutLearnerExperienceDraftFromJSONTyped = PutLearnerExperienceDraftFromJSONTyped;
19
+ exports.PutLearnerExperienceDraftToJSON = PutLearnerExperienceDraftToJSON;
20
+ exports.PutLearnerExperienceDraftToJSONTyped = PutLearnerExperienceDraftToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PutLearnerExperienceDraft interface.
23
+ */
24
+ function instanceOfPutLearnerExperienceDraft(value) {
25
+ if (!('designDocument' in value) || value['designDocument'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function PutLearnerExperienceDraftFromJSON(json) {
30
+ return PutLearnerExperienceDraftFromJSONTyped(json, false);
31
+ }
32
+ function PutLearnerExperienceDraftFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'designDocument': json['design_document'],
38
+ 'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
39
+ };
40
+ }
41
+ function PutLearnerExperienceDraftToJSON(json) {
42
+ return PutLearnerExperienceDraftToJSONTyped(json, false);
43
+ }
44
+ function PutLearnerExperienceDraftToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'design_document': value['designDocument'],
50
+ 'change_notes': value['changeNotes'],
51
+ };
52
+ }
@@ -83,12 +83,18 @@ export * from './GetCourseVersionSection';
83
83
  export * from './GetCourseVersionSectionChild';
84
84
  export * from './GetCourseVersionSectionProgression';
85
85
  export * from './GetCourseVersionSectionReporting';
86
+ export * from './GetEffectiveLearnerExperience';
86
87
  export * from './GetEmailAssetUpload';
87
88
  export * from './GetEmailDelivery';
88
89
  export * from './GetEmailDeliveryList';
89
90
  export * from './GetEmailTemplate';
90
91
  export * from './GetEmailTemplateList';
91
92
  export * from './GetEmailTemplatePreview';
93
+ export * from './GetLearnerDashboard';
94
+ export * from './GetLearnerDashboardCourseList';
95
+ export * from './GetLearnerDashboardSummary';
96
+ export * from './GetLearnerExperience';
97
+ export * from './GetLearnerExperiencePreview';
92
98
  export * from './GetLibraryQuiz';
93
99
  export * from './GetLibraryQuizAnalytics';
94
100
  export * from './GetLibraryQuizCriteriaPreview';
@@ -152,6 +158,7 @@ export * from './GetUserCourseListItemCourse';
152
158
  export * from './GetUserCourseListItemEnrollment';
153
159
  export * from './GetUserCourseListItemProgress';
154
160
  export * from './GetUserRole';
161
+ export * from './LearnerExperienceVersion';
155
162
  export * from './LibraryQuizCriteriaPreviewQuestion';
156
163
  export * from './LibraryQuizCriterion';
157
164
  export * from './LibraryQuizCriterionPreview';
@@ -207,6 +214,7 @@ export * from './PostEmailAssetComplete';
207
214
  export * from './PostEmailAssetUpload';
208
215
  export * from './PostEmailTemplatePreview';
209
216
  export * from './PostEmailTemplateTestSend';
217
+ export * from './PostLearnerExperiencePreview';
210
218
  export * from './PostLibraryQuiz';
211
219
  export * from './PostLibraryQuizSession';
212
220
  export * from './PostLibraryQuizVersion';
@@ -254,6 +262,7 @@ export * from './PutCourseVersionItem';
254
262
  export * from './PutCourseVersionOutlineEntryMove';
255
263
  export * from './PutCourseVersionSection';
256
264
  export * from './PutEmailTemplateDraft';
265
+ export * from './PutLearnerExperienceDraft';
257
266
  export * from './PutLibraryQuiz';
258
267
  export * from './PutLibraryQuizCriteria';
259
268
  export * from './PutLibraryQuizQuestions';
@@ -101,12 +101,18 @@ __exportStar(require("./GetCourseVersionSection"), exports);
101
101
  __exportStar(require("./GetCourseVersionSectionChild"), exports);
102
102
  __exportStar(require("./GetCourseVersionSectionProgression"), exports);
103
103
  __exportStar(require("./GetCourseVersionSectionReporting"), exports);
104
+ __exportStar(require("./GetEffectiveLearnerExperience"), exports);
104
105
  __exportStar(require("./GetEmailAssetUpload"), exports);
105
106
  __exportStar(require("./GetEmailDelivery"), exports);
106
107
  __exportStar(require("./GetEmailDeliveryList"), exports);
107
108
  __exportStar(require("./GetEmailTemplate"), exports);
108
109
  __exportStar(require("./GetEmailTemplateList"), exports);
109
110
  __exportStar(require("./GetEmailTemplatePreview"), exports);
111
+ __exportStar(require("./GetLearnerDashboard"), exports);
112
+ __exportStar(require("./GetLearnerDashboardCourseList"), exports);
113
+ __exportStar(require("./GetLearnerDashboardSummary"), exports);
114
+ __exportStar(require("./GetLearnerExperience"), exports);
115
+ __exportStar(require("./GetLearnerExperiencePreview"), exports);
110
116
  __exportStar(require("./GetLibraryQuiz"), exports);
111
117
  __exportStar(require("./GetLibraryQuizAnalytics"), exports);
112
118
  __exportStar(require("./GetLibraryQuizCriteriaPreview"), exports);
@@ -170,6 +176,7 @@ __exportStar(require("./GetUserCourseListItemCourse"), exports);
170
176
  __exportStar(require("./GetUserCourseListItemEnrollment"), exports);
171
177
  __exportStar(require("./GetUserCourseListItemProgress"), exports);
172
178
  __exportStar(require("./GetUserRole"), exports);
179
+ __exportStar(require("./LearnerExperienceVersion"), exports);
173
180
  __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
174
181
  __exportStar(require("./LibraryQuizCriterion"), exports);
175
182
  __exportStar(require("./LibraryQuizCriterionPreview"), exports);
@@ -225,6 +232,7 @@ __exportStar(require("./PostEmailAssetComplete"), exports);
225
232
  __exportStar(require("./PostEmailAssetUpload"), exports);
226
233
  __exportStar(require("./PostEmailTemplatePreview"), exports);
227
234
  __exportStar(require("./PostEmailTemplateTestSend"), exports);
235
+ __exportStar(require("./PostLearnerExperiencePreview"), exports);
228
236
  __exportStar(require("./PostLibraryQuiz"), exports);
229
237
  __exportStar(require("./PostLibraryQuizSession"), exports);
230
238
  __exportStar(require("./PostLibraryQuizVersion"), exports);
@@ -272,6 +280,7 @@ __exportStar(require("./PutCourseVersionItem"), exports);
272
280
  __exportStar(require("./PutCourseVersionOutlineEntryMove"), exports);
273
281
  __exportStar(require("./PutCourseVersionSection"), exports);
274
282
  __exportStar(require("./PutEmailTemplateDraft"), exports);
283
+ __exportStar(require("./PutLearnerExperienceDraft"), exports);
275
284
  __exportStar(require("./PutLibraryQuiz"), exports);
276
285
  __exportStar(require("./PutLibraryQuizCriteria"), exports);
277
286
  __exportStar(require("./PutLibraryQuizQuestions"), exports);
@@ -0,0 +1,40 @@
1
+
2
+ # GetEffectiveLearnerExperience
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `effectiveSource` | string
10
+ `effectiveSourcePortalId` | string
11
+ `versionId` | string
12
+ `designDocument` | { [key: string]: any; }
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { GetEffectiveLearnerExperience } from '@easyedu/js-lsm-api'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "effectiveSource": null,
22
+ "effectiveSourcePortalId": null,
23
+ "versionId": null,
24
+ "designDocument": null,
25
+ } satisfies GetEffectiveLearnerExperience
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as GetEffectiveLearnerExperience
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+