@easyedu/js-lsm-api 1.132.0 → 1.134.0

package/dist/models/PutCourse.d.ts

@@ -63,6 +63,12 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     tags?: Set<string>;
+    /**
+     * Your own identifier, unique within the portal. Omit to leave unchanged, send null to clear.
+     * @type {string}
+     * @memberof PutCourse
+     */
+    customerRef?: string | null;
 }
 /**
  * @export

package/dist/models/PutCourse.js

@@ -49,6 +49,7 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
         'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
         'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+        'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
     };
 }
 function PutCourseToJSON(json) {
@@ -66,5 +67,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'access_duration_days': value['accessDurationDays'],
         'access_fixed_end_at': value['accessFixedEndAt'],
         'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
+        'customer_ref': value['customerRef'],
     };
 }

package/dist/models/PutPortalUser.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfPutPortalUser(value: object): value is PutPortalUser;
+export declare function PutPortalUserFromJSON(json: any): PutPortalUser;
+export declare function PutPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalUser;
+export declare function PutPortalUserToJSON(json: any): PutPortalUser;
+export declare function PutPortalUserToJSONTyped(value?: PutPortalUser | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutPortalUser.js

@@ -0,0 +1,48 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutPortalUser = instanceOfPutPortalUser;
+exports.PutPortalUserFromJSON = PutPortalUserFromJSON;
+exports.PutPortalUserFromJSONTyped = PutPortalUserFromJSONTyped;
+exports.PutPortalUserToJSON = PutPortalUserToJSON;
+exports.PutPortalUserToJSONTyped = PutPortalUserToJSONTyped;
+/**
+ * Check if a given object implements the PutPortalUser interface.
+ */
+function instanceOfPutPortalUser(value) {
+    return true;
+}
+function PutPortalUserFromJSON(json) {
+    return PutPortalUserFromJSONTyped(json, false);
+}
+function PutPortalUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'customerRef': json['customer_ref'] == null ? undefined : json['customer_ref'],
+    };
+}
+function PutPortalUserToJSON(json) {
+    return PutPortalUserToJSONTyped(json, false);
+}
+function PutPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'customer_ref': value['customerRef'],
+    };
+}

package/dist/models/PutResource.d.ts

@@ -33,6 +33,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;
 }
 /**
  * Check if a given object implements the PutResource interface.

package/dist/models/PutResource.js

@@ -35,6 +35,7 @@ function PutResourceFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
 }
 function PutResourceToJSON(json) {
@@ -48,5 +49,6 @@ function PutResourceToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
+        'customer_ref': value['customerRef'],
     };
 }

package/dist/models/RichTextAsset.d.ts

@@ -51,6 +51,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;
 }
 /**
  * Check if a given object implements the RichTextAsset interface.

package/dist/models/RichTextAsset.js

@@ -46,6 +46,7 @@ function RichTextAssetFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
 }
 function RichTextAssetToJSON(json) {
@@ -62,5 +63,6 @@ function RichTextAssetToJSONTyped(value, ignoreDiscriminator = false) {
         'width': value['width'],
         'height': value['height'],
         'render_url': value['renderUrl'],
+        'customer_ref': value['customerRef'],
     };
 }

package/dist/models/ZapierCourse.d.ts

@@ -39,6 +39,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;
 }
 /**
  * Check if a given object implements the ZapierCourse interface.

package/dist/models/ZapierCourse.js

@@ -30,6 +30,8 @@ function instanceOfZapierCourse(value) {
         return false;
     if (!('published' in value) || value['published'] === undefined)
         return false;
+    if (!('customerRef' in value) || value['customerRef'] === undefined)
+        return false;
     return true;
 }
 function ZapierCourseFromJSON(json) {
@@ -44,6 +46,7 @@ function ZapierCourseFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'description': json['description'],
         'published': json['published'],
+        'customerRef': json['customer_ref'],
     };
 }
 function ZapierCourseToJSON(json) {
@@ -58,5 +61,6 @@ function ZapierCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'published': value['published'],
+        'customer_ref': value['customerRef'],
     };
 }

package/dist/models/ZapierEnrollment.d.ts

@@ -63,6 +63,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;
 }
 /**
  * Check if a given object implements the ZapierEnrollment interface.

package/dist/models/ZapierEnrollment.js

@@ -36,6 +36,10 @@ function instanceOfZapierEnrollment(value) {
         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;
 }
 function ZapierEnrollmentFromJSON(json) {
@@ -54,6 +58,8 @@ function ZapierEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
 }
 function ZapierEnrollmentToJSON(json) {
@@ -72,5 +78,7 @@ function ZapierEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
         'enrollment_date_end': value['enrollmentDateEnd'],
         'created': value['created'],
         'idempotent_replay': value['idempotentReplay'],
+        'course_customer_ref': value['courseCustomerRef'],
+        'user_customer_ref': value['userCustomerRef'],
     };
 }

package/dist/models/ZapierUser.d.ts

@@ -45,6 +45,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;
 }
 /**
  * Check if a given object implements the ZapierUser interface.

package/dist/models/ZapierUser.js

@@ -32,6 +32,8 @@ function instanceOfZapierUser(value) {
         return false;
     if (!('created' in value) || value['created'] === undefined)
         return false;
+    if (!('customerRef' in value) || value['customerRef'] === undefined)
+        return false;
     return true;
 }
 function ZapierUserFromJSON(json) {
@@ -47,6 +49,7 @@ function ZapierUserFromJSONTyped(json, ignoreDiscriminator) {
         'firstName': json['first_name'],
         'lastName': json['last_name'],
         'created': json['created'],
+        'customerRef': json['customer_ref'],
     };
 }
 function ZapierUserToJSON(json) {
@@ -62,5 +65,6 @@ function ZapierUserToJSONTyped(value, ignoreDiscriminator = false) {
         'first_name': value['firstName'],
         'last_name': value['lastName'],
         'created': value['created'],
+        'customer_ref': value['customerRef'],
     };
 }

package/dist/models/index.d.ts

@@ -277,6 +277,8 @@ export * from './PostQuestionImportCommit';
 export * from './PostQuestionImportCommitItem';
 export * from './PostQuestionImportCommitResponse';
 export * from './PostQuestionImportParseResponse';
+export * from './PostQuestionTags';
+export * from './PostQuestionTagsResponse';
 export * from './PostReportExport';
 export * from './PostReportQuery';
 export * from './PostResetPassword';
@@ -336,6 +338,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';

package/dist/models/index.js

@@ -295,6 +295,8 @@ __exportStar(require("./PostQuestionImportCommit"), exports);
 __exportStar(require("./PostQuestionImportCommitItem"), exports);
 __exportStar(require("./PostQuestionImportCommitResponse"), exports);
 __exportStar(require("./PostQuestionImportParseResponse"), exports);
+__exportStar(require("./PostQuestionTags"), exports);
+__exportStar(require("./PostQuestionTagsResponse"), exports);
 __exportStar(require("./PostReportExport"), exports);
 __exportStar(require("./PostReportQuery"), exports);
 __exportStar(require("./PostResetPassword"), exports);
@@ -354,6 +356,7 @@ __exportStar(require("./PutLibraryQuizVersion"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
 __exportStar(require("./PutPortalCertificateTemplate"), exports);
 __exportStar(require("./PutPortalSublicense"), exports);
+__exportStar(require("./PutPortalUser"), exports);
 __exportStar(require("./PutPortalUserFieldValues"), exports);
 __exportStar(require("./PutQuestion"), exports);
 __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);

package/docs/GetCourse.md

@@ -16,6 +16,7 @@ Name | Type
 `accessDurationDays` | number
 `accessFixedEndAt` | number
 `tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
+`customerRef` | string
 
 ## Example
 
@@ -34,6 +35,7 @@ const example = {
   "accessDurationDays": null,
   "accessFixedEndAt": null,
   "tags": null,
+  "customerRef": null,
 } satisfies GetCourse
 
 console.log(example)

package/docs/GetCourseEnrollmentListItem.md

@@ -14,6 +14,7 @@ Name | Type
 `courseVersionNumber` | number
 `firstName` | string
 `lastName` | string
+`email` | string
 `enrollmentDateStart` | number
 `enrollmentDateEnd` | number
 `status` | string
@@ -36,6 +37,7 @@ const example = {
   "courseVersionNumber": null,
   "firstName": null,
   "lastName": null,
+  "email": null,
   "enrollmentDateStart": null,
   "enrollmentDateEnd": null,
   "status": null,

package/docs/GetPortalUser.md

@@ -14,6 +14,7 @@ Name | Type
 `role` | string
 `isActive` | boolean
 `invitation` | [GetPortalInvitationSummary](GetPortalInvitationSummary.md)
+`customerRef` | string
 
 ## Example
 
@@ -29,6 +30,7 @@ const example = {
   "role": null,
   "isActive": null,
   "invitation": null,
+  "customerRef": null,
 } satisfies GetPortalUser
 
 console.log(example)

package/docs/GetResource.md

@@ -22,6 +22,7 @@ Name | Type
 `createdAt` | number
 `updatedAt` | number
 `archivedAt` | number
+`customerRef` | string
 
 ## Example
 
@@ -46,6 +47,7 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "archivedAt": null,
+  "customerRef": null,
 } satisfies GetResource
 
 console.log(example)

package/docs/GetResourceUsageCoursesInner.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `courseId` | string
+`courseName` | string
 `courseVersionId` | string
 `courseVersionNumber` | number
 `courseStatus` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
@@ -21,6 +22,7 @@ import type { GetResourceUsageCoursesInner } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "courseId": null,
+  "courseName": null,
   "courseVersionId": null,
   "courseVersionNumber": null,
   "courseStatus": null,

package/docs/IntegrationApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getZapierMe**](IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions |
 | [**getZapierSetup**](IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal |
 | [**getZapierShopifyCourseMappings**](IntegrationApi.md#getzapiershopifycoursemappings) | **GET** /integrations/zapier/shopify/course-mappings | List Shopify variant-to-course mappings |
-| [**getZapierUsers**](IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address |
+| [**getZapierUsers**](IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address or customer_ref |
 | [**postCustomWebhookIntegration**](IntegrationApi.md#postcustomwebhookintegration) | **POST** /integrations/webhooks | Create a custom webhook destination for lifecycle events |
 | [**postZapierEnrollment**](IntegrationApi.md#postzapierenrollment) | **POST** /integrations/zapier/enrollments | Enroll an existing learner in a course |
 | [**postZapierSetup**](IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal |
@@ -292,7 +292,7 @@ No authorization required
 
 ## getZapierCourses
 
-> GetZapierCourses getZapierCourses(xAPIKEY, xPORTALSUBDOMAIN, page, pageSize, search)
+> GetZapierCourses getZapierCourses(xAPIKEY, xPORTALSUBDOMAIN, page, pageSize, search, customerRef)
 
 List published courses available to a Zapier connection
 
@@ -320,6 +320,8 @@ async function example() {
     pageSize: 56,
     // string (optional)
     search: search_example,
+    // string | Return only the course with this exact customer_ref. (optional)
+    customerRef: customerRef_example,
   } satisfies GetZapierCoursesRequest;
 
   try {
@@ -344,6 +346,7 @@ example().catch(console.error);
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `100`] |
 | **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **customerRef** | `string` | Return only the course with this exact customer_ref. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -649,9 +652,11 @@ No authorization required
 
 ## getZapierUsers
 
-> GetZapierUsers getZapierUsers(xAPIKEY, xPORTALSUBDOMAIN, email)
+> GetZapierUsers getZapierUsers(xAPIKEY, xPORTALSUBDOMAIN, email, customerRef)
 
-Find a learner by exact email address
+Find a learner by exact email address or customer_ref
+
+Send email, customer_ref, or both. When both are sent the learner must match both.
 
 ### Example
 
@@ -671,8 +676,10 @@ async function example() {
     xAPIKEY: xAPIKEY_example,
     // string
     xPORTALSUBDOMAIN: xPORTALSUBDOMAIN_example,
-    // string
+    // string (optional)
     email: email_example,
+    // string (optional)
+    customerRef: customerRef_example,
   } satisfies GetZapierUsersRequest;
 
   try {
@@ -694,7 +701,8 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **xAPIKEY** | `string` |  | [Defaults to `undefined`] |
 | **xPORTALSUBDOMAIN** | `string` |  | [Defaults to `undefined`] |
-| **email** | `string` |  | [Defaults to `undefined`] |
+| **email** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **customerRef** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -714,6 +722,7 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Zero or one exact learner match |  -  |
+| **400** | Neither email nor customer_ref was sent |  -  |
 | **401** | Missing, invalid, or revoked API key |  -  |
 | **403** | The API key does not have user:read_any |  -  |
 

package/docs/IntegrationEventCourse.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `name` | string
+`customerRef` | string
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { IntegrationEventCourse } from '@easyedu/js-lsm-api'
 const example = {
   "id": null,
   "name": null,
+  "customerRef": null,
 } satisfies IntegrationEventCourse
 
 console.log(example)

package/docs/IntegrationEventLearner.md

@@ -10,6 +10,7 @@ Name | Type
 `email` | string
 `firstName` | string
 `lastName` | string
+`customerRef` | string
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "email": null,
   "firstName": null,
   "lastName": null,
+  "customerRef": null,
 } satisfies IntegrationEventLearner
 
 console.log(example)

package/docs/IntegrationEventUser.md

@@ -11,6 +11,7 @@ Name | Type
 `email` | string
 `firstName` | string
 `lastName` | string
+`customerRef` | string
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "email": null,
   "firstName": null,
   "lastName": null,
+  "customerRef": null,
 } satisfies IntegrationEventUser
 
 console.log(example)

package/docs/PortalApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
 | [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
 | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding and complete application theme |
+| [**putPortalUser**](PortalApi.md#putportaluser) | **PUT** /portals/{portalId}/users/{userId} | Update admin-managed details for a portal member |
 | [**putPortalUserFieldConfig**](PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration |
 | [**putPortalUserFieldValues**](PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values |
 | [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
@@ -554,7 +555,7 @@ No authorization required
 
 ## getPortalUsers
 
-> GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
+> GetPortalUserList getPortalUsers(portalId, type, roles, search, status, page, pageSize)
 
 Get all users for a portal with optional role filtering
 
@@ -580,6 +581,8 @@ async function example() {
     roles: ...,
     // string | Search users by first name, last name, or email (optional)
     search: Josh,
+    // 'active' | 'removed' | Which members to list. \"removed\" lists people removed from the portal, whose history is kept and who can be re-invited. (optional)
+    status: status_example,
     // number (optional)
     page: 56,
     // number (optional)
@@ -607,6 +610,7 @@ example().catch(console.error);
 | **type** | `student`, `instructor` | Filter users by type (student maps to Learner, instructor maps to Instructor) | [Optional] [Defaults to `undefined`] [Enum: student, instructor] |
 | **roles** | `Admin`, `Instructor`, `Learner` | Filter users by role (can specify multiple) | [Optional] [Enum: Admin, Instructor, Learner] |
 | **search** | `string` | Search users by first name, last name, or email | [Optional] [Defaults to `undefined`] |
+| **status** | `active`, `removed` | Which members to list. \"removed\" lists people removed from the portal, whose history is kept and who can be re-invited. | [Optional] [Defaults to `'active'`] [Enum: active, removed] |
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 
@@ -1162,6 +1166,83 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## putPortalUser
+
+> GetPortalUser putPortalUser(portalId, userId, putPortalUser)
+
+Update admin-managed details for a portal member
+
+Sets or clears the member\'s customer_ref for this portal.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PutPortalUserRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // string
+    userId: userId_example,
+    // PutPortalUser
+    putPortalUser: ...,
+  } satisfies PutPortalUserRequest;
+
+  try {
+    const data = await api.putPortalUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **putPortalUser** | [PutPortalUser](PutPortalUser.md) |  | |
+
+### Return type
+
+[**GetPortalUser**](GetPortalUser.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated portal member |  -  |
+| **400** | Invalid customer_ref |  -  |
+| **403** | Forbidden |  -  |
+| **404** | User is not a member of the portal |  -  |
+| **409** | Another member of this portal already has this customer_ref |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putPortalUserFieldConfig
 
 > PortalUserFieldConfig putPortalUserFieldConfig(portalId, portalUserFieldConfig)