@easyedu/js-lsm-api 1.131.0 → 1.133.0

package/src/apis/QuestionApi.ts

@@ -28,6 +28,16 @@ import {
     PostQuestionFromJSON,
     PostQuestionToJSON,
 } from '../models/PostQuestion';
+import {
+    type PostQuestionTags,
+    PostQuestionTagsFromJSON,
+    PostQuestionTagsToJSON,
+} from '../models/PostQuestionTags';
+import {
+    type PostQuestionTagsResponse,
+    PostQuestionTagsResponseFromJSON,
+    PostQuestionTagsResponseToJSON,
+} from '../models/PostQuestionTagsResponse';
 import {
     type PutQuestion,
     PutQuestionFromJSON,
@@ -58,6 +68,10 @@ export interface PostQuestionRequest {
     postQuestion: PostQuestion;
 }
 
+export interface PostQuestionTagsRequest {
+    postQuestionTags: PostQuestionTags;
+}
+
 export interface PutQuestionRequest {
     questionId: string;
     putQuestion: PutQuestion;
@@ -306,6 +320,55 @@ export class QuestionApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postQuestionTags without sending the request
+     */
+    async postQuestionTagsRequestOpts(requestParameters: PostQuestionTagsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postQuestionTags'] == null) {
+            throw new runtime.RequiredError(
+                'postQuestionTags',
+                'Required parameter "postQuestionTags" was null or undefined when calling postQuestionTags().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/questions/tags`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostQuestionTagsToJSON(requestParameters['postQuestionTags']),
+        };
+    }
+
+    /**
+     * Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
+     * Add tags to several questions
+     */
+    async postQuestionTagsRaw(requestParameters: PostQuestionTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostQuestionTagsResponse>> {
+        const requestOptions = await this.postQuestionTagsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostQuestionTagsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
+     * Add tags to several questions
+     */
+    async postQuestionTags(requestParameters: PostQuestionTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostQuestionTagsResponse> {
+        const response = await this.postQuestionTagsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putQuestion without sending the request
      */

package/src/apis/SystemApi.ts

@@ -38,6 +38,11 @@ import {
     GetSystemMetricsFromJSON,
     GetSystemMetricsToJSON,
 } from '../models/GetSystemMetrics';
+import {
+    type GetSystemPortalOverview,
+    GetSystemPortalOverviewFromJSON,
+    GetSystemPortalOverviewToJSON,
+} from '../models/GetSystemPortalOverview';
 
 export interface GetSystemBillingRequest {
     page?: number;
@@ -48,6 +53,10 @@ export interface GetSystemPortalRequest {
     portalId: string;
 }
 
+export interface GetSystemPortalOverviewRequest {
+    portalId: string;
+}
+
 export interface GetSystemPortalsRequest {
     page?: number;
     pageSize?: number;
@@ -190,6 +199,51 @@ export class SystemApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getSystemPortalOverview without sending the request
+     */
+    async getSystemPortalOverviewRequestOpts(requestParameters: GetSystemPortalOverviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getSystemPortalOverview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/portals/{portalId}/overview`;
+        urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    async getSystemPortalOverviewRaw(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemPortalOverview>> {
+        const requestOptions = await this.getSystemPortalOverviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemPortalOverviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    async getSystemPortalOverview(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemPortalOverview> {
+        const response = await this.getSystemPortalOverviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSystemPortals without sending the request
      */

package/src/models/GetCourseEnrollmentListItem.ts

@@ -61,6 +61,12 @@ export interface GetCourseEnrollmentListItem {
      * @memberof GetCourseEnrollmentListItem
      */
     lastName: string;
+    /**
+     * Contact email of the enrolled user. Only populated for Instructor enrollments so learners can contact course instructors; null for Student enrollments.
+     * @type {string}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    email?: string | null;
     /**
      * Start date of the enrollment (Unix timestamp)
      * @type {number}
@@ -185,6 +191,7 @@ export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscri
         'courseVersionNumber': json['course_version_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
+        'email': json['email'] == null ? undefined : json['email'],
         'enrollmentDateStart': json['enrollment_date_start'],
         'enrollmentDateEnd': json['enrollment_date_end'],
         'status': json['status'],
@@ -213,6 +220,7 @@ export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollme
         'course_version_number': value['courseVersionNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
+        'email': value['email'],
         'enrollment_date_start': value['enrollmentDateStart'],
         'enrollment_date_end': value['enrollmentDateEnd'],
         'status': value['status'],

package/src/models/GetResourceUsageCoursesInner.ts

@@ -33,6 +33,12 @@ export interface GetResourceUsageCoursesInner {
      * @memberof GetResourceUsageCoursesInner
      */
     courseId: string;
+    /**
+     * Display name of the course
+     * @type {string}
+     * @memberof GetResourceUsageCoursesInner
+     */
+    courseName: string;
     /**
      * 
      * @type {string}
@@ -72,6 +78,7 @@ export interface GetResourceUsageCoursesInner {
  */
 export function instanceOfGetResourceUsageCoursesInner(value: object): value is GetResourceUsageCoursesInner {
     if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseName' in value) || value['courseName'] === 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;
@@ -91,6 +98,7 @@ export function GetResourceUsageCoursesInnerFromJSONTyped(json: any, ignoreDiscr
     return {
         
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'courseVersionId': json['course_version_id'],
         'courseVersionNumber': json['course_version_number'],
         'courseStatus': ContentLibraryVersionStatusFromJSON(json['course_status']),
@@ -111,6 +119,7 @@ export function GetResourceUsageCoursesInnerToJSONTyped(value?: GetResourceUsage
     return {
         
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'course_version_id': value['courseVersionId'],
         'course_version_number': value['courseVersionNumber'],
         'course_status': ContentLibraryVersionStatusToJSON(value['courseStatus']),

package/src/models/GetSystemPortalOverview.ts

@@ -0,0 +1,261 @@
+/* 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 { SystemPortalCourseStats } from './SystemPortalCourseStats';
+import {
+    SystemPortalCourseStatsFromJSON,
+    SystemPortalCourseStatsFromJSONTyped,
+    SystemPortalCourseStatsToJSON,
+    SystemPortalCourseStatsToJSONTyped,
+} from './SystemPortalCourseStats';
+import type { SystemPortalLicense } from './SystemPortalLicense';
+import {
+    SystemPortalLicenseFromJSON,
+    SystemPortalLicenseFromJSONTyped,
+    SystemPortalLicenseToJSON,
+    SystemPortalLicenseToJSONTyped,
+} from './SystemPortalLicense';
+import type { SystemPortalCertificateStats } from './SystemPortalCertificateStats';
+import {
+    SystemPortalCertificateStatsFromJSON,
+    SystemPortalCertificateStatsFromJSONTyped,
+    SystemPortalCertificateStatsToJSON,
+    SystemPortalCertificateStatsToJSONTyped,
+} from './SystemPortalCertificateStats';
+import type { SystemPortalStorageUsage } from './SystemPortalStorageUsage';
+import {
+    SystemPortalStorageUsageFromJSON,
+    SystemPortalStorageUsageFromJSONTyped,
+    SystemPortalStorageUsageToJSON,
+    SystemPortalStorageUsageToJSONTyped,
+} from './SystemPortalStorageUsage';
+import type { SystemPortalSupportStats } from './SystemPortalSupportStats';
+import {
+    SystemPortalSupportStatsFromJSON,
+    SystemPortalSupportStatsFromJSONTyped,
+    SystemPortalSupportStatsToJSON,
+    SystemPortalSupportStatsToJSONTyped,
+} from './SystemPortalSupportStats';
+import type { GetPortal } from './GetPortal';
+import {
+    GetPortalFromJSON,
+    GetPortalFromJSONTyped,
+    GetPortalToJSON,
+    GetPortalToJSONTyped,
+} from './GetPortal';
+import type { SystemPortalEnrollmentStats } from './SystemPortalEnrollmentStats';
+import {
+    SystemPortalEnrollmentStatsFromJSON,
+    SystemPortalEnrollmentStatsFromJSONTyped,
+    SystemPortalEnrollmentStatsToJSON,
+    SystemPortalEnrollmentStatsToJSONTyped,
+} from './SystemPortalEnrollmentStats';
+import type { SystemPortalActivityStats } from './SystemPortalActivityStats';
+import {
+    SystemPortalActivityStatsFromJSON,
+    SystemPortalActivityStatsFromJSONTyped,
+    SystemPortalActivityStatsToJSON,
+    SystemPortalActivityStatsToJSONTyped,
+} from './SystemPortalActivityStats';
+import type { SystemPortalContentStats } from './SystemPortalContentStats';
+import {
+    SystemPortalContentStatsFromJSON,
+    SystemPortalContentStatsFromJSONTyped,
+    SystemPortalContentStatsToJSON,
+    SystemPortalContentStatsToJSONTyped,
+} from './SystemPortalContentStats';
+import type { SystemPortalHierarchy } from './SystemPortalHierarchy';
+import {
+    SystemPortalHierarchyFromJSON,
+    SystemPortalHierarchyFromJSONTyped,
+    SystemPortalHierarchyToJSON,
+    SystemPortalHierarchyToJSONTyped,
+} from './SystemPortalHierarchy';
+import type { SystemPortalUserStats } from './SystemPortalUserStats';
+import {
+    SystemPortalUserStatsFromJSON,
+    SystemPortalUserStatsFromJSONTyped,
+    SystemPortalUserStatsToJSON,
+    SystemPortalUserStatsToJSONTyped,
+} from './SystemPortalUserStats';
+
+/**
+ * Detailed read-only overview of a single portal for platform administrators. All counts are scoped to the portal itself and exclude child portals. Timestamps are Unix epoch seconds (UTC).
+ * @export
+ * @interface GetSystemPortalOverview
+ */
+export interface GetSystemPortalOverview {
+    /**
+     * 
+     * @type {GetPortal}
+     * @memberof GetSystemPortalOverview
+     */
+    portal: GetPortal;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    updatedAt: number;
+    /**
+     * When these statistics were computed.
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    generatedAt: number;
+    /**
+     * 
+     * @type {SystemPortalHierarchy}
+     * @memberof GetSystemPortalOverview
+     */
+    hierarchy: SystemPortalHierarchy;
+    /**
+     * 
+     * @type {SystemPortalLicense}
+     * @memberof GetSystemPortalOverview
+     */
+    license: SystemPortalLicense;
+    /**
+     * 
+     * @type {SystemPortalUserStats}
+     * @memberof GetSystemPortalOverview
+     */
+    users: SystemPortalUserStats;
+    /**
+     * 
+     * @type {SystemPortalCourseStats}
+     * @memberof GetSystemPortalOverview
+     */
+    courses: SystemPortalCourseStats;
+    /**
+     * 
+     * @type {SystemPortalEnrollmentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    enrollments: SystemPortalEnrollmentStats;
+    /**
+     * 
+     * @type {SystemPortalContentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    content: SystemPortalContentStats;
+    /**
+     * 
+     * @type {SystemPortalCertificateStats}
+     * @memberof GetSystemPortalOverview
+     */
+    certificates: SystemPortalCertificateStats;
+    /**
+     * 
+     * @type {SystemPortalStorageUsage}
+     * @memberof GetSystemPortalOverview
+     */
+    storage: SystemPortalStorageUsage;
+    /**
+     * 
+     * @type {SystemPortalActivityStats}
+     * @memberof GetSystemPortalOverview
+     */
+    activity: SystemPortalActivityStats;
+    /**
+     * 
+     * @type {SystemPortalSupportStats}
+     * @memberof GetSystemPortalOverview
+     */
+    support: SystemPortalSupportStats;
+}
+
+/**
+ * Check if a given object implements the GetSystemPortalOverview interface.
+ */
+export function instanceOfGetSystemPortalOverview(value: object): value is GetSystemPortalOverview {
+    if (!('portal' in value) || value['portal'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined) return false;
+    if (!('hierarchy' in value) || value['hierarchy'] === undefined) return false;
+    if (!('license' in value) || value['license'] === undefined) return false;
+    if (!('users' in value) || value['users'] === undefined) return false;
+    if (!('courses' in value) || value['courses'] === undefined) return false;
+    if (!('enrollments' in value) || value['enrollments'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('certificates' in value) || value['certificates'] === undefined) return false;
+    if (!('storage' in value) || value['storage'] === undefined) return false;
+    if (!('activity' in value) || value['activity'] === undefined) return false;
+    if (!('support' in value) || value['support'] === undefined) return false;
+    return true;
+}
+
+export function GetSystemPortalOverviewFromJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewFromJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemPortalOverview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portal': GetPortalFromJSON(json['portal']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'generatedAt': json['generated_at'],
+        'hierarchy': SystemPortalHierarchyFromJSON(json['hierarchy']),
+        'license': SystemPortalLicenseFromJSON(json['license']),
+        'users': SystemPortalUserStatsFromJSON(json['users']),
+        'courses': SystemPortalCourseStatsFromJSON(json['courses']),
+        'enrollments': SystemPortalEnrollmentStatsFromJSON(json['enrollments']),
+        'content': SystemPortalContentStatsFromJSON(json['content']),
+        'certificates': SystemPortalCertificateStatsFromJSON(json['certificates']),
+        'storage': SystemPortalStorageUsageFromJSON(json['storage']),
+        'activity': SystemPortalActivityStatsFromJSON(json['activity']),
+        'support': SystemPortalSupportStatsFromJSON(json['support']),
+    };
+}
+
+export function GetSystemPortalOverviewToJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewToJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewToJSONTyped(value?: GetSystemPortalOverview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal': GetPortalToJSON(value['portal']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'generated_at': value['generatedAt'],
+        'hierarchy': SystemPortalHierarchyToJSON(value['hierarchy']),
+        'license': SystemPortalLicenseToJSON(value['license']),
+        'users': SystemPortalUserStatsToJSON(value['users']),
+        'courses': SystemPortalCourseStatsToJSON(value['courses']),
+        'enrollments': SystemPortalEnrollmentStatsToJSON(value['enrollments']),
+        'content': SystemPortalContentStatsToJSON(value['content']),
+        'certificates': SystemPortalCertificateStatsToJSON(value['certificates']),
+        'storage': SystemPortalStorageUsageToJSON(value['storage']),
+        'activity': SystemPortalActivityStatsToJSON(value['activity']),
+        'support': SystemPortalSupportStatsToJSON(value['support']),
+    };
+}
+

package/src/models/PostQuestionTags.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';
+/**
+ * Adds shared tags to several questions at once without creating new question versions.
+ * @export
+ * @interface PostQuestionTags
+ */
+export interface PostQuestionTags {
+    /**
+     * External IDs of the questions to tag
+     * @type {Array<string>}
+     * @memberof PostQuestionTags
+     */
+    questionIds: Array<string>;
+    /**
+     * Tag names to add. Existing tags on each question are kept.
+     * @type {Array<string>}
+     * @memberof PostQuestionTags
+     */
+    tags: Array<string>;
+}
+
+/**
+ * Check if a given object implements the PostQuestionTags interface.
+ */
+export function instanceOfPostQuestionTags(value: object): value is PostQuestionTags {
+    if (!('questionIds' in value) || value['questionIds'] === undefined) return false;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    return true;
+}
+
+export function PostQuestionTagsFromJSON(json: any): PostQuestionTags {
+    return PostQuestionTagsFromJSONTyped(json, false);
+}
+
+export function PostQuestionTagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionTags {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'questionIds': json['question_ids'],
+        'tags': json['tags'],
+    };
+}
+
+export function PostQuestionTagsToJSON(json: any): PostQuestionTags {
+    return PostQuestionTagsToJSONTyped(json, false);
+}
+
+export function PostQuestionTagsToJSONTyped(value?: PostQuestionTags | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'question_ids': value['questionIds'],
+        'tags': value['tags'],
+    };
+}
+

package/src/models/PostQuestionTagsResponse.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 PostQuestionTagsResponse
+ */
+export interface PostQuestionTagsResponse {
+    /**
+     * Number of questions that received the tags
+     * @type {number}
+     * @memberof PostQuestionTagsResponse
+     */
+    updatedCount: number;
+}
+
+/**
+ * Check if a given object implements the PostQuestionTagsResponse interface.
+ */
+export function instanceOfPostQuestionTagsResponse(value: object): value is PostQuestionTagsResponse {
+    if (!('updatedCount' in value) || value['updatedCount'] === undefined) return false;
+    return true;
+}
+
+export function PostQuestionTagsResponseFromJSON(json: any): PostQuestionTagsResponse {
+    return PostQuestionTagsResponseFromJSONTyped(json, false);
+}
+
+export function PostQuestionTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostQuestionTagsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'updatedCount': json['updated_count'],
+    };
+}
+
+export function PostQuestionTagsResponseToJSON(json: any): PostQuestionTagsResponse {
+    return PostQuestionTagsResponseToJSONTyped(json, false);
+}
+
+export function PostQuestionTagsResponseToJSONTyped(value?: PostQuestionTagsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'updated_count': value['updatedCount'],
+    };
+}
+