@easyedu/js-lsm-api 1.124.0 → 1.126.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 (82) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +7 -5
  3. package/dist/apis/CertificateTemplateApi.d.ts +10 -5
  4. package/dist/apis/CertificateTemplateApi.js +17 -12
  5. package/dist/apis/ContentLibraryApi.d.ts +4 -2
  6. package/dist/apis/ContentLibraryApi.js +5 -3
  7. package/dist/apis/CourseApi.d.ts +5 -4
  8. package/dist/apis/CourseApi.js +7 -4
  9. package/dist/esm/apis/CertificateTemplateApi.d.ts +10 -5
  10. package/dist/esm/apis/CertificateTemplateApi.js +17 -12
  11. package/dist/esm/apis/ContentLibraryApi.d.ts +4 -2
  12. package/dist/esm/apis/ContentLibraryApi.js +5 -3
  13. package/dist/esm/apis/CourseApi.d.ts +5 -4
  14. package/dist/esm/apis/CourseApi.js +7 -4
  15. package/dist/esm/models/CertificateTemplate.d.ts +7 -0
  16. package/dist/esm/models/CertificateTemplate.js +5 -0
  17. package/dist/esm/models/ContentLibraryTag.d.ts +12 -0
  18. package/dist/esm/models/ContentLibraryTag.js +8 -0
  19. package/dist/esm/models/ContentLibraryTagItem.d.ts +2 -0
  20. package/dist/esm/models/ContentLibraryTagItem.js +3 -1
  21. package/dist/esm/models/GetCourse.d.ts +7 -0
  22. package/dist/esm/models/GetCourse.js +5 -0
  23. package/dist/esm/models/PostCourse.d.ts +6 -0
  24. package/dist/esm/models/PostCourse.js +2 -0
  25. package/dist/esm/models/PostCourseEnrollment.d.ts +8 -4
  26. package/dist/esm/models/PostPortalCertificateTemplate.d.ts +57 -0
  27. package/dist/esm/models/PostPortalCertificateTemplate.js +52 -0
  28. package/dist/esm/models/PutCourse.d.ts +6 -0
  29. package/dist/esm/models/PutCourse.js +2 -0
  30. package/dist/esm/models/PutCourseEnrollment.d.ts +0 -14
  31. package/dist/esm/models/PutCourseEnrollment.js +0 -9
  32. package/dist/esm/models/PutPortalCertificateTemplate.d.ts +50 -0
  33. package/dist/esm/models/PutPortalCertificateTemplate.js +47 -0
  34. package/dist/esm/models/index.d.ts +2 -0
  35. package/dist/esm/models/index.js +2 -0
  36. package/dist/models/CertificateTemplate.d.ts +7 -0
  37. package/dist/models/CertificateTemplate.js +5 -0
  38. package/dist/models/ContentLibraryTag.d.ts +12 -0
  39. package/dist/models/ContentLibraryTag.js +8 -0
  40. package/dist/models/ContentLibraryTagItem.d.ts +2 -0
  41. package/dist/models/ContentLibraryTagItem.js +3 -1
  42. package/dist/models/GetCourse.d.ts +7 -0
  43. package/dist/models/GetCourse.js +5 -0
  44. package/dist/models/PostCourse.d.ts +6 -0
  45. package/dist/models/PostCourse.js +2 -0
  46. package/dist/models/PostCourseEnrollment.d.ts +8 -4
  47. package/dist/models/PostPortalCertificateTemplate.d.ts +57 -0
  48. package/dist/models/PostPortalCertificateTemplate.js +59 -0
  49. package/dist/models/PutCourse.d.ts +6 -0
  50. package/dist/models/PutCourse.js +2 -0
  51. package/dist/models/PutCourseEnrollment.d.ts +0 -14
  52. package/dist/models/PutCourseEnrollment.js +1 -10
  53. package/dist/models/PutPortalCertificateTemplate.d.ts +50 -0
  54. package/dist/models/PutPortalCertificateTemplate.js +54 -0
  55. package/dist/models/index.d.ts +2 -0
  56. package/dist/models/index.js +2 -0
  57. package/docs/CertificateTemplate.md +2 -0
  58. package/docs/CertificateTemplateApi.md +19 -11
  59. package/docs/ContentLibraryApi.md +4 -4
  60. package/docs/ContentLibraryTag.md +4 -0
  61. package/docs/CourseApi.md +12 -7
  62. package/docs/GetCourse.md +2 -0
  63. package/docs/PostCourse.md +2 -0
  64. package/docs/PostPortalCertificateTemplate.md +42 -0
  65. package/docs/PutCourse.md +2 -0
  66. package/docs/PutCourseEnrollment.md +0 -2
  67. package/docs/PutPortalCertificateTemplate.md +40 -0
  68. package/package.json +1 -1
  69. package/src/apis/CertificateTemplateApi.ts +33 -15
  70. package/src/apis/ContentLibraryApi.ts +5 -3
  71. package/src/apis/CourseApi.ts +9 -4
  72. package/src/models/CertificateTemplate.ts +16 -0
  73. package/src/models/ContentLibraryTag.ts +18 -0
  74. package/src/models/ContentLibraryTagItem.ts +3 -1
  75. package/src/models/GetCourse.ts +17 -0
  76. package/src/models/PostCourse.ts +8 -0
  77. package/src/models/PostCourseEnrollment.ts +8 -4
  78. package/src/models/PostPortalCertificateTemplate.ts +106 -0
  79. package/src/models/PutCourse.ts +8 -0
  80. package/src/models/PutCourseEnrollment.ts +0 -17
  81. package/src/models/PutPortalCertificateTemplate.ts +89 -0
  82. package/src/models/index.ts +2 -0
@@ -87,6 +87,18 @@ export interface ContentLibraryTag {
87
87
  * @memberof ContentLibraryTag
88
88
  */
89
89
  questionCount: number;
90
+ /**
91
+ *
92
+ * @type {number}
93
+ * @memberof ContentLibraryTag
94
+ */
95
+ courseCount: number;
96
+ /**
97
+ *
98
+ * @type {number}
99
+ * @memberof ContentLibraryTag
100
+ */
101
+ certificateTemplateCount: number;
90
102
  /**
91
103
  *
92
104
  * @type {number}
@@ -40,6 +40,10 @@ function instanceOfContentLibraryTag(value) {
40
40
  return false;
41
41
  if (!('questionCount' in value) || value['questionCount'] === undefined)
42
42
  return false;
43
+ if (!('courseCount' in value) || value['courseCount'] === undefined)
44
+ return false;
45
+ if (!('certificateTemplateCount' in value) || value['certificateTemplateCount'] === undefined)
46
+ return false;
43
47
  if (!('createdAt' in value) || value['createdAt'] === undefined)
44
48
  return false;
45
49
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -66,6 +70,8 @@ function ContentLibraryTagFromJSONTyped(json, ignoreDiscriminator) {
66
70
  'resourceCount': json['resource_count'],
67
71
  'quizCount': json['quiz_count'],
68
72
  'questionCount': json['question_count'],
73
+ 'courseCount': json['course_count'],
74
+ 'certificateTemplateCount': json['certificate_template_count'],
69
75
  'createdAt': json['created_at'],
70
76
  'updatedAt': json['updated_at'],
71
77
  };
@@ -90,6 +96,8 @@ function ContentLibraryTagToJSONTyped(value, ignoreDiscriminator = false) {
90
96
  'resource_count': value['resourceCount'],
91
97
  'quiz_count': value['quizCount'],
92
98
  'question_count': value['questionCount'],
99
+ 'course_count': value['courseCount'],
100
+ 'certificate_template_count': value['certificateTemplateCount'],
93
101
  'created_at': value['createdAt'],
94
102
  'updated_at': value['updatedAt'],
95
103
  };
@@ -73,6 +73,8 @@ export declare const ContentLibraryTagItemKindEnum: {
73
73
  readonly Resource: "resource";
74
74
  readonly Quiz: "quiz";
75
75
  readonly Question: "question";
76
+ readonly Course: "course";
77
+ readonly CertificateTemplate: "certificate_template";
76
78
  };
77
79
  export type ContentLibraryTagItemKindEnum = typeof ContentLibraryTagItemKindEnum[keyof typeof ContentLibraryTagItemKindEnum];
78
80
  /**
@@ -27,7 +27,9 @@ const ResourceType_1 = require("./ResourceType");
27
27
  exports.ContentLibraryTagItemKindEnum = {
28
28
  Resource: 'resource',
29
29
  Quiz: 'quiz',
30
- Question: 'question'
30
+ Question: 'question',
31
+ Course: 'course',
32
+ CertificateTemplate: 'certificate_template'
31
33
  };
32
34
  /**
33
35
  * Check if a given object implements the ContentLibraryTagItem interface.
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { ContentLibraryTag } from './ContentLibraryTag';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -69,6 +70,12 @@ export interface GetCourse {
69
70
  * @memberof GetCourse
70
71
  */
71
72
  accessFixedEndAt: number | null;
73
+ /**
74
+ *
75
+ * @type {Array<ContentLibraryTag>}
76
+ * @memberof GetCourse
77
+ */
78
+ tags: Array<ContentLibraryTag>;
72
79
  }
73
80
  /**
74
81
  * @export
@@ -19,6 +19,7 @@ exports.GetCourseFromJSON = GetCourseFromJSON;
19
19
  exports.GetCourseFromJSONTyped = GetCourseFromJSONTyped;
20
20
  exports.GetCourseToJSON = GetCourseToJSON;
21
21
  exports.GetCourseToJSONTyped = GetCourseToJSONTyped;
22
+ const ContentLibraryTag_1 = require("./ContentLibraryTag");
22
23
  /**
23
24
  * @export
24
25
  */
@@ -49,6 +50,8 @@ function instanceOfGetCourse(value) {
49
50
  return false;
50
51
  if (!('accessFixedEndAt' in value) || value['accessFixedEndAt'] === undefined)
51
52
  return false;
53
+ if (!('tags' in value) || value['tags'] === undefined)
54
+ return false;
52
55
  return true;
53
56
  }
54
57
  function GetCourseFromJSON(json) {
@@ -68,6 +71,7 @@ function GetCourseFromJSONTyped(json, ignoreDiscriminator) {
68
71
  'accessPolicyType': json['access_policy_type'],
69
72
  'accessDurationDays': json['access_duration_days'],
70
73
  'accessFixedEndAt': json['access_fixed_end_at'],
74
+ 'tags': (json['tags'].map(ContentLibraryTag_1.ContentLibraryTagFromJSON)),
71
75
  };
72
76
  }
73
77
  function GetCourseToJSON(json) {
@@ -86,5 +90,6 @@ function GetCourseToJSONTyped(value, ignoreDiscriminator = false) {
86
90
  'access_policy_type': value['accessPolicyType'],
87
91
  'access_duration_days': value['accessDurationDays'],
88
92
  'access_fixed_end_at': value['accessFixedEndAt'],
93
+ 'tags': (value['tags'].map(ContentLibraryTag_1.ContentLibraryTagToJSON)),
89
94
  };
90
95
  }
@@ -47,6 +47,12 @@ export interface PostCourse {
47
47
  * @memberof PostCourse
48
48
  */
49
49
  accessFixedEndAt?: number | null;
50
+ /**
51
+ *
52
+ * @type {Set<string>}
53
+ * @memberof PostCourse
54
+ */
55
+ tags?: Set<string>;
50
56
  }
51
57
  /**
52
58
  * @export
@@ -50,6 +50,7 @@ function PostCourseFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
51
51
  'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
52
52
  'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
53
+ 'tags': json['tags'] == null ? undefined : new Set(json['tags']),
53
54
  };
54
55
  }
55
56
  function PostCourseToJSON(json) {
@@ -65,5 +66,6 @@ function PostCourseToJSONTyped(value, ignoreDiscriminator = false) {
65
66
  'access_policy_type': value['accessPolicyType'],
66
67
  'access_duration_days': value['accessDurationDays'],
67
68
  'access_fixed_end_at': value['accessFixedEndAt'],
69
+ 'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
68
70
  };
69
71
  }
@@ -40,15 +40,19 @@ export interface PostCourseEnrollment {
40
40
  */
41
41
  notes?: string | null;
42
42
  /**
43
- * The role/type of the user in this enrollment
43
+ * The role/type of this enrollment. A user may have one current Student and
44
+ * one current Instructor enrollment for the same course. Assign both roles
45
+ * with two requests, one for each user_type.
46
+ *
44
47
  * @type {PostCourseEnrollmentUserTypeEnum}
45
48
  * @memberof PostCourseEnrollment
46
49
  */
47
50
  userType?: PostCourseEnrollmentUserTypeEnum | null;
48
51
  /**
49
- * How to handle a learner with a prior terminal enrollment for this course.
50
- * restart creates a new enrollment period; resume reopens the latest terminal
51
- * enrollment. Active enrollments always conflict.
52
+ * How to handle a user with a prior terminal enrollment of the requested
53
+ * user_type for this course. restart creates a new enrollment period; resume
54
+ * reopens the latest terminal enrollment of that type. A current enrollment
55
+ * of the same type always conflicts.
52
56
  *
53
57
  * @type {PostCourseEnrollmentReEnrollmentModeEnum}
54
58
  * @memberof PostCourseEnrollment
@@ -0,0 +1,57 @@
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
+ import type { CertificateCanvasDocument } from './CertificateCanvasDocument';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PostPortalCertificateTemplate
17
+ */
18
+ export interface PostPortalCertificateTemplate {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof PostPortalCertificateTemplate
23
+ */
24
+ name: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof PostPortalCertificateTemplate
29
+ */
30
+ description?: string;
31
+ /**
32
+ *
33
+ * @type {boolean}
34
+ * @memberof PostPortalCertificateTemplate
35
+ */
36
+ isDefault?: boolean;
37
+ /**
38
+ *
39
+ * @type {CertificateCanvasDocument}
40
+ * @memberof PostPortalCertificateTemplate
41
+ */
42
+ designDocument?: CertificateCanvasDocument;
43
+ /**
44
+ *
45
+ * @type {Set<string>}
46
+ * @memberof PostPortalCertificateTemplate
47
+ */
48
+ tags?: Set<string>;
49
+ }
50
+ /**
51
+ * Check if a given object implements the PostPortalCertificateTemplate interface.
52
+ */
53
+ export declare function instanceOfPostPortalCertificateTemplate(value: object): value is PostPortalCertificateTemplate;
54
+ export declare function PostPortalCertificateTemplateFromJSON(json: any): PostPortalCertificateTemplate;
55
+ export declare function PostPortalCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortalCertificateTemplate;
56
+ export declare function PostPortalCertificateTemplateToJSON(json: any): PostPortalCertificateTemplate;
57
+ export declare function PostPortalCertificateTemplateToJSONTyped(value?: PostPortalCertificateTemplate | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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.instanceOfPostPortalCertificateTemplate = instanceOfPostPortalCertificateTemplate;
17
+ exports.PostPortalCertificateTemplateFromJSON = PostPortalCertificateTemplateFromJSON;
18
+ exports.PostPortalCertificateTemplateFromJSONTyped = PostPortalCertificateTemplateFromJSONTyped;
19
+ exports.PostPortalCertificateTemplateToJSON = PostPortalCertificateTemplateToJSON;
20
+ exports.PostPortalCertificateTemplateToJSONTyped = PostPortalCertificateTemplateToJSONTyped;
21
+ const CertificateCanvasDocument_1 = require("./CertificateCanvasDocument");
22
+ /**
23
+ * Check if a given object implements the PostPortalCertificateTemplate interface.
24
+ */
25
+ function instanceOfPostPortalCertificateTemplate(value) {
26
+ if (!('name' in value) || value['name'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ function PostPortalCertificateTemplateFromJSON(json) {
31
+ return PostPortalCertificateTemplateFromJSONTyped(json, false);
32
+ }
33
+ function PostPortalCertificateTemplateFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'name': json['name'],
39
+ 'description': json['description'] == null ? undefined : json['description'],
40
+ 'isDefault': json['is_default'] == null ? undefined : json['is_default'],
41
+ 'designDocument': json['design_document'] == null ? undefined : (0, CertificateCanvasDocument_1.CertificateCanvasDocumentFromJSON)(json['design_document']),
42
+ 'tags': json['tags'] == null ? undefined : new Set(json['tags']),
43
+ };
44
+ }
45
+ function PostPortalCertificateTemplateToJSON(json) {
46
+ return PostPortalCertificateTemplateToJSONTyped(json, false);
47
+ }
48
+ function PostPortalCertificateTemplateToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'name': value['name'],
54
+ 'description': value['description'],
55
+ 'is_default': value['isDefault'],
56
+ 'design_document': (0, CertificateCanvasDocument_1.CertificateCanvasDocumentToJSON)(value['designDocument']),
57
+ 'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
58
+ };
59
+ }
@@ -57,6 +57,12 @@ export interface PutCourse {
57
57
  * @memberof PutCourse
58
58
  */
59
59
  accessFixedEndAt?: number | null;
60
+ /**
61
+ *
62
+ * @type {Set<string>}
63
+ * @memberof PutCourse
64
+ */
65
+ tags?: Set<string>;
60
66
  }
61
67
  /**
62
68
  * @export
@@ -48,6 +48,7 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
48
48
  'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
49
49
  'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
50
50
  'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
51
+ 'tags': json['tags'] == null ? undefined : new Set(json['tags']),
51
52
  };
52
53
  }
53
54
  function PutCourseToJSON(json) {
@@ -64,5 +65,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
64
65
  'access_policy_type': value['accessPolicyType'],
65
66
  'access_duration_days': value['accessDurationDays'],
66
67
  'access_fixed_end_at': value['accessFixedEndAt'],
68
+ 'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
67
69
  };
68
70
  }
@@ -24,12 +24,6 @@ export interface PutCourseEnrollment {
24
24
  * @memberof PutCourseEnrollment
25
25
  */
26
26
  status?: PutCourseEnrollmentStatusEnum;
27
- /**
28
- * The role/type of the user in this enrollment
29
- * @type {PutCourseEnrollmentUserTypeEnum}
30
- * @memberof PutCourseEnrollment
31
- */
32
- userType?: PutCourseEnrollmentUserTypeEnum;
33
27
  /**
34
28
  * End date of the enrollment (Unix timestamp)
35
29
  * @type {number}
@@ -71,14 +65,6 @@ export declare const PutCourseEnrollmentStatusEnum: {
71
65
  readonly Suspended: "Suspended";
72
66
  };
73
67
  export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
74
- /**
75
- * @export
76
- */
77
- export declare const PutCourseEnrollmentUserTypeEnum: {
78
- readonly Student: "Student";
79
- readonly Instructor: "Instructor";
80
- };
81
- export type PutCourseEnrollmentUserTypeEnum = typeof PutCourseEnrollmentUserTypeEnum[keyof typeof PutCourseEnrollmentUserTypeEnum];
82
68
  /**
83
69
  * Check if a given object implements the PutCourseEnrollment interface.
84
70
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.PutCourseEnrollmentUserTypeEnum = exports.PutCourseEnrollmentStatusEnum = void 0;
16
+ exports.PutCourseEnrollmentStatusEnum = void 0;
17
17
  exports.instanceOfPutCourseEnrollment = instanceOfPutCourseEnrollment;
18
18
  exports.PutCourseEnrollmentFromJSON = PutCourseEnrollmentFromJSON;
19
19
  exports.PutCourseEnrollmentFromJSONTyped = PutCourseEnrollmentFromJSONTyped;
@@ -31,13 +31,6 @@ exports.PutCourseEnrollmentStatusEnum = {
31
31
  Archived: 'Archived',
32
32
  Suspended: 'Suspended'
33
33
  };
34
- /**
35
- * @export
36
- */
37
- exports.PutCourseEnrollmentUserTypeEnum = {
38
- Student: 'Student',
39
- Instructor: 'Instructor'
40
- };
41
34
  /**
42
35
  * Check if a given object implements the PutCourseEnrollment interface.
43
36
  */
@@ -53,7 +46,6 @@ function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
53
46
  }
54
47
  return {
55
48
  'status': json['status'] == null ? undefined : json['status'],
56
- 'userType': json['user_type'] == null ? undefined : json['user_type'],
57
49
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
58
50
  'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
59
51
  'notes': json['notes'] == null ? undefined : json['notes'],
@@ -69,7 +61,6 @@ function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
69
61
  }
70
62
  return {
71
63
  'status': value['status'],
72
- 'user_type': value['userType'],
73
64
  'enrollment_date_end': value['enrollmentDateEnd'],
74
65
  'extension_days': value['extensionDays'],
75
66
  'notes': value['notes'],
@@ -0,0 +1,50 @@
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 PutPortalCertificateTemplate
16
+ */
17
+ export interface PutPortalCertificateTemplate {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PutPortalCertificateTemplate
22
+ */
23
+ name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof PutPortalCertificateTemplate
28
+ */
29
+ description?: string;
30
+ /**
31
+ *
32
+ * @type {boolean}
33
+ * @memberof PutPortalCertificateTemplate
34
+ */
35
+ isDefault?: boolean;
36
+ /**
37
+ *
38
+ * @type {Set<string>}
39
+ * @memberof PutPortalCertificateTemplate
40
+ */
41
+ tags?: Set<string>;
42
+ }
43
+ /**
44
+ * Check if a given object implements the PutPortalCertificateTemplate interface.
45
+ */
46
+ export declare function instanceOfPutPortalCertificateTemplate(value: object): value is PutPortalCertificateTemplate;
47
+ export declare function PutPortalCertificateTemplateFromJSON(json: any): PutPortalCertificateTemplate;
48
+ export declare function PutPortalCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalCertificateTemplate;
49
+ export declare function PutPortalCertificateTemplateToJSON(json: any): PutPortalCertificateTemplate;
50
+ export declare function PutPortalCertificateTemplateToJSONTyped(value?: PutPortalCertificateTemplate | 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.instanceOfPutPortalCertificateTemplate = instanceOfPutPortalCertificateTemplate;
17
+ exports.PutPortalCertificateTemplateFromJSON = PutPortalCertificateTemplateFromJSON;
18
+ exports.PutPortalCertificateTemplateFromJSONTyped = PutPortalCertificateTemplateFromJSONTyped;
19
+ exports.PutPortalCertificateTemplateToJSON = PutPortalCertificateTemplateToJSON;
20
+ exports.PutPortalCertificateTemplateToJSONTyped = PutPortalCertificateTemplateToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PutPortalCertificateTemplate interface.
23
+ */
24
+ function instanceOfPutPortalCertificateTemplate(value) {
25
+ return true;
26
+ }
27
+ function PutPortalCertificateTemplateFromJSON(json) {
28
+ return PutPortalCertificateTemplateFromJSONTyped(json, false);
29
+ }
30
+ function PutPortalCertificateTemplateFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': json['name'] == null ? undefined : json['name'],
36
+ 'description': json['description'] == null ? undefined : json['description'],
37
+ 'isDefault': json['is_default'] == null ? undefined : json['is_default'],
38
+ 'tags': json['tags'] == null ? undefined : new Set(json['tags']),
39
+ };
40
+ }
41
+ function PutPortalCertificateTemplateToJSON(json) {
42
+ return PutPortalCertificateTemplateToJSONTyped(json, false);
43
+ }
44
+ function PutPortalCertificateTemplateToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'name': value['name'],
50
+ 'description': value['description'],
51
+ 'is_default': value['isDefault'],
52
+ 'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
53
+ };
54
+ }
@@ -263,6 +263,7 @@ export * from './PostOfferCatalogResponse';
263
263
  export * from './PostOfferCourse';
264
264
  export * from './PostOfferCourseResponse';
265
265
  export * from './PostPortal';
266
+ export * from './PostPortalCertificateTemplate';
266
267
  export * from './PostPortalInvite';
267
268
  export * from './PostQuestion';
268
269
  export * from './PostQuestionAnswerChoicesInner';
@@ -322,6 +323,7 @@ export * from './PutLibraryQuizSessionGrade';
322
323
  export * from './PutLibraryQuizSessionOverride';
323
324
  export * from './PutLibraryQuizVersion';
324
325
  export * from './PutPortalBranding';
326
+ export * from './PutPortalCertificateTemplate';
325
327
  export * from './PutPortalSublicense';
326
328
  export * from './PutPortalUserFieldValues';
327
329
  export * from './PutQuestion';
@@ -281,6 +281,7 @@ __exportStar(require("./PostOfferCatalogResponse"), exports);
281
281
  __exportStar(require("./PostOfferCourse"), exports);
282
282
  __exportStar(require("./PostOfferCourseResponse"), exports);
283
283
  __exportStar(require("./PostPortal"), exports);
284
+ __exportStar(require("./PostPortalCertificateTemplate"), exports);
284
285
  __exportStar(require("./PostPortalInvite"), exports);
285
286
  __exportStar(require("./PostQuestion"), exports);
286
287
  __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
@@ -340,6 +341,7 @@ __exportStar(require("./PutLibraryQuizSessionGrade"), exports);
340
341
  __exportStar(require("./PutLibraryQuizSessionOverride"), exports);
341
342
  __exportStar(require("./PutLibraryQuizVersion"), exports);
342
343
  __exportStar(require("./PutPortalBranding"), exports);
344
+ __exportStar(require("./PutPortalCertificateTemplate"), exports);
343
345
  __exportStar(require("./PutPortalSublicense"), exports);
344
346
  __exportStar(require("./PutPortalUserFieldValues"), exports);
345
347
  __exportStar(require("./PutQuestion"), exports);
@@ -14,6 +14,7 @@ Name | Type
14
14
  `isInherited` | boolean
15
15
  `effectiveSource` | string
16
16
  `effectiveSourcePortalId` | string
17
+ `tags` | [Array&lt;ContentLibraryTag&gt;](ContentLibraryTag.md)
17
18
  `activeVersion` | [CertificateTemplateVersion](CertificateTemplateVersion.md)
18
19
  `draftVersion` | [CertificateTemplateVersion](CertificateTemplateVersion.md)
19
20
  `versions` | [Array&lt;CertificateTemplateVersion&gt;](CertificateTemplateVersion.md)
@@ -36,6 +37,7 @@ const example = {
36
37
  "isInherited": null,
37
38
  "effectiveSource": null,
38
39
  "effectiveSourcePortalId": null,
40
+ "tags": null,
39
41
  "activeVersion": null,
40
42
  "draftVersion": null,
41
43
  "versions": null,
@@ -309,7 +309,7 @@ No authorization required
309
309
 
310
310
  ## getCertificateTemplateList
311
311
 
312
- > GetCertificateTemplateList getCertificateTemplateList()
312
+ > GetCertificateTemplateList getCertificateTemplateList(tagId)
313
313
 
314
314
  List local and inherited certificate designs
315
315
 
@@ -326,8 +326,13 @@ async function example() {
326
326
  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
327
327
  const api = new CertificateTemplateApi();
328
328
 
329
+ const body = {
330
+ // string | Return locally owned certificate designs assigned to this portal tag. (optional)
331
+ tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
332
+ } satisfies GetCertificateTemplateListRequest;
333
+
329
334
  try {
330
- const data = await api.getCertificateTemplateList();
335
+ const data = await api.getCertificateTemplateList(body);
331
336
  console.log(data);
332
337
  } catch (error) {
333
338
  console.error(error);
@@ -340,7 +345,10 @@ example().catch(console.error);
340
345
 
341
346
  ### Parameters
342
347
 
343
- This endpoint does not need any parameter.
348
+
349
+ | Name | Type | Description | Notes |
350
+ |------------- | ------------- | ------------- | -------------|
351
+ | **tagId** | `string` | Return locally owned certificate designs assigned to this portal tag. | [Optional] [Defaults to `undefined`] |
344
352
 
345
353
  ### Return type
346
354
 
@@ -885,7 +893,7 @@ No authorization required
885
893
 
886
894
  ## postCertificateTemplate
887
895
 
888
- > CertificateTemplate postCertificateTemplate(postCertificateTemplate)
896
+ > CertificateTemplate postCertificateTemplate(postPortalCertificateTemplate)
889
897
 
890
898
  Create a portal certificate design and initial draft
891
899
 
@@ -903,8 +911,8 @@ async function example() {
903
911
  const api = new CertificateTemplateApi();
904
912
 
905
913
  const body = {
906
- // PostCertificateTemplate
907
- postCertificateTemplate: ...,
914
+ // PostPortalCertificateTemplate
915
+ postPortalCertificateTemplate: ...,
908
916
  } satisfies PostCertificateTemplateRequest;
909
917
 
910
918
  try {
@@ -924,7 +932,7 @@ example().catch(console.error);
924
932
 
925
933
  | Name | Type | Description | Notes |
926
934
  |------------- | ------------- | ------------- | -------------|
927
- | **postCertificateTemplate** | [PostCertificateTemplate](PostCertificateTemplate.md) | | |
935
+ | **postPortalCertificateTemplate** | [PostPortalCertificateTemplate](PostPortalCertificateTemplate.md) | | |
928
936
 
929
937
  ### Return type
930
938
 
@@ -2151,7 +2159,7 @@ No authorization required
2151
2159
 
2152
2160
  ## putCertificateTemplate
2153
2161
 
2154
- > CertificateTemplate putCertificateTemplate(templateId, putCertificateTemplate)
2162
+ > CertificateTemplate putCertificateTemplate(templateId, putPortalCertificateTemplate)
2155
2163
 
2156
2164
  Update local certificate design metadata
2157
2165
 
@@ -2171,8 +2179,8 @@ async function example() {
2171
2179
  const body = {
2172
2180
  // string
2173
2181
  templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2174
- // PutCertificateTemplate
2175
- putCertificateTemplate: ...,
2182
+ // PutPortalCertificateTemplate
2183
+ putPortalCertificateTemplate: ...,
2176
2184
  } satisfies PutCertificateTemplateRequest;
2177
2185
 
2178
2186
  try {
@@ -2193,7 +2201,7 @@ example().catch(console.error);
2193
2201
  | Name | Type | Description | Notes |
2194
2202
  |------------- | ------------- | ------------- | -------------|
2195
2203
  | **templateId** | `string` | | [Defaults to `undefined`] |
2196
- | **putCertificateTemplate** | [PutCertificateTemplate](PutCertificateTemplate.md) | | |
2204
+ | **putPortalCertificateTemplate** | [PutPortalCertificateTemplate](PutPortalCertificateTemplate.md) | | |
2197
2205
 
2198
2206
  ### Return type
2199
2207