@easyedu/js-lsm-api 1.26.0 → 1.27.0

package/src/apis/ContentApi.ts

@@ -19,10 +19,14 @@ import type {
   GetContentList,
   GetContentSession,
   GetContentUpload,
+  GetContentVersion,
+  GetContentVersionList,
+  GetScormPackage,
   PostContentQuiz,
   PostContentSession,
   PostContentUpload,
   PutContent,
+  PutContentVersion,
 } from '../models/index';
 import {
     GetContentFromJSON,
@@ -33,6 +37,12 @@ import {
     GetContentSessionToJSON,
     GetContentUploadFromJSON,
     GetContentUploadToJSON,
+    GetContentVersionFromJSON,
+    GetContentVersionToJSON,
+    GetContentVersionListFromJSON,
+    GetContentVersionListToJSON,
+    GetScormPackageFromJSON,
+    GetScormPackageToJSON,
     PostContentQuizFromJSON,
     PostContentQuizToJSON,
     PostContentSessionFromJSON,
@@ -41,6 +51,8 @@ import {
     PostContentUploadToJSON,
     PutContentFromJSON,
     PutContentToJSON,
+    PutContentVersionFromJSON,
+    PutContentVersionToJSON,
 } from '../models/index';
 
 export interface GetContentRequest {
@@ -60,6 +72,25 @@ export interface GetContentSessionRequest {
     courseId: string;
 }
 
+export interface GetContentVersionRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    versionId: string;
+}
+
+export interface GetContentVersionListRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    page?: number;
+    pageSize?: number;
+}
+
+export interface GetScormPackageRequest {
+    packageId: string;
+}
+
 export interface PostContentProcessRequest {
     moduleId: string;
     courseId: string;
@@ -91,6 +122,14 @@ export interface PutContentRequest {
     putContent: PutContent;
 }
 
+export interface PutContentVersionRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    versionId: string;
+    putContentVersion: PutContentVersion;
+}
+
 /**
  * 
  */
@@ -230,6 +269,154 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
+     * Get details of a specific content version
+     */
+    async getContentVersionRaw(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getContentVersion().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling getContentVersion().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getContentVersion().'
+            );
+        }
+
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling getContentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"versionId"}}`, encodeURIComponent(String(requestParameters['versionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
+     * Get details of a specific content version
+     */
+    async getContentVersion(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion> {
+        const response = await this.getContentVersionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
+     * Get all versions of a content
+     */
+    async getContentVersionListRaw(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersionList>> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getContentVersionList().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling getContentVersionList().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getContentVersionList().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionListFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
+     * Get all versions of a content
+     */
+    async getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList> {
+        const response = await this.getContentVersionListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns package information and table of contents for a SCORM package
+     * Get details of a SCORM package
+     */
+    async getScormPackageRaw(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormPackage>> {
+        if (requestParameters['packageId'] == null) {
+            throw new runtime.RequiredError(
+                'packageId',
+                'Required parameter "packageId" was null or undefined when calling getScormPackage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/scorm/packages/{packageId}`.replace(`{${"packageId"}}`, encodeURIComponent(String(requestParameters['packageId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetScormPackageFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns package information and table of contents for a SCORM package
+     * Get details of a SCORM package
+     */
+    async getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage> {
+        const response = await this.getScormPackageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Post a new content process
      */
@@ -483,4 +670,70 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
+     * Update a content version
+     */
+    async putContentVersionRaw(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentVersion>> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling putContentVersion().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling putContentVersion().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putContentVersion().'
+            );
+        }
+
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling putContentVersion().'
+            );
+        }
+
+        if (requestParameters['putContentVersion'] == null) {
+            throw new runtime.RequiredError(
+                'putContentVersion',
+                'Required parameter "putContentVersion" was null or undefined when calling putContentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"versionId"}}`, encodeURIComponent(String(requestParameters['versionId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutContentVersionToJSON(requestParameters['putContentVersion']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
+     * Update a content version
+     */
+    async putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion> {
+        const response = await this.putContentVersionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/GetContentVersion.ts

@@ -0,0 +1,143 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { GetContentVersionSandbox } from './GetContentVersionSandbox';
+import {
+    GetContentVersionSandboxFromJSON,
+    GetContentVersionSandboxFromJSONTyped,
+    GetContentVersionSandboxToJSON,
+    GetContentVersionSandboxToJSONTyped,
+} from './GetContentVersionSandbox';
+import type { GetContentVersionScormData } from './GetContentVersionScormData';
+import {
+    GetContentVersionScormDataFromJSON,
+    GetContentVersionScormDataFromJSONTyped,
+    GetContentVersionScormDataToJSON,
+    GetContentVersionScormDataToJSONTyped,
+} from './GetContentVersionScormData';
+
+/**
+ * Details of a specific content version
+ * @export
+ * @interface GetContentVersion
+ */
+export interface GetContentVersion {
+    /**
+     * The external_id (UUID) for this version
+     * @type {string}
+     * @memberof GetContentVersion
+     */
+    id: string;
+    /**
+     * The content's external_id that this version belongs to
+     * @type {string}
+     * @memberof GetContentVersion
+     */
+    contentId: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof GetContentVersion
+     */
+    version: number;
+    /**
+     * Whether this is the currently active version
+     * @type {boolean}
+     * @memberof GetContentVersion
+     */
+    isActive: boolean;
+    /**
+     * When this version was created
+     * @type {Date}
+     * @memberof GetContentVersion
+     */
+    createdAt: Date;
+    /**
+     * When this version was last updated
+     * @type {Date}
+     * @memberof GetContentVersion
+     */
+    updatedAt: Date;
+    /**
+     * 
+     * @type {GetContentVersionSandbox}
+     * @memberof GetContentVersion
+     */
+    sandbox: GetContentVersionSandbox;
+    /**
+     * 
+     * @type {GetContentVersionScormData}
+     * @memberof GetContentVersion
+     */
+    scormData?: GetContentVersionScormData | null;
+}
+
+/**
+ * Check if a given object implements the GetContentVersion interface.
+ */
+export function instanceOfGetContentVersion(value: object): value is GetContentVersion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('version' in value) || value['version'] === undefined) return false;
+    if (!('isActive' in value) || value['isActive'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('sandbox' in value) || value['sandbox'] === undefined) return false;
+    return true;
+}
+
+export function GetContentVersionFromJSON(json: any): GetContentVersion {
+    return GetContentVersionFromJSONTyped(json, false);
+}
+
+export function GetContentVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'contentId': json['content_id'],
+        'version': json['version'],
+        'isActive': json['is_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'sandbox': GetContentVersionSandboxFromJSON(json['sandbox']),
+        'scormData': json['scorm_data'] == null ? undefined : GetContentVersionScormDataFromJSON(json['scorm_data']),
+    };
+}
+
+export function GetContentVersionToJSON(json: any): GetContentVersion {
+    return GetContentVersionToJSONTyped(json, false);
+}
+
+export function GetContentVersionToJSONTyped(value?: GetContentVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'content_id': value['contentId'],
+        'version': value['version'],
+        'is_active': value['isActive'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+        'sandbox': GetContentVersionSandboxToJSON(value['sandbox']),
+        'scorm_data': GetContentVersionScormDataToJSON(value['scormData']),
+    };
+}
+

package/src/models/GetContentVersionList.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { GetContentVersionListItemsInner } from './GetContentVersionListItemsInner';
+import {
+    GetContentVersionListItemsInnerFromJSON,
+    GetContentVersionListItemsInnerFromJSONTyped,
+    GetContentVersionListItemsInnerToJSON,
+    GetContentVersionListItemsInnerToJSONTyped,
+} from './GetContentVersionListItemsInner';
+
+/**
+ * A paginated list of content versions
+ * @export
+ * @interface GetContentVersionList
+ */
+export interface GetContentVersionList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalPages: number;
+    /**
+     * The total number of versions
+     * @type {number}
+     * @memberof GetContentVersionList
+     */
+    totalItems: number;
+    /**
+     * List of content versions
+     * @type {Array<GetContentVersionListItemsInner>}
+     * @memberof GetContentVersionList
+     */
+    items: Array<GetContentVersionListItemsInner>;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionList interface.
+ */
+export function instanceOfGetContentVersionList(value: object): value is GetContentVersionList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetContentVersionListFromJSON(json: any): GetContentVersionList {
+    return GetContentVersionListFromJSONTyped(json, false);
+}
+
+export function GetContentVersionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetContentVersionListItemsInnerFromJSON)),
+    };
+}
+
+export function GetContentVersionListToJSON(json: any): GetContentVersionList {
+    return GetContentVersionListToJSONTyped(json, false);
+}
+
+export function GetContentVersionListToJSONTyped(value?: GetContentVersionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetContentVersionListItemsInnerToJSON)),
+    };
+}
+

package/src/models/GetContentVersionListItemsInner.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetContentVersionListItemsInner
+ */
+export interface GetContentVersionListItemsInner {
+    /**
+     * The external_id (UUID) for this version
+     * @type {string}
+     * @memberof GetContentVersionListItemsInner
+     */
+    id: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof GetContentVersionListItemsInner
+     */
+    version: number;
+    /**
+     * Whether this is the currently active version
+     * @type {boolean}
+     * @memberof GetContentVersionListItemsInner
+     */
+    isActive: boolean;
+    /**
+     * When this version was created
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    createdAt: Date;
+    /**
+     * When this version was last updated
+     * @type {Date}
+     * @memberof GetContentVersionListItemsInner
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the GetContentVersionListItemsInner interface.
+ */
+export function instanceOfGetContentVersionListItemsInner(value: object): value is GetContentVersionListItemsInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('version' in value) || value['version'] === undefined) return false;
+    if (!('isActive' in value) || value['isActive'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetContentVersionListItemsInnerFromJSON(json: any): GetContentVersionListItemsInner {
+    return GetContentVersionListItemsInnerFromJSONTyped(json, false);
+}
+
+export function GetContentVersionListItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentVersionListItemsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'version': json['version'],
+        'isActive': json['is_active'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function GetContentVersionListItemsInnerToJSON(json: any): GetContentVersionListItemsInner {
+    return GetContentVersionListItemsInnerToJSONTyped(json, false);
+}
+
+export function GetContentVersionListItemsInnerToJSONTyped(value?: GetContentVersionListItemsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version': value['version'],
+        'is_active': value['isActive'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+    };
+}
+