@easyedu/js-lsm-api 1.106.0 → 1.108.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 +4 -0
- package/README.md +7 -4
- package/dist/apis/CourseApi.d.ts +30 -2
- package/dist/apis/CourseApi.js +59 -3
- package/dist/apis/CourseCatalogApi.d.ts +8 -3
- package/dist/apis/CourseCatalogApi.js +14 -7
- package/dist/apis/CourseShareApi.d.ts +31 -12
- package/dist/apis/CourseShareApi.js +44 -16
- package/dist/esm/apis/CourseApi.d.ts +30 -2
- package/dist/esm/apis/CourseApi.js +58 -2
- package/dist/esm/apis/CourseCatalogApi.d.ts +8 -3
- package/dist/esm/apis/CourseCatalogApi.js +14 -7
- package/dist/esm/apis/CourseShareApi.d.ts +31 -12
- package/dist/esm/apis/CourseShareApi.js +43 -15
- package/dist/esm/models/CourseShare.d.ts +57 -9
- package/dist/esm/models/CourseShare.js +32 -0
- package/dist/esm/models/GetCourseCatalogList.d.ts +57 -0
- package/dist/esm/models/GetCourseCatalogList.js +60 -0
- package/dist/esm/models/GetCourseExport.d.ts +6 -0
- package/dist/esm/models/GetCourseExport.js +4 -0
- package/dist/esm/models/GetCourseShareList.d.ts +57 -0
- package/dist/esm/models/GetCourseShareList.js +60 -0
- package/dist/esm/models/PostOfferCatalog.d.ts +1 -1
- package/dist/esm/models/PostOfferCourse.d.ts +1 -1
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/CourseShare.d.ts +57 -9
- package/dist/models/CourseShare.js +32 -0
- package/dist/models/GetCourseCatalogList.d.ts +57 -0
- package/dist/models/GetCourseCatalogList.js +67 -0
- package/dist/models/GetCourseExport.d.ts +6 -0
- package/dist/models/GetCourseExport.js +4 -0
- package/dist/models/GetCourseShareList.d.ts +57 -0
- package/dist/models/GetCourseShareList.js +67 -0
- package/dist/models/PostOfferCatalog.d.ts +1 -1
- package/dist/models/PostOfferCourse.d.ts +1 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/CourseApi.md +79 -1
- package/docs/CourseCatalogApi.md +15 -4
- package/docs/CourseShare.md +19 -3
- package/docs/CourseShareApi.md +39 -13
- package/docs/GetCourseCatalogList.md +42 -0
- package/docs/GetCourseExport.md +2 -0
- package/docs/GetCourseShareList.md +42 -0
- package/package.json +1 -1
- package/src/apis/CourseApi.ts +72 -2
- package/src/apis/CourseCatalogApi.ts +24 -6
- package/src/apis/CourseShareApi.ts +63 -19
- package/src/models/CourseShare.ts +81 -9
- package/src/models/GetCourseCatalogList.ts +110 -0
- package/src/models/GetCourseExport.ts +9 -0
- package/src/models/GetCourseShareList.ts +110 -0
- package/src/models/PostOfferCatalog.ts +1 -1
- package/src/models/PostOfferCourse.ts +1 -1
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -71,6 +71,7 @@ docs/GetContentLibraryVersion.md
|
|
|
71
71
|
docs/GetConversation.md
|
|
72
72
|
docs/GetConversationList.md
|
|
73
73
|
docs/GetCourse.md
|
|
74
|
+
docs/GetCourseCatalogList.md
|
|
74
75
|
docs/GetCourseEnrollment.md
|
|
75
76
|
docs/GetCourseEnrollmentList.md
|
|
76
77
|
docs/GetCourseEnrollmentListItem.md
|
|
@@ -78,6 +79,7 @@ docs/GetCourseExport.md
|
|
|
78
79
|
docs/GetCourseExportList.md
|
|
79
80
|
docs/GetCourseImageUpload.md
|
|
80
81
|
docs/GetCourseList.md
|
|
82
|
+
docs/GetCourseShareList.md
|
|
81
83
|
docs/GetCourseVersion.md
|
|
82
84
|
docs/GetCourseVersionItem.md
|
|
83
85
|
docs/GetCourseVersionItemLaunch.md
|
|
@@ -386,6 +388,7 @@ src/models/GetContentLibraryVersion.ts
|
|
|
386
388
|
src/models/GetConversation.ts
|
|
387
389
|
src/models/GetConversationList.ts
|
|
388
390
|
src/models/GetCourse.ts
|
|
391
|
+
src/models/GetCourseCatalogList.ts
|
|
389
392
|
src/models/GetCourseEnrollment.ts
|
|
390
393
|
src/models/GetCourseEnrollmentList.ts
|
|
391
394
|
src/models/GetCourseEnrollmentListItem.ts
|
|
@@ -393,6 +396,7 @@ src/models/GetCourseExport.ts
|
|
|
393
396
|
src/models/GetCourseExportList.ts
|
|
394
397
|
src/models/GetCourseImageUpload.ts
|
|
395
398
|
src/models/GetCourseList.ts
|
|
399
|
+
src/models/GetCourseShareList.ts
|
|
396
400
|
src/models/GetCourseVersion.ts
|
|
397
401
|
src/models/GetCourseVersionItem.ts
|
|
398
402
|
src/models/GetCourseVersionItemLaunch.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.108.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -191,6 +191,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
191
191
|
*CourseApi* | [**getCourseVersionItemLaunch**](docs/CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version
|
|
192
192
|
*CourseApi* | [**getCourseVersionList**](docs/CourseApi.md#getcourseversionlist) | **GET** /courses/{courseId}/versions | List immutable course versions and the current draft
|
|
193
193
|
*CourseApi* | [**getCourseVersionProgression**](docs/CourseApi.md#getcourseversionprogression) | **GET** /courses/{courseId}/versions/{courseVersionId}/progression | Get learner-specific completion and section lock state
|
|
194
|
+
*CourseApi* | [**getPortalCourseExports**](docs/CourseApi.md#getportalcourseexports) | **GET** /course-exports | List SCORM exports owned by the current portal
|
|
194
195
|
*CourseApi* | [**postCourse**](docs/CourseApi.md#postcourse) | **POST** /courses | Post a new course
|
|
195
196
|
*CourseApi* | [**postCourseDraft**](docs/CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft
|
|
196
197
|
*CourseApi* | [**postCourseDraftResourceUpdateAll**](docs/CourseApi.md#postcoursedraftresourceupdateall) | **POST** /courses/{courseId}/draft/resources/update-all | Update all draft resource placements to their latest published versions
|
|
@@ -223,8 +224,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
223
224
|
*CourseShareApi* | [**deleteCourseShare**](docs/CourseShareApi.md#deletecourseshare) | **DELETE** /course-shares/{shareId} | Revoke a share
|
|
224
225
|
*CourseShareApi* | [**getCourseSharesOfferedByMe**](docs/CourseShareApi.md#getcoursesharesofferedbyme) | **GET** /course-shares/offered-by-me | List shares the current portal has offered out
|
|
225
226
|
*CourseShareApi* | [**getCourseSharesOfferedToMe**](docs/CourseShareApi.md#getcoursesharesofferedtome) | **GET** /course-shares/offered-to-me | List shares offered to the current portal
|
|
226
|
-
*CourseShareApi* | [**postOfferCatalog**](docs/CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to
|
|
227
|
-
*CourseShareApi* | [**postOfferCourse**](docs/CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to
|
|
227
|
+
*CourseShareApi* | [**postOfferCatalog**](docs/CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to another portal
|
|
228
|
+
*CourseShareApi* | [**postOfferCourse**](docs/CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to another portal
|
|
228
229
|
*CourseShareApi* | [**postUnrevokeShare**](docs/CourseShareApi.md#postunrevokeshare) | **POST** /course-shares/{shareId}/unrevoke | Restore a previously revoked share
|
|
229
230
|
*CourseShareApi* | [**putAcceptClone**](docs/CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal)
|
|
230
231
|
*CourseShareApi* | [**putAcceptMirror**](docs/CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source)
|
|
@@ -416,6 +417,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
416
417
|
- [GetConversation](docs/GetConversation.md)
|
|
417
418
|
- [GetConversationList](docs/GetConversationList.md)
|
|
418
419
|
- [GetCourse](docs/GetCourse.md)
|
|
420
|
+
- [GetCourseCatalogList](docs/GetCourseCatalogList.md)
|
|
419
421
|
- [GetCourseEnrollment](docs/GetCourseEnrollment.md)
|
|
420
422
|
- [GetCourseEnrollmentList](docs/GetCourseEnrollmentList.md)
|
|
421
423
|
- [GetCourseEnrollmentListItem](docs/GetCourseEnrollmentListItem.md)
|
|
@@ -423,6 +425,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
423
425
|
- [GetCourseExportList](docs/GetCourseExportList.md)
|
|
424
426
|
- [GetCourseImageUpload](docs/GetCourseImageUpload.md)
|
|
425
427
|
- [GetCourseList](docs/GetCourseList.md)
|
|
428
|
+
- [GetCourseShareList](docs/GetCourseShareList.md)
|
|
426
429
|
- [GetCourseVersion](docs/GetCourseVersion.md)
|
|
427
430
|
- [GetCourseVersionItem](docs/GetCourseVersionItem.md)
|
|
428
431
|
- [GetCourseVersionItemLaunch](docs/GetCourseVersionItemLaunch.md)
|
|
@@ -650,7 +653,7 @@ and is automatically generated by the
|
|
|
650
653
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
651
654
|
|
|
652
655
|
- API version: `1.0.0`
|
|
653
|
-
- Package version: `1.
|
|
656
|
+
- Package version: `1.108.0`
|
|
654
657
|
- Generator version: `7.22.0`
|
|
655
658
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
656
659
|
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -131,6 +131,12 @@ export interface GetCourseVersionProgressionRequest {
|
|
|
131
131
|
courseVersionId: string;
|
|
132
132
|
preview?: boolean;
|
|
133
133
|
}
|
|
134
|
+
export interface GetPortalCourseExportsRequest {
|
|
135
|
+
page?: number;
|
|
136
|
+
pageSize?: number;
|
|
137
|
+
courseId?: string;
|
|
138
|
+
status?: GetPortalCourseExportsStatusEnum;
|
|
139
|
+
}
|
|
134
140
|
export interface PostCourseRequest {
|
|
135
141
|
postCourse: PostCourse;
|
|
136
142
|
}
|
|
@@ -462,6 +468,18 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
462
468
|
* Get learner-specific completion and section lock state
|
|
463
469
|
*/
|
|
464
470
|
getCourseVersionProgression(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionProgression>;
|
|
471
|
+
/**
|
|
472
|
+
* Creates request options for getPortalCourseExports without sending the request
|
|
473
|
+
*/
|
|
474
|
+
getPortalCourseExportsRequestOpts(requestParameters: GetPortalCourseExportsRequest): Promise<runtime.RequestOpts>;
|
|
475
|
+
/**
|
|
476
|
+
* List SCORM exports owned by the current portal
|
|
477
|
+
*/
|
|
478
|
+
getPortalCourseExportsRaw(requestParameters: GetPortalCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExportList>>;
|
|
479
|
+
/**
|
|
480
|
+
* List SCORM exports owned by the current portal
|
|
481
|
+
*/
|
|
482
|
+
getPortalCourseExports(requestParameters?: GetPortalCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExportList>;
|
|
465
483
|
/**
|
|
466
484
|
* Creates request options for postCourse without sending the request
|
|
467
485
|
*/
|
|
@@ -529,12 +547,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
529
547
|
*/
|
|
530
548
|
postCourseExportRequestOpts(requestParameters: PostCourseExportRequest): Promise<runtime.RequestOpts>;
|
|
531
549
|
/**
|
|
532
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
550
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
533
551
|
* Create a new SCORM export for a course
|
|
534
552
|
*/
|
|
535
553
|
postCourseExportRaw(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
|
|
536
554
|
/**
|
|
537
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
555
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
538
556
|
* Create a new SCORM export for a course
|
|
539
557
|
*/
|
|
540
558
|
postCourseExport(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
|
|
@@ -729,3 +747,13 @@ export declare const GetCourseEnrollmentsTypeEnum: {
|
|
|
729
747
|
readonly Instructor: "instructor";
|
|
730
748
|
};
|
|
731
749
|
export type GetCourseEnrollmentsTypeEnum = typeof GetCourseEnrollmentsTypeEnum[keyof typeof GetCourseEnrollmentsTypeEnum];
|
|
750
|
+
/**
|
|
751
|
+
* @export
|
|
752
|
+
*/
|
|
753
|
+
export declare const GetPortalCourseExportsStatusEnum: {
|
|
754
|
+
readonly Pending: "PENDING";
|
|
755
|
+
readonly Processing: "PROCESSING";
|
|
756
|
+
readonly Completed: "COMPLETED";
|
|
757
|
+
readonly Failed: "FAILED";
|
|
758
|
+
};
|
|
759
|
+
export type GetPortalCourseExportsStatusEnum = typeof GetPortalCourseExportsStatusEnum[keyof typeof GetPortalCourseExportsStatusEnum];
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetCourseEnrollmentsTypeEnum = exports.CourseApi = void 0;
|
|
25
|
+
exports.GetPortalCourseExportsStatusEnum = exports.GetCourseEnrollmentsTypeEnum = exports.CourseApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const GetAttemptAllowance_1 = require("../models/GetAttemptAllowance");
|
|
28
28
|
const GetCourse_1 = require("../models/GetCourse");
|
|
@@ -901,6 +901,53 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
901
901
|
return yield response.value();
|
|
902
902
|
});
|
|
903
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* Creates request options for getPortalCourseExports without sending the request
|
|
906
|
+
*/
|
|
907
|
+
getPortalCourseExportsRequestOpts(requestParameters) {
|
|
908
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
909
|
+
const queryParameters = {};
|
|
910
|
+
if (requestParameters['page'] != null) {
|
|
911
|
+
queryParameters['page'] = requestParameters['page'];
|
|
912
|
+
}
|
|
913
|
+
if (requestParameters['pageSize'] != null) {
|
|
914
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
915
|
+
}
|
|
916
|
+
if (requestParameters['courseId'] != null) {
|
|
917
|
+
queryParameters['course_id'] = requestParameters['courseId'];
|
|
918
|
+
}
|
|
919
|
+
if (requestParameters['status'] != null) {
|
|
920
|
+
queryParameters['status'] = requestParameters['status'];
|
|
921
|
+
}
|
|
922
|
+
const headerParameters = {};
|
|
923
|
+
let urlPath = `/course-exports`;
|
|
924
|
+
return {
|
|
925
|
+
path: urlPath,
|
|
926
|
+
method: 'GET',
|
|
927
|
+
headers: headerParameters,
|
|
928
|
+
query: queryParameters,
|
|
929
|
+
};
|
|
930
|
+
});
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* List SCORM exports owned by the current portal
|
|
934
|
+
*/
|
|
935
|
+
getPortalCourseExportsRaw(requestParameters, initOverrides) {
|
|
936
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
937
|
+
const requestOptions = yield this.getPortalCourseExportsRequestOpts(requestParameters);
|
|
938
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
939
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseExportList_1.GetCourseExportListFromJSON)(jsonValue));
|
|
940
|
+
});
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* List SCORM exports owned by the current portal
|
|
944
|
+
*/
|
|
945
|
+
getPortalCourseExports() {
|
|
946
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
947
|
+
const response = yield this.getPortalCourseExportsRaw(requestParameters, initOverrides);
|
|
948
|
+
return yield response.value();
|
|
949
|
+
});
|
|
950
|
+
}
|
|
904
951
|
/**
|
|
905
952
|
* Creates request options for postCourse without sending the request
|
|
906
953
|
*/
|
|
@@ -1134,7 +1181,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
1134
1181
|
});
|
|
1135
1182
|
}
|
|
1136
1183
|
/**
|
|
1137
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
1184
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
1138
1185
|
* Create a new SCORM export for a course
|
|
1139
1186
|
*/
|
|
1140
1187
|
postCourseExportRaw(requestParameters, initOverrides) {
|
|
@@ -1145,7 +1192,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
1145
1192
|
});
|
|
1146
1193
|
}
|
|
1147
1194
|
/**
|
|
1148
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
1195
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
1149
1196
|
* Create a new SCORM export for a course
|
|
1150
1197
|
*/
|
|
1151
1198
|
postCourseExport(requestParameters, initOverrides) {
|
|
@@ -1898,3 +1945,12 @@ exports.GetCourseEnrollmentsTypeEnum = {
|
|
|
1898
1945
|
Student: 'student',
|
|
1899
1946
|
Instructor: 'instructor'
|
|
1900
1947
|
};
|
|
1948
|
+
/**
|
|
1949
|
+
* @export
|
|
1950
|
+
*/
|
|
1951
|
+
exports.GetPortalCourseExportsStatusEnum = {
|
|
1952
|
+
Pending: 'PENDING',
|
|
1953
|
+
Processing: 'PROCESSING',
|
|
1954
|
+
Completed: 'COMPLETED',
|
|
1955
|
+
Failed: 'FAILED'
|
|
1956
|
+
};
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type CourseCatalog } from '../models/CourseCatalog';
|
|
14
14
|
import { type GetCourse } from '../models/GetCourse';
|
|
15
|
+
import { type GetCourseCatalogList } from '../models/GetCourseCatalogList';
|
|
15
16
|
import { type PostCourseCatalog } from '../models/PostCourseCatalog';
|
|
16
17
|
import { type PutCourseCatalog } from '../models/PutCourseCatalog';
|
|
17
18
|
export interface AddCourseToCatalogRequest {
|
|
@@ -27,6 +28,10 @@ export interface GetCatalogCoursesRequest {
|
|
|
27
28
|
export interface GetCourseCatalogRequest {
|
|
28
29
|
catalogId: string;
|
|
29
30
|
}
|
|
31
|
+
export interface GetCourseCatalogsRequest {
|
|
32
|
+
page?: number;
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
}
|
|
30
35
|
export interface PostCourseCatalogRequest {
|
|
31
36
|
postCourseCatalog: PostCourseCatalog;
|
|
32
37
|
}
|
|
@@ -93,15 +98,15 @@ export declare class CourseCatalogApi extends runtime.BaseAPI {
|
|
|
93
98
|
/**
|
|
94
99
|
* Creates request options for getCourseCatalogs without sending the request
|
|
95
100
|
*/
|
|
96
|
-
getCourseCatalogsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
101
|
+
getCourseCatalogsRequestOpts(requestParameters: GetCourseCatalogsRequest): Promise<runtime.RequestOpts>;
|
|
97
102
|
/**
|
|
98
103
|
* List catalogs in the current portal
|
|
99
104
|
*/
|
|
100
|
-
getCourseCatalogsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
105
|
+
getCourseCatalogsRaw(requestParameters: GetCourseCatalogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseCatalogList>>;
|
|
101
106
|
/**
|
|
102
107
|
* List catalogs in the current portal
|
|
103
108
|
*/
|
|
104
|
-
getCourseCatalogs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
109
|
+
getCourseCatalogs(requestParameters?: GetCourseCatalogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseCatalogList>;
|
|
105
110
|
/**
|
|
106
111
|
* Creates request options for postCourseCatalog without sending the request
|
|
107
112
|
*/
|
|
@@ -26,6 +26,7 @@ exports.CourseCatalogApi = void 0;
|
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const CourseCatalog_1 = require("../models/CourseCatalog");
|
|
28
28
|
const GetCourse_1 = require("../models/GetCourse");
|
|
29
|
+
const GetCourseCatalogList_1 = require("../models/GetCourseCatalogList");
|
|
29
30
|
const PostCourseCatalog_1 = require("../models/PostCourseCatalog");
|
|
30
31
|
const PutCourseCatalog_1 = require("../models/PutCourseCatalog");
|
|
31
32
|
/**
|
|
@@ -193,9 +194,15 @@ class CourseCatalogApi extends runtime.BaseAPI {
|
|
|
193
194
|
/**
|
|
194
195
|
* Creates request options for getCourseCatalogs without sending the request
|
|
195
196
|
*/
|
|
196
|
-
getCourseCatalogsRequestOpts() {
|
|
197
|
+
getCourseCatalogsRequestOpts(requestParameters) {
|
|
197
198
|
return __awaiter(this, void 0, void 0, function* () {
|
|
198
199
|
const queryParameters = {};
|
|
200
|
+
if (requestParameters['page'] != null) {
|
|
201
|
+
queryParameters['page'] = requestParameters['page'];
|
|
202
|
+
}
|
|
203
|
+
if (requestParameters['pageSize'] != null) {
|
|
204
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
205
|
+
}
|
|
199
206
|
const headerParameters = {};
|
|
200
207
|
let urlPath = `/catalogs`;
|
|
201
208
|
return {
|
|
@@ -209,19 +216,19 @@ class CourseCatalogApi extends runtime.BaseAPI {
|
|
|
209
216
|
/**
|
|
210
217
|
* List catalogs in the current portal
|
|
211
218
|
*/
|
|
212
|
-
getCourseCatalogsRaw(initOverrides) {
|
|
219
|
+
getCourseCatalogsRaw(requestParameters, initOverrides) {
|
|
213
220
|
return __awaiter(this, void 0, void 0, function* () {
|
|
214
|
-
const requestOptions = yield this.getCourseCatalogsRequestOpts();
|
|
221
|
+
const requestOptions = yield this.getCourseCatalogsRequestOpts(requestParameters);
|
|
215
222
|
const response = yield this.request(requestOptions, initOverrides);
|
|
216
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
223
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseCatalogList_1.GetCourseCatalogListFromJSON)(jsonValue));
|
|
217
224
|
});
|
|
218
225
|
}
|
|
219
226
|
/**
|
|
220
227
|
* List catalogs in the current portal
|
|
221
228
|
*/
|
|
222
|
-
getCourseCatalogs(
|
|
223
|
-
return __awaiter(this,
|
|
224
|
-
const response = yield this.getCourseCatalogsRaw(initOverrides);
|
|
229
|
+
getCourseCatalogs() {
|
|
230
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
231
|
+
const response = yield this.getCourseCatalogsRaw(requestParameters, initOverrides);
|
|
225
232
|
return yield response.value();
|
|
226
233
|
});
|
|
227
234
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { type
|
|
13
|
+
import { type GetCourseShareList } from '../models/GetCourseShareList';
|
|
14
14
|
import { type PostOfferCatalog } from '../models/PostOfferCatalog';
|
|
15
15
|
import { type PostOfferCatalogResponse } from '../models/PostOfferCatalogResponse';
|
|
16
16
|
import { type PostOfferCourse } from '../models/PostOfferCourse';
|
|
@@ -18,7 +18,15 @@ import { type PostOfferCourseResponse } from '../models/PostOfferCourseResponse'
|
|
|
18
18
|
export interface DeleteCourseShareRequest {
|
|
19
19
|
shareId: string;
|
|
20
20
|
}
|
|
21
|
+
export interface GetCourseSharesOfferedByMeRequest {
|
|
22
|
+
page?: number;
|
|
23
|
+
pageSize?: number;
|
|
24
|
+
courseId?: string;
|
|
25
|
+
state?: GetCourseSharesOfferedByMeStateEnum;
|
|
26
|
+
}
|
|
21
27
|
export interface GetCourseSharesOfferedToMeRequest {
|
|
28
|
+
page?: number;
|
|
29
|
+
pageSize?: number;
|
|
22
30
|
state?: GetCourseSharesOfferedToMeStateEnum;
|
|
23
31
|
}
|
|
24
32
|
export interface PostOfferCatalogRequest {
|
|
@@ -62,41 +70,41 @@ export declare class CourseShareApi extends runtime.BaseAPI {
|
|
|
62
70
|
/**
|
|
63
71
|
* Creates request options for getCourseSharesOfferedByMe without sending the request
|
|
64
72
|
*/
|
|
65
|
-
getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts>;
|
|
73
|
+
getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts>;
|
|
66
74
|
/**
|
|
67
75
|
* List shares the current portal has offered out
|
|
68
76
|
*/
|
|
69
|
-
getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
77
|
+
getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseShareList>>;
|
|
70
78
|
/**
|
|
71
79
|
* List shares the current portal has offered out
|
|
72
80
|
*/
|
|
73
|
-
getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
81
|
+
getCourseSharesOfferedByMe(requestParameters?: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseShareList>;
|
|
74
82
|
/**
|
|
75
83
|
* Creates request options for getCourseSharesOfferedToMe without sending the request
|
|
76
84
|
*/
|
|
77
85
|
getCourseSharesOfferedToMeRequestOpts(requestParameters: GetCourseSharesOfferedToMeRequest): Promise<runtime.RequestOpts>;
|
|
78
86
|
/**
|
|
79
|
-
* Returns
|
|
87
|
+
* Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
|
|
80
88
|
* List shares offered to the current portal
|
|
81
89
|
*/
|
|
82
|
-
getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
90
|
+
getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseShareList>>;
|
|
83
91
|
/**
|
|
84
|
-
* Returns
|
|
92
|
+
* Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
|
|
85
93
|
* List shares offered to the current portal
|
|
86
94
|
*/
|
|
87
|
-
getCourseSharesOfferedToMe(requestParameters?: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
95
|
+
getCourseSharesOfferedToMe(requestParameters?: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseShareList>;
|
|
88
96
|
/**
|
|
89
97
|
* Creates request options for postOfferCatalog without sending the request
|
|
90
98
|
*/
|
|
91
99
|
postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts>;
|
|
92
100
|
/**
|
|
93
101
|
* Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
|
|
94
|
-
* Offer every course in a catalog to
|
|
102
|
+
* Offer every course in a catalog to another portal
|
|
95
103
|
*/
|
|
96
104
|
postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>>;
|
|
97
105
|
/**
|
|
98
106
|
* Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
|
|
99
|
-
* Offer every course in a catalog to
|
|
107
|
+
* Offer every course in a catalog to another portal
|
|
100
108
|
*/
|
|
101
109
|
postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse>;
|
|
102
110
|
/**
|
|
@@ -104,11 +112,11 @@ export declare class CourseShareApi extends runtime.BaseAPI {
|
|
|
104
112
|
*/
|
|
105
113
|
postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts>;
|
|
106
114
|
/**
|
|
107
|
-
* Offer a single course to
|
|
115
|
+
* Offer a single course to another portal
|
|
108
116
|
*/
|
|
109
117
|
postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>>;
|
|
110
118
|
/**
|
|
111
|
-
* Offer a single course to
|
|
119
|
+
* Offer a single course to another portal
|
|
112
120
|
*/
|
|
113
121
|
postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse>;
|
|
114
122
|
/**
|
|
@@ -160,6 +168,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
|
|
|
160
168
|
*/
|
|
161
169
|
putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
162
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* @export
|
|
173
|
+
*/
|
|
174
|
+
export declare const GetCourseSharesOfferedByMeStateEnum: {
|
|
175
|
+
readonly Offered: "offered";
|
|
176
|
+
readonly AcceptedMirror: "accepted_mirror";
|
|
177
|
+
readonly AcceptedClone: "accepted_clone";
|
|
178
|
+
readonly Declined: "declined";
|
|
179
|
+
readonly Revoked: "revoked";
|
|
180
|
+
};
|
|
181
|
+
export type GetCourseSharesOfferedByMeStateEnum = typeof GetCourseSharesOfferedByMeStateEnum[keyof typeof GetCourseSharesOfferedByMeStateEnum];
|
|
163
182
|
/**
|
|
164
183
|
* @export
|
|
165
184
|
*/
|
|
@@ -22,9 +22,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetCourseSharesOfferedToMeStateEnum = exports.CourseShareApi = void 0;
|
|
25
|
+
exports.GetCourseSharesOfferedToMeStateEnum = exports.GetCourseSharesOfferedByMeStateEnum = exports.CourseShareApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
|
-
const
|
|
27
|
+
const GetCourseShareList_1 = require("../models/GetCourseShareList");
|
|
28
28
|
const PostOfferCatalog_1 = require("../models/PostOfferCatalog");
|
|
29
29
|
const PostOfferCatalogResponse_1 = require("../models/PostOfferCatalogResponse");
|
|
30
30
|
const PostOfferCourse_1 = require("../models/PostOfferCourse");
|
|
@@ -76,9 +76,21 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
76
76
|
/**
|
|
77
77
|
* Creates request options for getCourseSharesOfferedByMe without sending the request
|
|
78
78
|
*/
|
|
79
|
-
getCourseSharesOfferedByMeRequestOpts() {
|
|
79
|
+
getCourseSharesOfferedByMeRequestOpts(requestParameters) {
|
|
80
80
|
return __awaiter(this, void 0, void 0, function* () {
|
|
81
81
|
const queryParameters = {};
|
|
82
|
+
if (requestParameters['page'] != null) {
|
|
83
|
+
queryParameters['page'] = requestParameters['page'];
|
|
84
|
+
}
|
|
85
|
+
if (requestParameters['pageSize'] != null) {
|
|
86
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
87
|
+
}
|
|
88
|
+
if (requestParameters['courseId'] != null) {
|
|
89
|
+
queryParameters['course_id'] = requestParameters['courseId'];
|
|
90
|
+
}
|
|
91
|
+
if (requestParameters['state'] != null) {
|
|
92
|
+
queryParameters['state'] = requestParameters['state'];
|
|
93
|
+
}
|
|
82
94
|
const headerParameters = {};
|
|
83
95
|
let urlPath = `/course-shares/offered-by-me`;
|
|
84
96
|
return {
|
|
@@ -92,19 +104,19 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
92
104
|
/**
|
|
93
105
|
* List shares the current portal has offered out
|
|
94
106
|
*/
|
|
95
|
-
getCourseSharesOfferedByMeRaw(initOverrides) {
|
|
107
|
+
getCourseSharesOfferedByMeRaw(requestParameters, initOverrides) {
|
|
96
108
|
return __awaiter(this, void 0, void 0, function* () {
|
|
97
|
-
const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts();
|
|
109
|
+
const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts(requestParameters);
|
|
98
110
|
const response = yield this.request(requestOptions, initOverrides);
|
|
99
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
111
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseShareList_1.GetCourseShareListFromJSON)(jsonValue));
|
|
100
112
|
});
|
|
101
113
|
}
|
|
102
114
|
/**
|
|
103
115
|
* List shares the current portal has offered out
|
|
104
116
|
*/
|
|
105
|
-
getCourseSharesOfferedByMe(
|
|
106
|
-
return __awaiter(this,
|
|
107
|
-
const response = yield this.getCourseSharesOfferedByMeRaw(initOverrides);
|
|
117
|
+
getCourseSharesOfferedByMe() {
|
|
118
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
119
|
+
const response = yield this.getCourseSharesOfferedByMeRaw(requestParameters, initOverrides);
|
|
108
120
|
return yield response.value();
|
|
109
121
|
});
|
|
110
122
|
}
|
|
@@ -114,6 +126,12 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
114
126
|
getCourseSharesOfferedToMeRequestOpts(requestParameters) {
|
|
115
127
|
return __awaiter(this, void 0, void 0, function* () {
|
|
116
128
|
const queryParameters = {};
|
|
129
|
+
if (requestParameters['page'] != null) {
|
|
130
|
+
queryParameters['page'] = requestParameters['page'];
|
|
131
|
+
}
|
|
132
|
+
if (requestParameters['pageSize'] != null) {
|
|
133
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
134
|
+
}
|
|
117
135
|
if (requestParameters['state'] != null) {
|
|
118
136
|
queryParameters['state'] = requestParameters['state'];
|
|
119
137
|
}
|
|
@@ -128,18 +146,18 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
128
146
|
});
|
|
129
147
|
}
|
|
130
148
|
/**
|
|
131
|
-
* Returns
|
|
149
|
+
* Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
|
|
132
150
|
* List shares offered to the current portal
|
|
133
151
|
*/
|
|
134
152
|
getCourseSharesOfferedToMeRaw(requestParameters, initOverrides) {
|
|
135
153
|
return __awaiter(this, void 0, void 0, function* () {
|
|
136
154
|
const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts(requestParameters);
|
|
137
155
|
const response = yield this.request(requestOptions, initOverrides);
|
|
138
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
156
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseShareList_1.GetCourseShareListFromJSON)(jsonValue));
|
|
139
157
|
});
|
|
140
158
|
}
|
|
141
159
|
/**
|
|
142
|
-
* Returns
|
|
160
|
+
* Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
|
|
143
161
|
* List shares offered to the current portal
|
|
144
162
|
*/
|
|
145
163
|
getCourseSharesOfferedToMe() {
|
|
@@ -175,7 +193,7 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
175
193
|
}
|
|
176
194
|
/**
|
|
177
195
|
* Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
|
|
178
|
-
* Offer every course in a catalog to
|
|
196
|
+
* Offer every course in a catalog to another portal
|
|
179
197
|
*/
|
|
180
198
|
postOfferCatalogRaw(requestParameters, initOverrides) {
|
|
181
199
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -186,7 +204,7 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
186
204
|
}
|
|
187
205
|
/**
|
|
188
206
|
* Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`.
|
|
189
|
-
* Offer every course in a catalog to
|
|
207
|
+
* Offer every course in a catalog to another portal
|
|
190
208
|
*/
|
|
191
209
|
postOfferCatalog(requestParameters, initOverrides) {
|
|
192
210
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -220,7 +238,7 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
220
238
|
});
|
|
221
239
|
}
|
|
222
240
|
/**
|
|
223
|
-
* Offer a single course to
|
|
241
|
+
* Offer a single course to another portal
|
|
224
242
|
*/
|
|
225
243
|
postOfferCourseRaw(requestParameters, initOverrides) {
|
|
226
244
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -230,7 +248,7 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
230
248
|
});
|
|
231
249
|
}
|
|
232
250
|
/**
|
|
233
|
-
* Offer a single course to
|
|
251
|
+
* Offer a single course to another portal
|
|
234
252
|
*/
|
|
235
253
|
postOfferCourse(requestParameters, initOverrides) {
|
|
236
254
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -392,6 +410,16 @@ class CourseShareApi extends runtime.BaseAPI {
|
|
|
392
410
|
}
|
|
393
411
|
}
|
|
394
412
|
exports.CourseShareApi = CourseShareApi;
|
|
413
|
+
/**
|
|
414
|
+
* @export
|
|
415
|
+
*/
|
|
416
|
+
exports.GetCourseSharesOfferedByMeStateEnum = {
|
|
417
|
+
Offered: 'offered',
|
|
418
|
+
AcceptedMirror: 'accepted_mirror',
|
|
419
|
+
AcceptedClone: 'accepted_clone',
|
|
420
|
+
Declined: 'declined',
|
|
421
|
+
Revoked: 'revoked'
|
|
422
|
+
};
|
|
395
423
|
/**
|
|
396
424
|
* @export
|
|
397
425
|
*/
|
|
@@ -131,6 +131,12 @@ export interface GetCourseVersionProgressionRequest {
|
|
|
131
131
|
courseVersionId: string;
|
|
132
132
|
preview?: boolean;
|
|
133
133
|
}
|
|
134
|
+
export interface GetPortalCourseExportsRequest {
|
|
135
|
+
page?: number;
|
|
136
|
+
pageSize?: number;
|
|
137
|
+
courseId?: string;
|
|
138
|
+
status?: GetPortalCourseExportsStatusEnum;
|
|
139
|
+
}
|
|
134
140
|
export interface PostCourseRequest {
|
|
135
141
|
postCourse: PostCourse;
|
|
136
142
|
}
|
|
@@ -462,6 +468,18 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
462
468
|
* Get learner-specific completion and section lock state
|
|
463
469
|
*/
|
|
464
470
|
getCourseVersionProgression(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionProgression>;
|
|
471
|
+
/**
|
|
472
|
+
* Creates request options for getPortalCourseExports without sending the request
|
|
473
|
+
*/
|
|
474
|
+
getPortalCourseExportsRequestOpts(requestParameters: GetPortalCourseExportsRequest): Promise<runtime.RequestOpts>;
|
|
475
|
+
/**
|
|
476
|
+
* List SCORM exports owned by the current portal
|
|
477
|
+
*/
|
|
478
|
+
getPortalCourseExportsRaw(requestParameters: GetPortalCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExportList>>;
|
|
479
|
+
/**
|
|
480
|
+
* List SCORM exports owned by the current portal
|
|
481
|
+
*/
|
|
482
|
+
getPortalCourseExports(requestParameters?: GetPortalCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExportList>;
|
|
465
483
|
/**
|
|
466
484
|
* Creates request options for postCourse without sending the request
|
|
467
485
|
*/
|
|
@@ -529,12 +547,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
529
547
|
*/
|
|
530
548
|
postCourseExportRequestOpts(requestParameters: PostCourseExportRequest): Promise<runtime.RequestOpts>;
|
|
531
549
|
/**
|
|
532
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
550
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
533
551
|
* Create a new SCORM export for a course
|
|
534
552
|
*/
|
|
535
553
|
postCourseExportRaw(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
|
|
536
554
|
/**
|
|
537
|
-
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package -
|
|
555
|
+
* Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status. **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
|
|
538
556
|
* Create a new SCORM export for a course
|
|
539
557
|
*/
|
|
540
558
|
postCourseExport(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
|
|
@@ -729,3 +747,13 @@ export declare const GetCourseEnrollmentsTypeEnum: {
|
|
|
729
747
|
readonly Instructor: "instructor";
|
|
730
748
|
};
|
|
731
749
|
export type GetCourseEnrollmentsTypeEnum = typeof GetCourseEnrollmentsTypeEnum[keyof typeof GetCourseEnrollmentsTypeEnum];
|
|
750
|
+
/**
|
|
751
|
+
* @export
|
|
752
|
+
*/
|
|
753
|
+
export declare const GetPortalCourseExportsStatusEnum: {
|
|
754
|
+
readonly Pending: "PENDING";
|
|
755
|
+
readonly Processing: "PROCESSING";
|
|
756
|
+
readonly Completed: "COMPLETED";
|
|
757
|
+
readonly Failed: "FAILED";
|
|
758
|
+
};
|
|
759
|
+
export type GetPortalCourseExportsStatusEnum = typeof GetPortalCourseExportsStatusEnum[keyof typeof GetPortalCourseExportsStatusEnum];
|