@easyedu/js-lsm-api 1.100.0 → 1.101.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,6 +26,7 @@ docs/CertificateRenewalPolicy.md
26
26
  docs/CertificateTemplate.md
27
27
  docs/CertificateTemplateApi.md
28
28
  docs/CertificateTemplateVersion.md
29
+ docs/ChangelogApi.md
29
30
  docs/ChatApi.md
30
31
  docs/ContentLaunchMode.md
31
32
  docs/ContentLibraryApi.md
@@ -49,6 +50,8 @@ docs/GetCertificateConfigList.md
49
50
  docs/GetCertificateEventList.md
50
51
  docs/GetCertificateList.md
51
52
  docs/GetCertificateTemplateList.md
53
+ docs/GetChangelogEntry.md
54
+ docs/GetChangelogList.md
52
55
  docs/GetChatMessage.md
53
56
  docs/GetContentLibraryVersion.md
54
57
  docs/GetConversation.md
@@ -278,6 +281,7 @@ docs/UserApi.md
278
281
  package.json
279
282
  src/apis/CertificateApi.ts
280
283
  src/apis/CertificateTemplateApi.ts
284
+ src/apis/ChangelogApi.ts
281
285
  src/apis/ChatApi.ts
282
286
  src/apis/ContentLibraryApi.ts
283
287
  src/apis/ContentLibraryQuizApi.ts
@@ -336,6 +340,8 @@ src/models/GetCertificateConfigList.ts
336
340
  src/models/GetCertificateEventList.ts
337
341
  src/models/GetCertificateList.ts
338
342
  src/models/GetCertificateTemplateList.ts
343
+ src/models/GetChangelogEntry.ts
344
+ src/models/GetChangelogList.ts
339
345
  src/models/GetChatMessage.ts
340
346
  src/models/GetContentLibraryVersion.ts
341
347
  src/models/GetConversation.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.100.0
1
+ # @easyedu/js-lsm-api@1.101.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -116,6 +116,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
116
116
  *CertificateTemplateApi* | [**putPlatformCertificateAssetFile**](docs/CertificateTemplateApi.md#putplatformcertificateassetfile) | **PUT** /system/certificate-assets/{assetId}/file | Upload platform certificate image bytes
117
117
  *CertificateTemplateApi* | [**putPlatformCertificateTemplate**](docs/CertificateTemplateApi.md#putplatformcertificatetemplate) | **PUT** /system/certificate-templates/{templateId} | Update platform certificate design metadata
118
118
  *CertificateTemplateApi* | [**putPlatformCertificateTemplateDraft**](docs/CertificateTemplateApi.md#putplatformcertificatetemplatedraft) | **PUT** /system/certificate-templates/{templateId}/draft | Update a platform certificate design draft
119
+ *ChangelogApi* | [**getChangelog**](docs/ChangelogApi.md#getchangelog) | **GET** /changelog | List user-facing product updates
119
120
  *ChatApi* | [**deleteConversation**](docs/ChatApi.md#deleteconversation) | **DELETE** /chat/conversations/{conversationId} | Delete a conversation
120
121
  *ChatApi* | [**getConversationMessages**](docs/ChatApi.md#getconversationmessages) | **GET** /chat/conversations/{conversationId}/messages | Get all messages in a conversation
121
122
  *ChatApi* | [**getConversations**](docs/ChatApi.md#getconversations) | **GET** /chat/conversations | List conversations for the current user
@@ -385,6 +386,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
385
386
  - [GetCertificateEventList](docs/GetCertificateEventList.md)
386
387
  - [GetCertificateList](docs/GetCertificateList.md)
387
388
  - [GetCertificateTemplateList](docs/GetCertificateTemplateList.md)
389
+ - [GetChangelogEntry](docs/GetChangelogEntry.md)
390
+ - [GetChangelogList](docs/GetChangelogList.md)
388
391
  - [GetChatMessage](docs/GetChatMessage.md)
389
392
  - [GetContentLibraryVersion](docs/GetContentLibraryVersion.md)
390
393
  - [GetConversation](docs/GetConversation.md)
@@ -613,7 +616,7 @@ and is automatically generated by the
613
616
  [OpenAPI Generator](https://openapi-generator.tech) project:
614
617
 
615
618
  - API version: `1.0.0`
616
- - Package version: `1.100.0`
619
+ - Package version: `1.101.0`
617
620
  - Generator version: `7.22.0`
618
621
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
619
622
 
@@ -0,0 +1,32 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { type GetChangelogList } from '../models/GetChangelogList';
14
+ /**
15
+ *
16
+ */
17
+ export declare class ChangelogApi extends runtime.BaseAPI {
18
+ /**
19
+ * Creates request options for getChangelog without sending the request
20
+ */
21
+ getChangelogRequestOpts(): Promise<runtime.RequestOpts>;
22
+ /**
23
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
24
+ * List user-facing product updates
25
+ */
26
+ getChangelogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChangelogList>>;
27
+ /**
28
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
29
+ * List user-facing product updates
30
+ */
31
+ getChangelog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChangelogList>;
32
+ }
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.ChangelogApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const GetChangelogList_1 = require("../models/GetChangelogList");
28
+ /**
29
+ *
30
+ */
31
+ class ChangelogApi extends runtime.BaseAPI {
32
+ /**
33
+ * Creates request options for getChangelog without sending the request
34
+ */
35
+ getChangelogRequestOpts() {
36
+ return __awaiter(this, void 0, void 0, function* () {
37
+ const queryParameters = {};
38
+ const headerParameters = {};
39
+ let urlPath = `/changelog`;
40
+ return {
41
+ path: urlPath,
42
+ method: 'GET',
43
+ headers: headerParameters,
44
+ query: queryParameters,
45
+ };
46
+ });
47
+ }
48
+ /**
49
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
50
+ * List user-facing product updates
51
+ */
52
+ getChangelogRaw(initOverrides) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ const requestOptions = yield this.getChangelogRequestOpts();
55
+ const response = yield this.request(requestOptions, initOverrides);
56
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetChangelogList_1.GetChangelogListFromJSON)(jsonValue));
57
+ });
58
+ }
59
+ /**
60
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
61
+ * List user-facing product updates
62
+ */
63
+ getChangelog(initOverrides) {
64
+ return __awaiter(this, void 0, void 0, function* () {
65
+ const response = yield this.getChangelogRaw(initOverrides);
66
+ return yield response.value();
67
+ });
68
+ }
69
+ }
70
+ exports.ChangelogApi = ChangelogApi;
@@ -1,5 +1,6 @@
1
1
  export * from './CertificateApi';
2
2
  export * from './CertificateTemplateApi';
3
+ export * from './ChangelogApi';
3
4
  export * from './ChatApi';
4
5
  export * from './ContentLibraryApi';
5
6
  export * from './ContentLibraryQuizApi';
@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
18
18
  /* eslint-disable */
19
19
  __exportStar(require("./CertificateApi"), exports);
20
20
  __exportStar(require("./CertificateTemplateApi"), exports);
21
+ __exportStar(require("./ChangelogApi"), exports);
21
22
  __exportStar(require("./ChatApi"), exports);
22
23
  __exportStar(require("./ContentLibraryApi"), exports);
23
24
  __exportStar(require("./ContentLibraryQuizApi"), exports);
@@ -0,0 +1,32 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { type GetChangelogList } from '../models/GetChangelogList';
14
+ /**
15
+ *
16
+ */
17
+ export declare class ChangelogApi extends runtime.BaseAPI {
18
+ /**
19
+ * Creates request options for getChangelog without sending the request
20
+ */
21
+ getChangelogRequestOpts(): Promise<runtime.RequestOpts>;
22
+ /**
23
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
24
+ * List user-facing product updates
25
+ */
26
+ getChangelogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChangelogList>>;
27
+ /**
28
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
29
+ * List user-facing product updates
30
+ */
31
+ getChangelog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChangelogList>;
32
+ }
@@ -0,0 +1,66 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { GetChangelogListFromJSON, } from '../models/GetChangelogList';
25
+ /**
26
+ *
27
+ */
28
+ export class ChangelogApi extends runtime.BaseAPI {
29
+ /**
30
+ * Creates request options for getChangelog without sending the request
31
+ */
32
+ getChangelogRequestOpts() {
33
+ return __awaiter(this, void 0, void 0, function* () {
34
+ const queryParameters = {};
35
+ const headerParameters = {};
36
+ let urlPath = `/changelog`;
37
+ return {
38
+ path: urlPath,
39
+ method: 'GET',
40
+ headers: headerParameters,
41
+ query: queryParameters,
42
+ };
43
+ });
44
+ }
45
+ /**
46
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
47
+ * List user-facing product updates
48
+ */
49
+ getChangelogRaw(initOverrides) {
50
+ return __awaiter(this, void 0, void 0, function* () {
51
+ const requestOptions = yield this.getChangelogRequestOpts();
52
+ const response = yield this.request(requestOptions, initOverrides);
53
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetChangelogListFromJSON(jsonValue));
54
+ });
55
+ }
56
+ /**
57
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
58
+ * List user-facing product updates
59
+ */
60
+ getChangelog(initOverrides) {
61
+ return __awaiter(this, void 0, void 0, function* () {
62
+ const response = yield this.getChangelogRaw(initOverrides);
63
+ return yield response.value();
64
+ });
65
+ }
66
+ }
@@ -1,5 +1,6 @@
1
1
  export * from './CertificateApi';
2
2
  export * from './CertificateTemplateApi';
3
+ export * from './ChangelogApi';
3
4
  export * from './ChatApi';
4
5
  export * from './ContentLibraryApi';
5
6
  export * from './ContentLibraryQuizApi';
@@ -2,6 +2,7 @@
2
2
  /* eslint-disable */
3
3
  export * from './CertificateApi';
4
4
  export * from './CertificateTemplateApi';
5
+ export * from './ChangelogApi';
5
6
  export * from './ChatApi';
6
7
  export * from './ContentLibraryApi';
7
8
  export * from './ContentLibraryQuizApi';
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A user-facing summary of product changes published on one date.
14
+ * @export
15
+ * @interface GetChangelogEntry
16
+ */
17
+ export interface GetChangelogEntry {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetChangelogEntry
22
+ */
23
+ title: string;
24
+ /**
25
+ * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
26
+ * @type {string}
27
+ * @memberof GetChangelogEntry
28
+ */
29
+ desc: string;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof GetChangelogEntry
34
+ */
35
+ date: Date;
36
+ }
37
+ /**
38
+ * Check if a given object implements the GetChangelogEntry interface.
39
+ */
40
+ export declare function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry;
41
+ export declare function GetChangelogEntryFromJSON(json: any): GetChangelogEntry;
42
+ export declare function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry;
43
+ export declare function GetChangelogEntryToJSON(json: any): GetChangelogEntry;
44
+ export declare function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the GetChangelogEntry interface.
16
+ */
17
+ export function instanceOfGetChangelogEntry(value) {
18
+ if (!('title' in value) || value['title'] === undefined)
19
+ return false;
20
+ if (!('desc' in value) || value['desc'] === undefined)
21
+ return false;
22
+ if (!('date' in value) || value['date'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function GetChangelogEntryFromJSON(json) {
27
+ return GetChangelogEntryFromJSONTyped(json, false);
28
+ }
29
+ export function GetChangelogEntryFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'title': json['title'],
35
+ 'desc': json['desc'],
36
+ 'date': (new Date(json['date'])),
37
+ };
38
+ }
39
+ export function GetChangelogEntryToJSON(json) {
40
+ return GetChangelogEntryToJSONTyped(json, false);
41
+ }
42
+ export function GetChangelogEntryToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'title': value['title'],
48
+ 'desc': value['desc'],
49
+ 'date': value['date'].toISOString().substring(0, 10),
50
+ };
51
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { GetChangelogEntry } from './GetChangelogEntry';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetChangelogList
17
+ */
18
+ export interface GetChangelogList {
19
+ /**
20
+ *
21
+ * @type {Array<GetChangelogEntry>}
22
+ * @memberof GetChangelogList
23
+ */
24
+ items: Array<GetChangelogEntry>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the GetChangelogList interface.
28
+ */
29
+ export declare function instanceOfGetChangelogList(value: object): value is GetChangelogList;
30
+ export declare function GetChangelogListFromJSON(json: any): GetChangelogList;
31
+ export declare function GetChangelogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogList;
32
+ export declare function GetChangelogListToJSON(json: any): GetChangelogList;
33
+ export declare function GetChangelogListToJSONTyped(value?: GetChangelogList | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,44 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { GetChangelogEntryFromJSON, GetChangelogEntryToJSON, } from './GetChangelogEntry';
15
+ /**
16
+ * Check if a given object implements the GetChangelogList interface.
17
+ */
18
+ export function instanceOfGetChangelogList(value) {
19
+ if (!('items' in value) || value['items'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function GetChangelogListFromJSON(json) {
24
+ return GetChangelogListFromJSONTyped(json, false);
25
+ }
26
+ export function GetChangelogListFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'items': (json['items'].map(GetChangelogEntryFromJSON)),
32
+ };
33
+ }
34
+ export function GetChangelogListToJSON(json) {
35
+ return GetChangelogListToJSONTyped(json, false);
36
+ }
37
+ export function GetChangelogListToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'items': (value['items'].map(GetChangelogEntryToJSON)),
43
+ };
44
+ }
@@ -35,6 +35,8 @@ export * from './GetCertificateConfigList';
35
35
  export * from './GetCertificateEventList';
36
36
  export * from './GetCertificateList';
37
37
  export * from './GetCertificateTemplateList';
38
+ export * from './GetChangelogEntry';
39
+ export * from './GetChangelogList';
38
40
  export * from './GetChatMessage';
39
41
  export * from './GetContentLibraryVersion';
40
42
  export * from './GetConversation';
@@ -37,6 +37,8 @@ export * from './GetCertificateConfigList';
37
37
  export * from './GetCertificateEventList';
38
38
  export * from './GetCertificateList';
39
39
  export * from './GetCertificateTemplateList';
40
+ export * from './GetChangelogEntry';
41
+ export * from './GetChangelogList';
40
42
  export * from './GetChatMessage';
41
43
  export * from './GetContentLibraryVersion';
42
44
  export * from './GetConversation';
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A user-facing summary of product changes published on one date.
14
+ * @export
15
+ * @interface GetChangelogEntry
16
+ */
17
+ export interface GetChangelogEntry {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetChangelogEntry
22
+ */
23
+ title: string;
24
+ /**
25
+ * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
26
+ * @type {string}
27
+ * @memberof GetChangelogEntry
28
+ */
29
+ desc: string;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof GetChangelogEntry
34
+ */
35
+ date: Date;
36
+ }
37
+ /**
38
+ * Check if a given object implements the GetChangelogEntry interface.
39
+ */
40
+ export declare function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry;
41
+ export declare function GetChangelogEntryFromJSON(json: any): GetChangelogEntry;
42
+ export declare function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry;
43
+ export declare function GetChangelogEntryToJSON(json: any): GetChangelogEntry;
44
+ export declare function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfGetChangelogEntry = instanceOfGetChangelogEntry;
17
+ exports.GetChangelogEntryFromJSON = GetChangelogEntryFromJSON;
18
+ exports.GetChangelogEntryFromJSONTyped = GetChangelogEntryFromJSONTyped;
19
+ exports.GetChangelogEntryToJSON = GetChangelogEntryToJSON;
20
+ exports.GetChangelogEntryToJSONTyped = GetChangelogEntryToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the GetChangelogEntry interface.
23
+ */
24
+ function instanceOfGetChangelogEntry(value) {
25
+ if (!('title' in value) || value['title'] === undefined)
26
+ return false;
27
+ if (!('desc' in value) || value['desc'] === undefined)
28
+ return false;
29
+ if (!('date' in value) || value['date'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function GetChangelogEntryFromJSON(json) {
34
+ return GetChangelogEntryFromJSONTyped(json, false);
35
+ }
36
+ function GetChangelogEntryFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'title': json['title'],
42
+ 'desc': json['desc'],
43
+ 'date': (new Date(json['date'])),
44
+ };
45
+ }
46
+ function GetChangelogEntryToJSON(json) {
47
+ return GetChangelogEntryToJSONTyped(json, false);
48
+ }
49
+ function GetChangelogEntryToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'title': value['title'],
55
+ 'desc': value['desc'],
56
+ 'date': value['date'].toISOString().substring(0, 10),
57
+ };
58
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { GetChangelogEntry } from './GetChangelogEntry';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetChangelogList
17
+ */
18
+ export interface GetChangelogList {
19
+ /**
20
+ *
21
+ * @type {Array<GetChangelogEntry>}
22
+ * @memberof GetChangelogList
23
+ */
24
+ items: Array<GetChangelogEntry>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the GetChangelogList interface.
28
+ */
29
+ export declare function instanceOfGetChangelogList(value: object): value is GetChangelogList;
30
+ export declare function GetChangelogListFromJSON(json: any): GetChangelogList;
31
+ export declare function GetChangelogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogList;
32
+ export declare function GetChangelogListToJSON(json: any): GetChangelogList;
33
+ export declare function GetChangelogListToJSONTyped(value?: GetChangelogList | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfGetChangelogList = instanceOfGetChangelogList;
17
+ exports.GetChangelogListFromJSON = GetChangelogListFromJSON;
18
+ exports.GetChangelogListFromJSONTyped = GetChangelogListFromJSONTyped;
19
+ exports.GetChangelogListToJSON = GetChangelogListToJSON;
20
+ exports.GetChangelogListToJSONTyped = GetChangelogListToJSONTyped;
21
+ const GetChangelogEntry_1 = require("./GetChangelogEntry");
22
+ /**
23
+ * Check if a given object implements the GetChangelogList interface.
24
+ */
25
+ function instanceOfGetChangelogList(value) {
26
+ if (!('items' in value) || value['items'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ function GetChangelogListFromJSON(json) {
31
+ return GetChangelogListFromJSONTyped(json, false);
32
+ }
33
+ function GetChangelogListFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'items': (json['items'].map(GetChangelogEntry_1.GetChangelogEntryFromJSON)),
39
+ };
40
+ }
41
+ function GetChangelogListToJSON(json) {
42
+ return GetChangelogListToJSONTyped(json, false);
43
+ }
44
+ function GetChangelogListToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'items': (value['items'].map(GetChangelogEntry_1.GetChangelogEntryToJSON)),
50
+ };
51
+ }
@@ -35,6 +35,8 @@ export * from './GetCertificateConfigList';
35
35
  export * from './GetCertificateEventList';
36
36
  export * from './GetCertificateList';
37
37
  export * from './GetCertificateTemplateList';
38
+ export * from './GetChangelogEntry';
39
+ export * from './GetChangelogList';
38
40
  export * from './GetChatMessage';
39
41
  export * from './GetContentLibraryVersion';
40
42
  export * from './GetConversation';
@@ -53,6 +53,8 @@ __exportStar(require("./GetCertificateConfigList"), exports);
53
53
  __exportStar(require("./GetCertificateEventList"), exports);
54
54
  __exportStar(require("./GetCertificateList"), exports);
55
55
  __exportStar(require("./GetCertificateTemplateList"), exports);
56
+ __exportStar(require("./GetChangelogEntry"), exports);
57
+ __exportStar(require("./GetChangelogList"), exports);
56
58
  __exportStar(require("./GetChatMessage"), exports);
57
59
  __exportStar(require("./GetContentLibraryVersion"), exports);
58
60
  __exportStar(require("./GetConversation"), exports);
@@ -0,0 +1,68 @@
1
+ # ChangelogApi
2
+
3
+ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**getChangelog**](ChangelogApi.md#getchangelog) | **GET** /changelog | List user-facing product updates |
8
+
9
+
10
+
11
+ ## getChangelog
12
+
13
+ > GetChangelogList getChangelog()
14
+
15
+ List user-facing product updates
16
+
17
+ Returns the changelog loaded from the server\&#39;s configured changelog file at startup, newest first.
18
+
19
+ ### Example
20
+
21
+ ```ts
22
+ import {
23
+ Configuration,
24
+ ChangelogApi,
25
+ } from '@easyedu/js-lsm-api';
26
+ import type { GetChangelogRequest } from '@easyedu/js-lsm-api';
27
+
28
+ async function example() {
29
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
30
+ const api = new ChangelogApi();
31
+
32
+ try {
33
+ const data = await api.getChangelog();
34
+ console.log(data);
35
+ } catch (error) {
36
+ console.error(error);
37
+ }
38
+ }
39
+
40
+ // Run the test
41
+ example().catch(console.error);
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+ This endpoint does not need any parameter.
47
+
48
+ ### Return type
49
+
50
+ [**GetChangelogList**](GetChangelogList.md)
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: `application/json`
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ | **200** | Product changelog | - |
66
+
67
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
68
+
@@ -0,0 +1,39 @@
1
+
2
+ # GetChangelogEntry
3
+
4
+ A user-facing summary of product changes published on one date.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `title` | string
11
+ `desc` | string
12
+ `date` | Date
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { GetChangelogEntry } from '@easyedu/js-lsm-api'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "title": null,
22
+ "desc": null,
23
+ "date": null,
24
+ } satisfies GetChangelogEntry
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as GetChangelogEntry
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,34 @@
1
+
2
+ # GetChangelogList
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `items` | [Array&lt;GetChangelogEntry&gt;](GetChangelogEntry.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { GetChangelogList } from '@easyedu/js-lsm-api'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "items": null,
19
+ } satisfies GetChangelogList
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as GetChangelogList
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.100.0",
3
+ "version": "1.101.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -0,0 +1,66 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type GetChangelogList,
18
+ GetChangelogListFromJSON,
19
+ GetChangelogListToJSON,
20
+ } from '../models/GetChangelogList';
21
+
22
+ /**
23
+ *
24
+ */
25
+ export class ChangelogApi extends runtime.BaseAPI {
26
+
27
+ /**
28
+ * Creates request options for getChangelog without sending the request
29
+ */
30
+ async getChangelogRequestOpts(): Promise<runtime.RequestOpts> {
31
+ const queryParameters: any = {};
32
+
33
+ const headerParameters: runtime.HTTPHeaders = {};
34
+
35
+
36
+ let urlPath = `/changelog`;
37
+
38
+ return {
39
+ path: urlPath,
40
+ method: 'GET',
41
+ headers: headerParameters,
42
+ query: queryParameters,
43
+ };
44
+ }
45
+
46
+ /**
47
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
48
+ * List user-facing product updates
49
+ */
50
+ async getChangelogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChangelogList>> {
51
+ const requestOptions = await this.getChangelogRequestOpts();
52
+ const response = await this.request(requestOptions, initOverrides);
53
+
54
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetChangelogListFromJSON(jsonValue));
55
+ }
56
+
57
+ /**
58
+ * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
59
+ * List user-facing product updates
60
+ */
61
+ async getChangelog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChangelogList> {
62
+ const response = await this.getChangelogRaw(initOverrides);
63
+ return await response.value();
64
+ }
65
+
66
+ }
package/src/apis/index.ts CHANGED
@@ -2,6 +2,7 @@
2
2
  /* eslint-disable */
3
3
  export * from './CertificateApi';
4
4
  export * from './CertificateTemplateApi';
5
+ export * from './ChangelogApi';
5
6
  export * from './ChatApi';
6
7
  export * from './ContentLibraryApi';
7
8
  export * from './ContentLibraryQuizApi';
@@ -0,0 +1,84 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * A user-facing summary of product changes published on one date.
18
+ * @export
19
+ * @interface GetChangelogEntry
20
+ */
21
+ export interface GetChangelogEntry {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof GetChangelogEntry
26
+ */
27
+ title: string;
28
+ /**
29
+ * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
30
+ * @type {string}
31
+ * @memberof GetChangelogEntry
32
+ */
33
+ desc: string;
34
+ /**
35
+ *
36
+ * @type {Date}
37
+ * @memberof GetChangelogEntry
38
+ */
39
+ date: Date;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the GetChangelogEntry interface.
44
+ */
45
+ export function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry {
46
+ if (!('title' in value) || value['title'] === undefined) return false;
47
+ if (!('desc' in value) || value['desc'] === undefined) return false;
48
+ if (!('date' in value) || value['date'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function GetChangelogEntryFromJSON(json: any): GetChangelogEntry {
53
+ return GetChangelogEntryFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'title': json['title'],
63
+ 'desc': json['desc'],
64
+ 'date': (new Date(json['date'])),
65
+ };
66
+ }
67
+
68
+ export function GetChangelogEntryToJSON(json: any): GetChangelogEntry {
69
+ return GetChangelogEntryToJSONTyped(json, false);
70
+ }
71
+
72
+ export function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator: boolean = false): any {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+
77
+ return {
78
+
79
+ 'title': value['title'],
80
+ 'desc': value['desc'],
81
+ 'date': value['date'].toISOString().substring(0,10),
82
+ };
83
+ }
84
+
@@ -0,0 +1,74 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { GetChangelogEntry } from './GetChangelogEntry';
17
+ import {
18
+ GetChangelogEntryFromJSON,
19
+ GetChangelogEntryFromJSONTyped,
20
+ GetChangelogEntryToJSON,
21
+ GetChangelogEntryToJSONTyped,
22
+ } from './GetChangelogEntry';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface GetChangelogList
28
+ */
29
+ export interface GetChangelogList {
30
+ /**
31
+ *
32
+ * @type {Array<GetChangelogEntry>}
33
+ * @memberof GetChangelogList
34
+ */
35
+ items: Array<GetChangelogEntry>;
36
+ }
37
+
38
+ /**
39
+ * Check if a given object implements the GetChangelogList interface.
40
+ */
41
+ export function instanceOfGetChangelogList(value: object): value is GetChangelogList {
42
+ if (!('items' in value) || value['items'] === undefined) return false;
43
+ return true;
44
+ }
45
+
46
+ export function GetChangelogListFromJSON(json: any): GetChangelogList {
47
+ return GetChangelogListFromJSONTyped(json, false);
48
+ }
49
+
50
+ export function GetChangelogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogList {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+
56
+ 'items': ((json['items'] as Array<any>).map(GetChangelogEntryFromJSON)),
57
+ };
58
+ }
59
+
60
+ export function GetChangelogListToJSON(json: any): GetChangelogList {
61
+ return GetChangelogListToJSONTyped(json, false);
62
+ }
63
+
64
+ export function GetChangelogListToJSONTyped(value?: GetChangelogList | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'items': ((value['items'] as Array<any>).map(GetChangelogEntryToJSON)),
72
+ };
73
+ }
74
+
@@ -37,6 +37,8 @@ export * from './GetCertificateConfigList';
37
37
  export * from './GetCertificateEventList';
38
38
  export * from './GetCertificateList';
39
39
  export * from './GetCertificateTemplateList';
40
+ export * from './GetChangelogEntry';
41
+ export * from './GetChangelogList';
40
42
  export * from './GetChatMessage';
41
43
  export * from './GetContentLibraryVersion';
42
44
  export * from './GetConversation';