@easyedu/js-lsm-api 1.133.0 → 1.134.0

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

@@ -338,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

@@ -356,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/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/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 |
@@ -1165,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)

package/docs/PostCourse.md

@@ -12,6 +12,7 @@ Name | Type
 `accessDurationDays` | number
 `accessFixedEndAt` | number
 `tags` | Set<string>
+`customerRef` | string
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "accessDurationDays": null,
   "accessFixedEndAt": null,
   "tags": null,
+  "customerRef": null,
 } satisfies PostCourse
 
 console.log(example)

package/docs/PostPortalInvite.md

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

package/docs/PostResource.md

@@ -12,6 +12,7 @@ Name | Type
 `linkUrl` | string
 `richText` | [RichTextInput](RichTextInput.md)
 `tags` | Set<string>
+`customerRef` | string
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "linkUrl": null,
   "richText": null,
   "tags": null,
+  "customerRef": null,
 } satisfies PostResource
 
 console.log(example)

package/docs/PostRichTextAssetUpload.md

@@ -12,6 +12,7 @@ Name | Type
 `width` | number
 `height` | number
 `usageContext` | string
+`customerRef` | string
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "width": null,
   "height": null,
   "usageContext": null,
+  "customerRef": null,
 } satisfies PostRichTextAssetUpload
 
 console.log(example)

package/docs/PostZapierEnrollment.md

@@ -13,6 +13,8 @@ Name | Type
 `enrollmentDateEnd` | number
 `notes` | string
 `reEnrollmentMode` | string
+`courseCustomerRef` | string
+`userCustomerRef` | string
 
 ## Example
 
@@ -28,6 +30,8 @@ const example = {
   "enrollmentDateEnd": null,
   "notes": null,
   "reEnrollmentMode": null,
+  "courseCustomerRef": null,
+  "userCustomerRef": null,
 } satisfies PostZapierEnrollment
 
 console.log(example)

package/docs/PostZapierShopifyCourseMapping.md

@@ -10,6 +10,7 @@ Name | Type
 `variantId` | string
 `productId` | string
 `courseId` | string
+`courseCustomerRef` | string
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "variantId": null,
   "productId": null,
   "courseId": null,
+  "courseCustomerRef": null,
 } satisfies PostZapierShopifyCourseMapping
 
 console.log(example)

package/docs/PostZapierUser.md

@@ -9,6 +9,7 @@ Name | Type
 `email` | string
 `firstName` | string
 `lastName` | string
+`customerRef` | string
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "email": null,
   "firstName": null,
   "lastName": null,
+  "customerRef": null,
 } satisfies PostZapierUser
 
 console.log(example)

package/docs/PutCourse.md

@@ -14,6 +14,7 @@ Name | Type
 `accessDurationDays` | number
 `accessFixedEndAt` | number
 `tags` | Set<string>
+`customerRef` | string
 
 ## Example
 
@@ -30,6 +31,7 @@ const example = {
   "accessDurationDays": null,
   "accessFixedEndAt": null,
   "tags": null,
+  "customerRef": null,
 } satisfies PutCourse
 
 console.log(example)

package/docs/PutPortalUser.md

@@ -0,0 +1,35 @@
+
+# PutPortalUser
+
+Admin-managed details for a portal member.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerRef` | string
+
+## Example
+
+```typescript
+import type { PutPortalUser } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerRef": null,
+} satisfies PutPortalUser
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutPortalUser
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutResource.md

@@ -9,6 +9,7 @@ Name | Type
 `name` | string
 `description` | string
 `tags` | Set<string>
+`customerRef` | string
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "name": null,
   "description": null,
   "tags": null,
+  "customerRef": null,
 } satisfies PutResource
 
 console.log(example)

package/docs/RichTextAsset.md

@@ -12,6 +12,7 @@ Name | Type
 `width` | number
 `height` | number
 `renderUrl` | string
+`customerRef` | string
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "width": null,
   "height": null,
   "renderUrl": null,
+  "customerRef": null,
 } satisfies RichTextAsset
 
 console.log(example)

package/docs/ZapierCourse.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `description` | string
 `published` | boolean
+`customerRef` | string
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "name": null,
   "description": null,
   "published": null,
+  "customerRef": null,
 } satisfies ZapierCourse
 
 console.log(example)

package/docs/ZapierEnrollment.md

@@ -14,6 +14,8 @@ Name | Type
 `enrollmentDateEnd` | number
 `created` | boolean
 `idempotentReplay` | boolean
+`courseCustomerRef` | string
+`userCustomerRef` | string
 
 ## Example
 
@@ -30,6 +32,8 @@ const example = {
   "enrollmentDateEnd": null,
   "created": null,
   "idempotentReplay": null,
+  "courseCustomerRef": null,
+  "userCustomerRef": null,
 } satisfies ZapierEnrollment
 
 console.log(example)

package/docs/ZapierUser.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.133.0",
+  "version": "1.134.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {