@easyedu/js-lsm-api 1.127.0 → 1.129.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.
- package/.openapi-generator/FILES +10 -0
- package/README.md +8 -2
- package/dist/apis/ScormToolsApi.d.ts +35 -0
- package/dist/apis/ScormToolsApi.js +75 -0
- package/dist/apis/UserApi.d.ts +16 -0
- package/dist/apis/UserApi.js +42 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ScormToolsApi.d.ts +35 -0
- package/dist/esm/apis/ScormToolsApi.js +71 -0
- package/dist/esm/apis/UserApi.d.ts +16 -0
- package/dist/esm/apis/UserApi.js +42 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/GetSignupSlugAvailability.d.ts +38 -0
- package/dist/esm/models/GetSignupSlugAvailability.js +47 -0
- package/dist/esm/models/PostSignupRequest.d.ts +6 -0
- package/dist/esm/models/PostSignupRequest.js +2 -0
- package/dist/esm/models/PostVerifyManifest.d.ts +106 -0
- package/dist/esm/models/PostVerifyManifest.js +73 -0
- package/dist/esm/models/PostVerifyManifestItemsInner.d.ts +74 -0
- package/dist/esm/models/PostVerifyManifestItemsInner.js +55 -0
- package/dist/esm/models/PostVerifyManifestResourcesInner.d.ts +56 -0
- package/dist/esm/models/PostVerifyManifestResourcesInner.js +49 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/GetSignupSlugAvailability.d.ts +38 -0
- package/dist/models/GetSignupSlugAvailability.js +54 -0
- package/dist/models/PostSignupRequest.d.ts +6 -0
- package/dist/models/PostSignupRequest.js +2 -0
- package/dist/models/PostVerifyManifest.d.ts +106 -0
- package/dist/models/PostVerifyManifest.js +80 -0
- package/dist/models/PostVerifyManifestItemsInner.d.ts +74 -0
- package/dist/models/PostVerifyManifestItemsInner.js +62 -0
- package/dist/models/PostVerifyManifestResourcesInner.d.ts +56 -0
- package/dist/models/PostVerifyManifestResourcesInner.js +56 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/docs/GetSignupSlugAvailability.md +36 -0
- package/docs/PostSignupRequest.md +2 -0
- package/docs/PostVerifyManifest.md +59 -0
- package/docs/PostVerifyManifestItemsInner.md +48 -0
- package/docs/PostVerifyManifestResourcesInner.md +42 -0
- package/docs/ScormToolsApi.md +78 -0
- package/docs/UserApi.md +69 -0
- package/package.json +1 -1
- package/src/apis/ScormToolsApi.ts +80 -0
- package/src/apis/UserApi.ts +57 -0
- package/src/apis/index.ts +1 -0
- package/src/models/GetSignupSlugAvailability.ts +75 -0
- package/src/models/PostSignupRequest.ts +8 -0
- package/src/models/PostVerifyManifest.ts +179 -0
- package/src/models/PostVerifyManifestItemsInner.ts +121 -0
- package/src/models/PostVerifyManifestResourcesInner.ts +97 -0
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -170,6 +170,7 @@ docs/GetResourceUsageCoursesInner.md
|
|
|
170
170
|
docs/GetResourceVersionUpload.md
|
|
171
171
|
docs/GetRichTextAssetUpload.md
|
|
172
172
|
docs/GetRole.md
|
|
173
|
+
docs/GetSignupSlugAvailability.md
|
|
173
174
|
docs/GetSupportTicket.md
|
|
174
175
|
docs/GetSupportTicketAttachment.md
|
|
175
176
|
docs/GetSupportTicketComment.md
|
|
@@ -308,6 +309,9 @@ docs/PostSignupRequest.md
|
|
|
308
309
|
docs/PostSignupRequestResponse.md
|
|
309
310
|
docs/PostSupportTicket.md
|
|
310
311
|
docs/PostSupportTicketComment.md
|
|
312
|
+
docs/PostVerifyManifest.md
|
|
313
|
+
docs/PostVerifyManifestItemsInner.md
|
|
314
|
+
docs/PostVerifyManifestResourcesInner.md
|
|
311
315
|
docs/PostZapierEnrollment.md
|
|
312
316
|
docs/PostZapierSetup.md
|
|
313
317
|
docs/PostZapierSetupResponse.md
|
|
@@ -384,6 +388,7 @@ docs/ScormRuntimeResponse.md
|
|
|
384
388
|
docs/ScormSetValueRequest.md
|
|
385
389
|
docs/ScormSetValueResponse.md
|
|
386
390
|
docs/ScormTerminateResponse.md
|
|
391
|
+
docs/ScormToolsApi.md
|
|
387
392
|
docs/SupportTicketApi.md
|
|
388
393
|
docs/SupportTicketUser.md
|
|
389
394
|
docs/SystemApi.md
|
|
@@ -420,6 +425,7 @@ src/apis/QuestionImportApi.ts
|
|
|
420
425
|
src/apis/ReportingApi.ts
|
|
421
426
|
src/apis/RichTextApi.ts
|
|
422
427
|
src/apis/RoleApi.ts
|
|
428
|
+
src/apis/ScormToolsApi.ts
|
|
423
429
|
src/apis/SupportTicketApi.ts
|
|
424
430
|
src/apis/SystemApi.ts
|
|
425
431
|
src/apis/UserApi.ts
|
|
@@ -582,6 +588,7 @@ src/models/GetResourceUsageCoursesInner.ts
|
|
|
582
588
|
src/models/GetResourceVersionUpload.ts
|
|
583
589
|
src/models/GetRichTextAssetUpload.ts
|
|
584
590
|
src/models/GetRole.ts
|
|
591
|
+
src/models/GetSignupSlugAvailability.ts
|
|
585
592
|
src/models/GetSupportTicket.ts
|
|
586
593
|
src/models/GetSupportTicketAttachment.ts
|
|
587
594
|
src/models/GetSupportTicketComment.ts
|
|
@@ -714,6 +721,9 @@ src/models/PostSignupRequest.ts
|
|
|
714
721
|
src/models/PostSignupRequestResponse.ts
|
|
715
722
|
src/models/PostSupportTicket.ts
|
|
716
723
|
src/models/PostSupportTicketComment.ts
|
|
724
|
+
src/models/PostVerifyManifest.ts
|
|
725
|
+
src/models/PostVerifyManifestItemsInner.ts
|
|
726
|
+
src/models/PostVerifyManifestResourcesInner.ts
|
|
717
727
|
src/models/PostZapierEnrollment.ts
|
|
718
728
|
src/models/PostZapierSetup.ts
|
|
719
729
|
src/models/PostZapierSetupResponse.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.129.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -380,6 +380,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
380
380
|
*RoleApi* | [**unassignUserRole**](docs/RoleApi.md#unassignuserrole) | **DELETE** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Remove a role from a user for a portal
|
|
381
381
|
*RoleApi* | [**updateRole**](docs/RoleApi.md#updaterole) | **PUT** /roles/{roleId} | Update a custom role name and description
|
|
382
382
|
*RoleApi* | [**updateRolePermissions**](docs/RoleApi.md#updaterolepermissions) | **PUT** /roles/{roleId}/permissions | Replace all permissions for a custom role
|
|
383
|
+
*ScormToolsApi* | [**verifyScormManifest**](docs/ScormToolsApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest
|
|
383
384
|
*SupportTicketApi* | [**closeSupportTicket**](docs/SupportTicketApi.md#closesupportticket) | **POST** /support/tickets/{ticketId}/close | Close a support ticket
|
|
384
385
|
*SupportTicketApi* | [**downloadSupportTicketAttachment**](docs/SupportTicketApi.md#downloadsupportticketattachment) | **GET** /support/tickets/{ticketId}/attachments/{attachmentId}/download | Download a ticket attachment
|
|
385
386
|
*SupportTicketApi* | [**getSupportTicket**](docs/SupportTicketApi.md#getsupportticket) | **GET** /support/tickets/{ticketId} | Get support ticket details
|
|
@@ -397,6 +398,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
397
398
|
*UserApi* | [**deleteUserAvatar**](docs/UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo
|
|
398
399
|
*UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
|
|
399
400
|
*UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
|
|
401
|
+
*UserApi* | [**getSignupSlugAvailability**](docs/UserApi.md#getsignupslugavailability) | **GET** /auth/signup/slug-availability | Check whether a learner subdomain is available
|
|
400
402
|
*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
|
|
401
403
|
*UserApi* | [**getUserCourses**](docs/UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user
|
|
402
404
|
*UserApi* | [**getUserEnrollments**](docs/UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments
|
|
@@ -569,6 +571,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
569
571
|
- [GetResourceVersionUpload](docs/GetResourceVersionUpload.md)
|
|
570
572
|
- [GetRichTextAssetUpload](docs/GetRichTextAssetUpload.md)
|
|
571
573
|
- [GetRole](docs/GetRole.md)
|
|
574
|
+
- [GetSignupSlugAvailability](docs/GetSignupSlugAvailability.md)
|
|
572
575
|
- [GetSupportTicket](docs/GetSupportTicket.md)
|
|
573
576
|
- [GetSupportTicketAttachment](docs/GetSupportTicketAttachment.md)
|
|
574
577
|
- [GetSupportTicketComment](docs/GetSupportTicketComment.md)
|
|
@@ -701,6 +704,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
701
704
|
- [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
|
|
702
705
|
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
703
706
|
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
707
|
+
- [PostVerifyManifest](docs/PostVerifyManifest.md)
|
|
708
|
+
- [PostVerifyManifestItemsInner](docs/PostVerifyManifestItemsInner.md)
|
|
709
|
+
- [PostVerifyManifestResourcesInner](docs/PostVerifyManifestResourcesInner.md)
|
|
704
710
|
- [PostZapierEnrollment](docs/PostZapierEnrollment.md)
|
|
705
711
|
- [PostZapierSetup](docs/PostZapierSetup.md)
|
|
706
712
|
- [PostZapierSetupResponse](docs/PostZapierSetupResponse.md)
|
|
@@ -795,7 +801,7 @@ and is automatically generated by the
|
|
|
795
801
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
796
802
|
|
|
797
803
|
- API version: `1.0.0`
|
|
798
|
-
- Package version: `1.
|
|
804
|
+
- Package version: `1.129.0`
|
|
799
805
|
- Generator version: `7.22.0`
|
|
800
806
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
801
807
|
|
|
@@ -0,0 +1,35 @@
|
|
|
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 PostVerifyManifest } from '../models/PostVerifyManifest';
|
|
14
|
+
export interface VerifyScormManifestRequest {
|
|
15
|
+
body: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
*/
|
|
20
|
+
export declare class ScormToolsApi extends runtime.BaseAPI {
|
|
21
|
+
/**
|
|
22
|
+
* Creates request options for verifyScormManifest without sending the request
|
|
23
|
+
*/
|
|
24
|
+
verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts>;
|
|
25
|
+
/**
|
|
26
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
27
|
+
* Parse and verify a SCORM manifest
|
|
28
|
+
*/
|
|
29
|
+
verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
|
|
30
|
+
/**
|
|
31
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
32
|
+
* Parse and verify a SCORM manifest
|
|
33
|
+
*/
|
|
34
|
+
verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
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.ScormToolsApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const PostVerifyManifest_1 = require("../models/PostVerifyManifest");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class ScormToolsApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for verifyScormManifest without sending the request
|
|
34
|
+
*/
|
|
35
|
+
verifyScormManifestRequestOpts(requestParameters) {
|
|
36
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
if (requestParameters['body'] == null) {
|
|
38
|
+
throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling verifyScormManifest().');
|
|
39
|
+
}
|
|
40
|
+
const queryParameters = {};
|
|
41
|
+
const headerParameters = {};
|
|
42
|
+
headerParameters['Content-Type'] = 'application/xml';
|
|
43
|
+
let urlPath = `/scorm/tools/verify-manifest`;
|
|
44
|
+
return {
|
|
45
|
+
path: urlPath,
|
|
46
|
+
method: 'POST',
|
|
47
|
+
headers: headerParameters,
|
|
48
|
+
query: queryParameters,
|
|
49
|
+
body: requestParameters['body'],
|
|
50
|
+
};
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
55
|
+
* Parse and verify a SCORM manifest
|
|
56
|
+
*/
|
|
57
|
+
verifyScormManifestRaw(requestParameters, initOverrides) {
|
|
58
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
59
|
+
const requestOptions = yield this.verifyScormManifestRequestOpts(requestParameters);
|
|
60
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
61
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostVerifyManifest_1.PostVerifyManifestFromJSON)(jsonValue));
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
66
|
+
* Parse and verify a SCORM manifest
|
|
67
|
+
*/
|
|
68
|
+
verifyScormManifest(requestParameters, initOverrides) {
|
|
69
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
70
|
+
const response = yield this.verifyScormManifestRaw(requestParameters, initOverrides);
|
|
71
|
+
return yield response.value();
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
exports.ScormToolsApi = ScormToolsApi;
|
package/dist/apis/UserApi.d.ts
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
|
|
14
|
+
import { type GetSignupSlugAvailability } from '../models/GetSignupSlugAvailability';
|
|
14
15
|
import { type GetUser } from '../models/GetUser';
|
|
15
16
|
import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
|
|
16
17
|
import { type GetUserCourseList } from '../models/GetUserCourseList';
|
|
@@ -24,6 +25,9 @@ import { type PutUser } from '../models/PutUser';
|
|
|
24
25
|
export interface DeleteUserAvatarRequest {
|
|
25
26
|
userId: string;
|
|
26
27
|
}
|
|
28
|
+
export interface GetSignupSlugAvailabilityRequest {
|
|
29
|
+
slug: string;
|
|
30
|
+
}
|
|
27
31
|
export interface GetUserRequest {
|
|
28
32
|
userId: string;
|
|
29
33
|
}
|
|
@@ -109,6 +113,18 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
109
113
|
* Get the current user\'s permissions
|
|
110
114
|
*/
|
|
111
115
|
getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
|
|
116
|
+
/**
|
|
117
|
+
* Creates request options for getSignupSlugAvailability without sending the request
|
|
118
|
+
*/
|
|
119
|
+
getSignupSlugAvailabilityRequestOpts(requestParameters: GetSignupSlugAvailabilityRequest): Promise<runtime.RequestOpts>;
|
|
120
|
+
/**
|
|
121
|
+
* Check whether a learner subdomain is available
|
|
122
|
+
*/
|
|
123
|
+
getSignupSlugAvailabilityRaw(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSignupSlugAvailability>>;
|
|
124
|
+
/**
|
|
125
|
+
* Check whether a learner subdomain is available
|
|
126
|
+
*/
|
|
127
|
+
getSignupSlugAvailability(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSignupSlugAvailability>;
|
|
112
128
|
/**
|
|
113
129
|
* Creates request options for getUser without sending the request
|
|
114
130
|
*/
|
package/dist/apis/UserApi.js
CHANGED
|
@@ -25,6 +25,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
25
25
|
exports.GetUserEnrollmentsTypeEnum = exports.GetUserCoursesOrderDirectionEnum = exports.GetUserCoursesOrderByEnum = exports.UserApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const GetCourseEnrollmentList_1 = require("../models/GetCourseEnrollmentList");
|
|
28
|
+
const GetSignupSlugAvailability_1 = require("../models/GetSignupSlugAvailability");
|
|
28
29
|
const GetUser_1 = require("../models/GetUser");
|
|
29
30
|
const GetUserAvatarUpload_1 = require("../models/GetUserAvatarUpload");
|
|
30
31
|
const GetUserCourseList_1 = require("../models/GetUserCourseList");
|
|
@@ -148,6 +149,47 @@ class UserApi extends runtime.BaseAPI {
|
|
|
148
149
|
return yield response.value();
|
|
149
150
|
});
|
|
150
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
* Creates request options for getSignupSlugAvailability without sending the request
|
|
154
|
+
*/
|
|
155
|
+
getSignupSlugAvailabilityRequestOpts(requestParameters) {
|
|
156
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
157
|
+
if (requestParameters['slug'] == null) {
|
|
158
|
+
throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getSignupSlugAvailability().');
|
|
159
|
+
}
|
|
160
|
+
const queryParameters = {};
|
|
161
|
+
if (requestParameters['slug'] != null) {
|
|
162
|
+
queryParameters['slug'] = requestParameters['slug'];
|
|
163
|
+
}
|
|
164
|
+
const headerParameters = {};
|
|
165
|
+
let urlPath = `/auth/signup/slug-availability`;
|
|
166
|
+
return {
|
|
167
|
+
path: urlPath,
|
|
168
|
+
method: 'GET',
|
|
169
|
+
headers: headerParameters,
|
|
170
|
+
query: queryParameters,
|
|
171
|
+
};
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Check whether a learner subdomain is available
|
|
176
|
+
*/
|
|
177
|
+
getSignupSlugAvailabilityRaw(requestParameters, initOverrides) {
|
|
178
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
179
|
+
const requestOptions = yield this.getSignupSlugAvailabilityRequestOpts(requestParameters);
|
|
180
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
181
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSignupSlugAvailability_1.GetSignupSlugAvailabilityFromJSON)(jsonValue));
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Check whether a learner subdomain is available
|
|
186
|
+
*/
|
|
187
|
+
getSignupSlugAvailability(requestParameters, initOverrides) {
|
|
188
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
189
|
+
const response = yield this.getSignupSlugAvailabilityRaw(requestParameters, initOverrides);
|
|
190
|
+
return yield response.value();
|
|
191
|
+
});
|
|
192
|
+
}
|
|
151
193
|
/**
|
|
152
194
|
* Creates request options for getUser without sending the request
|
|
153
195
|
*/
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ export * from './QuestionImportApi';
|
|
|
20
20
|
export * from './ReportingApi';
|
|
21
21
|
export * from './RichTextApi';
|
|
22
22
|
export * from './RoleApi';
|
|
23
|
+
export * from './ScormToolsApi';
|
|
23
24
|
export * from './SupportTicketApi';
|
|
24
25
|
export * from './SystemApi';
|
|
25
26
|
export * from './UserApi';
|
package/dist/apis/index.js
CHANGED
|
@@ -38,6 +38,7 @@ __exportStar(require("./QuestionImportApi"), exports);
|
|
|
38
38
|
__exportStar(require("./ReportingApi"), exports);
|
|
39
39
|
__exportStar(require("./RichTextApi"), exports);
|
|
40
40
|
__exportStar(require("./RoleApi"), exports);
|
|
41
|
+
__exportStar(require("./ScormToolsApi"), exports);
|
|
41
42
|
__exportStar(require("./SupportTicketApi"), exports);
|
|
42
43
|
__exportStar(require("./SystemApi"), exports);
|
|
43
44
|
__exportStar(require("./UserApi"), exports);
|
|
@@ -0,0 +1,35 @@
|
|
|
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 PostVerifyManifest } from '../models/PostVerifyManifest';
|
|
14
|
+
export interface VerifyScormManifestRequest {
|
|
15
|
+
body: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
*/
|
|
20
|
+
export declare class ScormToolsApi extends runtime.BaseAPI {
|
|
21
|
+
/**
|
|
22
|
+
* Creates request options for verifyScormManifest without sending the request
|
|
23
|
+
*/
|
|
24
|
+
verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts>;
|
|
25
|
+
/**
|
|
26
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
27
|
+
* Parse and verify a SCORM manifest
|
|
28
|
+
*/
|
|
29
|
+
verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
|
|
30
|
+
/**
|
|
31
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
32
|
+
* Parse and verify a SCORM manifest
|
|
33
|
+
*/
|
|
34
|
+
verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
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 { PostVerifyManifestFromJSON, } from '../models/PostVerifyManifest';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class ScormToolsApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Creates request options for verifyScormManifest without sending the request
|
|
31
|
+
*/
|
|
32
|
+
verifyScormManifestRequestOpts(requestParameters) {
|
|
33
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
34
|
+
if (requestParameters['body'] == null) {
|
|
35
|
+
throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling verifyScormManifest().');
|
|
36
|
+
}
|
|
37
|
+
const queryParameters = {};
|
|
38
|
+
const headerParameters = {};
|
|
39
|
+
headerParameters['Content-Type'] = 'application/xml';
|
|
40
|
+
let urlPath = `/scorm/tools/verify-manifest`;
|
|
41
|
+
return {
|
|
42
|
+
path: urlPath,
|
|
43
|
+
method: 'POST',
|
|
44
|
+
headers: headerParameters,
|
|
45
|
+
query: queryParameters,
|
|
46
|
+
body: requestParameters['body'],
|
|
47
|
+
};
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
52
|
+
* Parse and verify a SCORM manifest
|
|
53
|
+
*/
|
|
54
|
+
verifyScormManifestRaw(requestParameters, initOverrides) {
|
|
55
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
56
|
+
const requestOptions = yield this.verifyScormManifestRequestOpts(requestParameters);
|
|
57
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
58
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PostVerifyManifestFromJSON(jsonValue));
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
|
|
63
|
+
* Parse and verify a SCORM manifest
|
|
64
|
+
*/
|
|
65
|
+
verifyScormManifest(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
const response = yield this.verifyScormManifestRaw(requestParameters, initOverrides);
|
|
68
|
+
return yield response.value();
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
|
|
14
|
+
import { type GetSignupSlugAvailability } from '../models/GetSignupSlugAvailability';
|
|
14
15
|
import { type GetUser } from '../models/GetUser';
|
|
15
16
|
import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
|
|
16
17
|
import { type GetUserCourseList } from '../models/GetUserCourseList';
|
|
@@ -24,6 +25,9 @@ import { type PutUser } from '../models/PutUser';
|
|
|
24
25
|
export interface DeleteUserAvatarRequest {
|
|
25
26
|
userId: string;
|
|
26
27
|
}
|
|
28
|
+
export interface GetSignupSlugAvailabilityRequest {
|
|
29
|
+
slug: string;
|
|
30
|
+
}
|
|
27
31
|
export interface GetUserRequest {
|
|
28
32
|
userId: string;
|
|
29
33
|
}
|
|
@@ -109,6 +113,18 @@ export declare class UserApi extends runtime.BaseAPI {
|
|
|
109
113
|
* Get the current user\'s permissions
|
|
110
114
|
*/
|
|
111
115
|
getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
|
|
116
|
+
/**
|
|
117
|
+
* Creates request options for getSignupSlugAvailability without sending the request
|
|
118
|
+
*/
|
|
119
|
+
getSignupSlugAvailabilityRequestOpts(requestParameters: GetSignupSlugAvailabilityRequest): Promise<runtime.RequestOpts>;
|
|
120
|
+
/**
|
|
121
|
+
* Check whether a learner subdomain is available
|
|
122
|
+
*/
|
|
123
|
+
getSignupSlugAvailabilityRaw(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSignupSlugAvailability>>;
|
|
124
|
+
/**
|
|
125
|
+
* Check whether a learner subdomain is available
|
|
126
|
+
*/
|
|
127
|
+
getSignupSlugAvailability(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSignupSlugAvailability>;
|
|
112
128
|
/**
|
|
113
129
|
* Creates request options for getUser without sending the request
|
|
114
130
|
*/
|
package/dist/esm/apis/UserApi.js
CHANGED
|
@@ -22,6 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
24
|
import { GetCourseEnrollmentListFromJSON, } from '../models/GetCourseEnrollmentList';
|
|
25
|
+
import { GetSignupSlugAvailabilityFromJSON, } from '../models/GetSignupSlugAvailability';
|
|
25
26
|
import { GetUserFromJSON, } from '../models/GetUser';
|
|
26
27
|
import { GetUserAvatarUploadFromJSON, } from '../models/GetUserAvatarUpload';
|
|
27
28
|
import { GetUserCourseListFromJSON, } from '../models/GetUserCourseList';
|
|
@@ -145,6 +146,47 @@ export class UserApi extends runtime.BaseAPI {
|
|
|
145
146
|
return yield response.value();
|
|
146
147
|
});
|
|
147
148
|
}
|
|
149
|
+
/**
|
|
150
|
+
* Creates request options for getSignupSlugAvailability without sending the request
|
|
151
|
+
*/
|
|
152
|
+
getSignupSlugAvailabilityRequestOpts(requestParameters) {
|
|
153
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
154
|
+
if (requestParameters['slug'] == null) {
|
|
155
|
+
throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getSignupSlugAvailability().');
|
|
156
|
+
}
|
|
157
|
+
const queryParameters = {};
|
|
158
|
+
if (requestParameters['slug'] != null) {
|
|
159
|
+
queryParameters['slug'] = requestParameters['slug'];
|
|
160
|
+
}
|
|
161
|
+
const headerParameters = {};
|
|
162
|
+
let urlPath = `/auth/signup/slug-availability`;
|
|
163
|
+
return {
|
|
164
|
+
path: urlPath,
|
|
165
|
+
method: 'GET',
|
|
166
|
+
headers: headerParameters,
|
|
167
|
+
query: queryParameters,
|
|
168
|
+
};
|
|
169
|
+
});
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Check whether a learner subdomain is available
|
|
173
|
+
*/
|
|
174
|
+
getSignupSlugAvailabilityRaw(requestParameters, initOverrides) {
|
|
175
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
176
|
+
const requestOptions = yield this.getSignupSlugAvailabilityRequestOpts(requestParameters);
|
|
177
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
178
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetSignupSlugAvailabilityFromJSON(jsonValue));
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Check whether a learner subdomain is available
|
|
183
|
+
*/
|
|
184
|
+
getSignupSlugAvailability(requestParameters, initOverrides) {
|
|
185
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
186
|
+
const response = yield this.getSignupSlugAvailabilityRaw(requestParameters, initOverrides);
|
|
187
|
+
return yield response.value();
|
|
188
|
+
});
|
|
189
|
+
}
|
|
148
190
|
/**
|
|
149
191
|
* Creates request options for getUser without sending the request
|
|
150
192
|
*/
|
package/dist/esm/apis/index.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ export * from './QuestionImportApi';
|
|
|
20
20
|
export * from './ReportingApi';
|
|
21
21
|
export * from './RichTextApi';
|
|
22
22
|
export * from './RoleApi';
|
|
23
|
+
export * from './ScormToolsApi';
|
|
23
24
|
export * from './SupportTicketApi';
|
|
24
25
|
export * from './SystemApi';
|
|
25
26
|
export * from './UserApi';
|
package/dist/esm/apis/index.js
CHANGED
|
@@ -22,6 +22,7 @@ export * from './QuestionImportApi';
|
|
|
22
22
|
export * from './ReportingApi';
|
|
23
23
|
export * from './RichTextApi';
|
|
24
24
|
export * from './RoleApi';
|
|
25
|
+
export * from './ScormToolsApi';
|
|
25
26
|
export * from './SupportTicketApi';
|
|
26
27
|
export * from './SystemApi';
|
|
27
28
|
export * from './UserApi';
|
|
@@ -0,0 +1,38 @@
|
|
|
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
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetSignupSlugAvailability
|
|
16
|
+
*/
|
|
17
|
+
export interface GetSignupSlugAvailability {
|
|
18
|
+
/**
|
|
19
|
+
* Normalized subdomain checked.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetSignupSlugAvailability
|
|
22
|
+
*/
|
|
23
|
+
slug: string;
|
|
24
|
+
/**
|
|
25
|
+
* Whether the subdomain is currently unused. This check does not reserve it.
|
|
26
|
+
* @type {boolean}
|
|
27
|
+
* @memberof GetSignupSlugAvailability
|
|
28
|
+
*/
|
|
29
|
+
available: boolean;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the GetSignupSlugAvailability interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfGetSignupSlugAvailability(value: object): value is GetSignupSlugAvailability;
|
|
35
|
+
export declare function GetSignupSlugAvailabilityFromJSON(json: any): GetSignupSlugAvailability;
|
|
36
|
+
export declare function GetSignupSlugAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSignupSlugAvailability;
|
|
37
|
+
export declare function GetSignupSlugAvailabilityToJSON(json: any): GetSignupSlugAvailability;
|
|
38
|
+
export declare function GetSignupSlugAvailabilityToJSONTyped(value?: GetSignupSlugAvailability | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,47 @@
|
|
|
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 GetSignupSlugAvailability interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfGetSignupSlugAvailability(value) {
|
|
18
|
+
if (!('slug' in value) || value['slug'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('available' in value) || value['available'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
export function GetSignupSlugAvailabilityFromJSON(json) {
|
|
25
|
+
return GetSignupSlugAvailabilityFromJSONTyped(json, false);
|
|
26
|
+
}
|
|
27
|
+
export function GetSignupSlugAvailabilityFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
|
+
if (json == null) {
|
|
29
|
+
return json;
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
'slug': json['slug'],
|
|
33
|
+
'available': json['available'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function GetSignupSlugAvailabilityToJSON(json) {
|
|
37
|
+
return GetSignupSlugAvailabilityToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function GetSignupSlugAvailabilityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'slug': value['slug'],
|
|
45
|
+
'available': value['available'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -45,6 +45,12 @@ export interface PostSignupRequest {
|
|
|
45
45
|
* @memberof PostSignupRequest
|
|
46
46
|
*/
|
|
47
47
|
organization: string;
|
|
48
|
+
/**
|
|
49
|
+
* Requested learner subdomain, without the domain suffix. Must be available and not reserved. If omitted, it is derived from the organization. Availability does not reserve the address; verification checks again and never substitutes another address.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof PostSignupRequest
|
|
52
|
+
*/
|
|
53
|
+
slug?: string;
|
|
48
54
|
/**
|
|
49
55
|
* Signup/onboarding role supplied by the user; not an LMS RBAC role.
|
|
50
56
|
* @type {string}
|
|
@@ -44,6 +44,7 @@ export function PostSignupRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
44
|
'email': json['email'],
|
|
45
45
|
'password': json['password'],
|
|
46
46
|
'organization': json['organization'],
|
|
47
|
+
'slug': json['slug'] == null ? undefined : json['slug'],
|
|
47
48
|
'jobRole': json['job_role'],
|
|
48
49
|
'learnerCount': json['learner_count'],
|
|
49
50
|
};
|
|
@@ -61,6 +62,7 @@ export function PostSignupRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
61
62
|
'email': value['email'],
|
|
62
63
|
'password': value['password'],
|
|
63
64
|
'organization': value['organization'],
|
|
65
|
+
'slug': value['slug'],
|
|
64
66
|
'job_role': value['jobRole'],
|
|
65
67
|
'learner_count': value['learnerCount'],
|
|
66
68
|
};
|