@easyedu/js-lsm-api 1.132.0 → 1.134.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 (170) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +8 -3
  3. package/dist/apis/IntegrationApi.d.ts +7 -3
  4. package/dist/apis/IntegrationApi.js +10 -5
  5. package/dist/apis/PortalApi.d.ts +30 -0
  6. package/dist/apis/PortalApi.js +63 -1
  7. package/dist/apis/QuestionApi.d.ts +19 -0
  8. package/dist/apis/QuestionApi.js +44 -0
  9. package/dist/esm/apis/IntegrationApi.d.ts +7 -3
  10. package/dist/esm/apis/IntegrationApi.js +10 -5
  11. package/dist/esm/apis/PortalApi.d.ts +30 -0
  12. package/dist/esm/apis/PortalApi.js +62 -0
  13. package/dist/esm/apis/QuestionApi.d.ts +19 -0
  14. package/dist/esm/apis/QuestionApi.js +44 -0
  15. package/dist/esm/models/GetCourse.d.ts +6 -0
  16. package/dist/esm/models/GetCourse.js +4 -0
  17. package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +6 -0
  18. package/dist/esm/models/GetCourseEnrollmentListItem.js +2 -0
  19. package/dist/esm/models/GetPortalUser.d.ts +6 -0
  20. package/dist/esm/models/GetPortalUser.js +4 -0
  21. package/dist/esm/models/GetResource.d.ts +6 -0
  22. package/dist/esm/models/GetResource.js +4 -0
  23. package/dist/esm/models/GetResourceUsageCoursesInner.d.ts +6 -0
  24. package/dist/esm/models/GetResourceUsageCoursesInner.js +4 -0
  25. package/dist/esm/models/IntegrationEventCourse.d.ts +6 -0
  26. package/dist/esm/models/IntegrationEventCourse.js +2 -0
  27. package/dist/esm/models/IntegrationEventLearner.d.ts +6 -0
  28. package/dist/esm/models/IntegrationEventLearner.js +2 -0
  29. package/dist/esm/models/IntegrationEventUser.d.ts +6 -0
  30. package/dist/esm/models/IntegrationEventUser.js +2 -0
  31. package/dist/esm/models/PostCourse.d.ts +6 -0
  32. package/dist/esm/models/PostCourse.js +2 -0
  33. package/dist/esm/models/PostPortalInvite.d.ts +6 -0
  34. package/dist/esm/models/PostPortalInvite.js +2 -0
  35. package/dist/esm/models/PostQuestionTags.d.ts +38 -0
  36. package/dist/esm/models/PostQuestionTags.js +47 -0
  37. package/dist/esm/models/PostQuestionTagsResponse.d.ts +32 -0
  38. package/dist/esm/models/PostQuestionTagsResponse.js +43 -0
  39. package/dist/esm/models/PostResource.d.ts +6 -0
  40. package/dist/esm/models/PostResource.js +2 -0
  41. package/dist/esm/models/PostRichTextAssetUpload.d.ts +6 -0
  42. package/dist/esm/models/PostRichTextAssetUpload.js +2 -0
  43. package/dist/esm/models/PostZapierEnrollment.d.ts +16 -4
  44. package/dist/esm/models/PostZapierEnrollment.js +6 -6
  45. package/dist/esm/models/PostZapierShopifyCourseMapping.d.ts +8 -2
  46. package/dist/esm/models/PostZapierShopifyCourseMapping.js +3 -3
  47. package/dist/esm/models/PostZapierUser.d.ts +6 -0
  48. package/dist/esm/models/PostZapierUser.js +2 -0
  49. package/dist/esm/models/PutCourse.d.ts +6 -0
  50. package/dist/esm/models/PutCourse.js +2 -0
  51. package/dist/esm/models/PutPortalUser.d.ts +32 -0
  52. package/dist/esm/models/PutPortalUser.js +41 -0
  53. package/dist/esm/models/PutResource.d.ts +6 -0
  54. package/dist/esm/models/PutResource.js +2 -0
  55. package/dist/esm/models/RichTextAsset.d.ts +6 -0
  56. package/dist/esm/models/RichTextAsset.js +2 -0
  57. package/dist/esm/models/ZapierCourse.d.ts +6 -0
  58. package/dist/esm/models/ZapierCourse.js +4 -0
  59. package/dist/esm/models/ZapierEnrollment.d.ts +12 -0
  60. package/dist/esm/models/ZapierEnrollment.js +8 -0
  61. package/dist/esm/models/ZapierUser.d.ts +6 -0
  62. package/dist/esm/models/ZapierUser.js +4 -0
  63. package/dist/esm/models/index.d.ts +3 -0
  64. package/dist/esm/models/index.js +3 -0
  65. package/dist/models/GetCourse.d.ts +6 -0
  66. package/dist/models/GetCourse.js +4 -0
  67. package/dist/models/GetCourseEnrollmentListItem.d.ts +6 -0
  68. package/dist/models/GetCourseEnrollmentListItem.js +2 -0
  69. package/dist/models/GetPortalUser.d.ts +6 -0
  70. package/dist/models/GetPortalUser.js +4 -0
  71. package/dist/models/GetResource.d.ts +6 -0
  72. package/dist/models/GetResource.js +4 -0
  73. package/dist/models/GetResourceUsageCoursesInner.d.ts +6 -0
  74. package/dist/models/GetResourceUsageCoursesInner.js +4 -0
  75. package/dist/models/IntegrationEventCourse.d.ts +6 -0
  76. package/dist/models/IntegrationEventCourse.js +2 -0
  77. package/dist/models/IntegrationEventLearner.d.ts +6 -0
  78. package/dist/models/IntegrationEventLearner.js +2 -0
  79. package/dist/models/IntegrationEventUser.d.ts +6 -0
  80. package/dist/models/IntegrationEventUser.js +2 -0
  81. package/dist/models/PostCourse.d.ts +6 -0
  82. package/dist/models/PostCourse.js +2 -0
  83. package/dist/models/PostPortalInvite.d.ts +6 -0
  84. package/dist/models/PostPortalInvite.js +2 -0
  85. package/dist/models/PostQuestionTags.d.ts +38 -0
  86. package/dist/models/PostQuestionTags.js +54 -0
  87. package/dist/models/PostQuestionTagsResponse.d.ts +32 -0
  88. package/dist/models/PostQuestionTagsResponse.js +50 -0
  89. package/dist/models/PostResource.d.ts +6 -0
  90. package/dist/models/PostResource.js +2 -0
  91. package/dist/models/PostRichTextAssetUpload.d.ts +6 -0
  92. package/dist/models/PostRichTextAssetUpload.js +2 -0
  93. package/dist/models/PostZapierEnrollment.d.ts +16 -4
  94. package/dist/models/PostZapierEnrollment.js +6 -6
  95. package/dist/models/PostZapierShopifyCourseMapping.d.ts +8 -2
  96. package/dist/models/PostZapierShopifyCourseMapping.js +3 -3
  97. package/dist/models/PostZapierUser.d.ts +6 -0
  98. package/dist/models/PostZapierUser.js +2 -0
  99. package/dist/models/PutCourse.d.ts +6 -0
  100. package/dist/models/PutCourse.js +2 -0
  101. package/dist/models/PutPortalUser.d.ts +32 -0
  102. package/dist/models/PutPortalUser.js +48 -0
  103. package/dist/models/PutResource.d.ts +6 -0
  104. package/dist/models/PutResource.js +2 -0
  105. package/dist/models/RichTextAsset.d.ts +6 -0
  106. package/dist/models/RichTextAsset.js +2 -0
  107. package/dist/models/ZapierCourse.d.ts +6 -0
  108. package/dist/models/ZapierCourse.js +4 -0
  109. package/dist/models/ZapierEnrollment.d.ts +12 -0
  110. package/dist/models/ZapierEnrollment.js +8 -0
  111. package/dist/models/ZapierUser.d.ts +6 -0
  112. package/dist/models/ZapierUser.js +4 -0
  113. package/dist/models/index.d.ts +3 -0
  114. package/dist/models/index.js +3 -0
  115. package/docs/GetCourse.md +2 -0
  116. package/docs/GetCourseEnrollmentListItem.md +2 -0
  117. package/docs/GetPortalUser.md +2 -0
  118. package/docs/GetResource.md +2 -0
  119. package/docs/GetResourceUsageCoursesInner.md +2 -0
  120. package/docs/IntegrationApi.md +15 -6
  121. package/docs/IntegrationEventCourse.md +2 -0
  122. package/docs/IntegrationEventLearner.md +2 -0
  123. package/docs/IntegrationEventUser.md +2 -0
  124. package/docs/PortalApi.md +82 -1
  125. package/docs/PostCourse.md +2 -0
  126. package/docs/PostPortalInvite.md +2 -0
  127. package/docs/PostQuestionTags.md +37 -0
  128. package/docs/PostQuestionTagsResponse.md +34 -0
  129. package/docs/PostResource.md +2 -0
  130. package/docs/PostRichTextAssetUpload.md +2 -0
  131. package/docs/PostZapierEnrollment.md +4 -0
  132. package/docs/PostZapierShopifyCourseMapping.md +2 -0
  133. package/docs/PostZapierUser.md +2 -0
  134. package/docs/PutCourse.md +2 -0
  135. package/docs/PutPortalUser.md +35 -0
  136. package/docs/PutResource.md +2 -0
  137. package/docs/QuestionApi.md +71 -0
  138. package/docs/RichTextAsset.md +2 -0
  139. package/docs/ZapierCourse.md +2 -0
  140. package/docs/ZapierEnrollment.md +4 -0
  141. package/docs/ZapierUser.md +2 -0
  142. package/package.json +1 -1
  143. package/src/apis/IntegrationApi.ts +15 -10
  144. package/src/apis/PortalApi.ts +94 -0
  145. package/src/apis/QuestionApi.ts +63 -0
  146. package/src/models/GetCourse.ts +9 -0
  147. package/src/models/GetCourseEnrollmentListItem.ts +8 -0
  148. package/src/models/GetPortalUser.ts +9 -0
  149. package/src/models/GetResource.ts +9 -0
  150. package/src/models/GetResourceUsageCoursesInner.ts +9 -0
  151. package/src/models/IntegrationEventCourse.ts +8 -0
  152. package/src/models/IntegrationEventLearner.ts +8 -0
  153. package/src/models/IntegrationEventUser.ts +8 -0
  154. package/src/models/PostCourse.ts +8 -0
  155. package/src/models/PostPortalInvite.ts +8 -0
  156. package/src/models/PostQuestionTags.ts +75 -0
  157. package/src/models/PostQuestionTagsResponse.ts +66 -0
  158. package/src/models/PostResource.ts +8 -0
  159. package/src/models/PostRichTextAssetUpload.ts +8 -0
  160. package/src/models/PostZapierEnrollment.ts +22 -8
  161. package/src/models/PostZapierShopifyCourseMapping.ts +11 -4
  162. package/src/models/PostZapierUser.ts +8 -0
  163. package/src/models/PutCourse.ts +8 -0
  164. package/src/models/PutPortalUser.ts +65 -0
  165. package/src/models/PutResource.ts +8 -0
  166. package/src/models/RichTextAsset.ts +8 -0
  167. package/src/models/ZapierCourse.ts +9 -0
  168. package/src/models/ZapierEnrollment.ts +18 -0
  169. package/src/models/ZapierUser.ts +9 -0
  170. package/src/models/index.ts +3 -0
@@ -58,6 +58,12 @@ export interface GetPortalUser {
58
58
  * @memberof GetPortalUser
59
59
  */
60
60
  invitation?: GetPortalInvitationSummary | null;
61
+ /**
62
+ * Your own identifier for this user in this portal, unique within the portal. Integrations such as Zapier can use it in place of the user id.
63
+ * @type {string}
64
+ * @memberof GetPortalUser
65
+ */
66
+ customerRef: string | null;
61
67
  }
62
68
  /**
63
69
  * Check if a given object implements the GetPortalUser interface.
@@ -35,6 +35,8 @@ function instanceOfGetPortalUser(value) {
35
35
  return false;
36
36
  if (!('isActive' in value) || value['isActive'] === undefined)
37
37
  return false;
38
+ if (!('customerRef' in value) || value['customerRef'] === undefined)
39
+ return false;
38
40
  return true;
39
41
  }
40
42
  function GetPortalUserFromJSON(json) {
@@ -52,6 +54,7 @@ function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
52
54
  'role': json['role'],
53
55
  'isActive': json['is_active'],
54
56
  'invitation': json['invitation'] == null ? undefined : (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryFromJSON)(json['invitation']),
57
+ 'customerRef': json['customer_ref'],
55
58
  };
56
59
  }
57
60
  function GetPortalUserToJSON(json) {
@@ -69,5 +72,6 @@ function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
69
72
  'role': value['role'],
70
73
  'is_active': value['isActive'],
71
74
  'invitation': (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryToJSON)(value['invitation']),
75
+ 'customer_ref': value['customerRef'],
72
76
  };
73
77
  }
@@ -114,6 +114,12 @@ export interface GetResource {
114
114
  * @memberof GetResource
115
115
  */
116
116
  archivedAt?: number | null;
117
+ /**
118
+ * Your own identifier for this resource, unique within the portal. Integrations can use it in place of id.
119
+ * @type {string}
120
+ * @memberof GetResource
121
+ */
122
+ customerRef: string | null;
117
123
  }
118
124
  /**
119
125
  * Check if a given object implements the GetResource interface.
@@ -51,6 +51,8 @@ function instanceOfGetResource(value) {
51
51
  return false;
52
52
  if (!('updatedAt' in value) || value['updatedAt'] === undefined)
53
53
  return false;
54
+ if (!('customerRef' in value) || value['customerRef'] === undefined)
55
+ return false;
54
56
  return true;
55
57
  }
56
58
  function GetResourceFromJSON(json) {
@@ -77,6 +79,7 @@ function GetResourceFromJSONTyped(json, ignoreDiscriminator) {
77
79
  'createdAt': json['created_at'],
78
80
  'updatedAt': json['updated_at'],
79
81
  'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
82
+ 'customerRef': json['customer_ref'],
80
83
  };
81
84
  }
82
85
  function GetResourceToJSON(json) {
@@ -103,5 +106,6 @@ function GetResourceToJSONTyped(value, ignoreDiscriminator = false) {
103
106
  'created_at': value['createdAt'],
104
107
  'updated_at': value['updatedAt'],
105
108
  'archived_at': value['archivedAt'],
109
+ 'customer_ref': value['customerRef'],
106
110
  };
107
111
  }
@@ -22,6 +22,12 @@ export interface GetResourceUsageCoursesInner {
22
22
  * @memberof GetResourceUsageCoursesInner
23
23
  */
24
24
  courseId: string;
25
+ /**
26
+ * Display name of the course
27
+ * @type {string}
28
+ * @memberof GetResourceUsageCoursesInner
29
+ */
30
+ courseName: string;
25
31
  /**
26
32
  *
27
33
  * @type {string}
@@ -25,6 +25,8 @@ const ContentLibraryVersionStatus_1 = require("./ContentLibraryVersionStatus");
25
25
  function instanceOfGetResourceUsageCoursesInner(value) {
26
26
  if (!('courseId' in value) || value['courseId'] === undefined)
27
27
  return false;
28
+ if (!('courseName' in value) || value['courseName'] === undefined)
29
+ return false;
28
30
  if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
29
31
  return false;
30
32
  if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
@@ -46,6 +48,7 @@ function GetResourceUsageCoursesInnerFromJSONTyped(json, ignoreDiscriminator) {
46
48
  }
47
49
  return {
48
50
  'courseId': json['course_id'],
51
+ 'courseName': json['course_name'],
49
52
  'courseVersionId': json['course_version_id'],
50
53
  'courseVersionNumber': json['course_version_number'],
51
54
  'courseStatus': (0, ContentLibraryVersionStatus_1.ContentLibraryVersionStatusFromJSON)(json['course_status']),
@@ -62,6 +65,7 @@ function GetResourceUsageCoursesInnerToJSONTyped(value, ignoreDiscriminator = fa
62
65
  }
63
66
  return {
64
67
  'course_id': value['courseId'],
68
+ 'course_name': value['courseName'],
65
69
  'course_version_id': value['courseVersionId'],
66
70
  'course_version_number': value['courseVersionNumber'],
67
71
  'course_status': (0, ContentLibraryVersionStatus_1.ContentLibraryVersionStatusToJSON)(value['courseStatus']),
@@ -27,6 +27,12 @@ export interface IntegrationEventCourse {
27
27
  * @memberof IntegrationEventCourse
28
28
  */
29
29
  name: string;
30
+ /**
31
+ * Your identifier for this course, if set.
32
+ * @type {string}
33
+ * @memberof IntegrationEventCourse
34
+ */
35
+ customerRef?: string | null;
30
36
  }
31
37
  /**
32
38
  * Check if a given object implements the IntegrationEventCourse interface.
@@ -38,6 +38,7 @@ function IntegrationEventCourseFromJSONTyped(json, ignoreDiscriminator) {
38
38
  return {
39
39
  'id': json['id'],
40
40
  'name': json['name'],
41
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
41
42
  };
42
43
  }
43
44
  function IntegrationEventCourseToJSON(json) {
@@ -50,5 +51,6 @@ function IntegrationEventCourseToJSONTyped(value, ignoreDiscriminator = false) {
50
51
  return {
51
52
  'id': value['id'],
52
53
  'name': value['name'],
54
+ 'customer_ref': value['customerRef'],
53
55
  };
54
56
  }
@@ -39,6 +39,12 @@ export interface IntegrationEventLearner {
39
39
  * @memberof IntegrationEventLearner
40
40
  */
41
41
  lastName: string;
42
+ /**
43
+ * Your identifier for this learner in the event portal, if set.
44
+ * @type {string}
45
+ * @memberof IntegrationEventLearner
46
+ */
47
+ customerRef?: string | null;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the IntegrationEventLearner interface.
@@ -44,6 +44,7 @@ function IntegrationEventLearnerFromJSONTyped(json, ignoreDiscriminator) {
44
44
  'email': json['email'],
45
45
  'firstName': json['first_name'],
46
46
  'lastName': json['last_name'],
47
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
47
48
  };
48
49
  }
49
50
  function IntegrationEventLearnerToJSON(json) {
@@ -58,5 +59,6 @@ function IntegrationEventLearnerToJSONTyped(value, ignoreDiscriminator = false)
58
59
  'email': value['email'],
59
60
  'first_name': value['firstName'],
60
61
  'last_name': value['lastName'],
62
+ 'customer_ref': value['customerRef'],
61
63
  };
62
64
  }
@@ -39,6 +39,12 @@ export interface IntegrationEventUser {
39
39
  * @memberof IntegrationEventUser
40
40
  */
41
41
  lastName: string;
42
+ /**
43
+ * Your identifier for this user in the event portal, if set.
44
+ * @type {string}
45
+ * @memberof IntegrationEventUser
46
+ */
47
+ customerRef?: string | null;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the IntegrationEventUser interface.
@@ -44,6 +44,7 @@ function IntegrationEventUserFromJSONTyped(json, ignoreDiscriminator) {
44
44
  'email': json['email'],
45
45
  'firstName': json['first_name'],
46
46
  'lastName': json['last_name'],
47
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
47
48
  };
48
49
  }
49
50
  function IntegrationEventUserToJSON(json) {
@@ -58,5 +59,6 @@ function IntegrationEventUserToJSONTyped(value, ignoreDiscriminator = false) {
58
59
  'email': value['email'],
59
60
  'first_name': value['firstName'],
60
61
  'last_name': value['lastName'],
62
+ 'customer_ref': value['customerRef'],
61
63
  };
62
64
  }
@@ -53,6 +53,12 @@ export interface PostCourse {
53
53
  * @memberof PostCourse
54
54
  */
55
55
  tags?: Set<string>;
56
+ /**
57
+ * Your own identifier for this course, unique within the portal. Integrations such as Zapier can use it in place of id.
58
+ * @type {string}
59
+ * @memberof PostCourse
60
+ */
61
+ customerRef?: string | null;
56
62
  }
57
63
  /**
58
64
  * @export
@@ -51,6 +51,7 @@ function PostCourseFromJSONTyped(json, ignoreDiscriminator) {
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
53
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
54
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
54
55
  };
55
56
  }
56
57
  function PostCourseToJSON(json) {
@@ -67,5 +68,6 @@ function PostCourseToJSONTyped(value, ignoreDiscriminator = false) {
67
68
  'access_duration_days': value['accessDurationDays'],
68
69
  'access_fixed_end_at': value['accessFixedEndAt'],
69
70
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
71
+ 'customer_ref': value['customerRef'],
70
72
  };
71
73
  }
@@ -39,6 +39,12 @@ export interface PostPortalInvite {
39
39
  * @memberof PostPortalInvite
40
40
  */
41
41
  userType: PostPortalInviteUserTypeEnum;
42
+ /**
43
+ * Your own identifier for this user in this portal, unique within the portal. Integrations such as Zapier can use it in place of the user id.
44
+ * @type {string}
45
+ * @memberof PostPortalInvite
46
+ */
47
+ customerRef?: string | null;
42
48
  }
43
49
  /**
44
50
  * @export
@@ -57,6 +57,7 @@ function PostPortalInviteFromJSONTyped(json, ignoreDiscriminator) {
57
57
  'firstName': json['first_name'],
58
58
  'lastName': json['last_name'],
59
59
  'userType': json['user_type'],
60
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
60
61
  };
61
62
  }
62
63
  function PostPortalInviteToJSON(json) {
@@ -71,5 +72,6 @@ function PostPortalInviteToJSONTyped(value, ignoreDiscriminator = false) {
71
72
  'first_name': value['firstName'],
72
73
  'last_name': value['lastName'],
73
74
  'user_type': value['userType'],
75
+ 'customer_ref': value['customerRef'],
74
76
  };
75
77
  }
@@ -0,0 +1,38 @@
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
+ * Adds shared tags to several questions at once without creating new question versions.
14
+ * @export
15
+ * @interface PostQuestionTags
16
+ */
17
+ export interface PostQuestionTags {
18
+ /**
19
+ * External IDs of the questions to tag
20
+ * @type {Array<string>}
21
+ * @memberof PostQuestionTags
22
+ */
23
+ questionIds: Array<string>;
24
+ /**
25
+ * Tag names to add. Existing tags on each question are kept.
26
+ * @type {Array<string>}
27
+ * @memberof PostQuestionTags
28
+ */
29
+ tags: Array<string>;
30
+ }
31
+ /**
32
+ * Check if a given object implements the PostQuestionTags interface.
33
+ */
34
+ export declare function instanceOfPostQuestionTags(value: object): value is PostQuestionTags;
35
+ export declare function PostQuestionTagsFromJSON(json: any): PostQuestionTags;
36
+ export declare function PostQuestionTagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionTags;
37
+ export declare function PostQuestionTagsToJSON(json: any): PostQuestionTags;
38
+ export declare function PostQuestionTagsToJSONTyped(value?: PostQuestionTags | 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.instanceOfPostQuestionTags = instanceOfPostQuestionTags;
17
+ exports.PostQuestionTagsFromJSON = PostQuestionTagsFromJSON;
18
+ exports.PostQuestionTagsFromJSONTyped = PostQuestionTagsFromJSONTyped;
19
+ exports.PostQuestionTagsToJSON = PostQuestionTagsToJSON;
20
+ exports.PostQuestionTagsToJSONTyped = PostQuestionTagsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PostQuestionTags interface.
23
+ */
24
+ function instanceOfPostQuestionTags(value) {
25
+ if (!('questionIds' in value) || value['questionIds'] === undefined)
26
+ return false;
27
+ if (!('tags' in value) || value['tags'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function PostQuestionTagsFromJSON(json) {
32
+ return PostQuestionTagsFromJSONTyped(json, false);
33
+ }
34
+ function PostQuestionTagsFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'questionIds': json['question_ids'],
40
+ 'tags': json['tags'],
41
+ };
42
+ }
43
+ function PostQuestionTagsToJSON(json) {
44
+ return PostQuestionTagsToJSONTyped(json, false);
45
+ }
46
+ function PostQuestionTagsToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'question_ids': value['questionIds'],
52
+ 'tags': value['tags'],
53
+ };
54
+ }
@@ -0,0 +1,32 @@
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 PostQuestionTagsResponse
16
+ */
17
+ export interface PostQuestionTagsResponse {
18
+ /**
19
+ * Number of questions that received the tags
20
+ * @type {number}
21
+ * @memberof PostQuestionTagsResponse
22
+ */
23
+ updatedCount: number;
24
+ }
25
+ /**
26
+ * Check if a given object implements the PostQuestionTagsResponse interface.
27
+ */
28
+ export declare function instanceOfPostQuestionTagsResponse(value: object): value is PostQuestionTagsResponse;
29
+ export declare function PostQuestionTagsResponseFromJSON(json: any): PostQuestionTagsResponse;
30
+ export declare function PostQuestionTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionTagsResponse;
31
+ export declare function PostQuestionTagsResponseToJSON(json: any): PostQuestionTagsResponse;
32
+ export declare function PostQuestionTagsResponseToJSONTyped(value?: PostQuestionTagsResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
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.instanceOfPostQuestionTagsResponse = instanceOfPostQuestionTagsResponse;
17
+ exports.PostQuestionTagsResponseFromJSON = PostQuestionTagsResponseFromJSON;
18
+ exports.PostQuestionTagsResponseFromJSONTyped = PostQuestionTagsResponseFromJSONTyped;
19
+ exports.PostQuestionTagsResponseToJSON = PostQuestionTagsResponseToJSON;
20
+ exports.PostQuestionTagsResponseToJSONTyped = PostQuestionTagsResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PostQuestionTagsResponse interface.
23
+ */
24
+ function instanceOfPostQuestionTagsResponse(value) {
25
+ if (!('updatedCount' in value) || value['updatedCount'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function PostQuestionTagsResponseFromJSON(json) {
30
+ return PostQuestionTagsResponseFromJSONTyped(json, false);
31
+ }
32
+ function PostQuestionTagsResponseFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'updatedCount': json['updated_count'],
38
+ };
39
+ }
40
+ function PostQuestionTagsResponseToJSON(json) {
41
+ return PostQuestionTagsResponseToJSONTyped(json, false);
42
+ }
43
+ function PostQuestionTagsResponseToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'updated_count': value['updatedCount'],
49
+ };
50
+ }
@@ -53,6 +53,12 @@ export interface PostResource {
53
53
  * @memberof PostResource
54
54
  */
55
55
  tags?: Set<string>;
56
+ /**
57
+ * Your own identifier for this resource, unique within the portal. Integrations can use it in place of id.
58
+ * @type {string}
59
+ * @memberof PostResource
60
+ */
61
+ customerRef?: string | null;
56
62
  }
57
63
  /**
58
64
  * Check if a given object implements the PostResource interface.
@@ -44,6 +44,7 @@ function PostResourceFromJSONTyped(json, ignoreDiscriminator) {
44
44
  'linkUrl': json['link_url'] == null ? undefined : json['link_url'],
45
45
  'richText': json['rich_text'] == null ? undefined : (0, RichTextInput_1.RichTextInputFromJSON)(json['rich_text']),
46
46
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
47
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
47
48
  };
48
49
  }
49
50
  function PostResourceToJSON(json) {
@@ -60,5 +61,6 @@ function PostResourceToJSONTyped(value, ignoreDiscriminator = false) {
60
61
  'link_url': value['linkUrl'],
61
62
  'rich_text': (0, RichTextInput_1.RichTextInputToJSON)(value['richText']),
62
63
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
64
+ 'customer_ref': value['customerRef'],
63
65
  };
64
66
  }
@@ -51,6 +51,12 @@ export interface PostRichTextAssetUpload {
51
51
  * @memberof PostRichTextAssetUpload
52
52
  */
53
53
  usageContext: PostRichTextAssetUploadUsageContextEnum;
54
+ /**
55
+ * Your own identifier for this asset, unique within the portal.
56
+ * @type {string}
57
+ * @memberof PostRichTextAssetUpload
58
+ */
59
+ customerRef?: string | null;
54
60
  }
55
61
  /**
56
62
  * @export
@@ -53,6 +53,7 @@ function PostRichTextAssetUploadFromJSONTyped(json, ignoreDiscriminator) {
53
53
  'width': json['width'] == null ? undefined : json['width'],
54
54
  'height': json['height'] == null ? undefined : json['height'],
55
55
  'usageContext': json['usage_context'],
56
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
56
57
  };
57
58
  }
58
59
  function PostRichTextAssetUploadToJSON(json) {
@@ -69,5 +70,6 @@ function PostRichTextAssetUploadToJSONTyped(value, ignoreDiscriminator = false)
69
70
  'width': value['width'],
70
71
  'height': value['height'],
71
72
  'usage_context': value['usageContext'],
73
+ 'customer_ref': value['customerRef'],
72
74
  };
73
75
  }
@@ -16,17 +16,17 @@
16
16
  */
17
17
  export interface PostZapierEnrollment {
18
18
  /**
19
- *
19
+ * Course id. Send this or course_customer_ref.
20
20
  * @type {string}
21
21
  * @memberof PostZapierEnrollment
22
22
  */
23
- courseId: string;
23
+ courseId?: string;
24
24
  /**
25
- *
25
+ * User id. Send this or user_customer_ref.
26
26
  * @type {string}
27
27
  * @memberof PostZapierEnrollment
28
28
  */
29
- userId: string;
29
+ userId?: string;
30
30
  /**
31
31
  * Stable source event ID used to make retries safe.
32
32
  * @type {string}
@@ -57,6 +57,18 @@ export interface PostZapierEnrollment {
57
57
  * @memberof PostZapierEnrollment
58
58
  */
59
59
  reEnrollmentMode?: PostZapierEnrollmentReEnrollmentModeEnum;
60
+ /**
61
+ * Your identifier for the course. Send this or course_id.
62
+ * @type {string}
63
+ * @memberof PostZapierEnrollment
64
+ */
65
+ courseCustomerRef?: string | null;
66
+ /**
67
+ * Your identifier for the learner. Send this or user_id.
68
+ * @type {string}
69
+ * @memberof PostZapierEnrollment
70
+ */
71
+ userCustomerRef?: string | null;
60
72
  }
61
73
  /**
62
74
  * @export
@@ -30,10 +30,6 @@ exports.PostZapierEnrollmentReEnrollmentModeEnum = {
30
30
  * Check if a given object implements the PostZapierEnrollment interface.
31
31
  */
32
32
  function instanceOfPostZapierEnrollment(value) {
33
- if (!('courseId' in value) || value['courseId'] === undefined)
34
- return false;
35
- if (!('userId' in value) || value['userId'] === undefined)
36
- return false;
37
33
  return true;
38
34
  }
39
35
  function PostZapierEnrollmentFromJSON(json) {
@@ -44,13 +40,15 @@ function PostZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
44
40
  return json;
45
41
  }
46
42
  return {
47
- 'courseId': json['course_id'],
48
- 'userId': json['user_id'],
43
+ 'courseId': json['course_id'] == null ? undefined : json['course_id'],
44
+ 'userId': json['user_id'] == null ? undefined : json['user_id'],
49
45
  'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
50
46
  'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
51
47
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
52
48
  'notes': json['notes'] == null ? undefined : json['notes'],
53
49
  'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
50
+ 'courseCustomerRef': json['course_customer_ref'] == null ? undefined : json['course_customer_ref'],
51
+ 'userCustomerRef': json['user_customer_ref'] == null ? undefined : json['user_customer_ref'],
54
52
  };
55
53
  }
56
54
  function PostZapierEnrollmentToJSON(json) {
@@ -68,5 +66,7 @@ function PostZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
68
66
  'enrollment_date_end': value['enrollmentDateEnd'],
69
67
  'notes': value['notes'],
70
68
  're_enrollment_mode': value['reEnrollmentMode'],
69
+ 'course_customer_ref': value['courseCustomerRef'],
70
+ 'user_customer_ref': value['userCustomerRef'],
71
71
  };
72
72
  }
@@ -34,11 +34,17 @@ export interface PostZapierShopifyCourseMapping {
34
34
  */
35
35
  productId?: string | null;
36
36
  /**
37
- * Stable external Edaxu course ID.
37
+ * Stable external Edaxu course ID. Send this or course_customer_ref.
38
38
  * @type {string}
39
39
  * @memberof PostZapierShopifyCourseMapping
40
40
  */
41
- courseId: string;
41
+ courseId?: string;
42
+ /**
43
+ * Your identifier for the course. Send this or course_id.
44
+ * @type {string}
45
+ * @memberof PostZapierShopifyCourseMapping
46
+ */
47
+ courseCustomerRef?: string | null;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the PostZapierShopifyCourseMapping interface.
@@ -26,8 +26,6 @@ function instanceOfPostZapierShopifyCourseMapping(value) {
26
26
  return false;
27
27
  if (!('variantId' in value) || value['variantId'] === undefined)
28
28
  return false;
29
- if (!('courseId' in value) || value['courseId'] === undefined)
30
- return false;
31
29
  return true;
32
30
  }
33
31
  function PostZapierShopifyCourseMappingFromJSON(json) {
@@ -41,7 +39,8 @@ function PostZapierShopifyCourseMappingFromJSONTyped(json, ignoreDiscriminator)
41
39
  'shopDomain': json['shop_domain'],
42
40
  'variantId': json['variant_id'],
43
41
  'productId': json['product_id'] == null ? undefined : json['product_id'],
44
- 'courseId': json['course_id'],
42
+ 'courseId': json['course_id'] == null ? undefined : json['course_id'],
43
+ 'courseCustomerRef': json['course_customer_ref'] == null ? undefined : json['course_customer_ref'],
45
44
  };
46
45
  }
47
46
  function PostZapierShopifyCourseMappingToJSON(json) {
@@ -56,5 +55,6 @@ function PostZapierShopifyCourseMappingToJSONTyped(value, ignoreDiscriminator =
56
55
  'variant_id': value['variantId'],
57
56
  'product_id': value['productId'],
58
57
  'course_id': value['courseId'],
58
+ 'course_customer_ref': value['courseCustomerRef'],
59
59
  };
60
60
  }
@@ -33,6 +33,12 @@ export interface PostZapierUser {
33
33
  * @memberof PostZapierUser
34
34
  */
35
35
  lastName: string;
36
+ /**
37
+ * Your identifier for this learner. If a learner in this portal already has it, that learner is returned. Otherwise it is assigned to the matched or invited learner.
38
+ * @type {string}
39
+ * @memberof PostZapierUser
40
+ */
41
+ customerRef?: string | null;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the PostZapierUser interface.
@@ -41,6 +41,7 @@ function PostZapierUserFromJSONTyped(json, ignoreDiscriminator) {
41
41
  'email': json['email'],
42
42
  'firstName': json['first_name'],
43
43
  'lastName': json['last_name'],
44
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
44
45
  };
45
46
  }
46
47
  function PostZapierUserToJSON(json) {
@@ -54,5 +55,6 @@ function PostZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
54
55
  'email': value['email'],
55
56
  'first_name': value['firstName'],
56
57
  'last_name': value['lastName'],
58
+ 'customer_ref': value['customerRef'],
57
59
  };
58
60
  }