@easyedu/js-lsm-api 1.133.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 (140) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +5 -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 +21 -0
  6. package/dist/apis/PortalApi.js +52 -0
  7. package/dist/esm/apis/IntegrationApi.d.ts +7 -3
  8. package/dist/esm/apis/IntegrationApi.js +10 -5
  9. package/dist/esm/apis/PortalApi.d.ts +21 -0
  10. package/dist/esm/apis/PortalApi.js +52 -0
  11. package/dist/esm/models/GetCourse.d.ts +6 -0
  12. package/dist/esm/models/GetCourse.js +4 -0
  13. package/dist/esm/models/GetPortalUser.d.ts +6 -0
  14. package/dist/esm/models/GetPortalUser.js +4 -0
  15. package/dist/esm/models/GetResource.d.ts +6 -0
  16. package/dist/esm/models/GetResource.js +4 -0
  17. package/dist/esm/models/IntegrationEventCourse.d.ts +6 -0
  18. package/dist/esm/models/IntegrationEventCourse.js +2 -0
  19. package/dist/esm/models/IntegrationEventLearner.d.ts +6 -0
  20. package/dist/esm/models/IntegrationEventLearner.js +2 -0
  21. package/dist/esm/models/IntegrationEventUser.d.ts +6 -0
  22. package/dist/esm/models/IntegrationEventUser.js +2 -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/PostPortalInvite.d.ts +6 -0
  26. package/dist/esm/models/PostPortalInvite.js +2 -0
  27. package/dist/esm/models/PostResource.d.ts +6 -0
  28. package/dist/esm/models/PostResource.js +2 -0
  29. package/dist/esm/models/PostRichTextAssetUpload.d.ts +6 -0
  30. package/dist/esm/models/PostRichTextAssetUpload.js +2 -0
  31. package/dist/esm/models/PostZapierEnrollment.d.ts +16 -4
  32. package/dist/esm/models/PostZapierEnrollment.js +6 -6
  33. package/dist/esm/models/PostZapierShopifyCourseMapping.d.ts +8 -2
  34. package/dist/esm/models/PostZapierShopifyCourseMapping.js +3 -3
  35. package/dist/esm/models/PostZapierUser.d.ts +6 -0
  36. package/dist/esm/models/PostZapierUser.js +2 -0
  37. package/dist/esm/models/PutCourse.d.ts +6 -0
  38. package/dist/esm/models/PutCourse.js +2 -0
  39. package/dist/esm/models/PutPortalUser.d.ts +32 -0
  40. package/dist/esm/models/PutPortalUser.js +41 -0
  41. package/dist/esm/models/PutResource.d.ts +6 -0
  42. package/dist/esm/models/PutResource.js +2 -0
  43. package/dist/esm/models/RichTextAsset.d.ts +6 -0
  44. package/dist/esm/models/RichTextAsset.js +2 -0
  45. package/dist/esm/models/ZapierCourse.d.ts +6 -0
  46. package/dist/esm/models/ZapierCourse.js +4 -0
  47. package/dist/esm/models/ZapierEnrollment.d.ts +12 -0
  48. package/dist/esm/models/ZapierEnrollment.js +8 -0
  49. package/dist/esm/models/ZapierUser.d.ts +6 -0
  50. package/dist/esm/models/ZapierUser.js +4 -0
  51. package/dist/esm/models/index.d.ts +1 -0
  52. package/dist/esm/models/index.js +1 -0
  53. package/dist/models/GetCourse.d.ts +6 -0
  54. package/dist/models/GetCourse.js +4 -0
  55. package/dist/models/GetPortalUser.d.ts +6 -0
  56. package/dist/models/GetPortalUser.js +4 -0
  57. package/dist/models/GetResource.d.ts +6 -0
  58. package/dist/models/GetResource.js +4 -0
  59. package/dist/models/IntegrationEventCourse.d.ts +6 -0
  60. package/dist/models/IntegrationEventCourse.js +2 -0
  61. package/dist/models/IntegrationEventLearner.d.ts +6 -0
  62. package/dist/models/IntegrationEventLearner.js +2 -0
  63. package/dist/models/IntegrationEventUser.d.ts +6 -0
  64. package/dist/models/IntegrationEventUser.js +2 -0
  65. package/dist/models/PostCourse.d.ts +6 -0
  66. package/dist/models/PostCourse.js +2 -0
  67. package/dist/models/PostPortalInvite.d.ts +6 -0
  68. package/dist/models/PostPortalInvite.js +2 -0
  69. package/dist/models/PostResource.d.ts +6 -0
  70. package/dist/models/PostResource.js +2 -0
  71. package/dist/models/PostRichTextAssetUpload.d.ts +6 -0
  72. package/dist/models/PostRichTextAssetUpload.js +2 -0
  73. package/dist/models/PostZapierEnrollment.d.ts +16 -4
  74. package/dist/models/PostZapierEnrollment.js +6 -6
  75. package/dist/models/PostZapierShopifyCourseMapping.d.ts +8 -2
  76. package/dist/models/PostZapierShopifyCourseMapping.js +3 -3
  77. package/dist/models/PostZapierUser.d.ts +6 -0
  78. package/dist/models/PostZapierUser.js +2 -0
  79. package/dist/models/PutCourse.d.ts +6 -0
  80. package/dist/models/PutCourse.js +2 -0
  81. package/dist/models/PutPortalUser.d.ts +32 -0
  82. package/dist/models/PutPortalUser.js +48 -0
  83. package/dist/models/PutResource.d.ts +6 -0
  84. package/dist/models/PutResource.js +2 -0
  85. package/dist/models/RichTextAsset.d.ts +6 -0
  86. package/dist/models/RichTextAsset.js +2 -0
  87. package/dist/models/ZapierCourse.d.ts +6 -0
  88. package/dist/models/ZapierCourse.js +4 -0
  89. package/dist/models/ZapierEnrollment.d.ts +12 -0
  90. package/dist/models/ZapierEnrollment.js +8 -0
  91. package/dist/models/ZapierUser.d.ts +6 -0
  92. package/dist/models/ZapierUser.js +4 -0
  93. package/dist/models/index.d.ts +1 -0
  94. package/dist/models/index.js +1 -0
  95. package/docs/GetCourse.md +2 -0
  96. package/docs/GetPortalUser.md +2 -0
  97. package/docs/GetResource.md +2 -0
  98. package/docs/IntegrationApi.md +15 -6
  99. package/docs/IntegrationEventCourse.md +2 -0
  100. package/docs/IntegrationEventLearner.md +2 -0
  101. package/docs/IntegrationEventUser.md +2 -0
  102. package/docs/PortalApi.md +78 -0
  103. package/docs/PostCourse.md +2 -0
  104. package/docs/PostPortalInvite.md +2 -0
  105. package/docs/PostResource.md +2 -0
  106. package/docs/PostRichTextAssetUpload.md +2 -0
  107. package/docs/PostZapierEnrollment.md +4 -0
  108. package/docs/PostZapierShopifyCourseMapping.md +2 -0
  109. package/docs/PostZapierUser.md +2 -0
  110. package/docs/PutCourse.md +2 -0
  111. package/docs/PutPortalUser.md +35 -0
  112. package/docs/PutResource.md +2 -0
  113. package/docs/RichTextAsset.md +2 -0
  114. package/docs/ZapierCourse.md +2 -0
  115. package/docs/ZapierEnrollment.md +4 -0
  116. package/docs/ZapierUser.md +2 -0
  117. package/package.json +1 -1
  118. package/src/apis/IntegrationApi.ts +15 -10
  119. package/src/apis/PortalApi.ts +81 -0
  120. package/src/models/GetCourse.ts +9 -0
  121. package/src/models/GetPortalUser.ts +9 -0
  122. package/src/models/GetResource.ts +9 -0
  123. package/src/models/IntegrationEventCourse.ts +8 -0
  124. package/src/models/IntegrationEventLearner.ts +8 -0
  125. package/src/models/IntegrationEventUser.ts +8 -0
  126. package/src/models/PostCourse.ts +8 -0
  127. package/src/models/PostPortalInvite.ts +8 -0
  128. package/src/models/PostResource.ts +8 -0
  129. package/src/models/PostRichTextAssetUpload.ts +8 -0
  130. package/src/models/PostZapierEnrollment.ts +22 -8
  131. package/src/models/PostZapierShopifyCourseMapping.ts +11 -4
  132. package/src/models/PostZapierUser.ts +8 -0
  133. package/src/models/PutCourse.ts +8 -0
  134. package/src/models/PutPortalUser.ts +65 -0
  135. package/src/models/PutResource.ts +8 -0
  136. package/src/models/RichTextAsset.ts +8 -0
  137. package/src/models/ZapierCourse.ts +9 -0
  138. package/src/models/ZapierEnrollment.ts +18 -0
  139. package/src/models/ZapierUser.ts +9 -0
  140. package/src/models/index.ts +1 -0
@@ -37,6 +37,7 @@ export function IntegrationEventUserFromJSONTyped(json, ignoreDiscriminator) {
37
37
  'email': json['email'],
38
38
  'firstName': json['first_name'],
39
39
  'lastName': json['last_name'],
40
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
40
41
  };
41
42
  }
42
43
  export function IntegrationEventUserToJSON(json) {
@@ -51,5 +52,6 @@ export function IntegrationEventUserToJSONTyped(value, ignoreDiscriminator = fal
51
52
  'email': value['email'],
52
53
  'first_name': value['firstName'],
53
54
  'last_name': value['lastName'],
55
+ 'customer_ref': value['customerRef'],
54
56
  };
55
57
  }
@@ -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
@@ -43,6 +43,7 @@ export function PostCourseFromJSONTyped(json, ignoreDiscriminator) {
43
43
  'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
44
44
  'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
45
45
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
46
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
46
47
  };
47
48
  }
48
49
  export function PostCourseToJSON(json) {
@@ -59,5 +60,6 @@ export function PostCourseToJSONTyped(value, ignoreDiscriminator = false) {
59
60
  'access_duration_days': value['accessDurationDays'],
60
61
  'access_fixed_end_at': value['accessFixedEndAt'],
61
62
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
63
+ 'customer_ref': value['customerRef'],
62
64
  };
63
65
  }
@@ -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
@@ -49,6 +49,7 @@ export function PostPortalInviteFromJSONTyped(json, ignoreDiscriminator) {
49
49
  'firstName': json['first_name'],
50
50
  'lastName': json['last_name'],
51
51
  'userType': json['user_type'],
52
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
52
53
  };
53
54
  }
54
55
  export function PostPortalInviteToJSON(json) {
@@ -63,5 +64,6 @@ export function PostPortalInviteToJSONTyped(value, ignoreDiscriminator = false)
63
64
  'first_name': value['firstName'],
64
65
  'last_name': value['lastName'],
65
66
  'user_type': value['userType'],
67
+ 'customer_ref': value['customerRef'],
66
68
  };
67
69
  }
@@ -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.
@@ -37,6 +37,7 @@ export function PostResourceFromJSONTyped(json, ignoreDiscriminator) {
37
37
  'linkUrl': json['link_url'] == null ? undefined : json['link_url'],
38
38
  'richText': json['rich_text'] == null ? undefined : RichTextInputFromJSON(json['rich_text']),
39
39
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
40
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
40
41
  };
41
42
  }
42
43
  export function PostResourceToJSON(json) {
@@ -53,5 +54,6 @@ export function PostResourceToJSONTyped(value, ignoreDiscriminator = false) {
53
54
  'link_url': value['linkUrl'],
54
55
  'rich_text': RichTextInputToJSON(value['richText']),
55
56
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
57
+ 'customer_ref': value['customerRef'],
56
58
  };
57
59
  }
@@ -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
@@ -45,6 +45,7 @@ export function PostRichTextAssetUploadFromJSONTyped(json, ignoreDiscriminator)
45
45
  'width': json['width'] == null ? undefined : json['width'],
46
46
  'height': json['height'] == null ? undefined : json['height'],
47
47
  'usageContext': json['usage_context'],
48
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
48
49
  };
49
50
  }
50
51
  export function PostRichTextAssetUploadToJSON(json) {
@@ -61,5 +62,6 @@ export function PostRichTextAssetUploadToJSONTyped(value, ignoreDiscriminator =
61
62
  'width': value['width'],
62
63
  'height': value['height'],
63
64
  'usage_context': value['usageContext'],
65
+ 'customer_ref': value['customerRef'],
64
66
  };
65
67
  }
@@ -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
@@ -22,10 +22,6 @@ export const PostZapierEnrollmentReEnrollmentModeEnum = {
22
22
  * Check if a given object implements the PostZapierEnrollment interface.
23
23
  */
24
24
  export function instanceOfPostZapierEnrollment(value) {
25
- if (!('courseId' in value) || value['courseId'] === undefined)
26
- return false;
27
- if (!('userId' in value) || value['userId'] === undefined)
28
- return false;
29
25
  return true;
30
26
  }
31
27
  export function PostZapierEnrollmentFromJSON(json) {
@@ -36,13 +32,15 @@ export function PostZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
36
32
  return json;
37
33
  }
38
34
  return {
39
- 'courseId': json['course_id'],
40
- 'userId': json['user_id'],
35
+ 'courseId': json['course_id'] == null ? undefined : json['course_id'],
36
+ 'userId': json['user_id'] == null ? undefined : json['user_id'],
41
37
  'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
42
38
  'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
43
39
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
44
40
  'notes': json['notes'] == null ? undefined : json['notes'],
45
41
  'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
42
+ 'courseCustomerRef': json['course_customer_ref'] == null ? undefined : json['course_customer_ref'],
43
+ 'userCustomerRef': json['user_customer_ref'] == null ? undefined : json['user_customer_ref'],
46
44
  };
47
45
  }
48
46
  export function PostZapierEnrollmentToJSON(json) {
@@ -60,5 +58,7 @@ export function PostZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = fal
60
58
  'enrollment_date_end': value['enrollmentDateEnd'],
61
59
  'notes': value['notes'],
62
60
  're_enrollment_mode': value['reEnrollmentMode'],
61
+ 'course_customer_ref': value['courseCustomerRef'],
62
+ 'user_customer_ref': value['userCustomerRef'],
63
63
  };
64
64
  }
@@ -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.
@@ -19,8 +19,6 @@ export function instanceOfPostZapierShopifyCourseMapping(value) {
19
19
  return false;
20
20
  if (!('variantId' in value) || value['variantId'] === undefined)
21
21
  return false;
22
- if (!('courseId' in value) || value['courseId'] === undefined)
23
- return false;
24
22
  return true;
25
23
  }
26
24
  export function PostZapierShopifyCourseMappingFromJSON(json) {
@@ -34,7 +32,8 @@ export function PostZapierShopifyCourseMappingFromJSONTyped(json, ignoreDiscrimi
34
32
  'shopDomain': json['shop_domain'],
35
33
  'variantId': json['variant_id'],
36
34
  'productId': json['product_id'] == null ? undefined : json['product_id'],
37
- 'courseId': json['course_id'],
35
+ 'courseId': json['course_id'] == null ? undefined : json['course_id'],
36
+ 'courseCustomerRef': json['course_customer_ref'] == null ? undefined : json['course_customer_ref'],
38
37
  };
39
38
  }
40
39
  export function PostZapierShopifyCourseMappingToJSON(json) {
@@ -49,5 +48,6 @@ export function PostZapierShopifyCourseMappingToJSONTyped(value, ignoreDiscrimin
49
48
  'variant_id': value['variantId'],
50
49
  'product_id': value['productId'],
51
50
  'course_id': value['courseId'],
51
+ 'course_customer_ref': value['courseCustomerRef'],
52
52
  };
53
53
  }
@@ -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.
@@ -34,6 +34,7 @@ export function PostZapierUserFromJSONTyped(json, ignoreDiscriminator) {
34
34
  'email': json['email'],
35
35
  'firstName': json['first_name'],
36
36
  'lastName': json['last_name'],
37
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
37
38
  };
38
39
  }
39
40
  export function PostZapierUserToJSON(json) {
@@ -47,5 +48,6 @@ export function PostZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
47
48
  'email': value['email'],
48
49
  'first_name': value['firstName'],
49
50
  'last_name': value['lastName'],
51
+ 'customer_ref': value['customerRef'],
50
52
  };
51
53
  }
@@ -63,6 +63,12 @@ export interface PutCourse {
63
63
  * @memberof PutCourse
64
64
  */
65
65
  tags?: Set<string>;
66
+ /**
67
+ * Your own identifier, unique within the portal. Omit to leave unchanged, send null to clear.
68
+ * @type {string}
69
+ * @memberof PutCourse
70
+ */
71
+ customerRef?: string | null;
66
72
  }
67
73
  /**
68
74
  * @export
@@ -41,6 +41,7 @@ export function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
41
41
  'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
42
42
  'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
43
43
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
44
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
44
45
  };
45
46
  }
46
47
  export function PutCourseToJSON(json) {
@@ -58,5 +59,6 @@ export function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
58
59
  'access_duration_days': value['accessDurationDays'],
59
60
  'access_fixed_end_at': value['accessFixedEndAt'],
60
61
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
62
+ 'customer_ref': value['customerRef'],
61
63
  };
62
64
  }
@@ -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
+ * Admin-managed details for a portal member.
14
+ * @export
15
+ * @interface PutPortalUser
16
+ */
17
+ export interface PutPortalUser {
18
+ /**
19
+ * Your own identifier for this user in this portal, unique within the portal. Omit to leave unchanged, send null to clear.
20
+ * @type {string}
21
+ * @memberof PutPortalUser
22
+ */
23
+ customerRef?: string | null;
24
+ }
25
+ /**
26
+ * Check if a given object implements the PutPortalUser interface.
27
+ */
28
+ export declare function instanceOfPutPortalUser(value: object): value is PutPortalUser;
29
+ export declare function PutPortalUserFromJSON(json: any): PutPortalUser;
30
+ export declare function PutPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalUser;
31
+ export declare function PutPortalUserToJSON(json: any): PutPortalUser;
32
+ export declare function PutPortalUserToJSONTyped(value?: PutPortalUser | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,41 @@
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
+ * Check if a given object implements the PutPortalUser interface.
16
+ */
17
+ export function instanceOfPutPortalUser(value) {
18
+ return true;
19
+ }
20
+ export function PutPortalUserFromJSON(json) {
21
+ return PutPortalUserFromJSONTyped(json, false);
22
+ }
23
+ export function PutPortalUserFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
29
+ };
30
+ }
31
+ export function PutPortalUserToJSON(json) {
32
+ return PutPortalUserToJSONTyped(json, false);
33
+ }
34
+ export function PutPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
35
+ if (value == null) {
36
+ return value;
37
+ }
38
+ return {
39
+ 'customer_ref': value['customerRef'],
40
+ };
41
+ }
@@ -33,6 +33,12 @@ export interface PutResource {
33
33
  * @memberof PutResource
34
34
  */
35
35
  tags?: Set<string>;
36
+ /**
37
+ * Your own identifier, unique within the portal. Omit to leave unchanged, send null to clear.
38
+ * @type {string}
39
+ * @memberof PutResource
40
+ */
41
+ customerRef?: string | null;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the PutResource interface.
@@ -28,6 +28,7 @@ export function PutResourceFromJSONTyped(json, ignoreDiscriminator) {
28
28
  'name': json['name'] == null ? undefined : json['name'],
29
29
  'description': json['description'] == null ? undefined : json['description'],
30
30
  'tags': json['tags'] == null ? undefined : new Set(json['tags']),
31
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
31
32
  };
32
33
  }
33
34
  export function PutResourceToJSON(json) {
@@ -41,5 +42,6 @@ export function PutResourceToJSONTyped(value, ignoreDiscriminator = false) {
41
42
  'name': value['name'],
42
43
  'description': value['description'],
43
44
  'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
45
+ 'customer_ref': value['customerRef'],
44
46
  };
45
47
  }
@@ -51,6 +51,12 @@ export interface RichTextAsset {
51
51
  * @memberof RichTextAsset
52
52
  */
53
53
  renderUrl: string;
54
+ /**
55
+ * Your own identifier for this asset, unique within the portal.
56
+ * @type {string}
57
+ * @memberof RichTextAsset
58
+ */
59
+ customerRef?: string | null;
54
60
  }
55
61
  /**
56
62
  * Check if a given object implements the RichTextAsset interface.
@@ -39,6 +39,7 @@ export function RichTextAssetFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'width': json['width'] == null ? undefined : json['width'],
40
40
  'height': json['height'] == null ? undefined : json['height'],
41
41
  'renderUrl': json['render_url'],
42
+ 'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
42
43
  };
43
44
  }
44
45
  export function RichTextAssetToJSON(json) {
@@ -55,5 +56,6 @@ export function RichTextAssetToJSONTyped(value, ignoreDiscriminator = false) {
55
56
  'width': value['width'],
56
57
  'height': value['height'],
57
58
  'render_url': value['renderUrl'],
59
+ 'customer_ref': value['customerRef'],
58
60
  };
59
61
  }
@@ -39,6 +39,12 @@ export interface ZapierCourse {
39
39
  * @memberof ZapierCourse
40
40
  */
41
41
  published: boolean;
42
+ /**
43
+ * Your own identifier for this course, unique within the portal. Integrations such as Zapier can use it in place of id.
44
+ * @type {string}
45
+ * @memberof ZapierCourse
46
+ */
47
+ customerRef: string | null;
42
48
  }
43
49
  /**
44
50
  * Check if a given object implements the ZapierCourse interface.
@@ -23,6 +23,8 @@ export function instanceOfZapierCourse(value) {
23
23
  return false;
24
24
  if (!('published' in value) || value['published'] === undefined)
25
25
  return false;
26
+ if (!('customerRef' in value) || value['customerRef'] === undefined)
27
+ return false;
26
28
  return true;
27
29
  }
28
30
  export function ZapierCourseFromJSON(json) {
@@ -37,6 +39,7 @@ export function ZapierCourseFromJSONTyped(json, ignoreDiscriminator) {
37
39
  'name': json['name'],
38
40
  'description': json['description'],
39
41
  'published': json['published'],
42
+ 'customerRef': json['customer_ref'],
40
43
  };
41
44
  }
42
45
  export function ZapierCourseToJSON(json) {
@@ -51,5 +54,6 @@ export function ZapierCourseToJSONTyped(value, ignoreDiscriminator = false) {
51
54
  'name': value['name'],
52
55
  'description': value['description'],
53
56
  'published': value['published'],
57
+ 'customer_ref': value['customerRef'],
54
58
  };
55
59
  }
@@ -63,6 +63,18 @@ export interface ZapierEnrollment {
63
63
  * @memberof ZapierEnrollment
64
64
  */
65
65
  idempotentReplay: boolean;
66
+ /**
67
+ * Your identifier for the course, if set.
68
+ * @type {string}
69
+ * @memberof ZapierEnrollment
70
+ */
71
+ courseCustomerRef: string | null;
72
+ /**
73
+ * Your identifier for the learner, if set.
74
+ * @type {string}
75
+ * @memberof ZapierEnrollment
76
+ */
77
+ userCustomerRef: string | null;
66
78
  }
67
79
  /**
68
80
  * Check if a given object implements the ZapierEnrollment interface.
@@ -29,6 +29,10 @@ export function instanceOfZapierEnrollment(value) {
29
29
  return false;
30
30
  if (!('idempotentReplay' in value) || value['idempotentReplay'] === undefined)
31
31
  return false;
32
+ if (!('courseCustomerRef' in value) || value['courseCustomerRef'] === undefined)
33
+ return false;
34
+ if (!('userCustomerRef' in value) || value['userCustomerRef'] === undefined)
35
+ return false;
32
36
  return true;
33
37
  }
34
38
  export function ZapierEnrollmentFromJSON(json) {
@@ -47,6 +51,8 @@ export function ZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
47
51
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
48
52
  'created': json['created'],
49
53
  'idempotentReplay': json['idempotent_replay'],
54
+ 'courseCustomerRef': json['course_customer_ref'],
55
+ 'userCustomerRef': json['user_customer_ref'],
50
56
  };
51
57
  }
52
58
  export function ZapierEnrollmentToJSON(json) {
@@ -65,5 +71,7 @@ export function ZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = false)
65
71
  'enrollment_date_end': value['enrollmentDateEnd'],
66
72
  'created': value['created'],
67
73
  'idempotent_replay': value['idempotentReplay'],
74
+ 'course_customer_ref': value['courseCustomerRef'],
75
+ 'user_customer_ref': value['userCustomerRef'],
68
76
  };
69
77
  }
@@ -45,6 +45,12 @@ export interface ZapierUser {
45
45
  * @memberof ZapierUser
46
46
  */
47
47
  created: boolean;
48
+ /**
49
+ * 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.
50
+ * @type {string}
51
+ * @memberof ZapierUser
52
+ */
53
+ customerRef: string | null;
48
54
  }
49
55
  /**
50
56
  * Check if a given object implements the ZapierUser interface.
@@ -25,6 +25,8 @@ export function instanceOfZapierUser(value) {
25
25
  return false;
26
26
  if (!('created' in value) || value['created'] === undefined)
27
27
  return false;
28
+ if (!('customerRef' in value) || value['customerRef'] === undefined)
29
+ return false;
28
30
  return true;
29
31
  }
30
32
  export function ZapierUserFromJSON(json) {
@@ -40,6 +42,7 @@ export function ZapierUserFromJSONTyped(json, ignoreDiscriminator) {
40
42
  'firstName': json['first_name'],
41
43
  'lastName': json['last_name'],
42
44
  'created': json['created'],
45
+ 'customerRef': json['customer_ref'],
43
46
  };
44
47
  }
45
48
  export function ZapierUserToJSON(json) {
@@ -55,5 +58,6 @@ export function ZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
55
58
  'first_name': value['firstName'],
56
59
  'last_name': value['lastName'],
57
60
  'created': value['created'],
61
+ 'customer_ref': value['customerRef'],
58
62
  };
59
63
  }
@@ -338,6 +338,7 @@ export * from './PutLibraryQuizVersion';
338
338
  export * from './PutPortalBranding';
339
339
  export * from './PutPortalCertificateTemplate';
340
340
  export * from './PutPortalSublicense';
341
+ export * from './PutPortalUser';
341
342
  export * from './PutPortalUserFieldValues';
342
343
  export * from './PutQuestion';
343
344
  export * from './PutQuestionAnswerChoicesInner';
@@ -340,6 +340,7 @@ export * from './PutLibraryQuizVersion';
340
340
  export * from './PutPortalBranding';
341
341
  export * from './PutPortalCertificateTemplate';
342
342
  export * from './PutPortalSublicense';
343
+ export * from './PutPortalUser';
343
344
  export * from './PutPortalUserFieldValues';
344
345
  export * from './PutQuestion';
345
346
  export * from './PutQuestionAnswerChoicesInner';
@@ -76,6 +76,12 @@ export interface GetCourse {
76
76
  * @memberof GetCourse
77
77
  */
78
78
  tags: Array<ContentLibraryTag>;
79
+ /**
80
+ * Your own identifier for this course, unique within the portal. Integrations such as Zapier can use it in place of id.
81
+ * @type {string}
82
+ * @memberof GetCourse
83
+ */
84
+ customerRef: string | null;
79
85
  }
80
86
  /**
81
87
  * @export
@@ -52,6 +52,8 @@ function instanceOfGetCourse(value) {
52
52
  return false;
53
53
  if (!('tags' in value) || value['tags'] === undefined)
54
54
  return false;
55
+ if (!('customerRef' in value) || value['customerRef'] === undefined)
56
+ return false;
55
57
  return true;
56
58
  }
57
59
  function GetCourseFromJSON(json) {
@@ -72,6 +74,7 @@ function GetCourseFromJSONTyped(json, ignoreDiscriminator) {
72
74
  'accessDurationDays': json['access_duration_days'],
73
75
  'accessFixedEndAt': json['access_fixed_end_at'],
74
76
  'tags': (json['tags'].map(ContentLibraryTag_1.ContentLibraryTagFromJSON)),
77
+ 'customerRef': json['customer_ref'],
75
78
  };
76
79
  }
77
80
  function GetCourseToJSON(json) {
@@ -91,5 +94,6 @@ function GetCourseToJSONTyped(value, ignoreDiscriminator = false) {
91
94
  'access_duration_days': value['accessDurationDays'],
92
95
  'access_fixed_end_at': value['accessFixedEndAt'],
93
96
  'tags': (value['tags'].map(ContentLibraryTag_1.ContentLibraryTagToJSON)),
97
+ 'customer_ref': value['customerRef'],
94
98
  };
95
99
  }
@@ -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.