@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/src/apis/CourseApi.ts

@@ -88,6 +88,16 @@ import {
     GetCourseVersionSectionFromJSON,
     GetCourseVersionSectionToJSON,
 } from '../models/GetCourseVersionSection';
+import {
+    type GetHostedScormRegistrationList,
+    GetHostedScormRegistrationListFromJSON,
+    GetHostedScormRegistrationListToJSON,
+} from '../models/GetHostedScormRegistrationList';
+import {
+    type HostedScormAccessPolicy,
+    HostedScormAccessPolicyFromJSON,
+    HostedScormAccessPolicyToJSON,
+} from '../models/HostedScormAccessPolicy';
 import {
     type PostClearSessions,
     PostClearSessionsFromJSON,
@@ -193,6 +203,11 @@ import {
     PutCourseVersionSectionFromJSON,
     PutCourseVersionSectionToJSON,
 } from '../models/PutCourseVersionSection';
+import {
+    type PutHostedScormStatus,
+    PutHostedScormStatusFromJSON,
+    PutHostedScormStatusToJSON,
+} from '../models/PutHostedScormStatus';
 
 export interface DeleteCourseRequest {
     courseId: string;
@@ -299,6 +314,13 @@ export interface GetCourseVersionProgressionRequest {
     preview?: boolean;
 }
 
+export interface GetHostedScormExportRegistrationsRequest {
+    courseId: string;
+    exportId: string;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface GetPortalCourseExportsRequest {
     page?: number;
     pageSize?: number;
@@ -424,6 +446,18 @@ export interface PutCourseVersionSectionRequest {
     putCourseVersionSection: PutCourseVersionSection;
 }
 
+export interface PutHostedScormExportAccessRequest {
+    courseId: string;
+    exportId: string;
+    body: HostedScormAccessPolicy;
+}
+
+export interface PutHostedScormExportStatusRequest {
+    courseId: string;
+    exportId: string;
+    putHostedScormStatus: PutHostedScormStatus;
+}
+
 /**
  * 
  */
@@ -1452,6 +1486,67 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getHostedScormExportRegistrations without sending the request
+     */
+    async getHostedScormExportRegistrationsRequestOpts(requestParameters: GetHostedScormExportRegistrationsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getHostedScormExportRegistrations().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling getHostedScormExportRegistrations().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List hosted SCORM learner registrations
+     */
+    async getHostedScormExportRegistrationsRaw(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetHostedScormRegistrationList>> {
+        const requestOptions = await this.getHostedScormExportRegistrationsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetHostedScormRegistrationListFromJSON(jsonValue));
+    }
+
+    /**
+     * List hosted SCORM learner registrations
+     */
+    async getHostedScormExportRegistrations(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetHostedScormRegistrationList> {
+        const response = await this.getHostedScormExportRegistrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getPortalCourseExports without sending the request
      */
@@ -2752,6 +2847,132 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putHostedScormExportAccess without sending the request
+     */
+    async putHostedScormExportAccessRequestOpts(requestParameters: PutHostedScormExportAccessRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError(
+                'body',
+                'Required parameter "body" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/access`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'] as any,
+        };
+    }
+
+    /**
+     * Update mutable access controls for a hosted SCORM export
+     */
+    async putHostedScormExportAccessRaw(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        const requestOptions = await this.putHostedScormExportAccessRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Update mutable access controls for a hosted SCORM export
+     */
+    async putHostedScormExportAccess(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.putHostedScormExportAccessRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putHostedScormExportStatus without sending the request
+     */
+    async putHostedScormExportStatusRequestOpts(requestParameters: PutHostedScormExportStatusRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        if (requestParameters['putHostedScormStatus'] == null) {
+            throw new runtime.RequiredError(
+                'putHostedScormStatus',
+                'Required parameter "putHostedScormStatus" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/status`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutHostedScormStatusToJSON(requestParameters['putHostedScormStatus']),
+        };
+    }
+
+    /**
+     * Revoke or reactivate a hosted SCORM export
+     */
+    async putHostedScormExportStatusRaw(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        const requestOptions = await this.putHostedScormExportStatusRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Revoke or reactivate a hosted SCORM export
+     */
+    async putHostedScormExportStatus(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.putHostedScormExportStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**