@easyedu/js-lsm-api 1.129.0 → 1.131.0

package/dist/esm/models/index.js

@@ -135,6 +135,8 @@ export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
 export * from './GetQuestionQuizzesInner';
+export * from './GetReportCatalog';
+export * from './GetReportQueryResult';
 export * from './GetResource';
 export * from './GetResourceList';
 export * from './GetResourceSession';
@@ -244,6 +246,8 @@ export * from './PostCourseVersionPublish';
 export * from './PostCourseVersionSection';
 export * from './PostCourseVersionSectionDuplicate';
 export * from './PostCustomWebhookIntegration';
+export * from './PostDemoRequest';
+export * from './PostDemoRequestResponse';
 export * from './PostDispatchItemLaunch';
 export * from './PostDispatchItemLaunchResponse';
 export * from './PostDispatchLaunch';
@@ -274,6 +278,8 @@ export * from './PostQuestionImportCommit';
 export * from './PostQuestionImportCommitItem';
 export * from './PostQuestionImportCommitResponse';
 export * from './PostQuestionImportParseResponse';
+export * from './PostReportExport';
+export * from './PostReportQuery';
 export * from './PostResetPassword';
 export * from './PostResource';
 export * from './PostResourceSessionActivityEvent';
@@ -349,6 +355,13 @@ export * from './QuestionImportPreviewImage';
 export * from './QuestionImportSource';
 export * from './QuestionImportSourceSummary';
 export * from './QuestionSelectionMethod';
+export * from './ReportCategory';
+export * from './ReportColumn';
+export * from './ReportDefinition';
+export * from './ReportFilterDefinition';
+export * from './ReportFilterOption';
+export * from './ReportFilters';
+export * from './ReportSort';
 export * from './ResourceSessionEnvironment';
 export * from './ResourceSessionScormApiLogItem';
 export * from './ResourceType';

package/dist/models/GetReportCatalog.d.ts

@@ -0,0 +1,40 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReportCategory } from './ReportCategory';
+import type { ReportDefinition } from './ReportDefinition';
+/**
+ * Reports the caller may run in the selected portal.
+ * @export
+ * @interface GetReportCatalog
+ */
+export interface GetReportCatalog {
+    /**
+     *
+     * @type {Array<ReportCategory>}
+     * @memberof GetReportCatalog
+     */
+    categories: Array<ReportCategory>;
+    /**
+     *
+     * @type {Array<ReportDefinition>}
+     * @memberof GetReportCatalog
+     */
+    reports: Array<ReportDefinition>;
+}
+/**
+ * Check if a given object implements the GetReportCatalog interface.
+ */
+export declare function instanceOfGetReportCatalog(value: object): value is GetReportCatalog;
+export declare function GetReportCatalogFromJSON(json: any): GetReportCatalog;
+export declare function GetReportCatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportCatalog;
+export declare function GetReportCatalogToJSON(json: any): GetReportCatalog;
+export declare function GetReportCatalogToJSONTyped(value?: GetReportCatalog | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetReportCatalog.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetReportCatalog = instanceOfGetReportCatalog;
+exports.GetReportCatalogFromJSON = GetReportCatalogFromJSON;
+exports.GetReportCatalogFromJSONTyped = GetReportCatalogFromJSONTyped;
+exports.GetReportCatalogToJSON = GetReportCatalogToJSON;
+exports.GetReportCatalogToJSONTyped = GetReportCatalogToJSONTyped;
+const ReportCategory_1 = require("./ReportCategory");
+const ReportDefinition_1 = require("./ReportDefinition");
+/**
+ * Check if a given object implements the GetReportCatalog interface.
+ */
+function instanceOfGetReportCatalog(value) {
+    if (!('categories' in value) || value['categories'] === undefined)
+        return false;
+    if (!('reports' in value) || value['reports'] === undefined)
+        return false;
+    return true;
+}
+function GetReportCatalogFromJSON(json) {
+    return GetReportCatalogFromJSONTyped(json, false);
+}
+function GetReportCatalogFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'categories': (json['categories'].map(ReportCategory_1.ReportCategoryFromJSON)),
+        'reports': (json['reports'].map(ReportDefinition_1.ReportDefinitionFromJSON)),
+    };
+}
+function GetReportCatalogToJSON(json) {
+    return GetReportCatalogToJSONTyped(json, false);
+}
+function GetReportCatalogToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'categories': (value['categories'].map(ReportCategory_1.ReportCategoryToJSON)),
+        'reports': (value['reports'].map(ReportDefinition_1.ReportDefinitionToJSON)),
+    };
+}

package/dist/models/GetReportQueryResult.d.ts

@@ -0,0 +1,84 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReportColumn } from './ReportColumn';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface GetReportQueryResult
+ */
+export interface GetReportQueryResult {
+    /**
+     *
+     * @type {string}
+     * @memberof GetReportQueryResult
+     */
+    reportKey: string;
+    /**
+     *
+     * @type {Array<ReportColumn>}
+     * @memberof GetReportQueryResult
+     */
+    columns: Array<ReportColumn>;
+    /**
+     * One object per row, keyed by column key.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof GetReportQueryResult
+     */
+    rows: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof GetReportQueryResult
+     */
+    sort: ReportSort;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalPages: number;
+    /**
+     * Unix timestamp in seconds.
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    generatedAt: number;
+}
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+export declare function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult;
+export declare function GetReportQueryResultFromJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult;
+export declare function GetReportQueryResultToJSON(json: any): GetReportQueryResult;
+export declare function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetReportQueryResult.js

@@ -0,0 +1,84 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetReportQueryResult = instanceOfGetReportQueryResult;
+exports.GetReportQueryResultFromJSON = GetReportQueryResultFromJSON;
+exports.GetReportQueryResultFromJSONTyped = GetReportQueryResultFromJSONTyped;
+exports.GetReportQueryResultToJSON = GetReportQueryResultToJSON;
+exports.GetReportQueryResultToJSONTyped = GetReportQueryResultToJSONTyped;
+const ReportColumn_1 = require("./ReportColumn");
+const ReportSort_1 = require("./ReportSort");
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+function instanceOfGetReportQueryResult(value) {
+    if (!('reportKey' in value) || value['reportKey'] === undefined)
+        return false;
+    if (!('columns' in value) || value['columns'] === undefined)
+        return false;
+    if (!('rows' in value) || value['rows'] === undefined)
+        return false;
+    if (!('sort' in value) || value['sort'] === undefined)
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined)
+        return false;
+    return true;
+}
+function GetReportQueryResultFromJSON(json) {
+    return GetReportQueryResultFromJSONTyped(json, false);
+}
+function GetReportQueryResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reportKey': json['report_key'],
+        'columns': (json['columns'].map(ReportColumn_1.ReportColumnFromJSON)),
+        'rows': json['rows'],
+        'sort': (0, ReportSort_1.ReportSortFromJSON)(json['sort']),
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'totalPages': json['total_pages'],
+        'generatedAt': json['generated_at'],
+    };
+}
+function GetReportQueryResultToJSON(json) {
+    return GetReportQueryResultToJSONTyped(json, false);
+}
+function GetReportQueryResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'report_key': value['reportKey'],
+        'columns': (value['columns'].map(ReportColumn_1.ReportColumnToJSON)),
+        'rows': value['rows'],
+        'sort': (0, ReportSort_1.ReportSortToJSON)(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'total_pages': value['totalPages'],
+        'generated_at': value['generatedAt'],
+    };
+}

package/dist/models/PostDemoRequest.d.ts

@@ -0,0 +1,100 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PostDemoRequest
+ */
+export interface PostDemoRequest {
+    /**
+     * Stable for retries of the same submission; use a new UUID when details change.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    submissionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    fullName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    email: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    organization: string;
+    /**
+     *
+     * @type {PostDemoRequestLearnerRangeEnum}
+     * @memberof PostDemoRequest
+     */
+    learnerRange?: PostDemoRequestLearnerRangeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    message?: string;
+    /**
+     *
+     * @type {PostDemoRequestInquiryTypeEnum}
+     * @memberof PostDemoRequest
+     */
+    inquiryType?: PostDemoRequestInquiryTypeEnum;
+    /**
+     * Originating site pathname; query strings and fragments are removed.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourcePath?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourceCta?: string;
+}
+/**
+ * @export
+ */
+export declare const PostDemoRequestLearnerRangeEnum: {
+    readonly _150: "1-50";
+    readonly _511000: "51-1000";
+    readonly _10013000: "1001-3000";
+    readonly _3001: "3001+";
+};
+export type PostDemoRequestLearnerRangeEnum = typeof PostDemoRequestLearnerRangeEnum[keyof typeof PostDemoRequestLearnerRangeEnum];
+/**
+ * @export
+ */
+export declare const PostDemoRequestInquiryTypeEnum: {
+    readonly Demo: "demo";
+    readonly Enterprise: "enterprise";
+    readonly Migration: "migration";
+    readonly Sales: "sales";
+};
+export type PostDemoRequestInquiryTypeEnum = typeof PostDemoRequestInquiryTypeEnum[keyof typeof PostDemoRequestInquiryTypeEnum];
+/**
+ * Check if a given object implements the PostDemoRequest interface.
+ */
+export declare function instanceOfPostDemoRequest(value: object): value is PostDemoRequest;
+export declare function PostDemoRequestFromJSON(json: any): PostDemoRequest;
+export declare function PostDemoRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequest;
+export declare function PostDemoRequestToJSON(json: any): PostDemoRequest;
+export declare function PostDemoRequestToJSONTyped(value?: PostDemoRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostDemoRequest.js

@@ -0,0 +1,91 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostDemoRequestInquiryTypeEnum = exports.PostDemoRequestLearnerRangeEnum = void 0;
+exports.instanceOfPostDemoRequest = instanceOfPostDemoRequest;
+exports.PostDemoRequestFromJSON = PostDemoRequestFromJSON;
+exports.PostDemoRequestFromJSONTyped = PostDemoRequestFromJSONTyped;
+exports.PostDemoRequestToJSON = PostDemoRequestToJSON;
+exports.PostDemoRequestToJSONTyped = PostDemoRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.PostDemoRequestLearnerRangeEnum = {
+    _150: '1-50',
+    _511000: '51-1000',
+    _10013000: '1001-3000',
+    _3001: '3001+'
+};
+/**
+ * @export
+ */
+exports.PostDemoRequestInquiryTypeEnum = {
+    Demo: 'demo',
+    Enterprise: 'enterprise',
+    Migration: 'migration',
+    Sales: 'sales'
+};
+/**
+ * Check if a given object implements the PostDemoRequest interface.
+ */
+function instanceOfPostDemoRequest(value) {
+    if (!('submissionId' in value) || value['submissionId'] === undefined)
+        return false;
+    if (!('fullName' in value) || value['fullName'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('organization' in value) || value['organization'] === undefined)
+        return false;
+    return true;
+}
+function PostDemoRequestFromJSON(json) {
+    return PostDemoRequestFromJSONTyped(json, false);
+}
+function PostDemoRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'submissionId': json['submission_id'],
+        'fullName': json['full_name'],
+        'email': json['email'],
+        'organization': json['organization'],
+        'learnerRange': json['learner_range'] == null ? undefined : json['learner_range'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'inquiryType': json['inquiry_type'] == null ? undefined : json['inquiry_type'],
+        'sourcePath': json['source_path'] == null ? undefined : json['source_path'],
+        'sourceCta': json['source_cta'] == null ? undefined : json['source_cta'],
+    };
+}
+function PostDemoRequestToJSON(json) {
+    return PostDemoRequestToJSONTyped(json, false);
+}
+function PostDemoRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'submission_id': value['submissionId'],
+        'full_name': value['fullName'],
+        'email': value['email'],
+        'organization': value['organization'],
+        'learner_range': value['learnerRange'],
+        'message': value['message'],
+        'inquiry_type': value['inquiryType'],
+        'source_path': value['sourcePath'],
+        'source_cta': value['sourceCta'],
+    };
+}

package/dist/models/PostDemoRequestResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PostDemoRequestResponse
+ */
+export interface PostDemoRequestResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    requestId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the PostDemoRequestResponse interface.
+ */
+export declare function instanceOfPostDemoRequestResponse(value: object): value is PostDemoRequestResponse;
+export declare function PostDemoRequestResponseFromJSON(json: any): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseToJSON(json: any): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseToJSONTyped(value?: PostDemoRequestResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostDemoRequestResponse.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostDemoRequestResponse = instanceOfPostDemoRequestResponse;
+exports.PostDemoRequestResponseFromJSON = PostDemoRequestResponseFromJSON;
+exports.PostDemoRequestResponseFromJSONTyped = PostDemoRequestResponseFromJSONTyped;
+exports.PostDemoRequestResponseToJSON = PostDemoRequestResponseToJSON;
+exports.PostDemoRequestResponseToJSONTyped = PostDemoRequestResponseToJSONTyped;
+/**
+ * Check if a given object implements the PostDemoRequestResponse interface.
+ */
+function instanceOfPostDemoRequestResponse(value) {
+    if (!('requestId' in value) || value['requestId'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+function PostDemoRequestResponseFromJSON(json) {
+    return PostDemoRequestResponseFromJSONTyped(json, false);
+}
+function PostDemoRequestResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'requestId': json['request_id'],
+        'message': json['message'],
+    };
+}
+function PostDemoRequestResponseToJSON(json) {
+    return PostDemoRequestResponseToJSONTyped(json, false);
+}
+function PostDemoRequestResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'request_id': value['requestId'],
+        'message': value['message'],
+    };
+}

package/dist/models/PostReportExport.d.ts

@@ -0,0 +1,54 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReportFilters } from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+/**
+ *
+ * @export
+ * @interface PostReportExport
+ */
+export interface PostReportExport {
+    /**
+     *
+     * @type {ReportFilters}
+     * @memberof PostReportExport
+     */
+    filters?: ReportFilters;
+    /**
+     *
+     * @type {ReportSort}
+     * @memberof PostReportExport
+     */
+    sort?: ReportSort;
+    /**
+     *
+     * @type {PostReportExportFormatEnum}
+     * @memberof PostReportExport
+     */
+    format: PostReportExportFormatEnum;
+}
+/**
+ * @export
+ */
+export declare const PostReportExportFormatEnum: {
+    readonly Csv: "csv";
+    readonly Xlsx: "xlsx";
+};
+export type PostReportExportFormatEnum = typeof PostReportExportFormatEnum[keyof typeof PostReportExportFormatEnum];
+/**
+ * Check if a given object implements the PostReportExport interface.
+ */
+export declare function instanceOfPostReportExport(value: object): value is PostReportExport;
+export declare function PostReportExportFromJSON(json: any): PostReportExport;
+export declare function PostReportExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportExport;
+export declare function PostReportExportToJSON(json: any): PostReportExport;
+export declare function PostReportExportToJSONTyped(value?: PostReportExport | null, ignoreDiscriminator?: boolean): any;