@easyedu/js-lsm-api 1.133.0 → 1.134.0

package/src/models/PutPortalUser.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Admin-managed details for a portal member.
+ * @export
+ * @interface PutPortalUser
+ */
+export interface PutPortalUser {
+    /**
+     * Your own identifier for this user in this portal, unique within the portal. Omit to leave unchanged, send null to clear.
+     * @type {string}
+     * @memberof PutPortalUser
+     */
+    customerRef?: string | null;
+}
+
+/**
+ * Check if a given object implements the PutPortalUser interface.
+ */
+export function instanceOfPutPortalUser(value: object): value is PutPortalUser {
+    return true;
+}
+
+export function PutPortalUserFromJSON(json: any): PutPortalUser {
+    return PutPortalUserFromJSONTyped(json, false);
+}
+
+export function PutPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
+    };
+}
+
+export function PutPortalUserToJSON(json: any): PutPortalUser {
+    return PutPortalUserToJSONTyped(json, false);
+}
+
+export function PutPortalUserToJSONTyped(value?: PutPortalUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customer_ref': value['customerRef'],
+    };
+}
+

package/src/models/PutResource.ts

@@ -37,6 +37,12 @@ export interface PutResource {
      * @memberof PutResource
      */
     tags?: Set<string>;
+    /**
+     * Your own identifier, unique within the portal. Omit to leave unchanged, send null to clear.
+     * @type {string}
+     * @memberof PutResource
+     */
+    customerRef?: string | null;
 }
 
 /**
@@ -59,6 +65,7 @@ export function PutResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+        'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
     };
 }
 
@@ -76,6 +83,7 @@ export function PutResourceToJSONTyped(value?: PutResource | null, ignoreDiscrim
         'name': value['name'],
         'description': value['description'],
         'tags': value['tags'] == null ? undefined : Array.from(value['tags'] as Set<any>),
+        'customer_ref': value['customerRef'],
     };
 }
 

package/src/models/RichTextAsset.ts

@@ -55,6 +55,12 @@ export interface RichTextAsset {
      * @memberof RichTextAsset
      */
     renderUrl: string;
+    /**
+     * Your own identifier for this asset, unique within the portal.
+     * @type {string}
+     * @memberof RichTextAsset
+     */
+    customerRef?: string | null;
 }
 
 /**
@@ -84,6 +90,7 @@ export function RichTextAssetFromJSONTyped(json: any, ignoreDiscriminator: boole
         'width': json['width'] == null ? undefined : json['width'],
         'height': json['height'] == null ? undefined : json['height'],
         'renderUrl': json['render_url'],
+        'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
     };
 }
 
@@ -104,6 +111,7 @@ export function RichTextAssetToJSONTyped(value?: RichTextAsset | null, ignoreDis
         'width': value['width'],
         'height': value['height'],
         'render_url': value['renderUrl'],
+        'customer_ref': value['customerRef'],
     };
 }
 

package/src/models/ZapierCourse.ts

@@ -43,6 +43,12 @@ export interface ZapierCourse {
      * @memberof ZapierCourse
      */
     published: boolean;
+    /**
+     * Your own identifier for this course, unique within the portal. Integrations such as Zapier can use it in place of id.
+     * @type {string}
+     * @memberof ZapierCourse
+     */
+    customerRef: string | null;
 }
 
 /**
@@ -53,6 +59,7 @@ export function instanceOfZapierCourse(value: object): value is ZapierCourse {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('published' in value) || value['published'] === undefined) return false;
+    if (!('customerRef' in value) || value['customerRef'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +77,7 @@ export function ZapierCourseFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'name': json['name'],
         'description': json['description'],
         'published': json['published'],
+        'customerRef': json['customer_ref'],
     };
 }
 
@@ -88,6 +96,7 @@ export function ZapierCourseToJSONTyped(value?: ZapierCourse | null, ignoreDiscr
         'name': value['name'],
         'description': value['description'],
         'published': value['published'],
+        'customer_ref': value['customerRef'],
     };
 }
 

package/src/models/ZapierEnrollment.ts

@@ -67,6 +67,18 @@ export interface ZapierEnrollment {
      * @memberof ZapierEnrollment
      */
     idempotentReplay: boolean;
+    /**
+     * Your identifier for the course, if set.
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    courseCustomerRef: string | null;
+    /**
+     * Your identifier for the learner, if set.
+     * @type {string}
+     * @memberof ZapierEnrollment
+     */
+    userCustomerRef: string | null;
 }
 
 /**
@@ -80,6 +92,8 @@ export function instanceOfZapierEnrollment(value: object): value is ZapierEnroll
     if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
     if (!('created' in value) || value['created'] === undefined) return false;
     if (!('idempotentReplay' in value) || value['idempotentReplay'] === undefined) return false;
+    if (!('courseCustomerRef' in value) || value['courseCustomerRef'] === undefined) return false;
+    if (!('userCustomerRef' in value) || value['userCustomerRef'] === undefined) return false;
     return true;
 }
 
@@ -101,6 +115,8 @@ export function ZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: bo
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'created': json['created'],
         'idempotentReplay': json['idempotent_replay'],
+        'courseCustomerRef': json['course_customer_ref'],
+        'userCustomerRef': json['user_customer_ref'],
     };
 }
 
@@ -123,6 +139,8 @@ export function ZapierEnrollmentToJSONTyped(value?: ZapierEnrollment | null, ign
         'enrollment_date_end': value['enrollmentDateEnd'],
         'created': value['created'],
         'idempotent_replay': value['idempotentReplay'],
+        'course_customer_ref': value['courseCustomerRef'],
+        'user_customer_ref': value['userCustomerRef'],
     };
 }
 

package/src/models/ZapierUser.ts

@@ -49,6 +49,12 @@ export interface ZapierUser {
      * @memberof ZapierUser
      */
     created: boolean;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ZapierUser
+     */
+    customerRef: string | null;
 }
 
 /**
@@ -60,6 +66,7 @@ export function instanceOfZapierUser(value: object): value is ZapierUser {
     if (!('firstName' in value) || value['firstName'] === undefined) return false;
     if (!('lastName' in value) || value['lastName'] === undefined) return false;
     if (!('created' in value) || value['created'] === undefined) return false;
+    if (!('customerRef' in value) || value['customerRef'] === undefined) return false;
     return true;
 }
 
@@ -78,6 +85,7 @@ export function ZapierUserFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'firstName': json['first_name'],
         'lastName': json['last_name'],
         'created': json['created'],
+        'customerRef': json['customer_ref'],
     };
 }
 
@@ -97,6 +105,7 @@ export function ZapierUserToJSONTyped(value?: ZapierUser | null, ignoreDiscrimin
         'first_name': value['firstName'],
         'last_name': value['lastName'],
         'created': value['created'],
+        'customer_ref': value['customerRef'],
     };
 }
 

package/src/models/index.ts

@@ -340,6 +340,7 @@ export * from './PutLibraryQuizVersion';
 export * from './PutPortalBranding';
 export * from './PutPortalCertificateTemplate';
 export * from './PutPortalSublicense';
+export * from './PutPortalUser';
 export * from './PutPortalUserFieldValues';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';