@easyedu/js-lsm-api 1.51.0 → 1.52.0

package/docs/PortalSublicenseApi.md

@@ -0,0 +1,81 @@
+# PortalSublicenseApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**putPortalSublicense**](PortalSublicenseApi.md#putportalsublicense) | **PUT** /portals/{portalId}/sublicense | Manage seat limit and license window for a descendant portal |
+
+
+
+## putPortalSublicense
+
+> PortalSublicense putPortalSublicense(portalId, putPortalSublicense)
+
+Manage seat limit and license window for a descendant portal
+
+Must be called by a parent portal against one of its descendants. Field semantics: omit to leave unchanged, send `null` to clear. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalSublicenseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutPortalSublicenseRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalSublicenseApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // PutPortalSublicense
+    putPortalSublicense: ...,
+  } satisfies PutPortalSublicenseRequest;
+
+  try {
+    const data = await api.putPortalSublicense(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`] |
+| **putPortalSublicense** | [PutPortalSublicense](PutPortalSublicense.md) |  | |
+
+### Return type
+
+[**PortalSublicense**](PortalSublicense.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 |  -  |
+| **403** | Target portal is not a descendant of your portal |  -  |
+| **404** | 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)
+

package/docs/PostCourseCatalog.md

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

@@ -0,0 +1,40 @@
+
+# PostOfferCatalog
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`targetPortalId` | string
+`allowedMode` | string
+`allowResharing` | boolean
+`seatLimit` | number
+
+## Example
+
+```typescript
+import type { PostOfferCatalog } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "targetPortalId": null,
+  "allowedMode": null,
+  "allowResharing": null,
+  "seatLimit": null,
+} satisfies PostOfferCatalog
+
+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 PostOfferCatalog
+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/PostOfferCatalogResponse.md

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

@@ -0,0 +1,40 @@
+
+# PostOfferCourse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`targetPortalId` | string
+`allowedMode` | string
+`allowResharing` | boolean
+`seatLimit` | number
+
+## Example
+
+```typescript
+import type { PostOfferCourse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "targetPortalId": null,
+  "allowedMode": null,
+  "allowResharing": null,
+  "seatLimit": null,
+} satisfies PostOfferCourse
+
+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 PostOfferCourse
+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/PostOfferCourseResponse.md

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

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

@@ -0,0 +1,39 @@
+
+# PutPortalSublicense
+
+All fields are optional. Omit a field to leave it unchanged. Send `null` to clear it (unlimited seats / no license window). 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`seatLimit` | number
+`licenseStartAt` | number
+`licenseEndAt` | number
+
+## Example
+
+```typescript
+import type { PutPortalSublicense } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "seatLimit": null,
+  "licenseStartAt": null,
+  "licenseEndAt": null,
+} satisfies PutPortalSublicense
+
+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 PutPortalSublicense
+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/package.json

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