@iblai/iblai-api 1.0.0-add-mcp-server-test-mount-core
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 +222 -0
- package/dist/index.cjs.js +17341 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.esm.js +17310 -0
- package/dist/index.esm.js.map +1 -0
- package/dist/index.umd.js +17347 -0
- package/dist/index.umd.js.map +1 -0
- package/dist/types/core/ApiError.d.ts +10 -0
- package/dist/types/core/ApiRequestOptions.d.ts +13 -0
- package/dist/types/core/ApiResult.d.ts +7 -0
- package/dist/types/core/CancelablePromise.d.ts +20 -0
- package/dist/types/core/OpenAPI.d.ts +16 -0
- package/dist/types/core/request.d.ts +30 -0
- package/dist/types/index.d.ts +264 -0
- package/dist/types/models/AWSTenantLaunchRequest.d.ts +20 -0
- package/dist/types/models/AcceptanceEnum.d.ts +10 -0
- package/dist/types/models/ActivateUserFreeTrial.d.ts +11 -0
- package/dist/types/models/ActiveUsersData.d.ts +18 -0
- package/dist/types/models/ActiveUsersList.d.ts +6 -0
- package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
- package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
- package/dist/types/models/ActivityAPI.d.ts +8 -0
- package/dist/types/models/ActivityData.d.ts +38 -0
- package/dist/types/models/App.d.ts +10 -0
- package/dist/types/models/AppleSubscriptionStatusRequest.d.ts +3 -0
- package/dist/types/models/AppleSubscriptionStatusView.d.ts +3 -0
- package/dist/types/models/AppleVerifyTransactionId.d.ts +3 -0
- package/dist/types/models/Assertion.d.ts +15 -0
- package/dist/types/models/AssociateAccountResponse.d.ts +5 -0
- package/dist/types/models/AssociateAppleAccount.d.ts +3 -0
- package/dist/types/models/AuthToken.d.ts +10 -0
- package/dist/types/models/Average.d.ts +4 -0
- package/dist/types/models/AverageData.d.ts +6 -0
- package/dist/types/models/AverageOvertime.d.ts +22 -0
- package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
- package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
- package/dist/types/models/BaseErrorResponse.d.ts +5 -0
- package/dist/types/models/BaseResponse.d.ts +5 -0
- package/dist/types/models/BlankEnum.d.ts +2 -0
- package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
- package/dist/types/models/CampaignEnablement.d.ts +8 -0
- package/dist/types/models/CampaignExclusion.d.ts +8 -0
- package/dist/types/models/CeleryHeartbeat.d.ts +5 -0
- package/dist/types/models/CeleryHeartbeatFail.d.ts +5 -0
- package/dist/types/models/CeleryHeartbeatFailStatusEnum.d.ts +8 -0
- package/dist/types/models/CeleryHeartbeatStatusEnum.d.ts +8 -0
- package/dist/types/models/Company.d.ts +23 -0
- package/dist/types/models/ContextResponse.d.ts +7 -0
- package/dist/types/models/Count.d.ts +4 -0
- package/dist/types/models/CountData.d.ts +6 -0
- package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
- package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
- package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
- package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
- package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
- package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
- package/dist/types/models/CourseGradeSummary.d.ts +4 -0
- package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
- package/dist/types/models/CourseGradingDetail.d.ts +4 -0
- package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
- package/dist/types/models/CoursePoint.d.ts +7 -0
- package/dist/types/models/CourseSkill.d.ts +8 -0
- package/dist/types/models/Credential.d.ts +28 -0
- package/dist/types/models/DesiredRole.d.ts +4 -0
- package/dist/types/models/DesiredSkill.d.ts +4 -0
- package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
- package/dist/types/models/DetailedGradeView.d.ts +4 -0
- package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
- package/dist/types/models/Education.d.ts +30 -0
- package/dist/types/models/EdxSignalReceiverRequest.d.ts +4 -0
- package/dist/types/models/EngagementPerCourse.d.ts +6 -0
- package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
- package/dist/types/models/Enrollments.d.ts +8 -0
- package/dist/types/models/EnrollmentsData.d.ts +18 -0
- package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
- package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
- package/dist/types/models/ErrorResponse.d.ts +8 -0
- package/dist/types/models/Experience.d.ts +29 -0
- package/dist/types/models/FloatOverTime.d.ts +10 -0
- package/dist/types/models/GCPTenantLaunchRequest.d.ts +24 -0
- package/dist/types/models/GooglePayAccountResponse.d.ts +15 -0
- package/dist/types/models/GooglePayAccountResponseStatusEnum.d.ts +8 -0
- package/dist/types/models/GooglePayVerifyToken.d.ts +6 -0
- package/dist/types/models/GradingPerUser.d.ts +8 -0
- package/dist/types/models/GradingPerUserData.d.ts +26 -0
- package/dist/types/models/GroupList.d.ts +6 -0
- package/dist/types/models/GroupListData.d.ts +16 -0
- package/dist/types/models/ImageUpload.d.ts +3 -0
- package/dist/types/models/Institution.d.ts +20 -0
- package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
- package/dist/types/models/Issuer.d.ts +9 -0
- package/dist/types/models/IssuerAuthority.d.ts +5 -0
- package/dist/types/models/ItemTypeEnum.d.ts +18 -0
- package/dist/types/models/LauncherViewPostRequest.d.ts +9 -0
- package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
- package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
- package/dist/types/models/LtiKey.d.ts +19 -0
- package/dist/types/models/LtiLaunchGate.d.ts +8 -0
- package/dist/types/models/LtiTool.d.ts +46 -0
- package/dist/types/models/ManagerAuthToken.d.ts +13 -0
- package/dist/types/models/MarkAllReadRequest.d.ts +9 -0
- package/dist/types/models/MarkAllReadResponse.d.ts +7 -0
- package/dist/types/models/MediaResource.d.ts +71 -0
- package/dist/types/models/MediaTypeEnum.d.ts +14 -0
- package/dist/types/models/ModeEnum.d.ts +10 -0
- package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
- package/dist/types/models/NewPerLearnerList.d.ts +6 -0
- package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
- package/dist/types/models/Notification.d.ts +14 -0
- package/dist/types/models/NotificationCount.d.ts +4 -0
- package/dist/types/models/NotificationPreview.d.ts +31 -0
- package/dist/types/models/NotificationSource.d.ts +8 -0
- package/dist/types/models/NotificationStatusEnum.d.ts +10 -0
- package/dist/types/models/NotificationTemplateData.d.ts +26 -0
- package/dist/types/models/OnboardingStatusUpdate.d.ts +7 -0
- package/dist/types/models/Order.d.ts +22 -0
- package/dist/types/models/OverTime.d.ts +3 -0
- package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
- package/dist/types/models/OvertimeMeta.d.ts +30 -0
- package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
- package/dist/types/models/PaginatedUserAppList.d.ts +7 -0
- package/dist/types/models/Pagination.d.ts +18 -0
- package/dist/types/models/PatchedMediaResource.d.ts +71 -0
- package/dist/types/models/PatchedNotification.d.ts +14 -0
- package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
- package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
- package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
- package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
- package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
- package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
- package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
- package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
- package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
- package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
- package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
- package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
- package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
- package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
- package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
- package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
- package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
- package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
- package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
- package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
- package/dist/types/models/PerlearnerUserList.d.ts +6 -0
- package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
- package/dist/types/models/Platform.d.ts +29 -0
- package/dist/types/models/PlatformApiKey.d.ts +30 -0
- package/dist/types/models/PlatformList.d.ts +29 -0
- package/dist/types/models/PlatformListStatusEnum.d.ts +22 -0
- package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
- package/dist/types/models/PlatformUpdatePostRequest.d.ts +9 -0
- package/dist/types/models/PointsPercentile.d.ts +8 -0
- package/dist/types/models/PreviewResponse.d.ts +11 -0
- package/dist/types/models/Product.d.ts +22 -0
- package/dist/types/models/ProductTable.d.ts +26 -0
- package/dist/types/models/Program.d.ts +24 -0
- package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
- package/dist/types/models/Recipient.d.ts +8 -0
- package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
- package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
- package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
- package/dist/types/models/ReportCreate.d.ts +7 -0
- package/dist/types/models/ReportData.d.ts +28 -0
- package/dist/types/models/ReportDetail.d.ts +4 -0
- package/dist/types/models/ReportList.d.ts +4 -0
- package/dist/types/models/ReportRequest.d.ts +21 -0
- package/dist/types/models/ReportStatus.d.ts +41 -0
- package/dist/types/models/ReportedRole.d.ts +4 -0
- package/dist/types/models/ReportedSkill.d.ts +4 -0
- package/dist/types/models/Resource.d.ts +22 -0
- package/dist/types/models/ResourceCreateUpdate.d.ts +42 -0
- package/dist/types/models/ResourcePoint.d.ts +7 -0
- package/dist/types/models/RevenueByProduct.d.ts +6 -0
- package/dist/types/models/Role.d.ts +7 -0
- package/dist/types/models/SendNotification.d.ts +6 -0
- package/dist/types/models/SendResponse.d.ts +9 -0
- package/dist/types/models/Skill.d.ts +7 -0
- package/dist/types/models/SkillDetail.d.ts +9 -0
- package/dist/types/models/SkillInfo.d.ts +23 -0
- package/dist/types/models/SkillThreshold.d.ts +14 -0
- package/dist/types/models/StateEnum.d.ts +22 -0
- package/dist/types/models/StripeCheckoutSessionRequest.d.ts +54 -0
- package/dist/types/models/StripeCheckoutSessionResponse.d.ts +6 -0
- package/dist/types/models/StripeCustomerPortalRequest.d.ts +3 -0
- package/dist/types/models/StripeCustomerPortalResponse.d.ts +3 -0
- package/dist/types/models/StripeLocalProduct.d.ts +8 -0
- package/dist/types/models/StripeSubscriptionRenewalRequest.d.ts +4 -0
- package/dist/types/models/StripeSubscriptionRenewalResponse.d.ts +3 -0
- package/dist/types/models/SubTimeChild.d.ts +18 -0
- package/dist/types/models/Summary.d.ts +18 -0
- package/dist/types/models/TenantLaunchError.d.ts +10 -0
- package/dist/types/models/TenantLaunchFailed.d.ts +15 -0
- package/dist/types/models/TenantLaunchRequest.d.ts +16 -0
- package/dist/types/models/TenantLaunchResponse.d.ts +15 -0
- package/dist/types/models/TimeChildData.d.ts +20 -0
- package/dist/types/models/TimeDetail.d.ts +8 -0
- package/dist/types/models/TimeDetailChild.d.ts +26 -0
- package/dist/types/models/TimeDetailData.d.ts +24 -0
- package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
- package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
- package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
- package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
- package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
- package/dist/types/models/TimeSpentUpdateRequest.d.ts +34 -0
- package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
- package/dist/types/models/TokenProxyInput.d.ts +21 -0
- package/dist/types/models/TokenProxyOutput.d.ts +7 -0
- package/dist/types/models/TokenProxyOutputSerializerData.d.ts +20 -0
- package/dist/types/models/TokenProxyUser.d.ts +25 -0
- package/dist/types/models/TypeEnum.d.ts +18 -0
- package/dist/types/models/UploadedImage.d.ts +5 -0
- package/dist/types/models/UserApp.d.ts +27 -0
- package/dist/types/models/UserDeleteAPIError.d.ts +3 -0
- package/dist/types/models/UserDeleteAPIRequest.d.ts +3 -0
- package/dist/types/models/UserDeleteAPIResponse.d.ts +3 -0
- package/dist/types/models/UserInfo.d.ts +13 -0
- package/dist/types/models/UserPlatformLink.d.ts +17 -0
- package/dist/types/models/UserPlatformManagementListViewGetResponse.d.ts +6 -0
- package/dist/types/models/UserPlatformViewPostRequest.d.ts +8 -0
- package/dist/types/models/UserProxyBulkRequest.d.ts +3 -0
- package/dist/types/models/UserProxyGetResponse.d.ts +8 -0
- package/dist/types/models/UserProxyPostRequest.d.ts +7 -0
- package/dist/types/models/UserProxyPostResponse.d.ts +8 -0
- package/dist/types/models/UserSearchViewGetResponse.d.ts +6 -0
- package/dist/types/models/UserSkill.d.ts +22 -0
- package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
- package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
- package/dist/types/models/Value.d.ts +4 -0
- package/dist/types/models/ValueData.d.ts +6 -0
- package/dist/types/models/VerifyGCPMarketPlaceFailedResponse.d.ts +11 -0
- package/dist/types/models/VerifyGCPMarketPlaceRequest.d.ts +3 -0
- package/dist/types/models/VerifyGCPMarketPlaceResponse.d.ts +11 -0
- package/dist/types/models/VideoBlock.d.ts +14 -0
- package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
- package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
- package/dist/types/models/VideosCount.d.ts +4 -0
- package/dist/types/models/VideosCountData.d.ts +6 -0
- package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
- package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
- package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
- package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
- package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
- package/dist/types/models/WatchedVideosPerCourse.d.ts +8 -0
- package/dist/types/models/WatchedVideosPerCourseData.d.ts +18 -0
- package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
- package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
- package/dist/types/models/WhitelistedDomain.d.ts +4 -0
- package/dist/types/services/AnalyticsService.d.ts +54 -0
- package/dist/types/services/AudienceService.d.ts +348 -0
- package/dist/types/services/CareerService.d.ts +210 -0
- package/dist/types/services/CatalogService.d.ts +6904 -0
- package/dist/types/services/CoreService.d.ts +638 -0
- package/dist/types/services/CredentialsService.d.ts +1186 -0
- package/dist/types/services/DepartmentsService.d.ts +43 -0
- package/dist/types/services/EngagementService.d.ts +467 -0
- package/dist/types/services/FeaturesService.d.ts +75 -0
- package/dist/types/services/FinanceService.d.ts +52 -0
- package/dist/types/services/MediaResourcesService.d.ts +112 -0
- package/dist/types/services/NotificationBuilderService.d.ts +58 -0
- package/dist/types/services/NotificationService.d.ts +128 -0
- package/dist/types/services/OverviewService.d.ts +184 -0
- package/dist/types/services/PerformanceService.d.ts +183 -0
- package/dist/types/services/PerlearnerService.d.ts +501 -0
- package/dist/types/services/PlatformService.d.ts +391 -0
- package/dist/types/services/ProvidersService.d.ts +142 -0
- package/dist/types/services/ProvisionService.d.ts +14 -0
- package/dist/types/services/RecommendationsService.d.ts +13 -0
- package/dist/types/services/ReportsService.d.ts +142 -0
- package/dist/types/services/RolesService.d.ts +57 -0
- package/dist/types/services/SearchService.d.ts +172 -0
- package/dist/types/services/ServiceService.d.ts +170 -0
- package/dist/types/services/SkillsService.d.ts +377 -0
- package/dist/types/services/UserGroupsService.d.ts +49 -0
- package/package.json +39 -0
- package/rollup.config.js +113 -0
- package/src/core/ApiError.ts +25 -0
- package/src/core/ApiRequestOptions.ts +17 -0
- package/src/core/ApiResult.ts +11 -0
- package/src/core/CancelablePromise.ts +131 -0
- package/src/core/OpenAPI.ts +32 -0
- package/src/core/request.ts +322 -0
- package/src/index.ts +270 -0
- package/src/models/AWSTenantLaunchRequest.ts +25 -0
- package/src/models/AcceptanceEnum.ts +14 -0
- package/src/models/ActivateUserFreeTrial.ts +16 -0
- package/src/models/ActiveUsersData.ts +23 -0
- package/src/models/ActiveUsersList.ts +11 -0
- package/src/models/ActiveUsersPerCourse.ts +15 -0
- package/src/models/ActiveUsersPerCourseData.ts +19 -0
- package/src/models/ActivityAPI.ts +13 -0
- package/src/models/ActivityData.ts +43 -0
- package/src/models/App.ts +15 -0
- package/src/models/AppleSubscriptionStatusRequest.ts +8 -0
- package/src/models/AppleSubscriptionStatusView.ts +8 -0
- package/src/models/AppleVerifyTransactionId.ts +8 -0
- package/src/models/Assertion.ts +20 -0
- package/src/models/AssociateAccountResponse.ts +10 -0
- package/src/models/AssociateAppleAccount.ts +8 -0
- package/src/models/AuthToken.ts +15 -0
- package/src/models/Average.ts +9 -0
- package/src/models/AverageData.ts +11 -0
- package/src/models/AverageOvertime.ts +27 -0
- package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
- package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
- package/src/models/BaseErrorResponse.ts +10 -0
- package/src/models/BaseResponse.ts +10 -0
- package/src/models/BlankEnum.ts +7 -0
- package/src/models/BulkCreateAssertion.ts +9 -0
- package/src/models/CampaignEnablement.ts +13 -0
- package/src/models/CampaignExclusion.ts +13 -0
- package/src/models/CeleryHeartbeat.ts +10 -0
- package/src/models/CeleryHeartbeatFail.ts +10 -0
- package/src/models/CeleryHeartbeatFailStatusEnum.ts +12 -0
- package/src/models/CeleryHeartbeatStatusEnum.ts +12 -0
- package/src/models/Company.ts +28 -0
- package/src/models/ContextResponse.ts +12 -0
- package/src/models/Count.ts +9 -0
- package/src/models/CountData.ts +11 -0
- package/src/models/CourseCompletionPerCourse.ts +11 -0
- package/src/models/CourseCompletionPerCourseData.ts +27 -0
- package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
- package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
- package/src/models/CourseGradeDetailBlock.ts +23 -0
- package/src/models/CourseGradeDetailSubSection.ts +28 -0
- package/src/models/CourseGradeSummary.ts +9 -0
- package/src/models/CourseGradeSummaryData.ts +23 -0
- package/src/models/CourseGradingDetail.ts +9 -0
- package/src/models/CourseGradingDetailData.ts +17 -0
- package/src/models/CoursePoint.ts +12 -0
- package/src/models/CourseSkill.ts +13 -0
- package/src/models/Credential.ts +33 -0
- package/src/models/DesiredRole.ts +9 -0
- package/src/models/DesiredSkill.ts +9 -0
- package/src/models/DetailedGradeSubsection.ts +27 -0
- package/src/models/DetailedGradeView.ts +9 -0
- package/src/models/DetailedGradeViewData.ts +17 -0
- package/src/models/Education.ts +35 -0
- package/src/models/EdxSignalReceiverRequest.ts +9 -0
- package/src/models/EngagementPerCourse.ts +11 -0
- package/src/models/EngagementPerCourseData.ts +31 -0
- package/src/models/Enrollments.ts +13 -0
- package/src/models/EnrollmentsData.ts +23 -0
- package/src/models/EnrollmentsPerUser.ts +11 -0
- package/src/models/EnrollmentsPerUserData.ts +23 -0
- package/src/models/ErrorResponse.ts +13 -0
- package/src/models/Experience.ts +34 -0
- package/src/models/FloatOverTime.ts +15 -0
- package/src/models/GCPTenantLaunchRequest.ts +29 -0
- package/src/models/GooglePayAccountResponse.ts +20 -0
- package/src/models/GooglePayAccountResponseStatusEnum.ts +12 -0
- package/src/models/GooglePayVerifyToken.ts +11 -0
- package/src/models/GradingPerUser.ts +13 -0
- package/src/models/GradingPerUserData.ts +31 -0
- package/src/models/GroupList.ts +11 -0
- package/src/models/GroupListData.ts +21 -0
- package/src/models/ImageUpload.ts +8 -0
- package/src/models/Institution.ts +25 -0
- package/src/models/InstitutionTypeEnum.ts +18 -0
- package/src/models/Issuer.ts +14 -0
- package/src/models/IssuerAuthority.ts +10 -0
- package/src/models/ItemTypeEnum.ts +22 -0
- package/src/models/LauncherViewPostRequest.ts +14 -0
- package/src/models/LearnerInformationAPI.ts +9 -0
- package/src/models/LearnerInformationAPIData.ts +88 -0
- package/src/models/LtiKey.ts +24 -0
- package/src/models/LtiLaunchGate.ts +13 -0
- package/src/models/LtiTool.ts +51 -0
- package/src/models/ManagerAuthToken.ts +18 -0
- package/src/models/MarkAllReadRequest.ts +14 -0
- package/src/models/MarkAllReadResponse.ts +12 -0
- package/src/models/MediaResource.ts +76 -0
- package/src/models/MediaTypeEnum.ts +18 -0
- package/src/models/ModeEnum.ts +14 -0
- package/src/models/NetRevenueOverTime.ts +13 -0
- package/src/models/NewPerLearnerList.ts +11 -0
- package/src/models/NewPerLearnerListData.ts +22 -0
- package/src/models/Notification.ts +19 -0
- package/src/models/NotificationCount.ts +9 -0
- package/src/models/NotificationPreview.ts +36 -0
- package/src/models/NotificationSource.ts +13 -0
- package/src/models/NotificationStatusEnum.ts +14 -0
- package/src/models/NotificationTemplateData.ts +31 -0
- package/src/models/OnboardingStatusUpdate.ts +12 -0
- package/src/models/Order.ts +27 -0
- package/src/models/OverTime.ts +8 -0
- package/src/models/OverTimeWithTotal.ts +27 -0
- package/src/models/OvertimeMeta.ts +35 -0
- package/src/models/OvertimeWithChangeInfo.ts +29 -0
- package/src/models/PaginatedUserAppList.ts +12 -0
- package/src/models/Pagination.ts +23 -0
- package/src/models/PatchedMediaResource.ts +76 -0
- package/src/models/PatchedNotification.ts +19 -0
- package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
- package/src/models/PatchedSkillThreshold.ts +19 -0
- package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
- package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
- package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
- package/src/models/PerLearnerLastAccess.ts +9 -0
- package/src/models/PerLearnerLastAccessData.ts +16 -0
- package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
- package/src/models/PerformanceGradesPerCourse.ts +11 -0
- package/src/models/PerformanceGradesPerCourseData.ts +27 -0
- package/src/models/PerlearnerCourseProgress.ts +9 -0
- package/src/models/PerlearnerCourseProgressData.ts +11 -0
- package/src/models/PerlearnerEngagementVideosData.ts +35 -0
- package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
- package/src/models/PerlearnerGradeSummary.ts +9 -0
- package/src/models/PerlearnerGradeSummaryData.ts +23 -0
- package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
- package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
- package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
- package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
- package/src/models/PerlearnerUserList.ts +11 -0
- package/src/models/PerlearnerUserListData.ts +39 -0
- package/src/models/Platform.ts +34 -0
- package/src/models/PlatformApiKey.ts +35 -0
- package/src/models/PlatformList.ts +34 -0
- package/src/models/PlatformListStatusEnum.ts +26 -0
- package/src/models/PlatformPublicMetadata.ts +13 -0
- package/src/models/PlatformUpdatePostRequest.ts +14 -0
- package/src/models/PointsPercentile.ts +13 -0
- package/src/models/PreviewResponse.ts +16 -0
- package/src/models/Product.ts +27 -0
- package/src/models/ProductTable.ts +31 -0
- package/src/models/Program.ts +29 -0
- package/src/models/ProgramTypeEnum.ts +22 -0
- package/src/models/Recipient.ts +13 -0
- package/src/models/RecommendationSearchAPI.ts +8 -0
- package/src/models/RedirectTokenRequest.ts +8 -0
- package/src/models/RedirectTokenResponse.ts +10 -0
- package/src/models/ReportCreate.ts +12 -0
- package/src/models/ReportData.ts +33 -0
- package/src/models/ReportDetail.ts +9 -0
- package/src/models/ReportList.ts +9 -0
- package/src/models/ReportRequest.ts +26 -0
- package/src/models/ReportStatus.ts +46 -0
- package/src/models/ReportedRole.ts +9 -0
- package/src/models/ReportedSkill.ts +9 -0
- package/src/models/Resource.ts +27 -0
- package/src/models/ResourceCreateUpdate.ts +47 -0
- package/src/models/ResourcePoint.ts +12 -0
- package/src/models/RevenueByProduct.ts +11 -0
- package/src/models/Role.ts +12 -0
- package/src/models/SendNotification.ts +11 -0
- package/src/models/SendResponse.ts +14 -0
- package/src/models/Skill.ts +12 -0
- package/src/models/SkillDetail.ts +14 -0
- package/src/models/SkillInfo.ts +28 -0
- package/src/models/SkillThreshold.ts +19 -0
- package/src/models/StateEnum.ts +26 -0
- package/src/models/StripeCheckoutSessionRequest.ts +59 -0
- package/src/models/StripeCheckoutSessionResponse.ts +11 -0
- package/src/models/StripeCustomerPortalRequest.ts +8 -0
- package/src/models/StripeCustomerPortalResponse.ts +8 -0
- package/src/models/StripeLocalProduct.ts +13 -0
- package/src/models/StripeSubscriptionRenewalRequest.ts +9 -0
- package/src/models/StripeSubscriptionRenewalResponse.ts +8 -0
- package/src/models/SubTimeChild.ts +23 -0
- package/src/models/Summary.ts +23 -0
- package/src/models/TenantLaunchError.ts +15 -0
- package/src/models/TenantLaunchFailed.ts +20 -0
- package/src/models/TenantLaunchRequest.ts +21 -0
- package/src/models/TenantLaunchResponse.ts +20 -0
- package/src/models/TimeChildData.ts +25 -0
- package/src/models/TimeDetail.ts +13 -0
- package/src/models/TimeDetailChild.ts +31 -0
- package/src/models/TimeDetailData.ts +29 -0
- package/src/models/TimeSpentByUsersInCourse.ts +11 -0
- package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
- package/src/models/TimeSpentPerCourse.ts +11 -0
- package/src/models/TimeSpentPerCourseData.ts +31 -0
- package/src/models/TimeSpentPerUserResponse.ts +8 -0
- package/src/models/TimeSpentUpdateRequest.ts +39 -0
- package/src/models/TimeSpentUpdateResponse.ts +9 -0
- package/src/models/TokenProxyInput.ts +26 -0
- package/src/models/TokenProxyOutput.ts +12 -0
- package/src/models/TokenProxyOutputSerializerData.ts +25 -0
- package/src/models/TokenProxyUser.ts +30 -0
- package/src/models/TypeEnum.ts +22 -0
- package/src/models/UploadedImage.ts +10 -0
- package/src/models/UserApp.ts +32 -0
- package/src/models/UserDeleteAPIError.ts +8 -0
- package/src/models/UserDeleteAPIRequest.ts +8 -0
- package/src/models/UserDeleteAPIResponse.ts +8 -0
- package/src/models/UserInfo.ts +18 -0
- package/src/models/UserPlatformLink.ts +22 -0
- package/src/models/UserPlatformManagementListViewGetResponse.ts +11 -0
- package/src/models/UserPlatformViewPostRequest.ts +13 -0
- package/src/models/UserProxyBulkRequest.ts +8 -0
- package/src/models/UserProxyGetResponse.ts +13 -0
- package/src/models/UserProxyPostRequest.ts +12 -0
- package/src/models/UserProxyPostResponse.ts +13 -0
- package/src/models/UserSearchViewGetResponse.ts +11 -0
- package/src/models/UserSkill.ts +27 -0
- package/src/models/UserSkillPointsPercentile.ts +13 -0
- package/src/models/ValidateSourceResponse.ts +15 -0
- package/src/models/Value.ts +9 -0
- package/src/models/ValueData.ts +11 -0
- package/src/models/VerifyGCPMarketPlaceFailedResponse.ts +16 -0
- package/src/models/VerifyGCPMarketPlaceRequest.ts +8 -0
- package/src/models/VerifyGCPMarketPlaceResponse.ts +16 -0
- package/src/models/VideoBlock.ts +19 -0
- package/src/models/VideoEngagementPerCourse.ts +11 -0
- package/src/models/VideoEngagementPerCourseData.ts +35 -0
- package/src/models/VideosCount.ts +9 -0
- package/src/models/VideosCountData.ts +11 -0
- package/src/models/VideosInCourseSummary.ts +9 -0
- package/src/models/VideosInCourseSummaryData.ts +17 -0
- package/src/models/VideosSpecificCourse.ts +9 -0
- package/src/models/VideosSpecificCourseData.ts +31 -0
- package/src/models/VideosWatchedSubSection.ts +24 -0
- package/src/models/WatchedVideosPerCourse.ts +13 -0
- package/src/models/WatchedVideosPerCourseData.ts +23 -0
- package/src/models/WatchedVideosPerUser.ts +13 -0
- package/src/models/WatchedVideosPerUserData.ts +23 -0
- package/src/models/WhitelistedDomain.ts +9 -0
- package/src/services/AnalyticsService.ts +103 -0
- package/src/services/AudienceService.ts +602 -0
- package/src/services/CareerService.ts +568 -0
- package/src/services/CatalogService.ts +7769 -0
- package/src/services/CoreService.ts +1278 -0
- package/src/services/CredentialsService.ts +1649 -0
- package/src/services/DepartmentsService.ts +85 -0
- package/src/services/EngagementService.ts +907 -0
- package/src/services/FeaturesService.ts +126 -0
- package/src/services/FinanceService.ts +136 -0
- package/src/services/MediaResourcesService.ts +319 -0
- package/src/services/NotificationBuilderService.ts +133 -0
- package/src/services/NotificationService.ts +317 -0
- package/src/services/OverviewService.ts +324 -0
- package/src/services/PerformanceService.ts +329 -0
- package/src/services/PerlearnerService.ts +1009 -0
- package/src/services/PlatformService.ts +763 -0
- package/src/services/ProvidersService.ts +271 -0
- package/src/services/ProvisionService.ts +30 -0
- package/src/services/RecommendationsService.ts +31 -0
- package/src/services/ReportsService.ts +218 -0
- package/src/services/RolesService.ts +87 -0
- package/src/services/SearchService.ts +332 -0
- package/src/services/ServiceService.ts +320 -0
- package/src/services/SkillsService.ts +521 -0
- package/src/services/UserGroupsService.ts +91 -0
- package/tsconfig.json +15 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import type { MediaResource } from '../models/MediaResource';
|
|
2
|
+
import type { PatchedMediaResource } from '../models/PatchedMediaResource';
|
|
3
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
+
export declare class MediaResourcesService {
|
|
5
|
+
/**
|
|
6
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
7
|
+
* @param org Organization identifier
|
|
8
|
+
* @param userId User identifier
|
|
9
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
10
|
+
* @param itemId Filter by item ID
|
|
11
|
+
* @param page A page number within the paginated result set.
|
|
12
|
+
* @param pageSize Number of results to return per page.
|
|
13
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
14
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
15
|
+
* @returns any Successfully retrieved media resources
|
|
16
|
+
* @throws ApiError
|
|
17
|
+
*/
|
|
18
|
+
static mediaOrgsUsersMediaMediaResourcesList(org: string, userId: string, courseId?: string, itemId?: string, page?: number, pageSize?: number, search?: string, unitId?: string): CancelablePromise<any>;
|
|
19
|
+
/**
|
|
20
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
21
|
+
* @param org Organization identifier
|
|
22
|
+
* @param userId User identifier
|
|
23
|
+
* @param requestBody
|
|
24
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
25
|
+
* @param itemId Filter by item ID
|
|
26
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
27
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
28
|
+
* @returns any Successfully retrieved media resources
|
|
29
|
+
* @throws ApiError
|
|
30
|
+
*/
|
|
31
|
+
static mediaOrgsUsersMediaMediaResourcesCreate(org: string, userId: string, requestBody: MediaResource, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
32
|
+
/**
|
|
33
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
34
|
+
* @param id A unique integer value identifying this Media Resource.
|
|
35
|
+
* @param org Organization identifier
|
|
36
|
+
* @param userId User identifier
|
|
37
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
38
|
+
* @param itemId Filter by item ID
|
|
39
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
40
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
41
|
+
* @returns any Successfully retrieved media resources
|
|
42
|
+
* @throws ApiError
|
|
43
|
+
*/
|
|
44
|
+
static mediaOrgsUsersMediaMediaResourcesRetrieve(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
45
|
+
/**
|
|
46
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
47
|
+
* @param id A unique integer value identifying this Media Resource.
|
|
48
|
+
* @param org Organization identifier
|
|
49
|
+
* @param userId User identifier
|
|
50
|
+
* @param requestBody
|
|
51
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
52
|
+
* @param itemId Filter by item ID
|
|
53
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
54
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
55
|
+
* @returns any Successfully retrieved media resources
|
|
56
|
+
* @throws ApiError
|
|
57
|
+
*/
|
|
58
|
+
static mediaOrgsUsersMediaMediaResourcesUpdate(id: number, org: string, userId: string, requestBody: MediaResource, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
59
|
+
/**
|
|
60
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
61
|
+
* @param id A unique integer value identifying this Media Resource.
|
|
62
|
+
* @param org Organization identifier
|
|
63
|
+
* @param userId User identifier
|
|
64
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
65
|
+
* @param itemId Filter by item ID
|
|
66
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
67
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
68
|
+
* @param requestBody
|
|
69
|
+
* @returns any Successfully retrieved media resources
|
|
70
|
+
* @throws ApiError
|
|
71
|
+
*/
|
|
72
|
+
static mediaOrgsUsersMediaMediaResourcesPartialUpdate(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string, requestBody?: PatchedMediaResource): CancelablePromise<any>;
|
|
73
|
+
/**
|
|
74
|
+
* List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
|
|
75
|
+
* @param id A unique integer value identifying this Media Resource.
|
|
76
|
+
* @param org Organization identifier
|
|
77
|
+
* @param userId User identifier
|
|
78
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
79
|
+
* @param itemId Filter by item ID
|
|
80
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
81
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
82
|
+
* @returns any Successfully retrieved media resources
|
|
83
|
+
* @throws ApiError
|
|
84
|
+
*/
|
|
85
|
+
static mediaOrgsUsersMediaMediaResourcesDestroy(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
86
|
+
/**
|
|
87
|
+
* Get media resources for a specific item. The item_type determines which resources are returned based on the provided item_id.
|
|
88
|
+
* @param itemId ID of the item
|
|
89
|
+
* @param itemType Type of item. Valid values: course, unit, resource, course_unit, course_resource, unit_resource, all
|
|
90
|
+
* @param org Organization identifier
|
|
91
|
+
* @param userId User identifier
|
|
92
|
+
* @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
|
|
93
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
94
|
+
* @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
|
|
95
|
+
* @returns any Successfully retrieved media resources for item
|
|
96
|
+
* @throws ApiError
|
|
97
|
+
*/
|
|
98
|
+
static mediaOrgsUsersMediaMediaResourcesByItemRetrieve(itemId: string, itemType: 'all' | 'course' | 'course_resource' | 'course_unit' | 'resource' | 'unit' | 'unit_resource', org: string, userId: string, courseId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
99
|
+
/**
|
|
100
|
+
* Search media resources by title, description, or IDs. Supports filtering results by course_id, unit_id, and item_id.
|
|
101
|
+
* @param org Organization identifier
|
|
102
|
+
* @param q Search query string
|
|
103
|
+
* @param userId User identifier
|
|
104
|
+
* @param courseId Filter results by course ID
|
|
105
|
+
* @param itemId Filter results by item ID
|
|
106
|
+
* @param search Search across title, description, course_id, unit_id, item_id, and file_url
|
|
107
|
+
* @param unitId Filter results by unit ID
|
|
108
|
+
* @returns any Successfully searched media resources
|
|
109
|
+
* @throws ApiError
|
|
110
|
+
*/
|
|
111
|
+
static mediaOrgsUsersMediaMediaResourcesSearchRetrieve(org: string, q: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
|
|
112
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { ContextResponse } from '../models/ContextResponse';
|
|
2
|
+
import type { NotificationPreview } from '../models/NotificationPreview';
|
|
3
|
+
import type { NotificationSource } from '../models/NotificationSource';
|
|
4
|
+
import type { PreviewResponse } from '../models/PreviewResponse';
|
|
5
|
+
import type { Recipient } from '../models/Recipient';
|
|
6
|
+
import type { SendNotification } from '../models/SendNotification';
|
|
7
|
+
import type { SendResponse } from '../models/SendResponse';
|
|
8
|
+
import type { ValidateSourceResponse } from '../models/ValidateSourceResponse';
|
|
9
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
10
|
+
export declare class NotificationBuilderService {
|
|
11
|
+
/**
|
|
12
|
+
* Get build recipients
|
|
13
|
+
* Get paginated list of recipients for a notification build
|
|
14
|
+
* @param id
|
|
15
|
+
* @param platformKey
|
|
16
|
+
* @param page Page number
|
|
17
|
+
* @param pageSize Number of items per page
|
|
18
|
+
* @param search Search recipients by username or email
|
|
19
|
+
* @returns Recipient
|
|
20
|
+
* @throws ApiError
|
|
21
|
+
*/
|
|
22
|
+
static notificationV1OrgsNotificationBuilderRecipientsList(id: string, platformKey: string, page?: number, pageSize?: number, search?: string): CancelablePromise<Array<Recipient>>;
|
|
23
|
+
/**
|
|
24
|
+
* Get notification context data
|
|
25
|
+
* Get all context data needed for notification building including templates, channels, and platforms
|
|
26
|
+
* @param platformKey
|
|
27
|
+
* @returns ContextResponse
|
|
28
|
+
* @throws ApiError
|
|
29
|
+
*/
|
|
30
|
+
static notificationV1OrgsNotificationBuilderContextRetrieve(platformKey: string): CancelablePromise<ContextResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Preview notification
|
|
33
|
+
* Preview notification recipients and get build ID for sending
|
|
34
|
+
* @param platformKey
|
|
35
|
+
* @param requestBody
|
|
36
|
+
* @returns PreviewResponse
|
|
37
|
+
* @throws ApiError
|
|
38
|
+
*/
|
|
39
|
+
static notificationV1OrgsNotificationBuilderPreviewCreate(platformKey: string, requestBody: NotificationPreview): CancelablePromise<PreviewResponse>;
|
|
40
|
+
/**
|
|
41
|
+
* Send notification
|
|
42
|
+
* Send notifications to all recipients in a build
|
|
43
|
+
* @param platformKey
|
|
44
|
+
* @param requestBody
|
|
45
|
+
* @returns SendResponse
|
|
46
|
+
* @throws ApiError
|
|
47
|
+
*/
|
|
48
|
+
static notificationV1OrgsNotificationBuilderSendCreate(platformKey: string, requestBody: SendNotification): CancelablePromise<SendResponse>;
|
|
49
|
+
/**
|
|
50
|
+
* Validate notification source
|
|
51
|
+
* Validate a single notification source (email, username, platform, csv)
|
|
52
|
+
* @param platformKey
|
|
53
|
+
* @param requestBody
|
|
54
|
+
* @returns ValidateSourceResponse
|
|
55
|
+
* @throws ApiError
|
|
56
|
+
*/
|
|
57
|
+
static notificationV1OrgsNotificationBuilderValidateSourceCreate(platformKey: string, requestBody: NotificationSource): CancelablePromise<ValidateSourceResponse>;
|
|
58
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import type { CampaignEnablement } from '../models/CampaignEnablement';
|
|
2
|
+
import type { CampaignExclusion } from '../models/CampaignExclusion';
|
|
3
|
+
import type { MarkAllReadRequest } from '../models/MarkAllReadRequest';
|
|
4
|
+
import type { MarkAllReadResponse } from '../models/MarkAllReadResponse';
|
|
5
|
+
import type { Notification } from '../models/Notification';
|
|
6
|
+
import type { NotificationCount } from '../models/NotificationCount';
|
|
7
|
+
import type { PatchedNotification } from '../models/PatchedNotification';
|
|
8
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
9
|
+
export declare class NotificationService {
|
|
10
|
+
/**
|
|
11
|
+
* Unsubscribe from a campaign using a hash
|
|
12
|
+
* @param unsubscribeHash
|
|
13
|
+
* @returns any
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
static notificationV1CampaignsUnsubscribeRetrieve(unsubscribeHash: string): CancelablePromise<{
|
|
17
|
+
success?: boolean;
|
|
18
|
+
message?: string;
|
|
19
|
+
}>;
|
|
20
|
+
/**
|
|
21
|
+
* Get notifications for a user
|
|
22
|
+
* @param org
|
|
23
|
+
* @param channel
|
|
24
|
+
* @param endDate
|
|
25
|
+
* @param excludeChannel
|
|
26
|
+
* @param startDate
|
|
27
|
+
* @param status
|
|
28
|
+
* @returns Notification
|
|
29
|
+
* @throws ApiError
|
|
30
|
+
*/
|
|
31
|
+
static notificationV1OrgsNotificationsRetrieve(org: string, channel?: string, endDate?: string, excludeChannel?: string, startDate?: string, status?: string): CancelablePromise<Notification>;
|
|
32
|
+
/**
|
|
33
|
+
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
34
|
+
* @param org
|
|
35
|
+
* @param requestBody
|
|
36
|
+
* @returns Notification
|
|
37
|
+
* @throws ApiError
|
|
38
|
+
*/
|
|
39
|
+
static notificationV1OrgsNotificationsUpdate(org: string, requestBody: Notification): CancelablePromise<Notification>;
|
|
40
|
+
/**
|
|
41
|
+
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
42
|
+
* @param org
|
|
43
|
+
* @param requestBody
|
|
44
|
+
* @returns Notification
|
|
45
|
+
* @throws ApiError
|
|
46
|
+
*/
|
|
47
|
+
static notificationV1OrgsNotificationsBulkUpdatePartialUpdate(org: string, requestBody?: PatchedNotification): CancelablePromise<Notification>;
|
|
48
|
+
/**
|
|
49
|
+
* Get notifications for a user
|
|
50
|
+
* @param org
|
|
51
|
+
* @param userId
|
|
52
|
+
* @param channel
|
|
53
|
+
* @param endDate
|
|
54
|
+
* @param excludeChannel
|
|
55
|
+
* @param startDate
|
|
56
|
+
* @param status
|
|
57
|
+
* @returns Notification
|
|
58
|
+
* @throws ApiError
|
|
59
|
+
*/
|
|
60
|
+
static notificationV1OrgsUsersNotificationsRetrieve(org: string, userId: string, channel?: string, endDate?: string, excludeChannel?: string, startDate?: string, status?: string): CancelablePromise<Notification>;
|
|
61
|
+
/**
|
|
62
|
+
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
63
|
+
* @param org
|
|
64
|
+
* @param userId
|
|
65
|
+
* @param requestBody
|
|
66
|
+
* @returns Notification
|
|
67
|
+
* @throws ApiError
|
|
68
|
+
*/
|
|
69
|
+
static notificationV1OrgsUsersNotificationsUpdate(org: string, userId: string, requestBody: Notification): CancelablePromise<Notification>;
|
|
70
|
+
/**
|
|
71
|
+
* Get notifications count for a user
|
|
72
|
+
* @param org
|
|
73
|
+
* @param userId
|
|
74
|
+
* @param channel
|
|
75
|
+
* @param status
|
|
76
|
+
* @returns NotificationCount
|
|
77
|
+
* @throws ApiError
|
|
78
|
+
*/
|
|
79
|
+
static notificationV1OrgsUsersNotificationsCountRetrieve(org: string, userId: string, channel?: string, status?: string): CancelablePromise<NotificationCount>;
|
|
80
|
+
/**
|
|
81
|
+
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
82
|
+
* @param notificationId
|
|
83
|
+
* @param org
|
|
84
|
+
* @param userId
|
|
85
|
+
* @returns void
|
|
86
|
+
* @throws ApiError
|
|
87
|
+
*/
|
|
88
|
+
static notificationV1OrgsUsersNotificationsDestroy(notificationId: string, org: string, userId: string): CancelablePromise<void>;
|
|
89
|
+
/**
|
|
90
|
+
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
91
|
+
* @param org
|
|
92
|
+
* @param userId
|
|
93
|
+
* @param requestBody
|
|
94
|
+
* @returns Notification
|
|
95
|
+
* @throws ApiError
|
|
96
|
+
*/
|
|
97
|
+
static notificationV1OrgsUsersNotificationsBulkUpdatePartialUpdate(org: string, userId: string, requestBody?: PatchedNotification): CancelablePromise<Notification>;
|
|
98
|
+
/**
|
|
99
|
+
* Re-enable campaigns for a user
|
|
100
|
+
* @param platformKey
|
|
101
|
+
* @param requestBody
|
|
102
|
+
* @returns any
|
|
103
|
+
* @throws ApiError
|
|
104
|
+
*/
|
|
105
|
+
static notificationV1OrgsCampaignsEnableCreate(platformKey: string, requestBody?: CampaignEnablement): CancelablePromise<{
|
|
106
|
+
success?: boolean;
|
|
107
|
+
message?: string;
|
|
108
|
+
}>;
|
|
109
|
+
/**
|
|
110
|
+
* Exclude a user from specified campaigns
|
|
111
|
+
* @param platformKey
|
|
112
|
+
* @param requestBody
|
|
113
|
+
* @returns any
|
|
114
|
+
* @throws ApiError
|
|
115
|
+
*/
|
|
116
|
+
static notificationV1OrgsCampaignsExcludeCreate(platformKey: string, requestBody?: CampaignExclusion): CancelablePromise<{
|
|
117
|
+
success?: boolean;
|
|
118
|
+
message?: string;
|
|
119
|
+
}>;
|
|
120
|
+
/**
|
|
121
|
+
* Mark all notifications as read for a user. Optionally provide specific notification IDs.
|
|
122
|
+
* @param platformKey
|
|
123
|
+
* @param requestBody
|
|
124
|
+
* @returns MarkAllReadResponse
|
|
125
|
+
* @throws ApiError
|
|
126
|
+
*/
|
|
127
|
+
static notificationV1OrgsMarkAllAsReadCreate(platformKey: string, requestBody?: MarkAllReadRequest): CancelablePromise<MarkAllReadResponse>;
|
|
128
|
+
}
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import type { Average } from '../models/Average';
|
|
2
|
+
import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
|
|
3
|
+
import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
|
|
4
|
+
import type { PerlearnerUserList } from '../models/PerlearnerUserList';
|
|
5
|
+
import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
|
|
6
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
7
|
+
export declare class OverviewService {
|
|
8
|
+
/**
|
|
9
|
+
* Get active user counts over time.
|
|
10
|
+
*
|
|
11
|
+
* This endpoint provides daily counts of active users (users with known activity)
|
|
12
|
+
* over a specified time period.
|
|
13
|
+
*
|
|
14
|
+
* Query Parameters:
|
|
15
|
+
* start_date (str, optional): Start date for the time range (ISO format)
|
|
16
|
+
* end_date (str, optional): End date for the time range (ISO format)
|
|
17
|
+
*
|
|
18
|
+
* Returns:
|
|
19
|
+
* Daily active user counts over the specified time period, with change metrics
|
|
20
|
+
* compared to previous periods.
|
|
21
|
+
*
|
|
22
|
+
* Default time range is the last 7 days if no dates are specified.
|
|
23
|
+
*
|
|
24
|
+
* An active user is defined as a user with any activity within the past 30 days.
|
|
25
|
+
* @param org
|
|
26
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
27
|
+
* @param endDate end date. ISO 8601
|
|
28
|
+
* @param format Format
|
|
29
|
+
*
|
|
30
|
+
* * `json` - json
|
|
31
|
+
* @param includeMainPlatform Include main platform data
|
|
32
|
+
* @param startDate start date. ISO 8601
|
|
33
|
+
* @returns OvertimeWithChangeInfo
|
|
34
|
+
* @throws ApiError
|
|
35
|
+
*/
|
|
36
|
+
static overviewOrgsActiveUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
|
|
37
|
+
/**
|
|
38
|
+
* Get average grade value for platform, course, or user.
|
|
39
|
+
*
|
|
40
|
+
* This endpoint returns the average grade at different levels:
|
|
41
|
+
* - Platform level: Average grade across all courses
|
|
42
|
+
* - Course level: Average grade for a specific course
|
|
43
|
+
* - Learner level: Average grade for a specific learner
|
|
44
|
+
* - Course-learner level: Grade for a specific learner in a specific course
|
|
45
|
+
*
|
|
46
|
+
* Query Parameters:
|
|
47
|
+
* course_id (str, optional): Filter by course ID
|
|
48
|
+
* learner_id (str, optional): Filter by username or email
|
|
49
|
+
*
|
|
50
|
+
* Returns:
|
|
51
|
+
* The average grade value based on the specified filters.
|
|
52
|
+
*
|
|
53
|
+
* Access Control:
|
|
54
|
+
* - Platform admins can access any grade data
|
|
55
|
+
* - Learners can access their own grade data
|
|
56
|
+
* @param org
|
|
57
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
58
|
+
* @param format Format
|
|
59
|
+
*
|
|
60
|
+
* * `json` - json
|
|
61
|
+
* @param includeMainPlatform Include main platform data
|
|
62
|
+
* @returns Average
|
|
63
|
+
* @throws ApiError
|
|
64
|
+
*/
|
|
65
|
+
static overviewOrgsAverageGradeRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
|
|
66
|
+
/**
|
|
67
|
+
* Get course completion summary metrics over time.
|
|
68
|
+
*
|
|
69
|
+
* This endpoint provides completion statistics across the platform over a
|
|
70
|
+
* specified time period, including daily completion counts and overall metrics.
|
|
71
|
+
*
|
|
72
|
+
* Query Parameters:
|
|
73
|
+
* start_date (str): Start date for the time range (ISO format)
|
|
74
|
+
* end_date (str): End date for the time range (ISO format)
|
|
75
|
+
*
|
|
76
|
+
* Returns:
|
|
77
|
+
* Completion data including:
|
|
78
|
+
* - Daily completion counts over time
|
|
79
|
+
* - Total unique user count
|
|
80
|
+
* - Total completion count
|
|
81
|
+
* - Completion percentage
|
|
82
|
+
* - Change metrics compared to previous periods
|
|
83
|
+
*
|
|
84
|
+
* Default time range is the last 7 days if no dates are specified.
|
|
85
|
+
* @param org
|
|
86
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
87
|
+
* @param endDate end date. ISO 8601
|
|
88
|
+
* @param format Format
|
|
89
|
+
*
|
|
90
|
+
* * `json` - json
|
|
91
|
+
* @param includeMainPlatform Include main platform data
|
|
92
|
+
* @param startDate start date. ISO 8601
|
|
93
|
+
* @returns CourseCompletionSummaryOvertime
|
|
94
|
+
* @throws ApiError
|
|
95
|
+
*/
|
|
96
|
+
static overviewOrgsCoursesCompletionsRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<CourseCompletionSummaryOvertime>;
|
|
97
|
+
/**
|
|
98
|
+
* List all learners on the platform with aggregated metrics.
|
|
99
|
+
*
|
|
100
|
+
* This endpoint returns a paginated list of all learners with key metrics including:
|
|
101
|
+
* - Enrollment counts
|
|
102
|
+
* - Completion counts
|
|
103
|
+
* - Time spent on platform
|
|
104
|
+
*
|
|
105
|
+
* Query Parameters:
|
|
106
|
+
* page (int): Page number for pagination
|
|
107
|
+
* length (int): Number of items per page
|
|
108
|
+
* search (str): Filter learners by username, email, or name
|
|
109
|
+
*
|
|
110
|
+
* Returns:
|
|
111
|
+
* A paginated list of learners with their associated metrics.
|
|
112
|
+
* @param org
|
|
113
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
114
|
+
* @param format Format
|
|
115
|
+
*
|
|
116
|
+
* * `json` - json
|
|
117
|
+
* @param includeMainPlatform Include main platform data
|
|
118
|
+
* @param length Size of data to return
|
|
119
|
+
* @param page Page offset
|
|
120
|
+
* @param search Search string for learner
|
|
121
|
+
* @returns PerlearnerUserList
|
|
122
|
+
* @throws ApiError
|
|
123
|
+
*/
|
|
124
|
+
static overviewOrgsLearnersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
|
|
125
|
+
/**
|
|
126
|
+
* Get time spent statistics on a per-course basis.
|
|
127
|
+
*
|
|
128
|
+
* This endpoint provides a paginated list of courses with the total time
|
|
129
|
+
* spent by users in each course.
|
|
130
|
+
*
|
|
131
|
+
* Query Parameters:
|
|
132
|
+
* start_date (str, optional): Start date for filtering (ISO format)
|
|
133
|
+
* end_date (str, optional): End date for filtering (ISO format)
|
|
134
|
+
* page (int, optional): Page number for pagination
|
|
135
|
+
* length (int, optional): Number of items per page
|
|
136
|
+
*
|
|
137
|
+
* Returns:
|
|
138
|
+
* A paginated list of courses with:
|
|
139
|
+
* - Course identification (ID and name)
|
|
140
|
+
* - Total time spent (in seconds)
|
|
141
|
+
* - Formatted time spent (human-readable)
|
|
142
|
+
* - Percentage of total platform time
|
|
143
|
+
* @param org
|
|
144
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
145
|
+
* @param endDate end date. ISO 8601
|
|
146
|
+
* @param format Format
|
|
147
|
+
*
|
|
148
|
+
* * `json` - json
|
|
149
|
+
* @param includeMainPlatform Include main platform data
|
|
150
|
+
* @param length Size of data to return
|
|
151
|
+
* @param page Page offset
|
|
152
|
+
* @param startDate start date. ISO 8601
|
|
153
|
+
* @returns TimeSpentPerCourse
|
|
154
|
+
* @throws ApiError
|
|
155
|
+
*/
|
|
156
|
+
static overviewOrgsMostActiveCoursesRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
|
|
157
|
+
/**
|
|
158
|
+
* Get registered user counts over time.
|
|
159
|
+
*
|
|
160
|
+
* This endpoint provides daily counts of new user registrations over a
|
|
161
|
+
* specified time period.
|
|
162
|
+
*
|
|
163
|
+
* Query Parameters:
|
|
164
|
+
* start_date (str, optional): Start date for the time range (ISO format)
|
|
165
|
+
* end_date (str, optional): End date for the time range (ISO format)
|
|
166
|
+
*
|
|
167
|
+
* Returns:
|
|
168
|
+
* Daily registration counts over the specified time period, with change metrics
|
|
169
|
+
* compared to previous periods.
|
|
170
|
+
*
|
|
171
|
+
* Default time range is the last 7 days if no dates are specified.
|
|
172
|
+
* @param org
|
|
173
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
174
|
+
* @param endDate end date. ISO 8601
|
|
175
|
+
* @param format Format
|
|
176
|
+
*
|
|
177
|
+
* * `json` - json
|
|
178
|
+
* @param includeMainPlatform Include main platform data
|
|
179
|
+
* @param startDate start date. ISO 8601
|
|
180
|
+
* @returns OvertimeWithChangeInfo
|
|
181
|
+
* @throws ApiError
|
|
182
|
+
*/
|
|
183
|
+
static overviewOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
|
|
184
|
+
}
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
import type { Average } from '../models/Average';
|
|
2
|
+
import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
|
|
3
|
+
import type { CourseGradeSummary } from '../models/CourseGradeSummary';
|
|
4
|
+
import type { CourseGradingDetail } from '../models/CourseGradingDetail';
|
|
5
|
+
import type { GradingPerUser } from '../models/GradingPerUser';
|
|
6
|
+
import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
|
|
7
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
|
+
export declare class PerformanceService {
|
|
9
|
+
/**
|
|
10
|
+
* Get average grade value for platform, course, or user.
|
|
11
|
+
*
|
|
12
|
+
* This endpoint returns the average grade at different levels:
|
|
13
|
+
* - Platform level: Average grade across all courses
|
|
14
|
+
* - Course level: Average grade for a specific course
|
|
15
|
+
* - Learner level: Average grade for a specific learner
|
|
16
|
+
* - Course-learner level: Grade for a specific learner in a specific course
|
|
17
|
+
*
|
|
18
|
+
* Query Parameters:
|
|
19
|
+
* course_id (str, optional): Filter by course ID
|
|
20
|
+
* learner_id (str, optional): Filter by username or email
|
|
21
|
+
*
|
|
22
|
+
* Returns:
|
|
23
|
+
* The average grade value based on the specified filters.
|
|
24
|
+
*
|
|
25
|
+
* Access Control:
|
|
26
|
+
* - Platform admins can access any grade data
|
|
27
|
+
* - Learners can access their own grade data
|
|
28
|
+
* @param courseId
|
|
29
|
+
* @param org
|
|
30
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
31
|
+
* @param format Format
|
|
32
|
+
*
|
|
33
|
+
* * `json` - json
|
|
34
|
+
* @param includeMainPlatform Include main platform data
|
|
35
|
+
* @returns Average
|
|
36
|
+
* @throws ApiError
|
|
37
|
+
*/
|
|
38
|
+
static performanceOrgsCoursesGradingAverageRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
|
|
39
|
+
/**
|
|
40
|
+
* Returns average course grade and grade cuttoff
|
|
41
|
+
*
|
|
42
|
+
* e.g
|
|
43
|
+
* ```
|
|
44
|
+
* {
|
|
45
|
+
* "data": {
|
|
46
|
+
* "grade_cutoffs": {
|
|
47
|
+
* "A": 90,
|
|
48
|
+
* "B": 80,
|
|
49
|
+
* "C": 70,
|
|
50
|
+
* },
|
|
51
|
+
* "average_grade": 50.0,
|
|
52
|
+
* }
|
|
53
|
+
* }
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* Kwargs
|
|
57
|
+
* course_id
|
|
58
|
+
* @param courseId
|
|
59
|
+
* @param org
|
|
60
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
61
|
+
* @param format Format
|
|
62
|
+
*
|
|
63
|
+
* * `json` - json
|
|
64
|
+
* @param includeMainPlatform Include main platform data
|
|
65
|
+
* @returns AvgCourseGradeWithCutoff
|
|
66
|
+
* @throws ApiError
|
|
67
|
+
*/
|
|
68
|
+
static performanceOrgsCoursesGradingAverageWithCutoffRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<AvgCourseGradeWithCutoff>;
|
|
69
|
+
/**
|
|
70
|
+
* Grading summary for the entire course overview in a tree-like format
|
|
71
|
+
*
|
|
72
|
+
* Kwargs
|
|
73
|
+
* course_id <required>
|
|
74
|
+
* @param courseId
|
|
75
|
+
* @param org
|
|
76
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
77
|
+
* @param format Format
|
|
78
|
+
*
|
|
79
|
+
* * `json` - json
|
|
80
|
+
* @param includeMainPlatform Include main platform data
|
|
81
|
+
* @returns CourseGradingDetail
|
|
82
|
+
* @throws ApiError
|
|
83
|
+
*/
|
|
84
|
+
static performanceOrgsCoursesGradingDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradingDetail>;
|
|
85
|
+
/**
|
|
86
|
+
* Grading information per enrolled user in a course
|
|
87
|
+
*
|
|
88
|
+
* Kwargs
|
|
89
|
+
* course_id <required>
|
|
90
|
+
* @param courseId
|
|
91
|
+
* @param org
|
|
92
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
93
|
+
* @param format Format
|
|
94
|
+
*
|
|
95
|
+
* * `json` - json
|
|
96
|
+
* @param includeMainPlatform Include main platform data
|
|
97
|
+
* @returns GradingPerUser
|
|
98
|
+
* @throws ApiError
|
|
99
|
+
*/
|
|
100
|
+
static performanceOrgsCoursesGradingPerLearnerRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<GradingPerUser>;
|
|
101
|
+
/**
|
|
102
|
+
* Returns average grades across various assignment types in a course
|
|
103
|
+
*
|
|
104
|
+
* Query Params
|
|
105
|
+
* course_id
|
|
106
|
+
*
|
|
107
|
+
* Returns:
|
|
108
|
+
* dict
|
|
109
|
+
* {
|
|
110
|
+
* "data": [
|
|
111
|
+
* {
|
|
112
|
+
* "assignment_type': <str>,
|
|
113
|
+
* "weight": <float>,
|
|
114
|
+
* "average_weighted_grade": <float>,
|
|
115
|
+
* "average_section_grade": <float>
|
|
116
|
+
* }, ...
|
|
117
|
+
* ]
|
|
118
|
+
* }
|
|
119
|
+
* @param courseId
|
|
120
|
+
* @param org
|
|
121
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
122
|
+
* @param format Format
|
|
123
|
+
*
|
|
124
|
+
* * `json` - json
|
|
125
|
+
* @param includeMainPlatform Include main platform data
|
|
126
|
+
* @returns CourseGradeSummary
|
|
127
|
+
* @throws ApiError
|
|
128
|
+
*/
|
|
129
|
+
static performanceOrgsCoursesGradingSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradeSummary>;
|
|
130
|
+
/**
|
|
131
|
+
* Get average grade value for platform, course, or user.
|
|
132
|
+
*
|
|
133
|
+
* This endpoint returns the average grade at different levels:
|
|
134
|
+
* - Platform level: Average grade across all courses
|
|
135
|
+
* - Course level: Average grade for a specific course
|
|
136
|
+
* - Learner level: Average grade for a specific learner
|
|
137
|
+
* - Course-learner level: Grade for a specific learner in a specific course
|
|
138
|
+
*
|
|
139
|
+
* Query Parameters:
|
|
140
|
+
* course_id (str, optional): Filter by course ID
|
|
141
|
+
* learner_id (str, optional): Filter by username or email
|
|
142
|
+
*
|
|
143
|
+
* Returns:
|
|
144
|
+
* The average grade value based on the specified filters.
|
|
145
|
+
*
|
|
146
|
+
* Access Control:
|
|
147
|
+
* - Platform admins can access any grade data
|
|
148
|
+
* - Learners can access their own grade data
|
|
149
|
+
* @param org
|
|
150
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
151
|
+
* @param format Format
|
|
152
|
+
*
|
|
153
|
+
* * `json` - json
|
|
154
|
+
* @param includeMainPlatform Include main platform data
|
|
155
|
+
* @returns Average
|
|
156
|
+
* @throws ApiError
|
|
157
|
+
*/
|
|
158
|
+
static performanceOrgsGradingAverageRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
|
|
159
|
+
/**
|
|
160
|
+
* List grade-related performance data for all courses.
|
|
161
|
+
*
|
|
162
|
+
* This endpoint provides a comprehensive view of grade performance across
|
|
163
|
+
* courses, including enrollment counts, pass rates, and average grades.
|
|
164
|
+
*
|
|
165
|
+
* Returns:
|
|
166
|
+
* A paginated list of courses with:
|
|
167
|
+
* - Course identification (ID and name)
|
|
168
|
+
* - Enrollment count
|
|
169
|
+
* - Number of students who passed
|
|
170
|
+
* - Average grade
|
|
171
|
+
* @param org
|
|
172
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
173
|
+
* @param format Format
|
|
174
|
+
*
|
|
175
|
+
* * `json` - json
|
|
176
|
+
* @param includeMainPlatform Include main platform data
|
|
177
|
+
* @param length Size of data to return
|
|
178
|
+
* @param page Page offset
|
|
179
|
+
* @returns PerformanceGradesPerCourse
|
|
180
|
+
* @throws ApiError
|
|
181
|
+
*/
|
|
182
|
+
static performanceOrgsGradingPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<PerformanceGradesPerCourse>;
|
|
183
|
+
}
|