@easyedu/js-lsm-api 1.110.0 → 1.111.0

package/docs/PutLearnerExperienceDraft.md

@@ -0,0 +1,36 @@
+
+# PutLearnerExperienceDraft
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`designDocument` | { [key: string]: any; }
+`changeNotes` | string
+
+## Example
+
+```typescript
+import type { PutLearnerExperienceDraft } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "designDocument": null,
+  "changeNotes": null,
+} satisfies PutLearnerExperienceDraft
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutLearnerExperienceDraft
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.110.0",
+  "version": "1.111.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/LearnerExperienceApi.ts

@@ -0,0 +1,465 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetEffectiveLearnerExperience,
+    GetEffectiveLearnerExperienceFromJSON,
+    GetEffectiveLearnerExperienceToJSON,
+} from '../models/GetEffectiveLearnerExperience';
+import {
+    type GetLearnerDashboard,
+    GetLearnerDashboardFromJSON,
+    GetLearnerDashboardToJSON,
+} from '../models/GetLearnerDashboard';
+import {
+    type GetLearnerExperience,
+    GetLearnerExperienceFromJSON,
+    GetLearnerExperienceToJSON,
+} from '../models/GetLearnerExperience';
+import {
+    type GetLearnerExperiencePreview,
+    GetLearnerExperiencePreviewFromJSON,
+    GetLearnerExperiencePreviewToJSON,
+} from '../models/GetLearnerExperiencePreview';
+import {
+    type LearnerExperienceVersion,
+    LearnerExperienceVersionFromJSON,
+    LearnerExperienceVersionToJSON,
+} from '../models/LearnerExperienceVersion';
+import {
+    type PostLearnerExperiencePreview,
+    PostLearnerExperiencePreviewFromJSON,
+    PostLearnerExperiencePreviewToJSON,
+} from '../models/PostLearnerExperiencePreview';
+import {
+    type PutLearnerExperienceDraft,
+    PutLearnerExperienceDraftFromJSON,
+    PutLearnerExperienceDraftToJSON,
+} from '../models/PutLearnerExperienceDraft';
+
+export interface PostLearnerExperiencePreviewRequest {
+    postLearnerExperiencePreview: PostLearnerExperiencePreview;
+}
+
+export interface PostLearnerExperienceVersionRestoreRequest {
+    versionId: string;
+}
+
+export interface PutLearnerExperienceDraftRequest {
+    putLearnerExperienceDraft: PutLearnerExperienceDraft;
+}
+
+/**
+ * 
+ */
+export class LearnerExperienceApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteLearnerExperienceDraft without sending the request
+     */
+    async deleteLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    async deleteLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteLearnerExperienceDraftRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    async deleteLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteLearnerExperienceDraftRaw(initOverrides);
+    }
+
+    /**
+     * Creates request options for getCurrentLearnerDashboard without sending the request
+     */
+    async getCurrentLearnerDashboardRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/current/dashboard`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    async getCurrentLearnerDashboardRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerDashboard>> {
+        const requestOptions = await this.getCurrentLearnerDashboardRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerDashboardFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    async getCurrentLearnerDashboard(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerDashboard> {
+        const response = await this.getCurrentLearnerDashboardRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getEffectiveLearnerExperience without sending the request
+     */
+    async getEffectiveLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/effective`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    async getEffectiveLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEffectiveLearnerExperience>> {
+        const requestOptions = await this.getEffectiveLearnerExperienceRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetEffectiveLearnerExperienceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    async getEffectiveLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEffectiveLearnerExperience> {
+        const response = await this.getEffectiveLearnerExperienceRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getLearnerExperience without sending the request
+     */
+    async getLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    async getLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperience>> {
+        const requestOptions = await this.getLearnerExperienceRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperienceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    async getLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperience> {
+        const response = await this.getLearnerExperienceRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceDraft without sending the request
+     */
+    async postLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    async postLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperienceDraftRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    async postLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperienceDraftRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceInherit without sending the request
+     */
+    async postLearnerExperienceInheritRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/inherit`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    async postLearnerExperienceInheritRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.postLearnerExperienceInheritRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    async postLearnerExperienceInherit(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.postLearnerExperienceInheritRaw(initOverrides);
+    }
+
+    /**
+     * Creates request options for postLearnerExperiencePreview without sending the request
+     */
+    async postLearnerExperiencePreviewRequestOpts(requestParameters: PostLearnerExperiencePreviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postLearnerExperiencePreview'] == null) {
+            throw new runtime.RequiredError(
+                'postLearnerExperiencePreview',
+                'Required parameter "postLearnerExperiencePreview" was null or undefined when calling postLearnerExperiencePreview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/learner-experience/preview`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostLearnerExperiencePreviewToJSON(requestParameters['postLearnerExperiencePreview']),
+        };
+    }
+
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    async postLearnerExperiencePreviewRaw(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperiencePreview>> {
+        const requestOptions = await this.postLearnerExperiencePreviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLearnerExperiencePreviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    async postLearnerExperiencePreview(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperiencePreview> {
+        const response = await this.postLearnerExperiencePreviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperiencePublish without sending the request
+     */
+    async postLearnerExperiencePublishRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/publish`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    async postLearnerExperiencePublishRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperiencePublishRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    async postLearnerExperiencePublish(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperiencePublishRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postLearnerExperienceVersionRestore without sending the request
+     */
+    async postLearnerExperienceVersionRestoreRequestOpts(requestParameters: PostLearnerExperienceVersionRestoreRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling postLearnerExperienceVersionRestore().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/learner-experience/versions/{versionId}/restore`;
+        urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    async postLearnerExperienceVersionRestoreRaw(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.postLearnerExperienceVersionRestoreRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    async postLearnerExperienceVersionRestore(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.postLearnerExperienceVersionRestoreRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putLearnerExperienceDraft without sending the request
+     */
+    async putLearnerExperienceDraftRequestOpts(requestParameters: PutLearnerExperienceDraftRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['putLearnerExperienceDraft'] == null) {
+            throw new runtime.RequiredError(
+                'putLearnerExperienceDraft',
+                'Required parameter "putLearnerExperienceDraft" was null or undefined when calling putLearnerExperienceDraft().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/learner-experience/draft`;
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutLearnerExperienceDraftToJSON(requestParameters['putLearnerExperienceDraft']),
+        };
+    }
+
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    async putLearnerExperienceDraftRaw(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>> {
+        const requestOptions = await this.putLearnerExperienceDraftRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LearnerExperienceVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    async putLearnerExperienceDraft(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion> {
+        const response = await this.putLearnerExperienceDraftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -11,6 +11,7 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
+export * from './LearnerExperienceApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';

package/src/models/GetEffectiveLearnerExperience.ts

@@ -0,0 +1,105 @@
+/* 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 GetEffectiveLearnerExperience
+ */
+export interface GetEffectiveLearnerExperience {
+    /**
+     * 
+     * @type {GetEffectiveLearnerExperienceEffectiveSourceEnum}
+     * @memberof GetEffectiveLearnerExperience
+     */
+    effectiveSource: GetEffectiveLearnerExperienceEffectiveSourceEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEffectiveLearnerExperience
+     */
+    effectiveSourcePortalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEffectiveLearnerExperience
+     */
+    versionId: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof GetEffectiveLearnerExperience
+     */
+    designDocument: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const GetEffectiveLearnerExperienceEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type GetEffectiveLearnerExperienceEffectiveSourceEnum = typeof GetEffectiveLearnerExperienceEffectiveSourceEnum[keyof typeof GetEffectiveLearnerExperienceEffectiveSourceEnum];
+
+
+/**
+ * Check if a given object implements the GetEffectiveLearnerExperience interface.
+ */
+export function instanceOfGetEffectiveLearnerExperience(value: object): value is GetEffectiveLearnerExperience {
+    if (!('effectiveSource' in value) || value['effectiveSource'] === undefined) return false;
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
+    return true;
+}
+
+export function GetEffectiveLearnerExperienceFromJSON(json: any): GetEffectiveLearnerExperience {
+    return GetEffectiveLearnerExperienceFromJSONTyped(json, false);
+}
+
+export function GetEffectiveLearnerExperienceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEffectiveLearnerExperience {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'effectiveSource': json['effective_source'],
+        'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
+        'versionId': json['version_id'],
+        'designDocument': json['design_document'],
+    };
+}
+
+export function GetEffectiveLearnerExperienceToJSON(json: any): GetEffectiveLearnerExperience {
+    return GetEffectiveLearnerExperienceToJSONTyped(json, false);
+}
+
+export function GetEffectiveLearnerExperienceToJSONTyped(value?: GetEffectiveLearnerExperience | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'effective_source': value['effectiveSource'],
+        'effective_source_portal_id': value['effectiveSourcePortalId'],
+        'version_id': value['versionId'],
+        'design_document': value['designDocument'],
+    };
+}
+