@easyedu/js-lsm-api 1.106.0 → 1.107.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.106.0
1
+ # @easyedu/js-lsm-api@1.107.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 a descendant portal
227
- *CourseShareApi* | [**postOfferCourse**](docs/CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to a descendant portal
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)
@@ -650,7 +651,7 @@ and is automatically generated by the
650
651
  [OpenAPI Generator](https://openapi-generator.tech) project:
651
652
 
652
653
  - API version: `1.0.0`
653
- - Package version: `1.106.0`
654
+ - Package version: `1.107.0`
654
655
  - Generator version: `7.22.0`
655
656
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
656
657
 
@@ -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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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];
@@ -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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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
+ };
@@ -18,6 +18,9 @@ import { type PostOfferCourseResponse } from '../models/PostOfferCourseResponse'
18
18
  export interface DeleteCourseShareRequest {
19
19
  shareId: string;
20
20
  }
21
+ export interface GetCourseSharesOfferedByMeRequest {
22
+ state?: GetCourseSharesOfferedByMeStateEnum;
23
+ }
21
24
  export interface GetCourseSharesOfferedToMeRequest {
22
25
  state?: GetCourseSharesOfferedToMeStateEnum;
23
26
  }
@@ -62,15 +65,15 @@ export declare class CourseShareApi extends runtime.BaseAPI {
62
65
  /**
63
66
  * Creates request options for getCourseSharesOfferedByMe without sending the request
64
67
  */
65
- getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts>;
68
+ getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts>;
66
69
  /**
67
70
  * List shares the current portal has offered out
68
71
  */
69
- getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
72
+ getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
70
73
  /**
71
74
  * List shares the current portal has offered out
72
75
  */
73
- getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
76
+ getCourseSharesOfferedByMe(requestParameters?: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
74
77
  /**
75
78
  * Creates request options for getCourseSharesOfferedToMe without sending the request
76
79
  */
@@ -91,12 +94,12 @@ export declare class CourseShareApi extends runtime.BaseAPI {
91
94
  postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts>;
92
95
  /**
93
96
  * 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 a descendant portal
97
+ * Offer every course in a catalog to another portal
95
98
  */
96
99
  postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>>;
97
100
  /**
98
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`.
99
- * Offer every course in a catalog to a descendant portal
102
+ * Offer every course in a catalog to another portal
100
103
  */
101
104
  postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse>;
102
105
  /**
@@ -104,11 +107,11 @@ export declare class CourseShareApi extends runtime.BaseAPI {
104
107
  */
105
108
  postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts>;
106
109
  /**
107
- * Offer a single course to a descendant portal
110
+ * Offer a single course to another portal
108
111
  */
109
112
  postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>>;
110
113
  /**
111
- * Offer a single course to a descendant portal
114
+ * Offer a single course to another portal
112
115
  */
113
116
  postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse>;
114
117
  /**
@@ -160,6 +163,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
160
163
  */
161
164
  putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
162
165
  }
166
+ /**
167
+ * @export
168
+ */
169
+ export declare const GetCourseSharesOfferedByMeStateEnum: {
170
+ readonly Offered: "offered";
171
+ readonly AcceptedMirror: "accepted_mirror";
172
+ readonly AcceptedClone: "accepted_clone";
173
+ readonly Declined: "declined";
174
+ readonly Revoked: "revoked";
175
+ };
176
+ export type GetCourseSharesOfferedByMeStateEnum = typeof GetCourseSharesOfferedByMeStateEnum[keyof typeof GetCourseSharesOfferedByMeStateEnum];
163
177
  /**
164
178
  * @export
165
179
  */
@@ -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.GetCourseSharesOfferedToMeStateEnum = exports.CourseShareApi = void 0;
25
+ exports.GetCourseSharesOfferedToMeStateEnum = exports.GetCourseSharesOfferedByMeStateEnum = exports.CourseShareApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const CourseShare_1 = require("../models/CourseShare");
28
28
  const PostOfferCatalog_1 = require("../models/PostOfferCatalog");
@@ -76,9 +76,12 @@ 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['state'] != null) {
83
+ queryParameters['state'] = requestParameters['state'];
84
+ }
82
85
  const headerParameters = {};
83
86
  let urlPath = `/course-shares/offered-by-me`;
84
87
  return {
@@ -92,9 +95,9 @@ class CourseShareApi extends runtime.BaseAPI {
92
95
  /**
93
96
  * List shares the current portal has offered out
94
97
  */
95
- getCourseSharesOfferedByMeRaw(initOverrides) {
98
+ getCourseSharesOfferedByMeRaw(requestParameters, initOverrides) {
96
99
  return __awaiter(this, void 0, void 0, function* () {
97
- const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts();
100
+ const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts(requestParameters);
98
101
  const response = yield this.request(requestOptions, initOverrides);
99
102
  return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShare_1.CourseShareFromJSON));
100
103
  });
@@ -102,9 +105,9 @@ class CourseShareApi extends runtime.BaseAPI {
102
105
  /**
103
106
  * List shares the current portal has offered out
104
107
  */
105
- getCourseSharesOfferedByMe(initOverrides) {
106
- return __awaiter(this, void 0, void 0, function* () {
107
- const response = yield this.getCourseSharesOfferedByMeRaw(initOverrides);
108
+ getCourseSharesOfferedByMe() {
109
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
110
+ const response = yield this.getCourseSharesOfferedByMeRaw(requestParameters, initOverrides);
108
111
  return yield response.value();
109
112
  });
110
113
  }
@@ -175,7 +178,7 @@ class CourseShareApi extends runtime.BaseAPI {
175
178
  }
176
179
  /**
177
180
  * 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 a descendant portal
181
+ * Offer every course in a catalog to another portal
179
182
  */
180
183
  postOfferCatalogRaw(requestParameters, initOverrides) {
181
184
  return __awaiter(this, void 0, void 0, function* () {
@@ -186,7 +189,7 @@ class CourseShareApi extends runtime.BaseAPI {
186
189
  }
187
190
  /**
188
191
  * 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 a descendant portal
192
+ * Offer every course in a catalog to another portal
190
193
  */
191
194
  postOfferCatalog(requestParameters, initOverrides) {
192
195
  return __awaiter(this, void 0, void 0, function* () {
@@ -220,7 +223,7 @@ class CourseShareApi extends runtime.BaseAPI {
220
223
  });
221
224
  }
222
225
  /**
223
- * Offer a single course to a descendant portal
226
+ * Offer a single course to another portal
224
227
  */
225
228
  postOfferCourseRaw(requestParameters, initOverrides) {
226
229
  return __awaiter(this, void 0, void 0, function* () {
@@ -230,7 +233,7 @@ class CourseShareApi extends runtime.BaseAPI {
230
233
  });
231
234
  }
232
235
  /**
233
- * Offer a single course to a descendant portal
236
+ * Offer a single course to another portal
234
237
  */
235
238
  postOfferCourse(requestParameters, initOverrides) {
236
239
  return __awaiter(this, void 0, void 0, function* () {
@@ -392,6 +395,16 @@ class CourseShareApi extends runtime.BaseAPI {
392
395
  }
393
396
  }
394
397
  exports.CourseShareApi = CourseShareApi;
398
+ /**
399
+ * @export
400
+ */
401
+ exports.GetCourseSharesOfferedByMeStateEnum = {
402
+ Offered: 'offered',
403
+ AcceptedMirror: 'accepted_mirror',
404
+ AcceptedClone: 'accepted_clone',
405
+ Declined: 'declined',
406
+ Revoked: 'revoked'
407
+ };
395
408
  /**
396
409
  * @export
397
410
  */
@@ -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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
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];
@@ -898,6 +898,53 @@ export class CourseApi extends runtime.BaseAPI {
898
898
  return yield response.value();
899
899
  });
900
900
  }
901
+ /**
902
+ * Creates request options for getPortalCourseExports without sending the request
903
+ */
904
+ getPortalCourseExportsRequestOpts(requestParameters) {
905
+ return __awaiter(this, void 0, void 0, function* () {
906
+ const queryParameters = {};
907
+ if (requestParameters['page'] != null) {
908
+ queryParameters['page'] = requestParameters['page'];
909
+ }
910
+ if (requestParameters['pageSize'] != null) {
911
+ queryParameters['page_size'] = requestParameters['pageSize'];
912
+ }
913
+ if (requestParameters['courseId'] != null) {
914
+ queryParameters['course_id'] = requestParameters['courseId'];
915
+ }
916
+ if (requestParameters['status'] != null) {
917
+ queryParameters['status'] = requestParameters['status'];
918
+ }
919
+ const headerParameters = {};
920
+ let urlPath = `/course-exports`;
921
+ return {
922
+ path: urlPath,
923
+ method: 'GET',
924
+ headers: headerParameters,
925
+ query: queryParameters,
926
+ };
927
+ });
928
+ }
929
+ /**
930
+ * List SCORM exports owned by the current portal
931
+ */
932
+ getPortalCourseExportsRaw(requestParameters, initOverrides) {
933
+ return __awaiter(this, void 0, void 0, function* () {
934
+ const requestOptions = yield this.getPortalCourseExportsRequestOpts(requestParameters);
935
+ const response = yield this.request(requestOptions, initOverrides);
936
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportListFromJSON(jsonValue));
937
+ });
938
+ }
939
+ /**
940
+ * List SCORM exports owned by the current portal
941
+ */
942
+ getPortalCourseExports() {
943
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
944
+ const response = yield this.getPortalCourseExportsRaw(requestParameters, initOverrides);
945
+ return yield response.value();
946
+ });
947
+ }
901
948
  /**
902
949
  * Creates request options for postCourse without sending the request
903
950
  */
@@ -1131,7 +1178,7 @@ export class CourseApi extends runtime.BaseAPI {
1131
1178
  });
1132
1179
  }
1133
1180
  /**
1134
- * 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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
1181
+ * 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
1135
1182
  * Create a new SCORM export for a course
1136
1183
  */
1137
1184
  postCourseExportRaw(requestParameters, initOverrides) {
@@ -1142,7 +1189,7 @@ export class CourseApi extends runtime.BaseAPI {
1142
1189
  });
1143
1190
  }
1144
1191
  /**
1145
- * 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 - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED
1192
+ * 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
1146
1193
  * Create a new SCORM export for a course
1147
1194
  */
1148
1195
  postCourseExport(requestParameters, initOverrides) {
@@ -1894,3 +1941,12 @@ export const GetCourseEnrollmentsTypeEnum = {
1894
1941
  Student: 'student',
1895
1942
  Instructor: 'instructor'
1896
1943
  };
1944
+ /**
1945
+ * @export
1946
+ */
1947
+ export const GetPortalCourseExportsStatusEnum = {
1948
+ Pending: 'PENDING',
1949
+ Processing: 'PROCESSING',
1950
+ Completed: 'COMPLETED',
1951
+ Failed: 'FAILED'
1952
+ };
@@ -18,6 +18,9 @@ import { type PostOfferCourseResponse } from '../models/PostOfferCourseResponse'
18
18
  export interface DeleteCourseShareRequest {
19
19
  shareId: string;
20
20
  }
21
+ export interface GetCourseSharesOfferedByMeRequest {
22
+ state?: GetCourseSharesOfferedByMeStateEnum;
23
+ }
21
24
  export interface GetCourseSharesOfferedToMeRequest {
22
25
  state?: GetCourseSharesOfferedToMeStateEnum;
23
26
  }
@@ -62,15 +65,15 @@ export declare class CourseShareApi extends runtime.BaseAPI {
62
65
  /**
63
66
  * Creates request options for getCourseSharesOfferedByMe without sending the request
64
67
  */
65
- getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts>;
68
+ getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts>;
66
69
  /**
67
70
  * List shares the current portal has offered out
68
71
  */
69
- getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
72
+ getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
70
73
  /**
71
74
  * List shares the current portal has offered out
72
75
  */
73
- getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
76
+ getCourseSharesOfferedByMe(requestParameters?: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
74
77
  /**
75
78
  * Creates request options for getCourseSharesOfferedToMe without sending the request
76
79
  */
@@ -91,12 +94,12 @@ export declare class CourseShareApi extends runtime.BaseAPI {
91
94
  postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts>;
92
95
  /**
93
96
  * 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 a descendant portal
97
+ * Offer every course in a catalog to another portal
95
98
  */
96
99
  postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>>;
97
100
  /**
98
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`.
99
- * Offer every course in a catalog to a descendant portal
102
+ * Offer every course in a catalog to another portal
100
103
  */
101
104
  postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse>;
102
105
  /**
@@ -104,11 +107,11 @@ export declare class CourseShareApi extends runtime.BaseAPI {
104
107
  */
105
108
  postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts>;
106
109
  /**
107
- * Offer a single course to a descendant portal
110
+ * Offer a single course to another portal
108
111
  */
109
112
  postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>>;
110
113
  /**
111
- * Offer a single course to a descendant portal
114
+ * Offer a single course to another portal
112
115
  */
113
116
  postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse>;
114
117
  /**
@@ -160,6 +163,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
160
163
  */
161
164
  putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
162
165
  }
166
+ /**
167
+ * @export
168
+ */
169
+ export declare const GetCourseSharesOfferedByMeStateEnum: {
170
+ readonly Offered: "offered";
171
+ readonly AcceptedMirror: "accepted_mirror";
172
+ readonly AcceptedClone: "accepted_clone";
173
+ readonly Declined: "declined";
174
+ readonly Revoked: "revoked";
175
+ };
176
+ export type GetCourseSharesOfferedByMeStateEnum = typeof GetCourseSharesOfferedByMeStateEnum[keyof typeof GetCourseSharesOfferedByMeStateEnum];
163
177
  /**
164
178
  * @export
165
179
  */