@easyedu/js-lsm-api 1.106.0 → 1.108.0

package/dist/esm/models/GetCourseCatalogList.js

@@ -0,0 +1,60 @@
+/* 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 { CourseCatalogFromJSON, CourseCatalogToJSON, } from './CourseCatalog';
+/**
+ * Check if a given object implements the GetCourseCatalogList interface.
+ */
+export function instanceOfGetCourseCatalogList(value) {
+    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 GetCourseCatalogListFromJSON(json) {
+    return GetCourseCatalogListFromJSONTyped(json, false);
+}
+export function GetCourseCatalogListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseCatalogFromJSON)),
+    };
+}
+export function GetCourseCatalogListToJSON(json) {
+    return GetCourseCatalogListToJSONTyped(json, false);
+}
+export function GetCourseCatalogListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseCatalogToJSON)),
+    };
+}

package/dist/esm/models/GetCourseExport.d.ts

@@ -27,6 +27,12 @@ export interface GetCourseExport {
      * @memberof GetCourseExport
      */
     courseId: string;
+    /**
+     * Display name of the course being exported
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseName: string;
     /**
      * Immutable version used by the export; null only for historical records.
      * @type {string}

package/dist/esm/models/GetCourseExport.js

@@ -36,6 +36,8 @@ export function instanceOfGetCourseExport(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('courseName' in value) || value['courseName'] === undefined)
+        return false;
     if (!('exportType' in value) || value['exportType'] === undefined)
         return false;
     if (!('sectionIds' in value) || value['sectionIds'] === undefined)
@@ -58,6 +60,7 @@ export function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
         'exportType': json['export_type'],
         'sectionIds': json['section_ids'],
@@ -79,6 +82,7 @@ export function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'section_ids': value['sectionIds'],

package/dist/esm/models/GetCourseShareList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { CourseShare } from './CourseShare';
+/**
+ *
+ * @export
+ * @interface GetCourseShareList
+ */
+export interface GetCourseShareList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseShare>}
+     * @memberof GetCourseShareList
+     */
+    items: Array<CourseShare>;
+}
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export declare function instanceOfGetCourseShareList(value: object): value is GetCourseShareList;
+export declare function GetCourseShareListFromJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseShareList;
+export declare function GetCourseShareListToJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListToJSONTyped(value?: GetCourseShareList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseShareList.js

@@ -0,0 +1,60 @@
+/* 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 { CourseShareFromJSON, CourseShareToJSON, } from './CourseShare';
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export function instanceOfGetCourseShareList(value) {
+    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 GetCourseShareListFromJSON(json) {
+    return GetCourseShareListFromJSONTyped(json, false);
+}
+export function GetCourseShareListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseShareFromJSON)),
+    };
+}
+export function GetCourseShareListToJSON(json) {
+    return GetCourseShareListToJSONTyped(json, false);
+}
+export function GetCourseShareListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseShareToJSON)),
+    };
+}

package/dist/esm/models/PostOfferCatalog.d.ts

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCatalog {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCatalog
      */

package/dist/esm/models/PostOfferCourse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCourse {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCourse
      */

package/dist/esm/models/index.d.ts

@@ -56,6 +56,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -63,6 +64,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/esm/models/index.js

@@ -58,6 +58,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -65,6 +66,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/models/CourseShare.d.ts

@@ -10,9 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- * Shape returned by `GET /course-shares/offered-to-me`. Includes joined source
- * portal name and course name so the child portal can render an inbox without
- * follow-up requests.
+ * Shared shape returned by the incoming and outgoing course-share lists. All
+ * resource identifiers are public external IDs so clients can link to the
+ * related course, portal, and catalog without exposing database keys.
  *
  * @export
  * @interface CourseShare
@@ -25,11 +25,11 @@ export interface CourseShare {
      */
     id: string;
     /**
-     * Internal ID of the offering portal
-     * @type {number}
+     * External ID of the offering portal
+     * @type {string}
      * @memberof CourseShare
      */
-    sourcePortalId: number;
+    sourcePortalId: string;
     /**
      * Display name of the offering portal
      * @type {string}
@@ -37,11 +37,23 @@ export interface CourseShare {
      */
     sourcePortalName: string;
     /**
-     * Internal ID of the offered course
-     * @type {number}
+     * External ID of the receiving portal
+     * @type {string}
+     * @memberof CourseShare
+     */
+    targetPortalId: string;
+    /**
+     * Display name of the receiving portal
+     * @type {string}
+     * @memberof CourseShare
+     */
+    targetPortalName: string;
+    /**
+     * External ID of the offered course
+     * @type {string}
      * @memberof CourseShare
      */
-    courseId: number;
+    courseId: string;
     /**
      * Display name of the offered course
      * @type {string}
@@ -66,6 +78,42 @@ export interface CourseShare {
      * @memberof CourseShare
      */
     allowResharing: boolean;
+    /**
+     * Per-share seat cap; null means unlimited
+     * @type {number}
+     * @memberof CourseShare
+     */
+    seatLimit: number | null;
+    /**
+     * External ID of the catalog that produced the offer, when applicable
+     * @type {string}
+     * @memberof CourseShare
+     */
+    originCatalogId: string | null;
+    /**
+     * Display name of the catalog that produced the offer, when applicable
+     * @type {string}
+     * @memberof CourseShare
+     */
+    originCatalogName: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    offeredAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    respondedAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    revokedAt: Date | null;
 }
 /**
  * @export

package/dist/models/CourseShare.js

@@ -47,6 +47,10 @@ function instanceOfCourseShare(value) {
         return false;
     if (!('sourcePortalName' in value) || value['sourcePortalName'] === undefined)
         return false;
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined)
+        return false;
+    if (!('targetPortalName' in value) || value['targetPortalName'] === undefined)
+        return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
     if (!('courseName' in value) || value['courseName'] === undefined)
@@ -57,6 +61,18 @@ function instanceOfCourseShare(value) {
         return false;
     if (!('allowResharing' in value) || value['allowResharing'] === undefined)
         return false;
+    if (!('seatLimit' in value) || value['seatLimit'] === undefined)
+        return false;
+    if (!('originCatalogId' in value) || value['originCatalogId'] === undefined)
+        return false;
+    if (!('originCatalogName' in value) || value['originCatalogName'] === undefined)
+        return false;
+    if (!('offeredAt' in value) || value['offeredAt'] === undefined)
+        return false;
+    if (!('respondedAt' in value) || value['respondedAt'] === undefined)
+        return false;
+    if (!('revokedAt' in value) || value['revokedAt'] === undefined)
+        return false;
     return true;
 }
 function CourseShareFromJSON(json) {
@@ -70,11 +86,19 @@ function CourseShareFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'sourcePortalId': json['source_portal_id'],
         'sourcePortalName': json['source_portal_name'],
+        'targetPortalId': json['target_portal_id'],
+        'targetPortalName': json['target_portal_name'],
         'courseId': json['course_id'],
         'courseName': json['course_name'],
         'allowedMode': json['allowed_mode'],
         'state': json['state'],
         'allowResharing': json['allow_resharing'],
+        'seatLimit': json['seat_limit'],
+        'originCatalogId': json['origin_catalog_id'],
+        'originCatalogName': json['origin_catalog_name'],
+        'offeredAt': (new Date(json['offered_at'])),
+        'respondedAt': (json['responded_at'] == null ? null : new Date(json['responded_at'])),
+        'revokedAt': (json['revoked_at'] == null ? null : new Date(json['revoked_at'])),
     };
 }
 function CourseShareToJSON(json) {
@@ -88,10 +112,18 @@ function CourseShareToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'source_portal_id': value['sourcePortalId'],
         'source_portal_name': value['sourcePortalName'],
+        'target_portal_id': value['targetPortalId'],
+        'target_portal_name': value['targetPortalName'],
         'course_id': value['courseId'],
         'course_name': value['courseName'],
         'allowed_mode': value['allowedMode'],
         'state': value['state'],
         'allow_resharing': value['allowResharing'],
+        'seat_limit': value['seatLimit'],
+        'origin_catalog_id': value['originCatalogId'],
+        'origin_catalog_name': value['originCatalogName'],
+        'offered_at': value['offeredAt'].toISOString(),
+        'responded_at': value['respondedAt'] == null ? value['respondedAt'] : value['respondedAt'].toISOString(),
+        'revoked_at': value['revokedAt'] == null ? value['revokedAt'] : value['revokedAt'].toISOString(),
     };
 }

package/dist/models/GetCourseCatalogList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { CourseCatalog } from './CourseCatalog';
+/**
+ *
+ * @export
+ * @interface GetCourseCatalogList
+ */
+export interface GetCourseCatalogList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseCatalog>}
+     * @memberof GetCourseCatalogList
+     */
+    items: Array<CourseCatalog>;
+}
+/**
+ * Check if a given object implements the GetCourseCatalogList interface.
+ */
+export declare function instanceOfGetCourseCatalogList(value: object): value is GetCourseCatalogList;
+export declare function GetCourseCatalogListFromJSON(json: any): GetCourseCatalogList;
+export declare function GetCourseCatalogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseCatalogList;
+export declare function GetCourseCatalogListToJSON(json: any): GetCourseCatalogList;
+export declare function GetCourseCatalogListToJSONTyped(value?: GetCourseCatalogList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseCatalogList.js

@@ -0,0 +1,67 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseCatalogList = instanceOfGetCourseCatalogList;
+exports.GetCourseCatalogListFromJSON = GetCourseCatalogListFromJSON;
+exports.GetCourseCatalogListFromJSONTyped = GetCourseCatalogListFromJSONTyped;
+exports.GetCourseCatalogListToJSON = GetCourseCatalogListToJSON;
+exports.GetCourseCatalogListToJSONTyped = GetCourseCatalogListToJSONTyped;
+const CourseCatalog_1 = require("./CourseCatalog");
+/**
+ * Check if a given object implements the GetCourseCatalogList interface.
+ */
+function instanceOfGetCourseCatalogList(value) {
+    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;
+}
+function GetCourseCatalogListFromJSON(json) {
+    return GetCourseCatalogListFromJSONTyped(json, false);
+}
+function GetCourseCatalogListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseCatalog_1.CourseCatalogFromJSON)),
+    };
+}
+function GetCourseCatalogListToJSON(json) {
+    return GetCourseCatalogListToJSONTyped(json, false);
+}
+function GetCourseCatalogListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseCatalog_1.CourseCatalogToJSON)),
+    };
+}

package/dist/models/GetCourseExport.d.ts

@@ -27,6 +27,12 @@ export interface GetCourseExport {
      * @memberof GetCourseExport
      */
     courseId: string;
+    /**
+     * Display name of the course being exported
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseName: string;
     /**
      * Immutable version used by the export; null only for historical records.
      * @type {string}

package/dist/models/GetCourseExport.js

@@ -44,6 +44,8 @@ function instanceOfGetCourseExport(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('courseName' in value) || value['courseName'] === undefined)
+        return false;
     if (!('exportType' in value) || value['exportType'] === undefined)
         return false;
     if (!('sectionIds' in value) || value['sectionIds'] === undefined)
@@ -66,6 +68,7 @@ function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
         'exportType': json['export_type'],
         'sectionIds': json['section_ids'],
@@ -87,6 +90,7 @@ function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'section_ids': value['sectionIds'],

package/dist/models/GetCourseShareList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { CourseShare } from './CourseShare';
+/**
+ *
+ * @export
+ * @interface GetCourseShareList
+ */
+export interface GetCourseShareList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseShare>}
+     * @memberof GetCourseShareList
+     */
+    items: Array<CourseShare>;
+}
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export declare function instanceOfGetCourseShareList(value: object): value is GetCourseShareList;
+export declare function GetCourseShareListFromJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseShareList;
+export declare function GetCourseShareListToJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListToJSONTyped(value?: GetCourseShareList | null, ignoreDiscriminator?: boolean): any;