@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/.openapi-generator/FILES

@@ -9,6 +9,10 @@ docs/CertificatePublic.md
 docs/ChatApi.md
 docs/ContentApi.md
 docs/CourseApi.md
+docs/CourseCatalog.md
+docs/CourseCatalogApi.md
+docs/CourseShare.md
+docs/CourseShareApi.md
 docs/CriteriaBasedSelection.md
 docs/CriteriaBasedSelectionCriteria.md
 docs/CriteriaBasedSelectionDistribution.md
@@ -167,6 +171,8 @@ docs/NoAnswer.md
 docs/OtherApi.md
 docs/Paginated.md
 docs/PortalApi.md
+docs/PortalSublicense.md
+docs/PortalSublicenseApi.md
 docs/PostCertificate.md
 docs/PostCertificateConfig.md
 docs/PostContentQuiz.md
@@ -178,6 +184,7 @@ docs/PostContentUpload.md
 docs/PostConversation.md
 docs/PostConversationResponse.md
 docs/PostCourse.md
+docs/PostCourseCatalog.md
 docs/PostCourseEnrollment.md
 docs/PostCourseExport.md
 docs/PostLogin.md
@@ -185,6 +192,10 @@ docs/PostManualQuestionSelection.md
 docs/PostMessage.md
 docs/PostMessageResponse.md
 docs/PostModule.md
+docs/PostOfferCatalog.md
+docs/PostOfferCatalogResponse.md
+docs/PostOfferCourse.md
+docs/PostOfferCourseResponse.md
 docs/PostPortal.md
 docs/PostPortalInvite.md
 docs/PostQuestion.md
@@ -217,10 +228,12 @@ docs/PutContent.md
 docs/PutContentReorder.md
 docs/PutContentVersion.md
 docs/PutCourse.md
+docs/PutCourseCatalog.md
 docs/PutCourseEnrollment.md
 docs/PutModule.md
 docs/PutModuleReorder.md
 docs/PutPortalBranding.md
+docs/PutPortalSublicense.md
 docs/PutQuestion.md
 docs/PutQuestionAnswerChoicesInner.md
 docs/PutQuiz.md
@@ -260,9 +273,12 @@ src/apis/CertificateApi.ts
 src/apis/ChatApi.ts
 src/apis/ContentApi.ts
 src/apis/CourseApi.ts
+src/apis/CourseCatalogApi.ts
+src/apis/CourseShareApi.ts
 src/apis/ModuleApi.ts
 src/apis/OtherApi.ts
 src/apis/PortalApi.ts
+src/apis/PortalSublicenseApi.ts
 src/apis/QuestionApi.ts
 src/apis/QuizApi.ts
 src/apis/ReportingApi.ts
@@ -274,6 +290,8 @@ src/index.ts
 src/models/Certificate.ts
 src/models/CertificateConfig.ts
 src/models/CertificatePublic.ts
+src/models/CourseCatalog.ts
+src/models/CourseShare.ts
 src/models/CriteriaBasedSelection.ts
 src/models/CriteriaBasedSelectionCriteria.ts
 src/models/CriteriaBasedSelectionDistribution.ts
@@ -429,6 +447,7 @@ src/models/MultipleAnswer.ts
 src/models/MultipleAnswer1.ts
 src/models/NoAnswer.ts
 src/models/Paginated.ts
+src/models/PortalSublicense.ts
 src/models/PostCertificate.ts
 src/models/PostCertificateConfig.ts
 src/models/PostContentQuiz.ts
@@ -440,6 +459,7 @@ src/models/PostContentUpload.ts
 src/models/PostConversation.ts
 src/models/PostConversationResponse.ts
 src/models/PostCourse.ts
+src/models/PostCourseCatalog.ts
 src/models/PostCourseEnrollment.ts
 src/models/PostCourseExport.ts
 src/models/PostLogin.ts
@@ -447,6 +467,10 @@ src/models/PostManualQuestionSelection.ts
 src/models/PostMessage.ts
 src/models/PostMessageResponse.ts
 src/models/PostModule.ts
+src/models/PostOfferCatalog.ts
+src/models/PostOfferCatalogResponse.ts
+src/models/PostOfferCourse.ts
+src/models/PostOfferCourseResponse.ts
 src/models/PostPortal.ts
 src/models/PostPortalInvite.ts
 src/models/PostQuestion.ts
@@ -479,10 +503,12 @@ src/models/PutContent.ts
 src/models/PutContentReorder.ts
 src/models/PutContentVersion.ts
 src/models/PutCourse.ts
+src/models/PutCourseCatalog.ts
 src/models/PutCourseEnrollment.ts
 src/models/PutModule.ts
 src/models/PutModuleReorder.ts
 src/models/PutPortalBranding.ts
+src/models/PutPortalSublicense.ts
 src/models/PutQuestion.ts
 src/models/PutQuestionAnswerChoicesInner.ts
 src/models/PutQuiz.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.51.0
+# @easyedu/js-lsm-api@1.53.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -105,6 +105,23 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *CourseApi* | [**postCourseImageUpload**](docs/CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image
 *CourseApi* | [**putCourse**](docs/CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id
 *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
+*CourseCatalogApi* | [**addCourseToCatalog**](docs/CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog
+*CourseCatalogApi* | [**deleteCourseCatalog**](docs/CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog
+*CourseCatalogApi* | [**getCatalogCourses**](docs/CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog
+*CourseCatalogApi* | [**getCourseCatalog**](docs/CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog
+*CourseCatalogApi* | [**getCourseCatalogs**](docs/CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal
+*CourseCatalogApi* | [**postCourseCatalog**](docs/CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog
+*CourseCatalogApi* | [**putCourseCatalog**](docs/CourseCatalogApi.md#putcoursecatalog) | **PUT** /catalogs/{catalogId} | Update a catalog
+*CourseCatalogApi* | [**removeCourseFromCatalog**](docs/CourseCatalogApi.md#removecoursefromcatalog) | **DELETE** /catalogs/{catalogId}/courses/{courseId} | Remove a course from a catalog
+*CourseShareApi* | [**deleteCourseShare**](docs/CourseShareApi.md#deletecourseshare) | **DELETE** /course-shares/{shareId} | Revoke a share
+*CourseShareApi* | [**getCourseSharesOfferedByMe**](docs/CourseShareApi.md#getcoursesharesofferedbyme) | **GET** /course-shares/offered-by-me | List shares the current portal has offered out
+*CourseShareApi* | [**getCourseSharesOfferedToMe**](docs/CourseShareApi.md#getcoursesharesofferedtome) | **GET** /course-shares/offered-to-me | List shares offered to the current portal
+*CourseShareApi* | [**postOfferCatalog**](docs/CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to a descendant portal
+*CourseShareApi* | [**postOfferCourse**](docs/CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to a descendant portal
+*CourseShareApi* | [**postUnrevokeShare**](docs/CourseShareApi.md#postunrevokeshare) | **POST** /course-shares/{shareId}/unrevoke | Restore a previously revoked share
+*CourseShareApi* | [**putAcceptClone**](docs/CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal)
+*CourseShareApi* | [**putAcceptMirror**](docs/CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source)
+*CourseShareApi* | [**putDeclineShare**](docs/CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer
 *ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
 *ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
 *ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
@@ -120,6 +137,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
 *PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color)
 *PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles.
+*PortalSublicenseApi* | [**putPortalSublicense**](docs/PortalSublicenseApi.md#putportalsublicense) | **PUT** /portals/{portalId}/sublicense | Manage seat limit and license window for a descendant portal
 *QuestionApi* | [**deleteQuestion**](docs/QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID
 *QuestionApi* | [**getQuestion**](docs/QuestionApi.md#getquestion) | **GET** /questions/{questionId} | Get a question by ID
 *QuestionApi* | [**getQuestionList**](docs/QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination
@@ -194,6 +212,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [Certificate](docs/Certificate.md)
 - [CertificateConfig](docs/CertificateConfig.md)
 - [CertificatePublic](docs/CertificatePublic.md)
+- [CourseCatalog](docs/CourseCatalog.md)
+- [CourseShare](docs/CourseShare.md)
 - [CriteriaBasedSelection](docs/CriteriaBasedSelection.md)
 - [CriteriaBasedSelectionCriteria](docs/CriteriaBasedSelectionCriteria.md)
 - [CriteriaBasedSelectionDistribution](docs/CriteriaBasedSelectionDistribution.md)
@@ -349,6 +369,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [MultipleAnswer1](docs/MultipleAnswer1.md)
 - [NoAnswer](docs/NoAnswer.md)
 - [Paginated](docs/Paginated.md)
+- [PortalSublicense](docs/PortalSublicense.md)
 - [PostCertificate](docs/PostCertificate.md)
 - [PostCertificateConfig](docs/PostCertificateConfig.md)
 - [PostContentQuiz](docs/PostContentQuiz.md)
@@ -360,6 +381,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostConversation](docs/PostConversation.md)
 - [PostConversationResponse](docs/PostConversationResponse.md)
 - [PostCourse](docs/PostCourse.md)
+- [PostCourseCatalog](docs/PostCourseCatalog.md)
 - [PostCourseEnrollment](docs/PostCourseEnrollment.md)
 - [PostCourseExport](docs/PostCourseExport.md)
 - [PostLogin](docs/PostLogin.md)
@@ -367,6 +389,10 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostMessage](docs/PostMessage.md)
 - [PostMessageResponse](docs/PostMessageResponse.md)
 - [PostModule](docs/PostModule.md)
+- [PostOfferCatalog](docs/PostOfferCatalog.md)
+- [PostOfferCatalogResponse](docs/PostOfferCatalogResponse.md)
+- [PostOfferCourse](docs/PostOfferCourse.md)
+- [PostOfferCourseResponse](docs/PostOfferCourseResponse.md)
 - [PostPortal](docs/PostPortal.md)
 - [PostPortalInvite](docs/PostPortalInvite.md)
 - [PostQuestion](docs/PostQuestion.md)
@@ -399,10 +425,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PutContentReorder](docs/PutContentReorder.md)
 - [PutContentVersion](docs/PutContentVersion.md)
 - [PutCourse](docs/PutCourse.md)
+- [PutCourseCatalog](docs/PutCourseCatalog.md)
 - [PutCourseEnrollment](docs/PutCourseEnrollment.md)
 - [PutModule](docs/PutModule.md)
 - [PutModuleReorder](docs/PutModuleReorder.md)
 - [PutPortalBranding](docs/PutPortalBranding.md)
+- [PutPortalSublicense](docs/PutPortalSublicense.md)
 - [PutQuestion](docs/PutQuestion.md)
 - [PutQuestionAnswerChoicesInner](docs/PutQuestionAnswerChoicesInner.md)
 - [PutQuiz](docs/PutQuiz.md)
@@ -444,7 +472,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.51.0`
+- Package version: `1.53.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/CourseCatalogApi.d.ts

@@ -0,0 +1,138 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { CourseCatalog, GetCourse, PostCourseCatalog, PutCourseCatalog } from '../models/index';
+export interface AddCourseToCatalogRequest {
+    catalogId: string;
+    courseId: string;
+}
+export interface DeleteCourseCatalogRequest {
+    catalogId: string;
+}
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
+export interface GetCourseCatalogRequest {
+    catalogId: string;
+}
+export interface PostCourseCatalogRequest {
+    postCourseCatalog: PostCourseCatalog;
+}
+export interface PutCourseCatalogRequest {
+    catalogId: string;
+    putCourseCatalog: PutCourseCatalog;
+}
+export interface RemoveCourseFromCatalogRequest {
+    catalogId: string;
+    courseId: string;
+}
+/**
+ *
+ */
+export declare class CourseCatalogApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for addCourseToCatalog without sending the request
+     */
+    addCourseToCatalogRequestOpts(requestParameters: AddCourseToCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Add a course to a catalog
+     */
+    addCourseToCatalogRaw(requestParameters: AddCourseToCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add a course to a catalog
+     */
+    addCourseToCatalog(requestParameters: AddCourseToCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for deleteCourseCatalog without sending the request
+     */
+    deleteCourseCatalogRequestOpts(requestParameters: DeleteCourseCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a catalog
+     */
+    deleteCourseCatalogRaw(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a catalog
+     */
+    deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>>;
+    /**
+     * Creates request options for getCourseCatalog without sending the request
+     */
+    getCourseCatalogRequestOpts(requestParameters: GetCourseCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a catalog
+     */
+    getCourseCatalogRaw(requestParameters: GetCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>>;
+    /**
+     * Get a catalog
+     */
+    getCourseCatalog(requestParameters: GetCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog>;
+    /**
+     * Creates request options for getCourseCatalogs without sending the request
+     */
+    getCourseCatalogsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List catalogs in the current portal
+     */
+    getCourseCatalogsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseCatalog>>>;
+    /**
+     * List catalogs in the current portal
+     */
+    getCourseCatalogs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseCatalog>>;
+    /**
+     * Creates request options for postCourseCatalog without sending the request
+     */
+    postCourseCatalogRequestOpts(requestParameters: PostCourseCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a course catalog
+     */
+    postCourseCatalogRaw(requestParameters: PostCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>>;
+    /**
+     * Create a course catalog
+     */
+    postCourseCatalog(requestParameters: PostCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog>;
+    /**
+     * Creates request options for putCourseCatalog without sending the request
+     */
+    putCourseCatalogRequestOpts(requestParameters: PutCourseCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a catalog
+     */
+    putCourseCatalogRaw(requestParameters: PutCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>>;
+    /**
+     * Update a catalog
+     */
+    putCourseCatalog(requestParameters: PutCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog>;
+    /**
+     * Creates request options for removeCourseFromCatalog without sending the request
+     */
+    removeCourseFromCatalogRequestOpts(requestParameters: RemoveCourseFromCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Remove a course from a catalog
+     */
+    removeCourseFromCatalogRaw(requestParameters: RemoveCourseFromCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a course from a catalog
+     */
+    removeCourseFromCatalog(requestParameters: RemoveCourseFromCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}