@easyedu/js-lsm-api 1.84.0 → 1.86.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 (109) hide show
  1. package/.openapi-generator/FILES +32 -0
  2. package/README.md +48 -2
  3. package/dist/apis/EmailTemplateApi.d.ts +504 -0
  4. package/dist/apis/EmailTemplateApi.js +1299 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/esm/apis/EmailTemplateApi.d.ts +504 -0
  8. package/dist/esm/apis/EmailTemplateApi.js +1295 -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/EmailTemplateDefinition.d.ts +64 -0
  12. package/dist/esm/models/EmailTemplateDefinition.js +65 -0
  13. package/dist/esm/models/EmailTemplateScope.d.ts +25 -0
  14. package/dist/esm/models/EmailTemplateScope.js +43 -0
  15. package/dist/esm/models/EmailTemplateVariable.d.ts +59 -0
  16. package/dist/esm/models/EmailTemplateVariable.js +63 -0
  17. package/dist/esm/models/EmailTemplateVersion.d.ts +110 -0
  18. package/dist/esm/models/EmailTemplateVersion.js +86 -0
  19. package/dist/esm/models/GetEmailAssetUpload.d.ts +50 -0
  20. package/dist/esm/models/GetEmailAssetUpload.js +55 -0
  21. package/dist/esm/models/GetEmailDelivery.d.ts +123 -0
  22. package/dist/esm/models/GetEmailDelivery.js +93 -0
  23. package/dist/esm/models/GetEmailDeliveryList.d.ts +51 -0
  24. package/dist/esm/models/GetEmailDeliveryList.js +56 -0
  25. package/dist/esm/models/GetEmailTemplate.d.ts +74 -0
  26. package/dist/esm/models/GetEmailTemplate.js +70 -0
  27. package/dist/esm/models/GetEmailTemplateList.d.ts +33 -0
  28. package/dist/esm/models/GetEmailTemplateList.js +44 -0
  29. package/dist/esm/models/GetEmailTemplatePreview.d.ts +44 -0
  30. package/dist/esm/models/GetEmailTemplatePreview.js +51 -0
  31. package/dist/esm/models/PostEmailAssetComplete.d.ts +32 -0
  32. package/dist/esm/models/PostEmailAssetComplete.js +43 -0
  33. package/dist/esm/models/PostEmailAssetUpload.d.ts +54 -0
  34. package/dist/esm/models/PostEmailAssetUpload.js +60 -0
  35. package/dist/esm/models/PostEmailTemplatePreview.d.ts +64 -0
  36. package/dist/esm/models/PostEmailTemplatePreview.js +55 -0
  37. package/dist/esm/models/PostEmailTemplateTestSend.d.ts +32 -0
  38. package/dist/esm/models/PostEmailTemplateTestSend.js +43 -0
  39. package/dist/esm/models/PutEmailTemplateDraft.d.ts +64 -0
  40. package/dist/esm/models/PutEmailTemplateDraft.js +55 -0
  41. package/dist/esm/models/index.d.ts +15 -0
  42. package/dist/esm/models/index.js +15 -0
  43. package/dist/models/EmailTemplateDefinition.d.ts +64 -0
  44. package/dist/models/EmailTemplateDefinition.js +72 -0
  45. package/dist/models/EmailTemplateScope.d.ts +25 -0
  46. package/dist/models/EmailTemplateScope.js +51 -0
  47. package/dist/models/EmailTemplateVariable.d.ts +59 -0
  48. package/dist/models/EmailTemplateVariable.js +71 -0
  49. package/dist/models/EmailTemplateVersion.d.ts +110 -0
  50. package/dist/models/EmailTemplateVersion.js +94 -0
  51. package/dist/models/GetEmailAssetUpload.d.ts +50 -0
  52. package/dist/models/GetEmailAssetUpload.js +62 -0
  53. package/dist/models/GetEmailDelivery.d.ts +123 -0
  54. package/dist/models/GetEmailDelivery.js +101 -0
  55. package/dist/models/GetEmailDeliveryList.d.ts +51 -0
  56. package/dist/models/GetEmailDeliveryList.js +63 -0
  57. package/dist/models/GetEmailTemplate.d.ts +74 -0
  58. package/dist/models/GetEmailTemplate.js +78 -0
  59. package/dist/models/GetEmailTemplateList.d.ts +33 -0
  60. package/dist/models/GetEmailTemplateList.js +51 -0
  61. package/dist/models/GetEmailTemplatePreview.d.ts +44 -0
  62. package/dist/models/GetEmailTemplatePreview.js +58 -0
  63. package/dist/models/PostEmailAssetComplete.d.ts +32 -0
  64. package/dist/models/PostEmailAssetComplete.js +50 -0
  65. package/dist/models/PostEmailAssetUpload.d.ts +54 -0
  66. package/dist/models/PostEmailAssetUpload.js +68 -0
  67. package/dist/models/PostEmailTemplatePreview.d.ts +64 -0
  68. package/dist/models/PostEmailTemplatePreview.js +62 -0
  69. package/dist/models/PostEmailTemplateTestSend.d.ts +32 -0
  70. package/dist/models/PostEmailTemplateTestSend.js +50 -0
  71. package/dist/models/PutEmailTemplateDraft.d.ts +64 -0
  72. package/dist/models/PutEmailTemplateDraft.js +62 -0
  73. package/dist/models/index.d.ts +15 -0
  74. package/dist/models/index.js +15 -0
  75. package/docs/EmailTemplateApi.md +2097 -0
  76. package/docs/EmailTemplateDefinition.md +44 -0
  77. package/docs/EmailTemplateScope.md +32 -0
  78. package/docs/EmailTemplateVariable.md +40 -0
  79. package/docs/EmailTemplateVersion.md +56 -0
  80. package/docs/GetEmailAssetUpload.md +40 -0
  81. package/docs/GetEmailDelivery.md +60 -0
  82. package/docs/GetEmailDeliveryList.md +40 -0
  83. package/docs/GetEmailTemplate.md +44 -0
  84. package/docs/GetEmailTemplateList.md +34 -0
  85. package/docs/GetEmailTemplatePreview.md +38 -0
  86. package/docs/PostEmailAssetComplete.md +34 -0
  87. package/docs/PostEmailAssetUpload.md +38 -0
  88. package/docs/PostEmailTemplatePreview.md +44 -0
  89. package/docs/PostEmailTemplateTestSend.md +34 -0
  90. package/docs/PutEmailTemplateDraft.md +44 -0
  91. package/package.json +1 -1
  92. package/src/apis/EmailTemplateApi.ts +1702 -0
  93. package/src/apis/index.ts +1 -0
  94. package/src/models/EmailTemplateDefinition.ts +128 -0
  95. package/src/models/EmailTemplateScope.ts +53 -0
  96. package/src/models/EmailTemplateVariable.ts +105 -0
  97. package/src/models/EmailTemplateVersion.ts +173 -0
  98. package/src/models/GetEmailAssetUpload.ts +93 -0
  99. package/src/models/GetEmailDelivery.ts +192 -0
  100. package/src/models/GetEmailDeliveryList.ts +101 -0
  101. package/src/models/GetEmailTemplate.ts +137 -0
  102. package/src/models/GetEmailTemplateList.ts +74 -0
  103. package/src/models/GetEmailTemplatePreview.ts +84 -0
  104. package/src/models/PostEmailAssetComplete.ts +66 -0
  105. package/src/models/PostEmailAssetUpload.ts +97 -0
  106. package/src/models/PostEmailTemplatePreview.ts +107 -0
  107. package/src/models/PostEmailTemplateTestSend.ts +66 -0
  108. package/src/models/PutEmailTemplateDraft.ts +107 -0
  109. package/src/models/index.ts +15 -0
@@ -0,0 +1,97 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostEmailAssetUpload
20
+ */
21
+ export interface PostEmailAssetUpload {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PostEmailAssetUpload
26
+ */
27
+ filename: string;
28
+ /**
29
+ *
30
+ * @type {PostEmailAssetUploadContentTypeEnum}
31
+ * @memberof PostEmailAssetUpload
32
+ */
33
+ contentType: PostEmailAssetUploadContentTypeEnum;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof PostEmailAssetUpload
38
+ */
39
+ byteSize: number;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const PostEmailAssetUploadContentTypeEnum = {
47
+ ImagePng: 'image/png',
48
+ ImageJpeg: 'image/jpeg',
49
+ ImageWebp: 'image/webp',
50
+ ImageGif: 'image/gif'
51
+ } as const;
52
+ export type PostEmailAssetUploadContentTypeEnum = typeof PostEmailAssetUploadContentTypeEnum[keyof typeof PostEmailAssetUploadContentTypeEnum];
53
+
54
+
55
+ /**
56
+ * Check if a given object implements the PostEmailAssetUpload interface.
57
+ */
58
+ export function instanceOfPostEmailAssetUpload(value: object): value is PostEmailAssetUpload {
59
+ if (!('filename' in value) || value['filename'] === undefined) return false;
60
+ if (!('contentType' in value) || value['contentType'] === undefined) return false;
61
+ if (!('byteSize' in value) || value['byteSize'] === undefined) return false;
62
+ return true;
63
+ }
64
+
65
+ export function PostEmailAssetUploadFromJSON(json: any): PostEmailAssetUpload {
66
+ return PostEmailAssetUploadFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function PostEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetUpload {
70
+ if (json == null) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'filename': json['filename'],
76
+ 'contentType': json['content_type'],
77
+ 'byteSize': json['byte_size'],
78
+ };
79
+ }
80
+
81
+ export function PostEmailAssetUploadToJSON(json: any): PostEmailAssetUpload {
82
+ return PostEmailAssetUploadToJSONTyped(json, false);
83
+ }
84
+
85
+ export function PostEmailAssetUploadToJSONTyped(value?: PostEmailAssetUpload | null, ignoreDiscriminator: boolean = false): any {
86
+ if (value == null) {
87
+ return value;
88
+ }
89
+
90
+ return {
91
+
92
+ 'filename': value['filename'],
93
+ 'content_type': value['contentType'],
94
+ 'byte_size': value['byteSize'],
95
+ };
96
+ }
97
+
@@ -0,0 +1,107 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostEmailTemplatePreview
20
+ */
21
+ export interface PostEmailTemplatePreview {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PostEmailTemplatePreview
26
+ */
27
+ subjectTemplate: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof PostEmailTemplatePreview
32
+ */
33
+ preheaderTemplate?: string | null;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof PostEmailTemplatePreview
38
+ */
39
+ fromNameTemplate?: string | null;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof PostEmailTemplatePreview
44
+ */
45
+ replyTo?: string | null;
46
+ /**
47
+ *
48
+ * @type {{ [key: string]: any; }}
49
+ * @memberof PostEmailTemplatePreview
50
+ */
51
+ designDocument: { [key: string]: any; };
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof PostEmailTemplatePreview
56
+ */
57
+ changeNotes?: string | null;
58
+ }
59
+
60
+ /**
61
+ * Check if a given object implements the PostEmailTemplatePreview interface.
62
+ */
63
+ export function instanceOfPostEmailTemplatePreview(value: object): value is PostEmailTemplatePreview {
64
+ if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined) return false;
65
+ if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
66
+ return true;
67
+ }
68
+
69
+ export function PostEmailTemplatePreviewFromJSON(json: any): PostEmailTemplatePreview {
70
+ return PostEmailTemplatePreviewFromJSONTyped(json, false);
71
+ }
72
+
73
+ export function PostEmailTemplatePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplatePreview {
74
+ if (json == null) {
75
+ return json;
76
+ }
77
+ return {
78
+
79
+ 'subjectTemplate': json['subject_template'],
80
+ 'preheaderTemplate': json['preheader_template'] == null ? undefined : json['preheader_template'],
81
+ 'fromNameTemplate': json['from_name_template'] == null ? undefined : json['from_name_template'],
82
+ 'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
83
+ 'designDocument': json['design_document'],
84
+ 'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
85
+ };
86
+ }
87
+
88
+ export function PostEmailTemplatePreviewToJSON(json: any): PostEmailTemplatePreview {
89
+ return PostEmailTemplatePreviewToJSONTyped(json, false);
90
+ }
91
+
92
+ export function PostEmailTemplatePreviewToJSONTyped(value?: PostEmailTemplatePreview | null, ignoreDiscriminator: boolean = false): any {
93
+ if (value == null) {
94
+ return value;
95
+ }
96
+
97
+ return {
98
+
99
+ 'subject_template': value['subjectTemplate'],
100
+ 'preheader_template': value['preheaderTemplate'],
101
+ 'from_name_template': value['fromNameTemplate'],
102
+ 'reply_to': value['replyTo'],
103
+ 'design_document': value['designDocument'],
104
+ 'change_notes': value['changeNotes'],
105
+ };
106
+ }
107
+
@@ -0,0 +1,66 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostEmailTemplateTestSend
20
+ */
21
+ export interface PostEmailTemplateTestSend {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PostEmailTemplateTestSend
26
+ */
27
+ recipient: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the PostEmailTemplateTestSend interface.
32
+ */
33
+ export function instanceOfPostEmailTemplateTestSend(value: object): value is PostEmailTemplateTestSend {
34
+ if (!('recipient' in value) || value['recipient'] === undefined) return false;
35
+ return true;
36
+ }
37
+
38
+ export function PostEmailTemplateTestSendFromJSON(json: any): PostEmailTemplateTestSend {
39
+ return PostEmailTemplateTestSendFromJSONTyped(json, false);
40
+ }
41
+
42
+ export function PostEmailTemplateTestSendFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplateTestSend {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+
48
+ 'recipient': json['recipient'],
49
+ };
50
+ }
51
+
52
+ export function PostEmailTemplateTestSendToJSON(json: any): PostEmailTemplateTestSend {
53
+ return PostEmailTemplateTestSendToJSONTyped(json, false);
54
+ }
55
+
56
+ export function PostEmailTemplateTestSendToJSONTyped(value?: PostEmailTemplateTestSend | null, ignoreDiscriminator: boolean = false): any {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+
61
+ return {
62
+
63
+ 'recipient': value['recipient'],
64
+ };
65
+ }
66
+
@@ -0,0 +1,107 @@
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
+ /**
17
+ *
18
+ * @export
19
+ * @interface PutEmailTemplateDraft
20
+ */
21
+ export interface PutEmailTemplateDraft {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PutEmailTemplateDraft
26
+ */
27
+ subjectTemplate: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof PutEmailTemplateDraft
32
+ */
33
+ preheaderTemplate?: string | null;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof PutEmailTemplateDraft
38
+ */
39
+ fromNameTemplate?: string | null;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof PutEmailTemplateDraft
44
+ */
45
+ replyTo?: string | null;
46
+ /**
47
+ *
48
+ * @type {{ [key: string]: any; }}
49
+ * @memberof PutEmailTemplateDraft
50
+ */
51
+ designDocument: { [key: string]: any; };
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof PutEmailTemplateDraft
56
+ */
57
+ changeNotes?: string | null;
58
+ }
59
+
60
+ /**
61
+ * Check if a given object implements the PutEmailTemplateDraft interface.
62
+ */
63
+ export function instanceOfPutEmailTemplateDraft(value: object): value is PutEmailTemplateDraft {
64
+ if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined) return false;
65
+ if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
66
+ return true;
67
+ }
68
+
69
+ export function PutEmailTemplateDraftFromJSON(json: any): PutEmailTemplateDraft {
70
+ return PutEmailTemplateDraftFromJSONTyped(json, false);
71
+ }
72
+
73
+ export function PutEmailTemplateDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutEmailTemplateDraft {
74
+ if (json == null) {
75
+ return json;
76
+ }
77
+ return {
78
+
79
+ 'subjectTemplate': json['subject_template'],
80
+ 'preheaderTemplate': json['preheader_template'] == null ? undefined : json['preheader_template'],
81
+ 'fromNameTemplate': json['from_name_template'] == null ? undefined : json['from_name_template'],
82
+ 'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
83
+ 'designDocument': json['design_document'],
84
+ 'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
85
+ };
86
+ }
87
+
88
+ export function PutEmailTemplateDraftToJSON(json: any): PutEmailTemplateDraft {
89
+ return PutEmailTemplateDraftToJSONTyped(json, false);
90
+ }
91
+
92
+ export function PutEmailTemplateDraftToJSONTyped(value?: PutEmailTemplateDraft | null, ignoreDiscriminator: boolean = false): any {
93
+ if (value == null) {
94
+ return value;
95
+ }
96
+
97
+ return {
98
+
99
+ 'subject_template': value['subjectTemplate'],
100
+ 'preheader_template': value['preheaderTemplate'],
101
+ 'from_name_template': value['fromNameTemplate'],
102
+ 'reply_to': value['replyTo'],
103
+ 'design_document': value['designDocument'],
104
+ 'change_notes': value['changeNotes'],
105
+ };
106
+ }
107
+
@@ -15,6 +15,10 @@ export * from './CriteriaBasedSelection';
15
15
  export * from './CriteriaBasedSelectionCriteria';
16
16
  export * from './CriteriaBasedSelectionDistribution';
17
17
  export * from './EffectiveCertificateConfig';
18
+ export * from './EmailTemplateDefinition';
19
+ export * from './EmailTemplateScope';
20
+ export * from './EmailTemplateVariable';
21
+ export * from './EmailTemplateVersion';
18
22
  export * from './Essay';
19
23
  export * from './Essay1';
20
24
  export * from './FillInBlank';
@@ -70,6 +74,12 @@ export * from './GetCourseVersionItemLaunch';
70
74
  export * from './GetCourseVersionItemSession';
71
75
  export * from './GetCourseVersionList';
72
76
  export * from './GetCourseVersionModule';
77
+ export * from './GetEmailAssetUpload';
78
+ export * from './GetEmailDelivery';
79
+ export * from './GetEmailDeliveryList';
80
+ export * from './GetEmailTemplate';
81
+ export * from './GetEmailTemplateList';
82
+ export * from './GetEmailTemplatePreview';
73
83
  export * from './GetManualQuestionSelectionItem';
74
84
  export * from './GetManualQuestionSelectionList';
75
85
  export * from './GetModule';
@@ -225,6 +235,10 @@ export * from './PostCourseVersionPublish';
225
235
  export * from './PostDuplicate';
226
236
  export * from './PostDuplicate1';
227
237
  export * from './PostDuplicate2';
238
+ export * from './PostEmailAssetComplete';
239
+ export * from './PostEmailAssetUpload';
240
+ export * from './PostEmailTemplatePreview';
241
+ export * from './PostEmailTemplateTestSend';
228
242
  export * from './PostLogin';
229
243
  export * from './PostManualQuestionSelection';
230
244
  export * from './PostMessage';
@@ -278,6 +292,7 @@ export * from './PutCourse';
278
292
  export * from './PutCourseCatalog';
279
293
  export * from './PutCourseEnrollment';
280
294
  export * from './PutCourseVersionItem';
295
+ export * from './PutEmailTemplateDraft';
281
296
  export * from './PutModule';
282
297
  export * from './PutModuleReorder';
283
298
  export * from './PutPortalBranding';