@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
@@ -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
  }
@@ -24,10 +24,58 @@ import * as runtime from '../runtime';
24
24
  import { GetCourseVersionReportingFromJSON, } from '../models/GetCourseVersionReporting';
25
25
  import { GetCourseVersionSectionReportingFromJSON, } from '../models/GetCourseVersionSectionReporting';
26
26
  import { GetPortalManagementDashboardFromJSON, } from '../models/GetPortalManagementDashboard';
27
+ import { GetReportCatalogFromJSON, } from '../models/GetReportCatalog';
28
+ import { GetReportQueryResultFromJSON, } from '../models/GetReportQueryResult';
29
+ import { PostReportExportToJSON, } from '../models/PostReportExport';
30
+ import { PostReportQueryToJSON, } from '../models/PostReportQuery';
27
31
  /**
28
32
  *
29
33
  */
30
34
  export class ReportingApi extends runtime.BaseAPI {
35
+ /**
36
+ * Creates request options for exportReport without sending the request
37
+ */
38
+ exportReportRequestOpts(requestParameters) {
39
+ return __awaiter(this, void 0, void 0, function* () {
40
+ if (requestParameters['reportKey'] == null) {
41
+ throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling exportReport().');
42
+ }
43
+ if (requestParameters['postReportExport'] == null) {
44
+ throw new runtime.RequiredError('postReportExport', 'Required parameter "postReportExport" was null or undefined when calling exportReport().');
45
+ }
46
+ const queryParameters = {};
47
+ const headerParameters = {};
48
+ headerParameters['Content-Type'] = 'application/json';
49
+ let urlPath = `/reporting/reports/{reportKey}/export`;
50
+ urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
51
+ return {
52
+ path: urlPath,
53
+ method: 'POST',
54
+ headers: headerParameters,
55
+ query: queryParameters,
56
+ body: PostReportExportToJSON(requestParameters['postReportExport']),
57
+ };
58
+ });
59
+ }
60
+ /**
61
+ * Export all rows of a report as CSV or XLSX
62
+ */
63
+ exportReportRaw(requestParameters, initOverrides) {
64
+ return __awaiter(this, void 0, void 0, function* () {
65
+ const requestOptions = yield this.exportReportRequestOpts(requestParameters);
66
+ const response = yield this.request(requestOptions, initOverrides);
67
+ return new runtime.BlobApiResponse(response);
68
+ });
69
+ }
70
+ /**
71
+ * Export all rows of a report as CSV or XLSX
72
+ */
73
+ exportReport(requestParameters, initOverrides) {
74
+ return __awaiter(this, void 0, void 0, function* () {
75
+ const response = yield this.exportReportRaw(requestParameters, initOverrides);
76
+ return yield response.value();
77
+ });
78
+ }
31
79
  /**
32
80
  * Creates request options for getCourseVersionReporting without sending the request
33
81
  */
@@ -156,4 +204,87 @@ export class ReportingApi extends runtime.BaseAPI {
156
204
  return yield response.value();
157
205
  });
158
206
  }
207
+ /**
208
+ * Creates request options for getReportCatalog without sending the request
209
+ */
210
+ getReportCatalogRequestOpts() {
211
+ return __awaiter(this, void 0, void 0, function* () {
212
+ const queryParameters = {};
213
+ const headerParameters = {};
214
+ let urlPath = `/reporting/reports`;
215
+ return {
216
+ path: urlPath,
217
+ method: 'GET',
218
+ headers: headerParameters,
219
+ query: queryParameters,
220
+ };
221
+ });
222
+ }
223
+ /**
224
+ * 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.
225
+ * List the reports the caller can run in the selected portal
226
+ */
227
+ getReportCatalogRaw(initOverrides) {
228
+ return __awaiter(this, void 0, void 0, function* () {
229
+ const requestOptions = yield this.getReportCatalogRequestOpts();
230
+ const response = yield this.request(requestOptions, initOverrides);
231
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetReportCatalogFromJSON(jsonValue));
232
+ });
233
+ }
234
+ /**
235
+ * 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.
236
+ * List the reports the caller can run in the selected portal
237
+ */
238
+ getReportCatalog(initOverrides) {
239
+ return __awaiter(this, void 0, void 0, function* () {
240
+ const response = yield this.getReportCatalogRaw(initOverrides);
241
+ return yield response.value();
242
+ });
243
+ }
244
+ /**
245
+ * Creates request options for queryReport without sending the request
246
+ */
247
+ queryReportRequestOpts(requestParameters) {
248
+ return __awaiter(this, void 0, void 0, function* () {
249
+ if (requestParameters['reportKey'] == null) {
250
+ throw new runtime.RequiredError('reportKey', 'Required parameter "reportKey" was null or undefined when calling queryReport().');
251
+ }
252
+ if (requestParameters['postReportQuery'] == null) {
253
+ throw new runtime.RequiredError('postReportQuery', 'Required parameter "postReportQuery" was null or undefined when calling queryReport().');
254
+ }
255
+ const queryParameters = {};
256
+ const headerParameters = {};
257
+ headerParameters['Content-Type'] = 'application/json';
258
+ let urlPath = `/reporting/reports/{reportKey}/query`;
259
+ urlPath = urlPath.replace('{reportKey}', encodeURIComponent(String(requestParameters['reportKey'])));
260
+ return {
261
+ path: urlPath,
262
+ method: 'POST',
263
+ headers: headerParameters,
264
+ query: queryParameters,
265
+ body: PostReportQueryToJSON(requestParameters['postReportQuery']),
266
+ };
267
+ });
268
+ }
269
+ /**
270
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
271
+ * Run a report and return one page of rows
272
+ */
273
+ queryReportRaw(requestParameters, initOverrides) {
274
+ return __awaiter(this, void 0, void 0, function* () {
275
+ const requestOptions = yield this.queryReportRequestOpts(requestParameters);
276
+ const response = yield this.request(requestOptions, initOverrides);
277
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetReportQueryResultFromJSON(jsonValue));
278
+ });
279
+ }
280
+ /**
281
+ * Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals.
282
+ * Run a report and return one page of rows
283
+ */
284
+ queryReport(requestParameters, initOverrides) {
285
+ return __awaiter(this, void 0, void 0, function* () {
286
+ const response = yield this.queryReportRaw(requestParameters, initOverrides);
287
+ return yield response.value();
288
+ });
289
+ }
159
290
  }
@@ -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';
@@ -13,6 +13,7 @@ export * from './DispatchApi';
13
13
  export * from './EmailTemplateApi';
14
14
  export * from './IntegrationApi';
15
15
  export * from './LearnerExperienceApi';
16
+ export * from './MarketingApi';
16
17
  export * from './OtherApi';
17
18
  export * from './PlayerApi';
18
19
  export * from './PortalApi';
@@ -0,0 +1,40 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReportCategory } from './ReportCategory';
13
+ import type { ReportDefinition } from './ReportDefinition';
14
+ /**
15
+ * Reports the caller may run in the selected portal.
16
+ * @export
17
+ * @interface GetReportCatalog
18
+ */
19
+ export interface GetReportCatalog {
20
+ /**
21
+ *
22
+ * @type {Array<ReportCategory>}
23
+ * @memberof GetReportCatalog
24
+ */
25
+ categories: Array<ReportCategory>;
26
+ /**
27
+ *
28
+ * @type {Array<ReportDefinition>}
29
+ * @memberof GetReportCatalog
30
+ */
31
+ reports: Array<ReportDefinition>;
32
+ }
33
+ /**
34
+ * Check if a given object implements the GetReportCatalog interface.
35
+ */
36
+ export declare function instanceOfGetReportCatalog(value: object): value is GetReportCatalog;
37
+ export declare function GetReportCatalogFromJSON(json: any): GetReportCatalog;
38
+ export declare function GetReportCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportCatalog;
39
+ export declare function GetReportCatalogToJSON(json: any): GetReportCatalog;
40
+ export declare function GetReportCatalogToJSONTyped(value?: GetReportCatalog | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,49 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ReportCategoryFromJSON, ReportCategoryToJSON, } from './ReportCategory';
15
+ import { ReportDefinitionFromJSON, ReportDefinitionToJSON, } from './ReportDefinition';
16
+ /**
17
+ * Check if a given object implements the GetReportCatalog interface.
18
+ */
19
+ export function instanceOfGetReportCatalog(value) {
20
+ if (!('categories' in value) || value['categories'] === undefined)
21
+ return false;
22
+ if (!('reports' in value) || value['reports'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function GetReportCatalogFromJSON(json) {
27
+ return GetReportCatalogFromJSONTyped(json, false);
28
+ }
29
+ export function GetReportCatalogFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'categories': (json['categories'].map(ReportCategoryFromJSON)),
35
+ 'reports': (json['reports'].map(ReportDefinitionFromJSON)),
36
+ };
37
+ }
38
+ export function GetReportCatalogToJSON(json) {
39
+ return GetReportCatalogToJSONTyped(json, false);
40
+ }
41
+ export function GetReportCatalogToJSONTyped(value, ignoreDiscriminator = false) {
42
+ if (value == null) {
43
+ return value;
44
+ }
45
+ return {
46
+ 'categories': (value['categories'].map(ReportCategoryToJSON)),
47
+ 'reports': (value['reports'].map(ReportDefinitionToJSON)),
48
+ };
49
+ }
@@ -0,0 +1,84 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReportColumn } from './ReportColumn';
13
+ import type { ReportSort } from './ReportSort';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface GetReportQueryResult
18
+ */
19
+ export interface GetReportQueryResult {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof GetReportQueryResult
24
+ */
25
+ reportKey: string;
26
+ /**
27
+ *
28
+ * @type {Array<ReportColumn>}
29
+ * @memberof GetReportQueryResult
30
+ */
31
+ columns: Array<ReportColumn>;
32
+ /**
33
+ * One object per row, keyed by column key.
34
+ * @type {Array<{ [key: string]: any; }>}
35
+ * @memberof GetReportQueryResult
36
+ */
37
+ rows: Array<{
38
+ [key: string]: any;
39
+ }>;
40
+ /**
41
+ *
42
+ * @type {ReportSort}
43
+ * @memberof GetReportQueryResult
44
+ */
45
+ sort: ReportSort;
46
+ /**
47
+ *
48
+ * @type {number}
49
+ * @memberof GetReportQueryResult
50
+ */
51
+ page: number;
52
+ /**
53
+ *
54
+ * @type {number}
55
+ * @memberof GetReportQueryResult
56
+ */
57
+ pageSize: number;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof GetReportQueryResult
62
+ */
63
+ totalItems: number;
64
+ /**
65
+ *
66
+ * @type {number}
67
+ * @memberof GetReportQueryResult
68
+ */
69
+ totalPages: number;
70
+ /**
71
+ * Unix timestamp in seconds.
72
+ * @type {number}
73
+ * @memberof GetReportQueryResult
74
+ */
75
+ generatedAt: number;
76
+ }
77
+ /**
78
+ * Check if a given object implements the GetReportQueryResult interface.
79
+ */
80
+ export declare function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult;
81
+ export declare function GetReportQueryResultFromJSON(json: any): GetReportQueryResult;
82
+ export declare function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult;
83
+ export declare function GetReportQueryResultToJSON(json: any): GetReportQueryResult;
84
+ export declare function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,77 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ReportColumnFromJSON, ReportColumnToJSON, } from './ReportColumn';
15
+ import { ReportSortFromJSON, ReportSortToJSON, } from './ReportSort';
16
+ /**
17
+ * Check if a given object implements the GetReportQueryResult interface.
18
+ */
19
+ export function instanceOfGetReportQueryResult(value) {
20
+ if (!('reportKey' in value) || value['reportKey'] === undefined)
21
+ return false;
22
+ if (!('columns' in value) || value['columns'] === undefined)
23
+ return false;
24
+ if (!('rows' in value) || value['rows'] === undefined)
25
+ return false;
26
+ if (!('sort' in value) || value['sort'] === undefined)
27
+ return false;
28
+ if (!('page' in value) || value['page'] === undefined)
29
+ return false;
30
+ if (!('pageSize' in value) || value['pageSize'] === undefined)
31
+ return false;
32
+ if (!('totalItems' in value) || value['totalItems'] === undefined)
33
+ return false;
34
+ if (!('totalPages' in value) || value['totalPages'] === undefined)
35
+ return false;
36
+ if (!('generatedAt' in value) || value['generatedAt'] === undefined)
37
+ return false;
38
+ return true;
39
+ }
40
+ export function GetReportQueryResultFromJSON(json) {
41
+ return GetReportQueryResultFromJSONTyped(json, false);
42
+ }
43
+ export function GetReportQueryResultFromJSONTyped(json, ignoreDiscriminator) {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+ 'reportKey': json['report_key'],
49
+ 'columns': (json['columns'].map(ReportColumnFromJSON)),
50
+ 'rows': json['rows'],
51
+ 'sort': ReportSortFromJSON(json['sort']),
52
+ 'page': json['page'],
53
+ 'pageSize': json['page_size'],
54
+ 'totalItems': json['total_items'],
55
+ 'totalPages': json['total_pages'],
56
+ 'generatedAt': json['generated_at'],
57
+ };
58
+ }
59
+ export function GetReportQueryResultToJSON(json) {
60
+ return GetReportQueryResultToJSONTyped(json, false);
61
+ }
62
+ export function GetReportQueryResultToJSONTyped(value, ignoreDiscriminator = false) {
63
+ if (value == null) {
64
+ return value;
65
+ }
66
+ return {
67
+ 'report_key': value['reportKey'],
68
+ 'columns': (value['columns'].map(ReportColumnToJSON)),
69
+ 'rows': value['rows'],
70
+ 'sort': ReportSortToJSON(value['sort']),
71
+ 'page': value['page'],
72
+ 'page_size': value['pageSize'],
73
+ 'total_items': value['totalItems'],
74
+ 'total_pages': value['totalPages'],
75
+ 'generated_at': value['generatedAt'],
76
+ };
77
+ }
@@ -0,0 +1,100 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostDemoRequest
16
+ */
17
+ export interface PostDemoRequest {
18
+ /**
19
+ * Stable for retries of the same submission; use a new UUID when details change.
20
+ * @type {string}
21
+ * @memberof PostDemoRequest
22
+ */
23
+ submissionId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof PostDemoRequest
28
+ */
29
+ fullName: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof PostDemoRequest
34
+ */
35
+ email: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof PostDemoRequest
40
+ */
41
+ organization: string;
42
+ /**
43
+ *
44
+ * @type {PostDemoRequestLearnerRangeEnum}
45
+ * @memberof PostDemoRequest
46
+ */
47
+ learnerRange?: PostDemoRequestLearnerRangeEnum;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof PostDemoRequest
52
+ */
53
+ message?: string;
54
+ /**
55
+ *
56
+ * @type {PostDemoRequestInquiryTypeEnum}
57
+ * @memberof PostDemoRequest
58
+ */
59
+ inquiryType?: PostDemoRequestInquiryTypeEnum;
60
+ /**
61
+ * Originating site pathname; query strings and fragments are removed.
62
+ * @type {string}
63
+ * @memberof PostDemoRequest
64
+ */
65
+ sourcePath?: string;
66
+ /**
67
+ *
68
+ * @type {string}
69
+ * @memberof PostDemoRequest
70
+ */
71
+ sourceCta?: string;
72
+ }
73
+ /**
74
+ * @export
75
+ */
76
+ export declare const PostDemoRequestLearnerRangeEnum: {
77
+ readonly _150: "1-50";
78
+ readonly _511000: "51-1000";
79
+ readonly _10013000: "1001-3000";
80
+ readonly _3001: "3001+";
81
+ };
82
+ export type PostDemoRequestLearnerRangeEnum = typeof PostDemoRequestLearnerRangeEnum[keyof typeof PostDemoRequestLearnerRangeEnum];
83
+ /**
84
+ * @export
85
+ */
86
+ export declare const PostDemoRequestInquiryTypeEnum: {
87
+ readonly Demo: "demo";
88
+ readonly Enterprise: "enterprise";
89
+ readonly Migration: "migration";
90
+ readonly Sales: "sales";
91
+ };
92
+ export type PostDemoRequestInquiryTypeEnum = typeof PostDemoRequestInquiryTypeEnum[keyof typeof PostDemoRequestInquiryTypeEnum];
93
+ /**
94
+ * Check if a given object implements the PostDemoRequest interface.
95
+ */
96
+ export declare function instanceOfPostDemoRequest(value: object): value is PostDemoRequest;
97
+ export declare function PostDemoRequestFromJSON(json: any): PostDemoRequest;
98
+ export declare function PostDemoRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequest;
99
+ export declare function PostDemoRequestToJSON(json: any): PostDemoRequest;
100
+ export declare function PostDemoRequestToJSONTyped(value?: PostDemoRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const PostDemoRequestLearnerRangeEnum = {
18
+ _150: '1-50',
19
+ _511000: '51-1000',
20
+ _10013000: '1001-3000',
21
+ _3001: '3001+'
22
+ };
23
+ /**
24
+ * @export
25
+ */
26
+ export const PostDemoRequestInquiryTypeEnum = {
27
+ Demo: 'demo',
28
+ Enterprise: 'enterprise',
29
+ Migration: 'migration',
30
+ Sales: 'sales'
31
+ };
32
+ /**
33
+ * Check if a given object implements the PostDemoRequest interface.
34
+ */
35
+ export function instanceOfPostDemoRequest(value) {
36
+ if (!('submissionId' in value) || value['submissionId'] === undefined)
37
+ return false;
38
+ if (!('fullName' in value) || value['fullName'] === undefined)
39
+ return false;
40
+ if (!('email' in value) || value['email'] === undefined)
41
+ return false;
42
+ if (!('organization' in value) || value['organization'] === undefined)
43
+ return false;
44
+ return true;
45
+ }
46
+ export function PostDemoRequestFromJSON(json) {
47
+ return PostDemoRequestFromJSONTyped(json, false);
48
+ }
49
+ export function PostDemoRequestFromJSONTyped(json, ignoreDiscriminator) {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+ 'submissionId': json['submission_id'],
55
+ 'fullName': json['full_name'],
56
+ 'email': json['email'],
57
+ 'organization': json['organization'],
58
+ 'learnerRange': json['learner_range'] == null ? undefined : json['learner_range'],
59
+ 'message': json['message'] == null ? undefined : json['message'],
60
+ 'inquiryType': json['inquiry_type'] == null ? undefined : json['inquiry_type'],
61
+ 'sourcePath': json['source_path'] == null ? undefined : json['source_path'],
62
+ 'sourceCta': json['source_cta'] == null ? undefined : json['source_cta'],
63
+ };
64
+ }
65
+ export function PostDemoRequestToJSON(json) {
66
+ return PostDemoRequestToJSONTyped(json, false);
67
+ }
68
+ export function PostDemoRequestToJSONTyped(value, ignoreDiscriminator = false) {
69
+ if (value == null) {
70
+ return value;
71
+ }
72
+ return {
73
+ 'submission_id': value['submissionId'],
74
+ 'full_name': value['fullName'],
75
+ 'email': value['email'],
76
+ 'organization': value['organization'],
77
+ 'learner_range': value['learnerRange'],
78
+ 'message': value['message'],
79
+ 'inquiry_type': value['inquiryType'],
80
+ 'source_path': value['sourcePath'],
81
+ 'source_cta': value['sourceCta'],
82
+ };
83
+ }