@easyedu/js-lsm-api 1.129.0 → 1.131.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.
Files changed (103) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/README.md +19 -2
  3. package/dist/apis/MarketingApi.d.ts +34 -0
  4. package/dist/apis/MarketingApi.js +74 -0
  5. package/dist/apis/ReportingApi.d.ts +52 -0
  6. package/dist/apis/ReportingApi.js +131 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/esm/apis/MarketingApi.d.ts +34 -0
  10. package/dist/esm/apis/MarketingApi.js +70 -0
  11. package/dist/esm/apis/ReportingApi.d.ts +52 -0
  12. package/dist/esm/apis/ReportingApi.js +131 -0
  13. package/dist/esm/apis/index.d.ts +1 -0
  14. package/dist/esm/apis/index.js +1 -0
  15. package/dist/esm/models/GetReportCatalog.d.ts +40 -0
  16. package/dist/esm/models/GetReportCatalog.js +49 -0
  17. package/dist/esm/models/GetReportQueryResult.d.ts +84 -0
  18. package/dist/esm/models/GetReportQueryResult.js +77 -0
  19. package/dist/esm/models/PostDemoRequest.d.ts +100 -0
  20. package/dist/esm/models/PostDemoRequest.js +83 -0
  21. package/dist/esm/models/PostDemoRequestResponse.d.ts +38 -0
  22. package/dist/esm/models/PostDemoRequestResponse.js +47 -0
  23. package/dist/esm/models/PostReportExport.d.ts +54 -0
  24. package/dist/esm/models/PostReportExport.js +56 -0
  25. package/dist/esm/models/PostReportQuery.d.ts +52 -0
  26. package/dist/esm/models/PostReportQuery.js +49 -0
  27. package/dist/esm/models/ReportCategory.d.ts +50 -0
  28. package/dist/esm/models/ReportCategory.js +58 -0
  29. package/dist/esm/models/ReportColumn.d.ts +59 -0
  30. package/dist/esm/models/ReportColumn.js +64 -0
  31. package/dist/esm/models/ReportDefinition.d.ts +89 -0
  32. package/dist/esm/models/ReportDefinition.js +85 -0
  33. package/dist/esm/models/ReportFilterDefinition.d.ts +94 -0
  34. package/dist/esm/models/ReportFilterDefinition.js +91 -0
  35. package/dist/esm/models/ReportFilterOption.d.ts +38 -0
  36. package/dist/esm/models/ReportFilterOption.js +47 -0
  37. package/dist/esm/models/ReportFilters.d.ts +105 -0
  38. package/dist/esm/models/ReportFilters.js +65 -0
  39. package/dist/esm/models/ReportSort.d.ts +46 -0
  40. package/dist/esm/models/ReportSort.js +54 -0
  41. package/dist/esm/models/index.d.ts +13 -0
  42. package/dist/esm/models/index.js +13 -0
  43. package/dist/models/GetReportCatalog.d.ts +40 -0
  44. package/dist/models/GetReportCatalog.js +56 -0
  45. package/dist/models/GetReportQueryResult.d.ts +84 -0
  46. package/dist/models/GetReportQueryResult.js +84 -0
  47. package/dist/models/PostDemoRequest.d.ts +100 -0
  48. package/dist/models/PostDemoRequest.js +91 -0
  49. package/dist/models/PostDemoRequestResponse.d.ts +38 -0
  50. package/dist/models/PostDemoRequestResponse.js +54 -0
  51. package/dist/models/PostReportExport.d.ts +54 -0
  52. package/dist/models/PostReportExport.js +64 -0
  53. package/dist/models/PostReportQuery.d.ts +52 -0
  54. package/dist/models/PostReportQuery.js +56 -0
  55. package/dist/models/ReportCategory.d.ts +50 -0
  56. package/dist/models/ReportCategory.js +66 -0
  57. package/dist/models/ReportColumn.d.ts +59 -0
  58. package/dist/models/ReportColumn.js +72 -0
  59. package/dist/models/ReportDefinition.d.ts +89 -0
  60. package/dist/models/ReportDefinition.js +93 -0
  61. package/dist/models/ReportFilterDefinition.d.ts +94 -0
  62. package/dist/models/ReportFilterDefinition.js +99 -0
  63. package/dist/models/ReportFilterOption.d.ts +38 -0
  64. package/dist/models/ReportFilterOption.js +54 -0
  65. package/dist/models/ReportFilters.d.ts +105 -0
  66. package/dist/models/ReportFilters.js +72 -0
  67. package/dist/models/ReportSort.d.ts +46 -0
  68. package/dist/models/ReportSort.js +62 -0
  69. package/dist/models/index.d.ts +13 -0
  70. package/dist/models/index.js +13 -0
  71. package/docs/GetReportCatalog.md +37 -0
  72. package/docs/GetReportQueryResult.md +50 -0
  73. package/docs/MarketingApi.md +78 -0
  74. package/docs/PostDemoRequest.md +50 -0
  75. package/docs/PostDemoRequestResponse.md +36 -0
  76. package/docs/PostReportExport.md +38 -0
  77. package/docs/PostReportQuery.md +40 -0
  78. package/docs/ReportCategory.md +36 -0
  79. package/docs/ReportColumn.md +39 -0
  80. package/docs/ReportDefinition.md +48 -0
  81. package/docs/ReportFilterDefinition.md +45 -0
  82. package/docs/ReportFilterOption.md +36 -0
  83. package/docs/ReportFilters.md +59 -0
  84. package/docs/ReportSort.md +36 -0
  85. package/docs/ReportingApi.md +207 -0
  86. package/package.json +1 -1
  87. package/src/apis/MarketingApi.ts +83 -0
  88. package/src/apis/ReportingApi.ts +181 -0
  89. package/src/apis/index.ts +1 -0
  90. package/src/models/GetReportCatalog.ts +90 -0
  91. package/src/models/GetReportQueryResult.ts +153 -0
  92. package/src/models/PostDemoRequest.ts +157 -0
  93. package/src/models/PostDemoRequestResponse.ts +75 -0
  94. package/src/models/PostReportExport.ts +108 -0
  95. package/src/models/PostReportQuery.ts +104 -0
  96. package/src/models/ReportCategory.ts +90 -0
  97. package/src/models/ReportColumn.ts +102 -0
  98. package/src/models/ReportDefinition.ts +166 -0
  99. package/src/models/ReportFilterDefinition.ts +154 -0
  100. package/src/models/ReportFilterOption.ts +75 -0
  101. package/src/models/ReportFilters.ts +162 -0
  102. package/src/models/ReportSort.ts +86 -0
  103. package/src/models/index.ts +13 -0
@@ -148,6 +148,8 @@ docs/GetQuestionAnswerChoicesInner.md
148
148
  docs/GetQuestionList.md
149
149
  docs/GetQuestionListFilters.md
150
150
  docs/GetQuestionQuizzesInner.md
151
+ docs/GetReportCatalog.md
152
+ docs/GetReportQueryResult.md
151
153
  docs/GetResource.md
152
154
  docs/GetResourceList.md
153
155
  docs/GetResourceSession.md
@@ -219,6 +221,7 @@ docs/LoginRes.md
219
221
  docs/LoginResAuthData.md
220
222
  docs/LoginResUserData.md
221
223
  docs/LoginResUserDataSelectedPortal.md
224
+ docs/MarketingApi.md
222
225
  docs/OtherApi.md
223
226
  docs/Paginated.md
224
227
  docs/PlayerApi.md
@@ -263,6 +266,8 @@ docs/PostCourseVersionPublish.md
263
266
  docs/PostCourseVersionSection.md
264
267
  docs/PostCourseVersionSectionDuplicate.md
265
268
  docs/PostCustomWebhookIntegration.md
269
+ docs/PostDemoRequest.md
270
+ docs/PostDemoRequestResponse.md
266
271
  docs/PostDispatchItemLaunch.md
267
272
  docs/PostDispatchItemLaunchResponse.md
268
273
  docs/PostDispatchLaunch.md
@@ -293,6 +298,8 @@ docs/PostQuestionImportCommit.md
293
298
  docs/PostQuestionImportCommitItem.md
294
299
  docs/PostQuestionImportCommitResponse.md
295
300
  docs/PostQuestionImportParseResponse.md
301
+ docs/PostReportExport.md
302
+ docs/PostReportQuery.md
296
303
  docs/PostResetPassword.md
297
304
  docs/PostResource.md
298
305
  docs/PostResourceSessionActivityEvent.md
@@ -370,6 +377,13 @@ docs/QuestionImportPreviewImage.md
370
377
  docs/QuestionImportSource.md
371
378
  docs/QuestionImportSourceSummary.md
372
379
  docs/QuestionSelectionMethod.md
380
+ docs/ReportCategory.md
381
+ docs/ReportColumn.md
382
+ docs/ReportDefinition.md
383
+ docs/ReportFilterDefinition.md
384
+ docs/ReportFilterOption.md
385
+ docs/ReportFilters.md
386
+ docs/ReportSort.md
373
387
  docs/ReportingApi.md
374
388
  docs/ResourceSessionEnvironment.md
375
389
  docs/ResourceSessionScormApiLogItem.md
@@ -416,6 +430,7 @@ src/apis/DispatchApi.ts
416
430
  src/apis/EmailTemplateApi.ts
417
431
  src/apis/IntegrationApi.ts
418
432
  src/apis/LearnerExperienceApi.ts
433
+ src/apis/MarketingApi.ts
419
434
  src/apis/OtherApi.ts
420
435
  src/apis/PlayerApi.ts
421
436
  src/apis/PortalApi.ts
@@ -566,6 +581,8 @@ src/models/GetQuestionAnswerChoicesInner.ts
566
581
  src/models/GetQuestionList.ts
567
582
  src/models/GetQuestionListFilters.ts
568
583
  src/models/GetQuestionQuizzesInner.ts
584
+ src/models/GetReportCatalog.ts
585
+ src/models/GetReportQueryResult.ts
569
586
  src/models/GetResource.ts
570
587
  src/models/GetResourceList.ts
571
588
  src/models/GetResourceSession.ts
@@ -675,6 +692,8 @@ src/models/PostCourseVersionPublish.ts
675
692
  src/models/PostCourseVersionSection.ts
676
693
  src/models/PostCourseVersionSectionDuplicate.ts
677
694
  src/models/PostCustomWebhookIntegration.ts
695
+ src/models/PostDemoRequest.ts
696
+ src/models/PostDemoRequestResponse.ts
678
697
  src/models/PostDispatchItemLaunch.ts
679
698
  src/models/PostDispatchItemLaunchResponse.ts
680
699
  src/models/PostDispatchLaunch.ts
@@ -705,6 +724,8 @@ src/models/PostQuestionImportCommit.ts
705
724
  src/models/PostQuestionImportCommitItem.ts
706
725
  src/models/PostQuestionImportCommitResponse.ts
707
726
  src/models/PostQuestionImportParseResponse.ts
727
+ src/models/PostReportExport.ts
728
+ src/models/PostReportQuery.ts
708
729
  src/models/PostResetPassword.ts
709
730
  src/models/PostResource.ts
710
731
  src/models/PostResourceSessionActivityEvent.ts
@@ -780,6 +801,13 @@ src/models/QuestionImportPreviewImage.ts
780
801
  src/models/QuestionImportSource.ts
781
802
  src/models/QuestionImportSourceSummary.ts
782
803
  src/models/QuestionSelectionMethod.ts
804
+ src/models/ReportCategory.ts
805
+ src/models/ReportColumn.ts
806
+ src/models/ReportDefinition.ts
807
+ src/models/ReportFilterDefinition.ts
808
+ src/models/ReportFilterOption.ts
809
+ src/models/ReportFilters.ts
810
+ src/models/ReportSort.ts
783
811
  src/models/ResourceSessionEnvironment.ts
784
812
  src/models/ResourceSessionScormApiLogItem.ts
785
813
  src/models/ResourceType.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.129.0
1
+ # @easyedu/js-lsm-api@1.131.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -312,6 +312,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
312
312
  *LearnerExperienceApi* | [**postLearnerExperiencePublish**](docs/LearnerExperienceApi.md#postlearnerexperiencepublish) | **POST** /learner-experience/publish | Publish the selected portal\'s learner experience draft
313
313
  *LearnerExperienceApi* | [**postLearnerExperienceVersionRestore**](docs/LearnerExperienceApi.md#postlearnerexperienceversionrestore) | **POST** /learner-experience/versions/{versionId}/restore | Create a new draft from a historical learner experience version
314
314
  *LearnerExperienceApi* | [**putLearnerExperienceDraft**](docs/LearnerExperienceApi.md#putlearnerexperiencedraft) | **PUT** /learner-experience/draft | Update the selected portal\'s learner experience draft
315
+ *MarketingApi* | [**postDemoRequest**](docs/MarketingApi.md#postdemorequest) | **POST** /mktg/demo-requests | Save a demo or sales inquiry and notify sales
315
316
  *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
316
317
  *PlayerApi* | [**commitResourceScormSession**](docs/PlayerApi.md#commitresourcescormsession) | **POST** /resource/sessions/{sessionId}/commit | Commit a reusable SCORM resource session
317
318
  *PlayerApi* | [**getCourseVersionResourceAsset**](docs/PlayerApi.md#getcourseversionresourceasset) | **GET** /resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath} | Stream an asset from an exact course and resource version
@@ -363,9 +364,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
363
364
  *QuestionApi* | [**putQuestion**](docs/QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question
364
365
  *QuestionImportApi* | [**postQuestionImportCommit**](docs/QuestionImportApi.md#postquestionimportcommit) | **POST** /question-imports/commit | Validate and atomically create, version, or skip approved question drafts
365
366
  *QuestionImportApi* | [**postQuestionImportParse**](docs/QuestionImportApi.md#postquestionimportparse) | **POST** /question-imports/parse | Parse a question document into stateless review drafts
367
+ *ReportingApi* | [**exportReport**](docs/ReportingApi.md#exportreport) | **POST** /reporting/reports/{reportKey}/export | Export all rows of a report as CSV or XLSX
366
368
  *ReportingApi* | [**getCourseVersionReporting**](docs/ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version
367
369
  *ReportingApi* | [**getCourseVersionSectionReporting**](docs/ReportingApi.md#getcourseversionsectionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting | Get instructor reporting for one section and its descendants in an explicit course version
368
370
  *ReportingApi* | [**getPortalManagementDashboard**](docs/ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting
371
+ *ReportingApi* | [**getReportCatalog**](docs/ReportingApi.md#getreportcatalog) | **GET** /reporting/reports | List the reports the caller can run in the selected portal
372
+ *ReportingApi* | [**queryReport**](docs/ReportingApi.md#queryreport) | **POST** /reporting/reports/{reportKey}/query | Run a report and return one page of rows
369
373
  *RichTextApi* | [**getRichTextAsset**](docs/RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL
370
374
  *RichTextApi* | [**postRichTextAssetComplete**](docs/RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload
371
375
  *RichTextApi* | [**postRichTextAssetUpload**](docs/RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload
@@ -549,6 +553,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
549
553
  - [GetQuestionList](docs/GetQuestionList.md)
550
554
  - [GetQuestionListFilters](docs/GetQuestionListFilters.md)
551
555
  - [GetQuestionQuizzesInner](docs/GetQuestionQuizzesInner.md)
556
+ - [GetReportCatalog](docs/GetReportCatalog.md)
557
+ - [GetReportQueryResult](docs/GetReportQueryResult.md)
552
558
  - [GetResource](docs/GetResource.md)
553
559
  - [GetResourceList](docs/GetResourceList.md)
554
560
  - [GetResourceSession](docs/GetResourceSession.md)
@@ -658,6 +664,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
658
664
  - [PostCourseVersionSection](docs/PostCourseVersionSection.md)
659
665
  - [PostCourseVersionSectionDuplicate](docs/PostCourseVersionSectionDuplicate.md)
660
666
  - [PostCustomWebhookIntegration](docs/PostCustomWebhookIntegration.md)
667
+ - [PostDemoRequest](docs/PostDemoRequest.md)
668
+ - [PostDemoRequestResponse](docs/PostDemoRequestResponse.md)
661
669
  - [PostDispatchItemLaunch](docs/PostDispatchItemLaunch.md)
662
670
  - [PostDispatchItemLaunchResponse](docs/PostDispatchItemLaunchResponse.md)
663
671
  - [PostDispatchLaunch](docs/PostDispatchLaunch.md)
@@ -688,6 +696,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
688
696
  - [PostQuestionImportCommitItem](docs/PostQuestionImportCommitItem.md)
689
697
  - [PostQuestionImportCommitResponse](docs/PostQuestionImportCommitResponse.md)
690
698
  - [PostQuestionImportParseResponse](docs/PostQuestionImportParseResponse.md)
699
+ - [PostReportExport](docs/PostReportExport.md)
700
+ - [PostReportQuery](docs/PostReportQuery.md)
691
701
  - [PostResetPassword](docs/PostResetPassword.md)
692
702
  - [PostResource](docs/PostResource.md)
693
703
  - [PostResourceSessionActivityEvent](docs/PostResourceSessionActivityEvent.md)
@@ -763,6 +773,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
763
773
  - [QuestionImportSource](docs/QuestionImportSource.md)
764
774
  - [QuestionImportSourceSummary](docs/QuestionImportSourceSummary.md)
765
775
  - [QuestionSelectionMethod](docs/QuestionSelectionMethod.md)
776
+ - [ReportCategory](docs/ReportCategory.md)
777
+ - [ReportColumn](docs/ReportColumn.md)
778
+ - [ReportDefinition](docs/ReportDefinition.md)
779
+ - [ReportFilterDefinition](docs/ReportFilterDefinition.md)
780
+ - [ReportFilterOption](docs/ReportFilterOption.md)
781
+ - [ReportFilters](docs/ReportFilters.md)
782
+ - [ReportSort](docs/ReportSort.md)
766
783
  - [ResourceSessionEnvironment](docs/ResourceSessionEnvironment.md)
767
784
  - [ResourceSessionScormApiLogItem](docs/ResourceSessionScormApiLogItem.md)
768
785
  - [ResourceType](docs/ResourceType.md)
@@ -801,7 +818,7 @@ and is automatically generated by the
801
818
  [OpenAPI Generator](https://openapi-generator.tech) project:
802
819
 
803
820
  - API version: `1.0.0`
804
- - Package version: `1.129.0`
821
+ - Package version: `1.131.0`
805
822
  - Generator version: `7.22.0`
806
823
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
807
824
 
@@ -0,0 +1,34 @@
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 PostDemoRequest } from '../models/PostDemoRequest';
14
+ import { type PostDemoRequestResponse } from '../models/PostDemoRequestResponse';
15
+ export interface PostDemoRequestRequest {
16
+ postDemoRequest: PostDemoRequest;
17
+ }
18
+ /**
19
+ *
20
+ */
21
+ export declare class MarketingApi extends runtime.BaseAPI {
22
+ /**
23
+ * Creates request options for postDemoRequest without sending the request
24
+ */
25
+ postDemoRequestRequestOpts(requestParameters: PostDemoRequestRequest): Promise<runtime.RequestOpts>;
26
+ /**
27
+ * Save a demo or sales inquiry and notify sales
28
+ */
29
+ postDemoRequestRaw(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostDemoRequestResponse>>;
30
+ /**
31
+ * Save a demo or sales inquiry and notify sales
32
+ */
33
+ postDemoRequest(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostDemoRequestResponse>;
34
+ }
@@ -0,0 +1,74 @@
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.MarketingApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const PostDemoRequest_1 = require("../models/PostDemoRequest");
28
+ const PostDemoRequestResponse_1 = require("../models/PostDemoRequestResponse");
29
+ /**
30
+ *
31
+ */
32
+ class MarketingApi extends runtime.BaseAPI {
33
+ /**
34
+ * Creates request options for postDemoRequest without sending the request
35
+ */
36
+ postDemoRequestRequestOpts(requestParameters) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters['postDemoRequest'] == null) {
39
+ throw new runtime.RequiredError('postDemoRequest', 'Required parameter "postDemoRequest" was null or undefined when calling postDemoRequest().');
40
+ }
41
+ const queryParameters = {};
42
+ const headerParameters = {};
43
+ headerParameters['Content-Type'] = 'application/json';
44
+ let urlPath = `/mktg/demo-requests`;
45
+ return {
46
+ path: urlPath,
47
+ method: 'POST',
48
+ headers: headerParameters,
49
+ query: queryParameters,
50
+ body: (0, PostDemoRequest_1.PostDemoRequestToJSON)(requestParameters['postDemoRequest']),
51
+ };
52
+ });
53
+ }
54
+ /**
55
+ * Save a demo or sales inquiry and notify sales
56
+ */
57
+ postDemoRequestRaw(requestParameters, initOverrides) {
58
+ return __awaiter(this, void 0, void 0, function* () {
59
+ const requestOptions = yield this.postDemoRequestRequestOpts(requestParameters);
60
+ const response = yield this.request(requestOptions, initOverrides);
61
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostDemoRequestResponse_1.PostDemoRequestResponseFromJSON)(jsonValue));
62
+ });
63
+ }
64
+ /**
65
+ * Save a demo or sales inquiry and notify sales
66
+ */
67
+ postDemoRequest(requestParameters, initOverrides) {
68
+ return __awaiter(this, void 0, void 0, function* () {
69
+ const response = yield this.postDemoRequestRaw(requestParameters, initOverrides);
70
+ return yield response.value();
71
+ });
72
+ }
73
+ }
74
+ exports.MarketingApi = MarketingApi;
@@ -13,6 +13,14 @@ import * as runtime from '../runtime';
13
13
  import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
14
14
  import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
15
15
  import { type GetPortalManagementDashboard } from '../models/GetPortalManagementDashboard';
16
+ import { type GetReportCatalog } from '../models/GetReportCatalog';
17
+ import { type GetReportQueryResult } from '../models/GetReportQueryResult';
18
+ import { type PostReportExport } from '../models/PostReportExport';
19
+ import { type PostReportQuery } from '../models/PostReportQuery';
20
+ export interface ExportReportRequest {
21
+ reportKey: string;
22
+ postReportExport: PostReportExport;
23
+ }
16
24
  export interface GetCourseVersionReportingRequest {
17
25
  courseId: string;
18
26
  courseVersionId: string;
@@ -25,10 +33,26 @@ export interface GetCourseVersionSectionReportingRequest {
25
33
  export interface GetPortalManagementDashboardRequest {
26
34
  days?: number;
27
35
  }
36
+ export interface QueryReportRequest {
37
+ reportKey: string;
38
+ postReportQuery: PostReportQuery;
39
+ }
28
40
  /**
29
41
  *
30
42
  */
31
43
  export declare class ReportingApi extends runtime.BaseAPI {
44
+ /**
45
+ * Creates request options for exportReport without sending the request
46
+ */
47
+ exportReportRequestOpts(requestParameters: ExportReportRequest): Promise<runtime.RequestOpts>;
48
+ /**
49
+ * Export all rows of a report as CSV or XLSX
50
+ */
51
+ exportReportRaw(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
52
+ /**
53
+ * Export all rows of a report as CSV or XLSX
54
+ */
55
+ exportReport(requestParameters: ExportReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
32
56
  /**
33
57
  * Creates request options for getCourseVersionReporting without sending the request
34
58
  */
@@ -65,4 +89,32 @@ export declare class ReportingApi extends runtime.BaseAPI {
65
89
  * Get the selected portal\'s management dashboard reporting
66
90
  */
67
91
  getPortalManagementDashboard(requestParameters?: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard>;
92
+ /**
93
+ * Creates request options for getReportCatalog without sending the request
94
+ */
95
+ getReportCatalogRequestOpts(): Promise<runtime.RequestOpts>;
96
+ /**
97
+ * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
98
+ * List the reports the caller can run in the selected portal
99
+ */
100
+ getReportCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportCatalog>>;
101
+ /**
102
+ * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
103
+ * List the reports the caller can run in the selected portal
104
+ */
105
+ getReportCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportCatalog>;
106
+ /**
107
+ * Creates request options for queryReport without sending the request
108
+ */
109
+ queryReportRequestOpts(requestParameters: QueryReportRequest): Promise<runtime.RequestOpts>;
110
+ /**
111
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
112
+ * Run a report and return one page of rows
113
+ */
114
+ queryReportRaw(requestParameters: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReportQueryResult>>;
115
+ /**
116
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
117
+ * Run a report and return one page of rows
118
+ */
119
+ queryReport(requestParameters: QueryReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReportQueryResult>;
68
120
  }
@@ -27,10 +27,58 @@ const runtime = require("../runtime");
27
27
  const GetCourseVersionReporting_1 = require("../models/GetCourseVersionReporting");
28
28
  const GetCourseVersionSectionReporting_1 = require("../models/GetCourseVersionSectionReporting");
29
29
  const GetPortalManagementDashboard_1 = require("../models/GetPortalManagementDashboard");
30
+ const GetReportCatalog_1 = require("../models/GetReportCatalog");
31
+ const GetReportQueryResult_1 = require("../models/GetReportQueryResult");
32
+ const PostReportExport_1 = require("../models/PostReportExport");
33
+ const PostReportQuery_1 = require("../models/PostReportQuery");
30
34
  /**
31
35
  *
32
36
  */
33
37
  class ReportingApi extends runtime.BaseAPI {
38
+ /**
39
+ * Creates request options for exportReport without sending the request
40
+ */
41
+ exportReportRequestOpts(requestParameters) {
42
+ return __awaiter(this, void 0, void 0, function* () {
43
+ if (requestParameters['reportKey'] == null) {
44
+ throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling exportReport().');
45
+ }
46
+ if (requestParameters['postReportExport'] == null) {
47
+ throw new runtime.RequiredError('postReportExport', 'Required parameter "postReportExport" was null or undefined when calling exportReport().');
48
+ }
49
+ const queryParameters = {};
50
+ const headerParameters = {};
51
+ headerParameters['Content-Type'] = 'application/json';
52
+ let urlPath = `/reporting/reports/{reportKey}/export`;
53
+ urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
54
+ return {
55
+ path: urlPath,
56
+ method: 'POST',
57
+ headers: headerParameters,
58
+ query: queryParameters,
59
+ body: (0, PostReportExport_1.PostReportExportToJSON)(requestParameters['postReportExport']),
60
+ };
61
+ });
62
+ }
63
+ /**
64
+ * Export all rows of a report as CSV or XLSX
65
+ */
66
+ exportReportRaw(requestParameters, initOverrides) {
67
+ return __awaiter(this, void 0, void 0, function* () {
68
+ const requestOptions = yield this.exportReportRequestOpts(requestParameters);
69
+ const response = yield this.request(requestOptions, initOverrides);
70
+ return new runtime.BlobApiResponse(response);
71
+ });
72
+ }
73
+ /**
74
+ * Export all rows of a report as CSV or XLSX
75
+ */
76
+ exportReport(requestParameters, initOverrides) {
77
+ return __awaiter(this, void 0, void 0, function* () {
78
+ const response = yield this.exportReportRaw(requestParameters, initOverrides);
79
+ return yield response.value();
80
+ });
81
+ }
34
82
  /**
35
83
  * Creates request options for getCourseVersionReporting without sending the request
36
84
  */
@@ -159,5 +207,88 @@ class ReportingApi extends runtime.BaseAPI {
159
207
  return yield response.value();
160
208
  });
161
209
  }
210
+ /**
211
+ * Creates request options for getReportCatalog without sending the request
212
+ */
213
+ getReportCatalogRequestOpts() {
214
+ return __awaiter(this, void 0, void 0, function* () {
215
+ const queryParameters = {};
216
+ const headerParameters = {};
217
+ let urlPath = `/reporting/reports`;
218
+ return {
219
+ path: urlPath,
220
+ method: 'GET',
221
+ headers: headerParameters,
222
+ query: queryParameters,
223
+ };
224
+ });
225
+ }
226
+ /**
227
+ * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
228
+ * List the reports the caller can run in the selected portal
229
+ */
230
+ getReportCatalogRaw(initOverrides) {
231
+ return __awaiter(this, void 0, void 0, function* () {
232
+ const requestOptions = yield this.getReportCatalogRequestOpts();
233
+ const response = yield this.request(requestOptions, initOverrides);
234
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetReportCatalog_1.GetReportCatalogFromJSON)(jsonValue));
235
+ });
236
+ }
237
+ /**
238
+ * Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted.
239
+ * List the reports the caller can run in the selected portal
240
+ */
241
+ getReportCatalog(initOverrides) {
242
+ return __awaiter(this, void 0, void 0, function* () {
243
+ const response = yield this.getReportCatalogRaw(initOverrides);
244
+ return yield response.value();
245
+ });
246
+ }
247
+ /**
248
+ * Creates request options for queryReport without sending the request
249
+ */
250
+ queryReportRequestOpts(requestParameters) {
251
+ return __awaiter(this, void 0, void 0, function* () {
252
+ if (requestParameters['reportKey'] == null) {
253
+ throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling queryReport().');
254
+ }
255
+ if (requestParameters['postReportQuery'] == null) {
256
+ throw new runtime.RequiredError('postReportQuery', 'Required parameter "postReportQuery" was null or undefined when calling queryReport().');
257
+ }
258
+ const queryParameters = {};
259
+ const headerParameters = {};
260
+ headerParameters['Content-Type'] = 'application/json';
261
+ let urlPath = `/reporting/reports/{reportKey}/query`;
262
+ urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
263
+ return {
264
+ path: urlPath,
265
+ method: 'POST',
266
+ headers: headerParameters,
267
+ query: queryParameters,
268
+ body: (0, PostReportQuery_1.PostReportQueryToJSON)(requestParameters['postReportQuery']),
269
+ };
270
+ });
271
+ }
272
+ /**
273
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
274
+ * Run a report and return one page of rows
275
+ */
276
+ queryReportRaw(requestParameters, initOverrides) {
277
+ return __awaiter(this, void 0, void 0, function* () {
278
+ const requestOptions = yield this.queryReportRequestOpts(requestParameters);
279
+ const response = yield this.request(requestOptions, initOverrides);
280
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetReportQueryResult_1.GetReportQueryResultFromJSON)(jsonValue));
281
+ });
282
+ }
283
+ /**
284
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
285
+ * Run a report and return one page of rows
286
+ */
287
+ queryReport(requestParameters, initOverrides) {
288
+ return __awaiter(this, void 0, void 0, function* () {
289
+ const response = yield this.queryReportRaw(requestParameters, initOverrides);
290
+ return yield response.value();
291
+ });
292
+ }
162
293
  }
163
294
  exports.ReportingApi = ReportingApi;
@@ -11,6 +11,7 @@ export * from './DispatchApi';
11
11
  export * from './EmailTemplateApi';
12
12
  export * from './IntegrationApi';
13
13
  export * from './LearnerExperienceApi';
14
+ export * from './MarketingApi';
14
15
  export * from './OtherApi';
15
16
  export * from './PlayerApi';
16
17
  export * from './PortalApi';
@@ -29,6 +29,7 @@ __exportStar(require("./DispatchApi"), exports);
29
29
  __exportStar(require("./EmailTemplateApi"), exports);
30
30
  __exportStar(require("./IntegrationApi"), exports);
31
31
  __exportStar(require("./LearnerExperienceApi"), exports);
32
+ __exportStar(require("./MarketingApi"), exports);
32
33
  __exportStar(require("./OtherApi"), exports);
33
34
  __exportStar(require("./PlayerApi"), exports);
34
35
  __exportStar(require("./PortalApi"), exports);
@@ -0,0 +1,34 @@
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 PostDemoRequest } from '../models/PostDemoRequest';
14
+ import { type PostDemoRequestResponse } from '../models/PostDemoRequestResponse';
15
+ export interface PostDemoRequestRequest {
16
+ postDemoRequest: PostDemoRequest;
17
+ }
18
+ /**
19
+ *
20
+ */
21
+ export declare class MarketingApi extends runtime.BaseAPI {
22
+ /**
23
+ * Creates request options for postDemoRequest without sending the request
24
+ */
25
+ postDemoRequestRequestOpts(requestParameters: PostDemoRequestRequest): Promise<runtime.RequestOpts>;
26
+ /**
27
+ * Save a demo or sales inquiry and notify sales
28
+ */
29
+ postDemoRequestRaw(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostDemoRequestResponse>>;
30
+ /**
31
+ * Save a demo or sales inquiry and notify sales
32
+ */
33
+ postDemoRequest(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostDemoRequestResponse>;
34
+ }
@@ -0,0 +1,70 @@
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 { PostDemoRequestToJSON, } from '../models/PostDemoRequest';
25
+ import { PostDemoRequestResponseFromJSON, } from '../models/PostDemoRequestResponse';
26
+ /**
27
+ *
28
+ */
29
+ export class MarketingApi extends runtime.BaseAPI {
30
+ /**
31
+ * Creates request options for postDemoRequest without sending the request
32
+ */
33
+ postDemoRequestRequestOpts(requestParameters) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['postDemoRequest'] == null) {
36
+ throw new runtime.RequiredError('postDemoRequest', 'Required parameter "postDemoRequest" was null or undefined when calling postDemoRequest().');
37
+ }
38
+ const queryParameters = {};
39
+ const headerParameters = {};
40
+ headerParameters['Content-Type'] = 'application/json';
41
+ let urlPath = `/mktg/demo-requests`;
42
+ return {
43
+ path: urlPath,
44
+ method: 'POST',
45
+ headers: headerParameters,
46
+ query: queryParameters,
47
+ body: PostDemoRequestToJSON(requestParameters['postDemoRequest']),
48
+ };
49
+ });
50
+ }
51
+ /**
52
+ * Save a demo or sales inquiry and notify sales
53
+ */
54
+ postDemoRequestRaw(requestParameters, initOverrides) {
55
+ return __awaiter(this, void 0, void 0, function* () {
56
+ const requestOptions = yield this.postDemoRequestRequestOpts(requestParameters);
57
+ const response = yield this.request(requestOptions, initOverrides);
58
+ return new runtime.JSONApiResponse(response, (jsonValue) => PostDemoRequestResponseFromJSON(jsonValue));
59
+ });
60
+ }
61
+ /**
62
+ * Save a demo or sales inquiry and notify sales
63
+ */
64
+ postDemoRequest(requestParameters, initOverrides) {
65
+ return __awaiter(this, void 0, void 0, function* () {
66
+ const response = yield this.postDemoRequestRaw(requestParameters, initOverrides);
67
+ return yield response.value();
68
+ });
69
+ }
70
+ }