@easyedu/js-lsm-api 1.50.0 → 1.52.0

package/docs/CourseShareApi.md

@@ -0,0 +1,609 @@
+# CourseShareApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteCourseShare**](CourseShareApi.md#deletecourseshare) | **DELETE** /course-shares/{shareId} | Revoke a share |
+| [**getCourseSharesOfferedByMe**](CourseShareApi.md#getcoursesharesofferedbyme) | **GET** /course-shares/offered-by-me | List shares the current portal has offered out |
+| [**getCourseSharesOfferedToMe**](CourseShareApi.md#getcoursesharesofferedtome) | **GET** /course-shares/offered-to-me | List shares offered to the current portal |
+| [**postOfferCatalog**](CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to a descendant portal |
+| [**postOfferCourse**](CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to a descendant portal |
+| [**postUnrevokeShare**](CourseShareApi.md#postunrevokeshare) | **POST** /course-shares/{shareId}/unrevoke | Restore a previously revoked share |
+| [**putAcceptClone**](CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal) |
+| [**putAcceptMirror**](CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source) |
+| [**putDeclineShare**](CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer |
+
+
+
+## deleteCourseShare
+
+> deleteCourseShare(shareId)
+
+Revoke a share
+
+Cascades to any downstream re-shares and archives enrollments in the target portal. Use `POST /course-shares/{shareId}/unrevoke` to restore. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseShareRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    shareId: shareId_example,
+  } satisfies DeleteCourseShareRequest;
+
+  try {
+    const data = await api.deleteCourseShare(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **shareId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Revoked |  -  |
+| **403** | Share not owned by your portal |  -  |
+| **404** | Share not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseSharesOfferedByMe
+
+> Array<CourseShare> getCourseSharesOfferedByMe()
+
+List shares the current portal has offered out
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseSharesOfferedByMeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  try {
+    const data = await api.getCourseSharesOfferedByMe();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<CourseShare>**](CourseShare.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Shares |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseSharesOfferedToMe
+
+> Array<CourseShare> getCourseSharesOfferedToMe()
+
+List shares offered to the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseSharesOfferedToMeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  try {
+    const data = await api.getCourseSharesOfferedToMe();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<CourseShare>**](CourseShare.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Shares |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postOfferCatalog
+
+> PostOfferCatalogResponse postOfferCatalog(catalogId, postOfferCatalog)
+
+Offer every course in a catalog to a descendant portal
+
+Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PostOfferCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+    // PostOfferCatalog
+    postOfferCatalog: ...,
+  } satisfies PostOfferCatalogRequest;
+
+  try {
+    const data = await api.postOfferCatalog(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+| **postOfferCatalog** | [PostOfferCatalog](PostOfferCatalog.md) |  | |
+
+### Return type
+
+[**PostOfferCatalogResponse**](PostOfferCatalogResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Catalog offered |  -  |
+| **403** | Catalog not owned by your portal, or target is not a descendant |  -  |
+| **404** | Catalog or target portal not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postOfferCourse
+
+> PostOfferCourseResponse postOfferCourse(courseId, postOfferCourse)
+
+Offer a single course to a descendant portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PostOfferCourseRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // PostOfferCourse
+    postOfferCourse: ...,
+  } satisfies PostOfferCourseRequest;
+
+  try {
+    const data = await api.postOfferCourse(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **postOfferCourse** | [PostOfferCourse](PostOfferCourse.md) |  | |
+
+### Return type
+
+[**PostOfferCourseResponse**](PostOfferCourseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Share created |  -  |
+| **403** | Course not owned by your portal, or target is not a descendant |  -  |
+| **404** | Course or target portal not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postUnrevokeShare
+
+> postUnrevokeShare(shareId)
+
+Restore a previously revoked share
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PostUnrevokeShareRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    shareId: shareId_example,
+  } satisfies PostUnrevokeShareRequest;
+
+  try {
+    const data = await api.postUnrevokeShare(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **shareId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Restored |  -  |
+| **403** | Share not owned by your portal |  -  |
+| **404** | Share not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putAcceptClone
+
+> putAcceptClone(shareId)
+
+Accept an offer as a clone (deep copy into your portal)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PutAcceptCloneRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    shareId: shareId_example,
+  } satisfies PutAcceptCloneRequest;
+
+  try {
+    const data = await api.putAcceptClone(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **shareId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Accepted, course cloned |  -  |
+| **403** | Share not addressed to your portal, or mode not allowed |  -  |
+| **404** | Share not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putAcceptMirror
+
+> putAcceptMirror(shareId)
+
+Accept an offer as a mirror (no copy, live link to source)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PutAcceptMirrorRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    shareId: shareId_example,
+  } satisfies PutAcceptMirrorRequest;
+
+  try {
+    const data = await api.putAcceptMirror(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **shareId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Accepted |  -  |
+| **403** | Share not addressed to your portal, or mode not allowed |  -  |
+| **404** | Share not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putDeclineShare
+
+> putDeclineShare(shareId)
+
+Decline an offer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseShareApi,
+} from '@easyedu/js-lsm-api';
+import type { PutDeclineShareRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseShareApi();
+
+  const body = {
+    // string
+    shareId: shareId_example,
+  } satisfies PutDeclineShareRequest;
+
+  try {
+    const data = await api.putDeclineShare(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **shareId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Declined |  -  |
+| **404** | Share not found |  -  |
+
+[[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/PortalSublicense.md

@@ -0,0 +1,42 @@
+
+# PortalSublicense
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`seatLimit` | number
+`licenseStartAt` | number
+`licenseEndAt` | number
+`licenseState` | string
+`activeEnrollmentCount` | number
+
+## Example
+
+```typescript
+import type { PortalSublicense } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "seatLimit": null,
+  "licenseStartAt": null,
+  "licenseEndAt": null,
+  "licenseState": null,
+  "activeEnrollmentCount": null,
+} satisfies PortalSublicense
+
+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 PortalSublicense
+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)
+
+