@easyedu/js-lsm-api 1.54.0 → 1.56.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 (65) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +8 -2
  3. package/dist/apis/ContentApi.d.ts +21 -1
  4. package/dist/apis/ContentApi.js +51 -0
  5. package/dist/apis/CourseApi.d.ts +23 -1
  6. package/dist/apis/CourseApi.js +55 -0
  7. package/dist/apis/ModuleApi.d.ts +20 -1
  8. package/dist/apis/ModuleApi.js +47 -0
  9. package/dist/esm/apis/ContentApi.d.ts +21 -1
  10. package/dist/esm/apis/ContentApi.js +52 -1
  11. package/dist/esm/apis/CourseApi.d.ts +23 -1
  12. package/dist/esm/apis/CourseApi.js +56 -1
  13. package/dist/esm/apis/ModuleApi.d.ts +20 -1
  14. package/dist/esm/apis/ModuleApi.js +48 -1
  15. package/dist/esm/models/GetCourseEnrollment.d.ts +15 -1
  16. package/dist/esm/models/GetCourseEnrollment.js +6 -1
  17. package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +5 -0
  18. package/dist/esm/models/GetCourseEnrollmentListItem.js +6 -1
  19. package/dist/esm/models/PostDuplicate.d.ts +32 -0
  20. package/dist/esm/models/PostDuplicate.js +41 -0
  21. package/dist/esm/models/PostDuplicate1.d.ts +32 -0
  22. package/dist/esm/models/PostDuplicate1.js +41 -0
  23. package/dist/esm/models/PostDuplicate2.d.ts +32 -0
  24. package/dist/esm/models/PostDuplicate2.js +41 -0
  25. package/dist/esm/models/PostOfferCatalogResponse.d.ts +25 -1
  26. package/dist/esm/models/PostOfferCatalogResponse.js +12 -0
  27. package/dist/esm/models/PutCourseEnrollment.d.ts +7 -1
  28. package/dist/esm/models/PutCourseEnrollment.js +4 -1
  29. package/dist/esm/models/index.d.ts +3 -0
  30. package/dist/esm/models/index.js +3 -0
  31. package/dist/models/GetCourseEnrollment.d.ts +15 -1
  32. package/dist/models/GetCourseEnrollment.js +6 -1
  33. package/dist/models/GetCourseEnrollmentListItem.d.ts +5 -0
  34. package/dist/models/GetCourseEnrollmentListItem.js +6 -1
  35. package/dist/models/PostDuplicate.d.ts +32 -0
  36. package/dist/models/PostDuplicate.js +48 -0
  37. package/dist/models/PostDuplicate1.d.ts +32 -0
  38. package/dist/models/PostDuplicate1.js +48 -0
  39. package/dist/models/PostDuplicate2.d.ts +32 -0
  40. package/dist/models/PostDuplicate2.js +48 -0
  41. package/dist/models/PostOfferCatalogResponse.d.ts +25 -1
  42. package/dist/models/PostOfferCatalogResponse.js +12 -0
  43. package/dist/models/PutCourseEnrollment.d.ts +7 -1
  44. package/dist/models/PutCourseEnrollment.js +4 -1
  45. package/dist/models/index.d.ts +3 -0
  46. package/dist/models/index.js +3 -0
  47. package/docs/ContentApi.md +78 -0
  48. package/docs/CourseApi.md +86 -2
  49. package/docs/ModuleApi.md +75 -0
  50. package/docs/PostDuplicate.md +35 -0
  51. package/docs/PostDuplicate1.md +35 -0
  52. package/docs/PostDuplicate2.md +35 -0
  53. package/docs/PostOfferCatalogResponse.md +7 -0
  54. package/package.json +1 -1
  55. package/src/apis/ContentApi.ts +76 -0
  56. package/src/apis/CourseApi.ts +78 -0
  57. package/src/apis/ModuleApi.ts +67 -0
  58. package/src/models/GetCourseEnrollment.ts +16 -2
  59. package/src/models/GetCourseEnrollmentListItem.ts +6 -1
  60. package/src/models/PostDuplicate.ts +65 -0
  61. package/src/models/PostDuplicate1.ts +65 -0
  62. package/src/models/PostDuplicate2.ts +65 -0
  63. package/src/models/PostOfferCatalogResponse.ts +34 -1
  64. package/src/models/PutCourseEnrollment.ts +8 -2
  65. package/src/models/index.ts +3 -0
@@ -0,0 +1,65 @@
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
+ * Optional body for duplicating a module
18
+ * @export
19
+ * @interface PostDuplicate1
20
+ */
21
+ export interface PostDuplicate1 {
22
+ /**
23
+ * Name for the duplicated module. Defaults to "{original name} (Copy)" if omitted.
24
+ * @type {string}
25
+ * @memberof PostDuplicate1
26
+ */
27
+ name?: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the PostDuplicate1 interface.
32
+ */
33
+ export function instanceOfPostDuplicate1(value: object): value is PostDuplicate1 {
34
+ return true;
35
+ }
36
+
37
+ export function PostDuplicate1FromJSON(json: any): PostDuplicate1 {
38
+ return PostDuplicate1FromJSONTyped(json, false);
39
+ }
40
+
41
+ export function PostDuplicate1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate1 {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+
47
+ 'name': json['name'] == null ? undefined : json['name'],
48
+ };
49
+ }
50
+
51
+ export function PostDuplicate1ToJSON(json: any): PostDuplicate1 {
52
+ return PostDuplicate1ToJSONTyped(json, false);
53
+ }
54
+
55
+ export function PostDuplicate1ToJSONTyped(value?: PostDuplicate1 | null, ignoreDiscriminator: boolean = false): any {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+
60
+ return {
61
+
62
+ 'name': value['name'],
63
+ };
64
+ }
65
+
@@ -0,0 +1,65 @@
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
+ * Optional body for duplicating a content item
18
+ * @export
19
+ * @interface PostDuplicate2
20
+ */
21
+ export interface PostDuplicate2 {
22
+ /**
23
+ * Name for the duplicated content. Defaults to "{original name} (Copy)" if omitted.
24
+ * @type {string}
25
+ * @memberof PostDuplicate2
26
+ */
27
+ name?: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the PostDuplicate2 interface.
32
+ */
33
+ export function instanceOfPostDuplicate2(value: object): value is PostDuplicate2 {
34
+ return true;
35
+ }
36
+
37
+ export function PostDuplicate2FromJSON(json: any): PostDuplicate2 {
38
+ return PostDuplicate2FromJSONTyped(json, false);
39
+ }
40
+
41
+ export function PostDuplicate2FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate2 {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+
47
+ 'name': json['name'] == null ? undefined : json['name'],
48
+ };
49
+ }
50
+
51
+ export function PostDuplicate2ToJSON(json: any): PostDuplicate2 {
52
+ return PostDuplicate2ToJSONTyped(json, false);
53
+ }
54
+
55
+ export function PostDuplicate2ToJSONTyped(value?: PostDuplicate2 | null, ignoreDiscriminator: boolean = false): any {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+
60
+ return {
61
+
62
+ 'name': value['name'],
63
+ };
64
+ }
65
+
@@ -14,17 +14,41 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
+ * Result of fanning a catalog out into per-course offers. Outcomes are bucketed
18
+ * so operators can distinguish brand-new shares from reactivations of
19
+ * previously-revoked shares, idempotent no-ops on already-active shares, and
20
+ * real failures.
17
21
  *
18
22
  * @export
19
23
  * @interface PostOfferCatalogResponse
20
24
  */
21
25
  export interface PostOfferCatalogResponse {
22
26
  /**
23
- * Number of per-course shares created from this catalog offer
27
+ * Brand-new `course_share` rows inserted from this catalog offer
24
28
  * @type {number}
25
29
  * @memberof PostOfferCatalogResponse
26
30
  */
27
31
  createdShareCount: number;
32
+ /**
33
+ * Existing Revoked or Declined shares that were flipped back to Offered
34
+ * @type {number}
35
+ * @memberof PostOfferCatalogResponse
36
+ */
37
+ reactivatedShareCount: number;
38
+ /**
39
+ * Already-active shares (Offered / AcceptedMirror / AcceptedClone). Terms
40
+ * may have been updated in place without disturbing the target's state.
41
+ *
42
+ * @type {number}
43
+ * @memberof PostOfferCatalogResponse
44
+ */
45
+ unchangedShareCount: number;
46
+ /**
47
+ * Shares that could not be created due to a database or validation error
48
+ * @type {number}
49
+ * @memberof PostOfferCatalogResponse
50
+ */
51
+ failedShareCount: number;
28
52
  }
29
53
 
30
54
  /**
@@ -32,6 +56,9 @@ export interface PostOfferCatalogResponse {
32
56
  */
33
57
  export function instanceOfPostOfferCatalogResponse(value: object): value is PostOfferCatalogResponse {
34
58
  if (!('createdShareCount' in value) || value['createdShareCount'] === undefined) return false;
59
+ if (!('reactivatedShareCount' in value) || value['reactivatedShareCount'] === undefined) return false;
60
+ if (!('unchangedShareCount' in value) || value['unchangedShareCount'] === undefined) return false;
61
+ if (!('failedShareCount' in value) || value['failedShareCount'] === undefined) return false;
35
62
  return true;
36
63
  }
37
64
 
@@ -46,6 +73,9 @@ export function PostOfferCatalogResponseFromJSONTyped(json: any, ignoreDiscrimin
46
73
  return {
47
74
 
48
75
  'createdShareCount': json['created_share_count'],
76
+ 'reactivatedShareCount': json['reactivated_share_count'],
77
+ 'unchangedShareCount': json['unchanged_share_count'],
78
+ 'failedShareCount': json['failed_share_count'],
49
79
  };
50
80
  }
51
81
 
@@ -61,6 +91,9 @@ export function PostOfferCatalogResponseToJSONTyped(value?: PostOfferCatalogResp
61
91
  return {
62
92
 
63
93
  'created_share_count': value['createdShareCount'],
94
+ 'reactivated_share_count': value['reactivatedShareCount'],
95
+ 'unchanged_share_count': value['unchangedShareCount'],
96
+ 'failed_share_count': value['failedShareCount'],
64
97
  };
65
98
  }
66
99
 
@@ -20,7 +20,10 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface PutCourseEnrollment {
22
22
  /**
23
- * Current status of the enrollment
23
+ * Target status for the enrollment. System-managed statuses (InProgress, Expired)
24
+ * cannot be set via this endpoint. Reopening a terminal enrollment to `Enrolled`
25
+ * requires `enrollment_date_end` to still be in the future.
26
+ *
24
27
  * @type {PutCourseEnrollmentStatusEnum}
25
28
  * @memberof PutCourseEnrollment
26
29
  */
@@ -52,7 +55,10 @@ export interface PutCourseEnrollment {
52
55
  export const PutCourseEnrollmentStatusEnum = {
53
56
  Enrolled: 'Enrolled',
54
57
  Completed: 'Completed',
55
- Removed: 'Removed'
58
+ Failed: 'Failed',
59
+ Withdrawn: 'Withdrawn',
60
+ Removed: 'Removed',
61
+ Archived: 'Archived'
56
62
  } as const;
57
63
  export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
58
64
 
@@ -175,6 +175,9 @@ export * from './PostCourse';
175
175
  export * from './PostCourseCatalog';
176
176
  export * from './PostCourseEnrollment';
177
177
  export * from './PostCourseExport';
178
+ export * from './PostDuplicate';
179
+ export * from './PostDuplicate1';
180
+ export * from './PostDuplicate2';
178
181
  export * from './PostLogin';
179
182
  export * from './PostManualQuestionSelection';
180
183
  export * from './PostMessage';