@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/src/models/CourseShare.ts

@@ -0,0 +1,144 @@
+/* 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 CourseShare
+ */
+export interface CourseShare {
+    /**
+     * External ID (UUID) of the share
+     * @type {string}
+     * @memberof CourseShare
+     */
+    id: string;
+    /**
+     * Internal ID of the offering portal
+     * @type {number}
+     * @memberof CourseShare
+     */
+    sourcePortalId: number;
+    /**
+     * Internal ID of the receiving portal
+     * @type {number}
+     * @memberof CourseShare
+     */
+    targetPortalId: number;
+    /**
+     * Internal ID of the offered course
+     * @type {number}
+     * @memberof CourseShare
+     */
+    courseId: number;
+    /**
+     * 
+     * @type {CourseShareAllowedModeEnum}
+     * @memberof CourseShare
+     */
+    allowedMode: CourseShareAllowedModeEnum;
+    /**
+     * 
+     * @type {CourseShareStateEnum}
+     * @memberof CourseShare
+     */
+    state: CourseShareStateEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CourseShare
+     */
+    allowResharing: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const CourseShareAllowedModeEnum = {
+    Mirror: 'Mirror',
+    Clone: 'Clone',
+    Either: 'Either'
+} as const;
+export type CourseShareAllowedModeEnum = typeof CourseShareAllowedModeEnum[keyof typeof CourseShareAllowedModeEnum];
+
+/**
+ * @export
+ */
+export const CourseShareStateEnum = {
+    Offered: 'Offered',
+    AcceptedMirror: 'AcceptedMirror',
+    AcceptedClone: 'AcceptedClone',
+    Declined: 'Declined',
+    Revoked: 'Revoked'
+} as const;
+export type CourseShareStateEnum = typeof CourseShareStateEnum[keyof typeof CourseShareStateEnum];
+
+
+/**
+ * Check if a given object implements the CourseShare interface.
+ */
+export function instanceOfCourseShare(value: object): value is CourseShare {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('sourcePortalId' in value) || value['sourcePortalId'] === undefined) return false;
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('allowedMode' in value) || value['allowedMode'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('allowResharing' in value) || value['allowResharing'] === undefined) return false;
+    return true;
+}
+
+export function CourseShareFromJSON(json: any): CourseShare {
+    return CourseShareFromJSONTyped(json, false);
+}
+
+export function CourseShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseShare {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'sourcePortalId': json['source_portal_id'],
+        'targetPortalId': json['target_portal_id'],
+        'courseId': json['course_id'],
+        'allowedMode': json['allowed_mode'],
+        'state': json['state'],
+        'allowResharing': json['allow_resharing'],
+    };
+}
+
+export function CourseShareToJSON(json: any): CourseShare {
+    return CourseShareToJSONTyped(json, false);
+}
+
+export function CourseShareToJSONTyped(value?: CourseShare | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'source_portal_id': value['sourcePortalId'],
+        'target_portal_id': value['targetPortalId'],
+        'course_id': value['courseId'],
+        'allowed_mode': value['allowedMode'],
+        'state': value['state'],
+        'allow_resharing': value['allowResharing'],
+    };
+}
+

package/src/models/PortalSublicense.ts

@@ -0,0 +1,111 @@
+/* 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 PortalSublicense
+ */
+export interface PortalSublicense {
+    /**
+     * Maximum active enrollments. null = unlimited.
+     * @type {number}
+     * @memberof PortalSublicense
+     */
+    seatLimit?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PortalSublicense
+     */
+    licenseStartAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PortalSublicense
+     */
+    licenseEndAt?: number | null;
+    /**
+     * 
+     * @type {PortalSublicenseLicenseStateEnum}
+     * @memberof PortalSublicense
+     */
+    licenseState: PortalSublicenseLicenseStateEnum;
+    /**
+     * Current count of non-archived enrollments in this portal
+     * @type {number}
+     * @memberof PortalSublicense
+     */
+    activeEnrollmentCount: number;
+}
+
+
+/**
+ * @export
+ */
+export const PortalSublicenseLicenseStateEnum = {
+    Active: 'Active',
+    Suspended: 'Suspended',
+    Expired: 'Expired'
+} as const;
+export type PortalSublicenseLicenseStateEnum = typeof PortalSublicenseLicenseStateEnum[keyof typeof PortalSublicenseLicenseStateEnum];
+
+
+/**
+ * Check if a given object implements the PortalSublicense interface.
+ */
+export function instanceOfPortalSublicense(value: object): value is PortalSublicense {
+    if (!('licenseState' in value) || value['licenseState'] === undefined) return false;
+    if (!('activeEnrollmentCount' in value) || value['activeEnrollmentCount'] === undefined) return false;
+    return true;
+}
+
+export function PortalSublicenseFromJSON(json: any): PortalSublicense {
+    return PortalSublicenseFromJSONTyped(json, false);
+}
+
+export function PortalSublicenseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalSublicense {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+        'licenseStartAt': json['license_start_at'] == null ? undefined : json['license_start_at'],
+        'licenseEndAt': json['license_end_at'] == null ? undefined : json['license_end_at'],
+        'licenseState': json['license_state'],
+        'activeEnrollmentCount': json['active_enrollment_count'],
+    };
+}
+
+export function PortalSublicenseToJSON(json: any): PortalSublicense {
+    return PortalSublicenseToJSONTyped(json, false);
+}
+
+export function PortalSublicenseToJSONTyped(value?: PortalSublicense | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'seat_limit': value['seatLimit'],
+        'license_start_at': value['licenseStartAt'],
+        'license_end_at': value['licenseEndAt'],
+        'license_state': value['licenseState'],
+        'active_enrollment_count': value['activeEnrollmentCount'],
+    };
+}
+

package/src/models/PostCourseCatalog.ts

@@ -0,0 +1,74 @@
+/* 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 PostCourseCatalog
+ */
+export interface PostCourseCatalog {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseCatalog
+     */
+    name: string;
+    /**
+     * Optional, defaults to empty string
+     * @type {string}
+     * @memberof PostCourseCatalog
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the PostCourseCatalog interface.
+ */
+export function instanceOfPostCourseCatalog(value: object): value is PostCourseCatalog {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostCourseCatalogFromJSON(json: any): PostCourseCatalog {
+    return PostCourseCatalogFromJSONTyped(json, false);
+}
+
+export function PostCourseCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseCatalog {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function PostCourseCatalogToJSON(json: any): PostCourseCatalog {
+    return PostCourseCatalogToJSONTyped(json, false);
+}
+
+export function PostCourseCatalogToJSONTyped(value?: PostCourseCatalog | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+

package/src/models/PostOfferCatalog.ts

@@ -0,0 +1,103 @@
+/* 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 PostOfferCatalog
+ */
+export interface PostOfferCatalog {
+    /**
+     * External ID of the target (descendant) portal
+     * @type {string}
+     * @memberof PostOfferCatalog
+     */
+    targetPortalId: string;
+    /**
+     * 
+     * @type {PostOfferCatalogAllowedModeEnum}
+     * @memberof PostOfferCatalog
+     */
+    allowedMode: PostOfferCatalogAllowedModeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostOfferCatalog
+     */
+    allowResharing?: boolean;
+    /**
+     * Per-share seat cap applied to each generated offer, null = unlimited
+     * @type {number}
+     * @memberof PostOfferCatalog
+     */
+    seatLimit?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostOfferCatalogAllowedModeEnum = {
+    Mirror: 'mirror',
+    Clone: 'clone',
+    Either: 'either'
+} as const;
+export type PostOfferCatalogAllowedModeEnum = typeof PostOfferCatalogAllowedModeEnum[keyof typeof PostOfferCatalogAllowedModeEnum];
+
+
+/**
+ * Check if a given object implements the PostOfferCatalog interface.
+ */
+export function instanceOfPostOfferCatalog(value: object): value is PostOfferCatalog {
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined) return false;
+    if (!('allowedMode' in value) || value['allowedMode'] === undefined) return false;
+    return true;
+}
+
+export function PostOfferCatalogFromJSON(json: any): PostOfferCatalog {
+    return PostOfferCatalogFromJSONTyped(json, false);
+}
+
+export function PostOfferCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfferCatalog {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'targetPortalId': json['target_portal_id'],
+        'allowedMode': json['allowed_mode'],
+        'allowResharing': json['allow_resharing'] == null ? undefined : json['allow_resharing'],
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+    };
+}
+
+export function PostOfferCatalogToJSON(json: any): PostOfferCatalog {
+    return PostOfferCatalogToJSONTyped(json, false);
+}
+
+export function PostOfferCatalogToJSONTyped(value?: PostOfferCatalog | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'target_portal_id': value['targetPortalId'],
+        'allowed_mode': value['allowedMode'],
+        'allow_resharing': value['allowResharing'],
+        'seat_limit': value['seatLimit'],
+    };
+}
+

package/src/models/PostOfferCatalogResponse.ts

@@ -0,0 +1,66 @@
+/* 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 PostOfferCatalogResponse
+ */
+export interface PostOfferCatalogResponse {
+    /**
+     * Number of per-course shares created from this catalog offer
+     * @type {number}
+     * @memberof PostOfferCatalogResponse
+     */
+    createdShareCount: number;
+}
+
+/**
+ * Check if a given object implements the PostOfferCatalogResponse interface.
+ */
+export function instanceOfPostOfferCatalogResponse(value: object): value is PostOfferCatalogResponse {
+    if (!('createdShareCount' in value) || value['createdShareCount'] === undefined) return false;
+    return true;
+}
+
+export function PostOfferCatalogResponseFromJSON(json: any): PostOfferCatalogResponse {
+    return PostOfferCatalogResponseFromJSONTyped(json, false);
+}
+
+export function PostOfferCatalogResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfferCatalogResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdShareCount': json['created_share_count'],
+    };
+}
+
+export function PostOfferCatalogResponseToJSON(json: any): PostOfferCatalogResponse {
+    return PostOfferCatalogResponseToJSONTyped(json, false);
+}
+
+export function PostOfferCatalogResponseToJSONTyped(value?: PostOfferCatalogResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'created_share_count': value['createdShareCount'],
+    };
+}
+

package/src/models/PostOfferCourse.ts

@@ -0,0 +1,103 @@
+/* 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 PostOfferCourse
+ */
+export interface PostOfferCourse {
+    /**
+     * External ID of the target (descendant) portal
+     * @type {string}
+     * @memberof PostOfferCourse
+     */
+    targetPortalId: string;
+    /**
+     * 
+     * @type {PostOfferCourseAllowedModeEnum}
+     * @memberof PostOfferCourse
+     */
+    allowedMode: PostOfferCourseAllowedModeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostOfferCourse
+     */
+    allowResharing?: boolean;
+    /**
+     * Per-share seat cap, null = unlimited
+     * @type {number}
+     * @memberof PostOfferCourse
+     */
+    seatLimit?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const PostOfferCourseAllowedModeEnum = {
+    Mirror: 'mirror',
+    Clone: 'clone',
+    Either: 'either'
+} as const;
+export type PostOfferCourseAllowedModeEnum = typeof PostOfferCourseAllowedModeEnum[keyof typeof PostOfferCourseAllowedModeEnum];
+
+
+/**
+ * Check if a given object implements the PostOfferCourse interface.
+ */
+export function instanceOfPostOfferCourse(value: object): value is PostOfferCourse {
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined) return false;
+    if (!('allowedMode' in value) || value['allowedMode'] === undefined) return false;
+    return true;
+}
+
+export function PostOfferCourseFromJSON(json: any): PostOfferCourse {
+    return PostOfferCourseFromJSONTyped(json, false);
+}
+
+export function PostOfferCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfferCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'targetPortalId': json['target_portal_id'],
+        'allowedMode': json['allowed_mode'],
+        'allowResharing': json['allow_resharing'] == null ? undefined : json['allow_resharing'],
+        'seatLimit': json['seat_limit'] == null ? undefined : json['seat_limit'],
+    };
+}
+
+export function PostOfferCourseToJSON(json: any): PostOfferCourse {
+    return PostOfferCourseToJSONTyped(json, false);
+}
+
+export function PostOfferCourseToJSONTyped(value?: PostOfferCourse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'target_portal_id': value['targetPortalId'],
+        'allowed_mode': value['allowedMode'],
+        'allow_resharing': value['allowResharing'],
+        'seat_limit': value['seatLimit'],
+    };
+}
+

package/src/models/PostOfferCourseResponse.ts

@@ -0,0 +1,89 @@
+/* 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 PostOfferCourseResponse
+ */
+export interface PostOfferCourseResponse {
+    /**
+     * External ID of the new course_share row
+     * @type {string}
+     * @memberof PostOfferCourseResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {PostOfferCourseResponseStateEnum}
+     * @memberof PostOfferCourseResponse
+     */
+    state: PostOfferCourseResponseStateEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostOfferCourseResponseStateEnum = {
+    Offered: 'Offered',
+    AcceptedMirror: 'AcceptedMirror',
+    AcceptedClone: 'AcceptedClone',
+    Declined: 'Declined',
+    Revoked: 'Revoked'
+} as const;
+export type PostOfferCourseResponseStateEnum = typeof PostOfferCourseResponseStateEnum[keyof typeof PostOfferCourseResponseStateEnum];
+
+
+/**
+ * Check if a given object implements the PostOfferCourseResponse interface.
+ */
+export function instanceOfPostOfferCourseResponse(value: object): value is PostOfferCourseResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    return true;
+}
+
+export function PostOfferCourseResponseFromJSON(json: any): PostOfferCourseResponse {
+    return PostOfferCourseResponseFromJSONTyped(json, false);
+}
+
+export function PostOfferCourseResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfferCourseResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'state': json['state'],
+    };
+}
+
+export function PostOfferCourseResponseToJSON(json: any): PostOfferCourseResponse {
+    return PostOfferCourseResponseToJSONTyped(json, false);
+}
+
+export function PostOfferCourseResponseToJSONTyped(value?: PostOfferCourseResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'state': value['state'],
+    };
+}
+