@easyedu/js-lsm-api 1.132.0 → 1.134.0

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/PostQuestionTags.md

@@ -0,0 +1,37 @@
+
+# PostQuestionTags
+
+Adds shared tags to several questions at once without creating new question versions.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionIds` | Array<string>
+`tags` | Array<string>
+
+## Example
+
+```typescript
+import type { PostQuestionTags } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questionIds": null,
+  "tags": null,
+} satisfies PostQuestionTags
+
+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 PostQuestionTags
+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/PostQuestionTagsResponse.md

@@ -0,0 +1,34 @@
+
+# PostQuestionTagsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`updatedCount` | number
+
+## Example
+
+```typescript
+import type { PostQuestionTagsResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "updatedCount": null,
+} satisfies PostQuestionTagsResponse
+
+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 PostQuestionTagsResponse
+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/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/QuestionApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getQuestionList**](QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination |
 | [**getQuestionVersions**](QuestionApi.md#getquestionversions) | **GET** /questions/{questionId}/versions | Get all versions of a question |
 | [**postQuestion**](QuestionApi.md#postquestion) | **POST** /questions | Create a new question |
+| [**postQuestionTags**](QuestionApi.md#postquestiontags) | **POST** /questions/tags | Add tags to several questions |
 | [**putQuestion**](QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question |
 
 
@@ -355,6 +356,76 @@ 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)
 
 
+## postQuestionTags
+
+> PostQuestionTagsResponse postQuestionTags(postQuestionTags)
+
+Add tags to several questions
+
+Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { PostQuestionTagsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // PostQuestionTags
+    postQuestionTags: ...,
+  } satisfies PostQuestionTagsRequest;
+
+  try {
+    const data = await api.postQuestionTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postQuestionTags** | [PostQuestionTags](PostQuestionTags.md) |  | |
+
+### Return type
+
+[**PostQuestionTagsResponse**](PostQuestionTagsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Tags added |  -  |
+| **400** | Invalid question IDs or tags |  -  |
+| **403** | Missing permission |  -  |
+| **409** | A tag is archived |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putQuestion
 
 > GetQuestion putQuestion(questionId, putQuestion)

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.132.0",
+  "version": "1.134.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/IntegrationApi.ts

@@ -149,6 +149,7 @@ export interface GetZapierCoursesRequest {
     page?: number;
     pageSize?: number;
     search?: string;
+    customerRef?: string;
 }
 
 export interface GetZapierEventsRequest {
@@ -172,7 +173,8 @@ export interface GetZapierShopifyCourseMappingsRequest {
 export interface GetZapierUsersRequest {
     xAPIKEY: string;
     xPORTALSUBDOMAIN: string;
-    email: string;
+    email?: string;
+    customerRef?: string;
 }
 
 export interface PostCustomWebhookIntegrationRequest {
@@ -451,6 +453,10 @@ export class IntegrationApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['customerRef'] != null) {
+            queryParameters['customer_ref'] = requestParameters['customerRef'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (requestParameters['xAPIKEY'] != null) {
@@ -741,19 +747,16 @@ export class IntegrationApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['email'] == null) {
-            throw new runtime.RequiredError(
-                'email',
-                'Required parameter "email" was null or undefined when calling getZapierUsers().'
-            );
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters['email'] != null) {
             queryParameters['email'] = requestParameters['email'];
         }
 
+        if (requestParameters['customerRef'] != null) {
+            queryParameters['customer_ref'] = requestParameters['customerRef'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (requestParameters['xAPIKEY'] != null) {
@@ -776,7 +779,8 @@ export class IntegrationApi extends runtime.BaseAPI {
     }
 
     /**
-     * Find a learner by exact email address
+     * Send email, customer_ref, or both. When both are sent the learner must match both.
+     * Find a learner by exact email address or customer_ref
      */
     async getZapierUsersRaw(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierUsers>> {
         const requestOptions = await this.getZapierUsersRequestOpts(requestParameters);
@@ -786,7 +790,8 @@ export class IntegrationApi extends runtime.BaseAPI {
     }
 
     /**
-     * Find a learner by exact email address
+     * Send email, customer_ref, or both. When both are sent the learner must match both.
+     * Find a learner by exact email address or customer_ref
      */
     async getZapierUsers(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierUsers> {
         const response = await this.getZapierUsersRaw(requestParameters, initOverrides);

package/src/apis/PortalApi.ts

@@ -33,6 +33,11 @@ import {
     GetPortalLogoUploadFromJSON,
     GetPortalLogoUploadToJSON,
 } from '../models/GetPortalLogoUpload';
+import {
+    type GetPortalUser,
+    GetPortalUserFromJSON,
+    GetPortalUserToJSON,
+} from '../models/GetPortalUser';
 import {
     type GetPortalUserFieldValues,
     GetPortalUserFieldValuesFromJSON,
@@ -68,6 +73,11 @@ import {
     PutPortalBrandingFromJSON,
     PutPortalBrandingToJSON,
 } from '../models/PutPortalBranding';
+import {
+    type PutPortalUser,
+    PutPortalUserFromJSON,
+    PutPortalUserToJSON,
+} from '../models/PutPortalUser';
 import {
     type PutPortalUserFieldValues,
     PutPortalUserFieldValuesFromJSON,
@@ -113,6 +123,7 @@ export interface GetPortalUsersRequest {
     type?: GetPortalUsersTypeEnum;
     roles?: Array<GetPortalUsersRolesEnum>;
     search?: string;
+    status?: GetPortalUsersStatusEnum;
     page?: number;
     pageSize?: number;
 }
@@ -141,6 +152,12 @@ export interface PutPortalBrandingRequest {
     putPortalBranding: PutPortalBranding;
 }
 
+export interface PutPortalUserRequest {
+    portalId: string;
+    userId: string;
+    putPortalUser: PutPortalUser;
+}
+
 export interface PutPortalUserFieldConfigRequest {
     portalId: string;
     portalUserFieldConfig: PortalUserFieldConfig;
@@ -549,6 +566,10 @@ export class PortalApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
         if (requestParameters['page'] != null) {
             queryParameters['page'] = requestParameters['page'];
         }
@@ -1008,6 +1029,71 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putPortalUser without sending the request
+     */
+    async putPortalUserRequestOpts(requestParameters: PutPortalUserRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling putPortalUser().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling putPortalUser().'
+            );
+        }
+
+        if (requestParameters['putPortalUser'] == null) {
+            throw new runtime.RequiredError(
+                'putPortalUser',
+                'Required parameter "putPortalUser" was null or undefined when calling putPortalUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/portals/{portalId}/users/{userId}`;
+        urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutPortalUserToJSON(requestParameters['putPortalUser']),
+        };
+    }
+
+    /**
+     * Sets or clears the member\'s customer_ref for this portal.
+     * Update admin-managed details for a portal member
+     */
+    async putPortalUserRaw(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUser>> {
+        const requestOptions = await this.putPortalUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserFromJSON(jsonValue));
+    }
+
+    /**
+     * Sets or clears the member\'s customer_ref for this portal.
+     * Update admin-managed details for a portal member
+     */
+    async putPortalUser(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUser> {
+        const response = await this.putPortalUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putPortalUserFieldConfig without sending the request
      */
@@ -1242,3 +1328,11 @@ export const GetPortalUsersRolesEnum = {
     Learner: 'Learner'
 } as const;
 export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
+/**
+ * @export
+ */
+export const GetPortalUsersStatusEnum = {
+    Active: 'active',
+    Removed: 'removed'
+} as const;
+export type GetPortalUsersStatusEnum = typeof GetPortalUsersStatusEnum[keyof typeof GetPortalUsersStatusEnum];