@easyedu/js-lsm-api 1.83.0 → 1.84.0

package/src/models/GetResource.ts

@@ -0,0 +1,206 @@
+/* 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 { GetContentLibraryVersion } from './GetContentLibraryVersion';
+import {
+    GetContentLibraryVersionFromJSON,
+    GetContentLibraryVersionFromJSONTyped,
+    GetContentLibraryVersionToJSON,
+    GetContentLibraryVersionToJSONTyped,
+} from './GetContentLibraryVersion';
+import type { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+
+/**
+ * 
+ * @export
+ * @interface GetResource
+ */
+export interface GetResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResource
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResource
+     */
+    description: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetResource
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResource
+     */
+    ownerId: string;
+    /**
+     * 
+     * @type {GetContentLibraryVersion}
+     * @memberof GetResource
+     */
+    latestPublishedVersion?: GetContentLibraryVersion | null;
+    /**
+     * 
+     * @type {GetContentLibraryVersion}
+     * @memberof GetResource
+     */
+    draftVersion?: GetContentLibraryVersion | null;
+    /**
+     * 
+     * @type {Array<GetContentLibraryVersion>}
+     * @memberof GetResource
+     */
+    versions: Array<GetContentLibraryVersion>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    publishedCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    draftCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    historicalCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResource
+     */
+    archivedAt?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResource interface.
+ */
+export function instanceOfGetResource(value: object): value is GetResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    if (!('ownerId' in value) || value['ownerId'] === undefined) return false;
+    if (!('versions' in value) || value['versions'] === undefined) return false;
+    if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined) return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
+    if (!('historicalCourseCount' in value) || value['historicalCourseCount'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === 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 GetResourceFromJSON(json: any): GetResource {
+    return GetResourceFromJSONTyped(json, false);
+}
+
+export function GetResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'ownerId': json['owner_id'],
+        'latestPublishedVersion': json['latest_published_version'] == null ? undefined : GetContentLibraryVersionFromJSON(json['latest_published_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : GetContentLibraryVersionFromJSON(json['draft_version']),
+        'versions': ((json['versions'] as Array<any>).map(GetContentLibraryVersionFromJSON)),
+        'publishedCourseCount': json['published_course_count'],
+        'draftCourseCount': json['draft_course_count'],
+        'historicalCourseCount': json['historical_course_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+    };
+}
+
+export function GetResourceToJSON(json: any): GetResource {
+    return GetResourceToJSONTyped(json, false);
+}
+
+export function GetResourceToJSONTyped(value?: GetResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'owner_id': value['ownerId'],
+        'latest_published_version': GetContentLibraryVersionToJSON(value['latestPublishedVersion']),
+        'draft_version': GetContentLibraryVersionToJSON(value['draftVersion']),
+        'versions': ((value['versions'] as Array<any>).map(GetContentLibraryVersionToJSON)),
+        'published_course_count': value['publishedCourseCount'],
+        'draft_course_count': value['draftCourseCount'],
+        'historical_course_count': value['historicalCourseCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'archived_at': value['archivedAt'],
+    };
+}
+

package/src/models/GetResourceList.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 { GetResource } from './GetResource';
+import {
+    GetResourceFromJSON,
+    GetResourceFromJSONTyped,
+    GetResourceToJSON,
+    GetResourceToJSONTyped,
+} from './GetResource';
+
+/**
+ * 
+ * @export
+ * @interface GetResourceList
+ */
+export interface GetResourceList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetResourceList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetResource>}
+     * @memberof GetResourceList
+     */
+    items: Array<GetResource>;
+}
+
+/**
+ * Check if a given object implements the GetResourceList interface.
+ */
+export function instanceOfGetResourceList(value: object): value is GetResourceList {
+    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 GetResourceListFromJSON(json: any): GetResourceList {
+    return GetResourceListFromJSONTyped(json, false);
+}
+
+export function GetResourceListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(GetResourceFromJSON)),
+    };
+}
+
+export function GetResourceListToJSON(json: any): GetResourceList {
+    return GetResourceListToJSONTyped(json, false);
+}
+
+export function GetResourceListToJSONTyped(value?: GetResourceList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetResourceToJSON)),
+    };
+}
+

package/src/models/GetResourceUsage.ts

@@ -0,0 +1,119 @@
+/* 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 { GetResourceUsageCoursesInner } from './GetResourceUsageCoursesInner';
+import {
+    GetResourceUsageCoursesInnerFromJSON,
+    GetResourceUsageCoursesInnerFromJSONTyped,
+    GetResourceUsageCoursesInnerToJSON,
+    GetResourceUsageCoursesInnerToJSONTyped,
+} from './GetResourceUsageCoursesInner';
+
+/**
+ * 
+ * @export
+ * @interface GetResourceUsage
+ */
+export interface GetResourceUsage {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceUsage
+     */
+    resourceId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    publishedCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    draftCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    historicalCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsage
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {Array<GetResourceUsageCoursesInner>}
+     * @memberof GetResourceUsage
+     */
+    courses: Array<GetResourceUsageCoursesInner>;
+}
+
+/**
+ * Check if a given object implements the GetResourceUsage interface.
+ */
+export function instanceOfGetResourceUsage(value: object): value is GetResourceUsage {
+    if (!('resourceId' in value) || value['resourceId'] === undefined) return false;
+    if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined) return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
+    if (!('historicalCourseCount' in value) || value['historicalCourseCount'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
+    if (!('courses' in value) || value['courses'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceUsageFromJSON(json: any): GetResourceUsage {
+    return GetResourceUsageFromJSONTyped(json, false);
+}
+
+export function GetResourceUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'resourceId': json['resource_id'],
+        'publishedCourseCount': json['published_course_count'],
+        'draftCourseCount': json['draft_course_count'],
+        'historicalCourseCount': json['historical_course_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'courses': ((json['courses'] as Array<any>).map(GetResourceUsageCoursesInnerFromJSON)),
+    };
+}
+
+export function GetResourceUsageToJSON(json: any): GetResourceUsage {
+    return GetResourceUsageToJSONTyped(json, false);
+}
+
+export function GetResourceUsageToJSONTyped(value?: GetResourceUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'resource_id': value['resourceId'],
+        'published_course_count': value['publishedCourseCount'],
+        'draft_course_count': value['draftCourseCount'],
+        'historical_course_count': value['historicalCourseCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'courses': ((value['courses'] as Array<any>).map(GetResourceUsageCoursesInnerToJSON)),
+    };
+}
+

package/src/models/GetResourceUsageCoursesInner.ts

@@ -0,0 +1,121 @@
+/* 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 { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
+import {
+    ContentLibraryVersionStatusFromJSON,
+    ContentLibraryVersionStatusFromJSONTyped,
+    ContentLibraryVersionStatusToJSON,
+    ContentLibraryVersionStatusToJSONTyped,
+} from './ContentLibraryVersionStatus';
+
+/**
+ * 
+ * @export
+ * @interface GetResourceUsageCoursesInner
+ */
+export interface GetResourceUsageCoursesInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseVersionNumber: number;
+    /**
+     * 
+     * @type {ContentLibraryVersionStatus}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseStatus: ContentLibraryVersionStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    resourceVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    resourceVersionNumber: number;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResourceUsageCoursesInner interface.
+ */
+export function instanceOfGetResourceUsageCoursesInner(value: object): value is GetResourceUsageCoursesInner {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
+    if (!('courseStatus' in value) || value['courseStatus'] === undefined) return false;
+    if (!('resourceVersionId' in value) || value['resourceVersionId'] === undefined) return false;
+    if (!('resourceVersionNumber' in value) || value['resourceVersionNumber'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceUsageCoursesInnerFromJSON(json: any): GetResourceUsageCoursesInner {
+    return GetResourceUsageCoursesInnerFromJSONTyped(json, false);
+}
+
+export function GetResourceUsageCoursesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceUsageCoursesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'courseVersionNumber': json['course_version_number'],
+        'courseStatus': ContentLibraryVersionStatusFromJSON(json['course_status']),
+        'resourceVersionId': json['resource_version_id'],
+        'resourceVersionNumber': json['resource_version_number'],
+    };
+}
+
+export function GetResourceUsageCoursesInnerToJSON(json: any): GetResourceUsageCoursesInner {
+    return GetResourceUsageCoursesInnerToJSONTyped(json, false);
+}
+
+export function GetResourceUsageCoursesInnerToJSONTyped(value?: GetResourceUsageCoursesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'course_version_number': value['courseVersionNumber'],
+        'course_status': ContentLibraryVersionStatusToJSON(value['courseStatus']),
+        'resource_version_id': value['resourceVersionId'],
+        'resource_version_number': value['resourceVersionNumber'],
+    };
+}
+

package/src/models/GetResourceVersionUpload.ts

@@ -0,0 +1,75 @@
+/* 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 GetResourceVersionUpload
+ */
+export interface GetResourceVersionUpload {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceVersionUpload
+     */
+    uploadUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceVersionUpload
+     */
+    versionId: string;
+}
+
+/**
+ * Check if a given object implements the GetResourceVersionUpload interface.
+ */
+export function instanceOfGetResourceVersionUpload(value: object): value is GetResourceVersionUpload {
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceVersionUploadFromJSON(json: any): GetResourceVersionUpload {
+    return GetResourceVersionUploadFromJSONTyped(json, false);
+}
+
+export function GetResourceVersionUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceVersionUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uploadUrl': json['upload_url'],
+        'versionId': json['version_id'],
+    };
+}
+
+export function GetResourceVersionUploadToJSON(json: any): GetResourceVersionUpload {
+    return GetResourceVersionUploadToJSONTyped(json, false);
+}
+
+export function GetResourceVersionUploadToJSONTyped(value?: GetResourceVersionUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'upload_url': value['uploadUrl'],
+        'version_id': value['versionId'],
+    };
+}
+

package/src/models/PostCourseDraft.ts

@@ -0,0 +1,65 @@
+/* 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 PostCourseDraft
+ */
+export interface PostCourseDraft {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseDraft
+     */
+    changeNotes?: string;
+}
+
+/**
+ * Check if a given object implements the PostCourseDraft interface.
+ */
+export function instanceOfPostCourseDraft(value: object): value is PostCourseDraft {
+    return true;
+}
+
+export function PostCourseDraftFromJSON(json: any): PostCourseDraft {
+    return PostCourseDraftFromJSONTyped(json, false);
+}
+
+export function PostCourseDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseDraft {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostCourseDraftToJSON(json: any): PostCourseDraft {
+    return PostCourseDraftToJSONTyped(json, false);
+}
+
+export function PostCourseDraftToJSONTyped(value?: PostCourseDraft | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+    };
+}
+