@easyedu/js-lsm-api 1.83.0 → 1.84.0

package/dist/esm/apis/CourseApi.d.ts

@@ -18,13 +18,23 @@ import { type GetCourseExportList } from '../models/GetCourseExportList';
 import { type GetCourseImageUpload } from '../models/GetCourseImageUpload';
 import { type GetCourseList } from '../models/GetCourseList';
 import { type GetCourseReportingBasic } from '../models/GetCourseReportingBasic';
+import { type GetCourseVersion } from '../models/GetCourseVersion';
+import { type GetCourseVersionItem } from '../models/GetCourseVersionItem';
+import { type GetCourseVersionItemLaunch } from '../models/GetCourseVersionItemLaunch';
+import { type GetCourseVersionItemSession } from '../models/GetCourseVersionItemSession';
+import { type GetCourseVersionList } from '../models/GetCourseVersionList';
 import { type PostCourse } from '../models/PostCourse';
+import { type PostCourseDraft } from '../models/PostCourseDraft';
 import { type PostCourseEnrollment } from '../models/PostCourseEnrollment';
 import { type PostCourseExport } from '../models/PostCourseExport';
 import { type PostCourseResume } from '../models/PostCourseResume';
+import { type PostCourseVersionItem } from '../models/PostCourseVersionItem';
+import { type PostCourseVersionItemSession } from '../models/PostCourseVersionItemSession';
+import { type PostCourseVersionPublish } from '../models/PostCourseVersionPublish';
 import { type PostDuplicate } from '../models/PostDuplicate';
 import { type PutCourse } from '../models/PutCourse';
 import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
+import { type PutCourseVersionItem } from '../models/PutCourseVersionItem';
 export interface DeleteCourseRequest {
     courseId: string;
 }
@@ -39,6 +49,10 @@ export interface DeleteCourseExportRequest {
 export interface DeleteCourseImageRequest {
     courseId: string;
 }
+export interface DeleteCourseVersionItemRequest {
+    courseId: string;
+    itemId: string;
+}
 export interface DownloadCourseExportRequest {
     courseId: string;
     exportId: string;
@@ -46,6 +60,9 @@ export interface DownloadCourseExportRequest {
 export interface GetCourseRequest {
     courseId: string;
 }
+export interface GetCourseDraftRequest {
+    courseId: string;
+}
 export interface GetCourseEnrollmentRequest {
     courseId: string;
     enrollmentId: string;
@@ -77,9 +94,24 @@ export interface GetCourseListRequest {
 export interface GetCourseReportingBasicRequest {
     courseId: string;
 }
+export interface GetCourseVersionItemLaunchRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+}
+export interface GetCourseVersionListRequest {
+    courseId: string;
+}
 export interface PostCourseRequest {
     postCourse: PostCourse;
 }
+export interface PostCourseDraftRequest {
+    courseId: string;
+    postCourseDraft?: PostCourseDraft;
+}
+export interface PostCourseDraftResourceUpdateAllRequest {
+    courseId: string;
+}
 export interface PostCourseDuplicateRequest {
     courseId: string;
     postDuplicate?: PostDuplicate;
@@ -99,6 +131,21 @@ export interface PostCourseImageUploadRequest {
 export interface PostCourseResumeRequest {
     courseId: string;
 }
+export interface PostCourseVersionItemRequest {
+    courseId: string;
+    postCourseVersionItem: PostCourseVersionItem;
+}
+export interface PostCourseVersionItemSessionRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    postCourseVersionItemSession?: PostCourseVersionItemSession;
+}
+export interface PostCourseVersionPublishRequest {
+    courseId: string;
+    courseVersionId: string;
+    postCourseVersionPublish?: PostCourseVersionPublish;
+}
 export interface PutCourseRequest {
     courseId: string;
     putCourse: Omit<PutCourse, 'id'>;
@@ -108,6 +155,11 @@ export interface PutCourseEnrollmentRequest {
     enrollmentId: string;
     putCourseEnrollment: PutCourseEnrollment;
 }
+export interface PutCourseVersionItemRequest {
+    courseId: string;
+    itemId: string;
+    putCourseVersionItem: PutCourseVersionItem;
+}
 /**
  *
  */
@@ -162,6 +214,18 @@ export declare class CourseApi extends runtime.BaseAPI {
      * Remove the course image
      */
     deleteCourseImage(requestParameters: DeleteCourseImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for deleteCourseVersionItem without sending the request
+     */
+    deleteCourseVersionItemRequestOpts(requestParameters: DeleteCourseVersionItemRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Remove a placement from the course draft
+     */
+    deleteCourseVersionItemRaw(requestParameters: DeleteCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a placement from the course draft
+     */
+    deleteCourseVersionItem(requestParameters: DeleteCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for downloadCourseExport without sending the request
      */
@@ -186,6 +250,18 @@ export declare class CourseApi extends runtime.BaseAPI {
      * get course
      */
     getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
+    /**
+     * Creates request options for getCourseDraft without sending the request
+     */
+    getCourseDraftRequestOpts(requestParameters: GetCourseDraftRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the current course draft
+     */
+    getCourseDraftRaw(requestParameters: GetCourseDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>>;
+    /**
+     * Get the current course draft
+     */
+    getCourseDraft(requestParameters: GetCourseDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion>;
     /**
      * Creates request options for getCourseEnrollment without sending the request
      */
@@ -258,6 +334,30 @@ export declare class CourseApi extends runtime.BaseAPI {
      * Get basic course reporting data
      */
     getCourseReportingBasic(requestParameters: GetCourseReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseReportingBasic>;
+    /**
+     * Creates request options for getCourseVersionItemLaunch without sending the request
+     */
+    getCourseVersionItemLaunchRequestOpts(requestParameters: GetCourseVersionItemLaunchRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Resolve the exact immutable resource launch selected by a course version
+     */
+    getCourseVersionItemLaunchRaw(requestParameters: GetCourseVersionItemLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionItemLaunch>>;
+    /**
+     * Resolve the exact immutable resource launch selected by a course version
+     */
+    getCourseVersionItemLaunch(requestParameters: GetCourseVersionItemLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionItemLaunch>;
+    /**
+     * Creates request options for getCourseVersionList without sending the request
+     */
+    getCourseVersionListRequestOpts(requestParameters: GetCourseVersionListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List immutable course versions and the current draft
+     */
+    getCourseVersionListRaw(requestParameters: GetCourseVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionList>>;
+    /**
+     * List immutable course versions and the current draft
+     */
+    getCourseVersionList(requestParameters: GetCourseVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionList>;
     /**
      * Creates request options for postCourse without sending the request
      */
@@ -270,6 +370,30 @@ export declare class CourseApi extends runtime.BaseAPI {
      * Post a new course
      */
     postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
+    /**
+     * Creates request options for postCourseDraft without sending the request
+     */
+    postCourseDraftRequestOpts(requestParameters: PostCourseDraftRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create or return the single editable course draft
+     */
+    postCourseDraftRaw(requestParameters: PostCourseDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>>;
+    /**
+     * Create or return the single editable course draft
+     */
+    postCourseDraft(requestParameters: PostCourseDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion>;
+    /**
+     * Creates request options for postCourseDraftResourceUpdateAll without sending the request
+     */
+    postCourseDraftResourceUpdateAllRequestOpts(requestParameters: PostCourseDraftResourceUpdateAllRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update all draft resource placements to their latest published versions
+     */
+    postCourseDraftResourceUpdateAllRaw(requestParameters: PostCourseDraftResourceUpdateAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>>;
+    /**
+     * Update all draft resource placements to their latest published versions
+     */
+    postCourseDraftResourceUpdateAll(requestParameters: PostCourseDraftResourceUpdateAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion>;
     /**
      * Creates request options for postCourseDuplicate without sending the request
      */
@@ -336,6 +460,42 @@ export declare class CourseApi extends runtime.BaseAPI {
      * Resume the current learner\'s progress in a course
      */
     postCourseResume(requestParameters: PostCourseResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostCourseResume | null | undefined>;
+    /**
+     * Creates request options for postCourseVersionItem without sending the request
+     */
+    postCourseVersionItemRequestOpts(requestParameters: PostCourseVersionItemRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Add a specific Content Library version to the course draft
+     */
+    postCourseVersionItemRaw(requestParameters: PostCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionItem>>;
+    /**
+     * Add a specific Content Library version to the course draft
+     */
+    postCourseVersionItem(requestParameters: PostCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionItem>;
+    /**
+     * Creates request options for postCourseVersionItemSession without sending the request
+     */
+    postCourseVersionItemSessionRequestOpts(requestParameters: PostCourseVersionItemSessionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Start or resume a version-pinned resource attempt
+     */
+    postCourseVersionItemSessionRaw(requestParameters: PostCourseVersionItemSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionItemSession>>;
+    /**
+     * Start or resume a version-pinned resource attempt
+     */
+    postCourseVersionItemSession(requestParameters: PostCourseVersionItemSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionItemSession>;
+    /**
+     * Creates request options for postCourseVersionPublish without sending the request
+     */
+    postCourseVersionPublishRequestOpts(requestParameters: PostCourseVersionPublishRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Publish an immutable course version
+     */
+    postCourseVersionPublishRaw(requestParameters: PostCourseVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>>;
+    /**
+     * Publish an immutable course version
+     */
+    postCourseVersionPublish(requestParameters: PostCourseVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion>;
     /**
      * Creates request options for putCourse without sending the request
      */
@@ -360,6 +520,18 @@ export declare class CourseApi extends runtime.BaseAPI {
      * Update a course enrollment
      */
     putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
+    /**
+     * Creates request options for putCourseVersionItem without sending the request
+     */
+    putCourseVersionItemRequestOpts(requestParameters: PutCourseVersionItemRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Change draft placement settings or selected version
+     */
+    putCourseVersionItemRaw(requestParameters: PutCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionItem>>;
+    /**
+     * Change draft placement settings or selected version
+     */
+    putCourseVersionItem(requestParameters: PutCourseVersionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionItem>;
 }
 /**
  * @export