@iblai/iblai-api 0.0.1-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 +17527 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.esm.js +17494 -0
- package/dist/index.esm.js.map +1 -0
- package/dist/index.umd.js +17533 -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 +396 -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/BlankCourseInvitationCreate.d.ts +21 -0
- package/dist/types/models/BlankEnum.d.ts +2 -0
- package/dist/types/models/BlankPlatformInvitationCreate.d.ts +21 -0
- package/dist/types/models/BlankProgramInvitationCreate.d.ts +21 -0
- package/dist/types/models/BlockSkillPointInfoRequest.d.ts +18 -0
- package/dist/types/models/BlockSkillPointInfoResponse.d.ts +10 -0
- package/dist/types/models/BulkCourseInvitationCreate.d.ts +14 -0
- package/dist/types/models/BulkCourseInvitationResponse.d.ts +13 -0
- package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
- package/dist/types/models/BulkPlatformInvitationCreate.d.ts +14 -0
- package/dist/types/models/BulkPlatformInvitationResponse.d.ts +13 -0
- package/dist/types/models/BulkProgramInvitationCreate.d.ts +14 -0
- package/dist/types/models/BulkProgramInvitationResponse.d.ts +13 -0
- package/dist/types/models/BulkSuggestionResponse.d.ts +13 -0
- package/dist/types/models/CampaignEnablement.d.ts +8 -0
- package/dist/types/models/CampaignExclusion.d.ts +8 -0
- package/dist/types/models/CatalogAutoIncrementResponse.d.ts +25 -0
- package/dist/types/models/CatalogAutoIncrementUpdateRequest.d.ts +17 -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/Course.d.ts +15 -0
- package/dist/types/models/CourseAccessRequestCreate.d.ts +17 -0
- package/dist/types/models/CourseAccessRequestDetail.d.ts +49 -0
- package/dist/types/models/CourseAccessRequestStatusResponse.d.ts +17 -0
- package/dist/types/models/CourseAccessRequestUpdate.d.ts +25 -0
- package/dist/types/models/CourseCompletion.d.ts +66 -0
- package/dist/types/models/CourseCompletionCatalogResponse.d.ts +11 -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/CourseCreateUpdate.d.ts +25 -0
- package/dist/types/models/CourseDeleteResponse.d.ts +13 -0
- package/dist/types/models/CourseEligibilityCheckResponse.d.ts +25 -0
- package/dist/types/models/CourseEnrollmentSearchResponse.d.ts +53 -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/CourseGroupSuggestionCreate.d.ts +41 -0
- package/dist/types/models/CourseGroupSuggestionDetail.d.ts +53 -0
- package/dist/types/models/CourseInvitationCreate.d.ts +41 -0
- package/dist/types/models/CourseInvitationDetail.d.ts +53 -0
- package/dist/types/models/CourseInvitationRedemption.d.ts +25 -0
- package/dist/types/models/CourseLicenseAssignmentCreate.d.ts +37 -0
- package/dist/types/models/CourseLicenseAssignmentDetail.d.ts +49 -0
- package/dist/types/models/CourseLicenseCreate.d.ts +61 -0
- package/dist/types/models/CourseLicenseDetail.d.ts +53 -0
- package/dist/types/models/CourseLicenseGroupAssignmentCreate.d.ts +33 -0
- package/dist/types/models/CourseLicenseGroupAssignmentDetail.d.ts +45 -0
- package/dist/types/models/CourseLicenseUpdate.d.ts +61 -0
- package/dist/types/models/CourseMetadataSearchRequest.d.ts +17 -0
- package/dist/types/models/CourseMetadataUpdateRequest.d.ts +17 -0
- package/dist/types/models/CoursePoint.d.ts +7 -0
- package/dist/types/models/CourseReviewInfoResponse.d.ts +17 -0
- package/dist/types/models/CourseSkill.d.ts +8 -0
- package/dist/types/models/CourseSkillPointInfoRequest.d.ts +18 -0
- package/dist/types/models/CourseSkillPointInfoResponse.d.ts +10 -0
- package/dist/types/models/CourseSuggestionBulkCreate.d.ts +17 -0
- package/dist/types/models/CourseSuggestionCreate.d.ts +49 -0
- package/dist/types/models/CourseSuggestionDetail.d.ts +53 -0
- package/dist/types/models/Credential.d.ts +28 -0
- package/dist/types/models/DesiredRole.d.ts +7 -0
- package/dist/types/models/DesiredRoleCreateUpdateRequest.d.ts +21 -0
- package/dist/types/models/DesiredSkill.d.ts +7 -0
- package/dist/types/models/DesiredSkillCreateUpdateRequest.d.ts +21 -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/GlobalCatalogSearchResponse.d.ts +33 -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/PaginatedCourseAccessRequest.d.ts +22 -0
- package/dist/types/models/PaginatedCourseGroupSuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedCourseInvitation.d.ts +22 -0
- package/dist/types/models/PaginatedCourseLicense.d.ts +22 -0
- package/dist/types/models/PaginatedCourseLicenseAssignment.d.ts +22 -0
- package/dist/types/models/PaginatedCourseLicenseGroupAssignment.d.ts +22 -0
- package/dist/types/models/PaginatedCourseSuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedPathwayGroupSuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedPathwaySuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedPlatformInvitation.d.ts +22 -0
- package/dist/types/models/PaginatedPlatformLicense.d.ts +22 -0
- package/dist/types/models/PaginatedProgramGroupSuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedProgramInvitation.d.ts +22 -0
- package/dist/types/models/PaginatedProgramLicense.d.ts +31 -0
- package/dist/types/models/PaginatedProgramLicenseAssignment.d.ts +31 -0
- package/dist/types/models/PaginatedProgramLicenseGroupAssignment.d.ts +31 -0
- package/dist/types/models/PaginatedProgramSuggestion.d.ts +22 -0
- package/dist/types/models/PaginatedUserAppList.d.ts +7 -0
- package/dist/types/models/PaginatedUserLicense.d.ts +22 -0
- package/dist/types/models/PaginatedUserLicenseAssignment.d.ts +22 -0
- package/dist/types/models/PaginatedUserLicenseGroupAssignment.d.ts +22 -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/Pathway.d.ts +28 -0
- package/dist/types/models/PathwayCompletionResponse.d.ts +13 -0
- package/dist/types/models/PathwayCreateUpdateRequest.d.ts +45 -0
- package/dist/types/models/PathwayDeleteResponse.d.ts +13 -0
- package/dist/types/models/PathwayEnrollment.d.ts +22 -0
- package/dist/types/models/PathwayEnrollmentPlus.d.ts +26 -0
- package/dist/types/models/PathwayEnrollmentRequest.d.ts +49 -0
- package/dist/types/models/PathwayGroupSuggestionCreate.d.ts +41 -0
- package/dist/types/models/PathwayGroupSuggestionDetail.d.ts +61 -0
- package/dist/types/models/PathwaySelfEnrollmentRequest.d.ts +37 -0
- package/dist/types/models/PathwaySuggestionBulkCreate.d.ts +21 -0
- package/dist/types/models/PathwaySuggestionCreate.d.ts +53 -0
- package/dist/types/models/PathwaySuggestionDetail.d.ts +61 -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/PlatformInvitationCreate.d.ts +41 -0
- package/dist/types/models/PlatformInvitationDetail.d.ts +53 -0
- package/dist/types/models/PlatformInvitationRedemption.d.ts +25 -0
- package/dist/types/models/PlatformLicenseCreate.d.ts +53 -0
- package/dist/types/models/PlatformLicenseDetail.d.ts +49 -0
- package/dist/types/models/PlatformLicenseUpdate.d.ts +57 -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/PlatformSkillPointBulkRequest.d.ts +13 -0
- package/dist/types/models/PlatformSkillPointBulkResponse.d.ts +13 -0
- package/dist/types/models/PlatformSkillPointGroupRequest.d.ts +21 -0
- package/dist/types/models/PlatformSkillPointRequest.d.ts +21 -0
- package/dist/types/models/PlatformSkillPointResponse.d.ts +21 -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/ProgramCompletionResponse.d.ts +13 -0
- package/dist/types/models/ProgramCoursePosition.d.ts +6 -0
- package/dist/types/models/ProgramCreateUpdateRequest.d.ts +45 -0
- package/dist/types/models/ProgramDeleteResponse.d.ts +13 -0
- package/dist/types/models/ProgramEnrollment.d.ts +30 -0
- package/dist/types/models/ProgramEnrollmentPlus.d.ts +34 -0
- package/dist/types/models/ProgramGroupSuggestionCreate.d.ts +37 -0
- package/dist/types/models/ProgramGroupSuggestionDetail.d.ts +53 -0
- package/dist/types/models/ProgramInvitationCreate.d.ts +41 -0
- package/dist/types/models/ProgramInvitationDetail.d.ts +53 -0
- package/dist/types/models/ProgramInvitationRedemption.d.ts +25 -0
- package/dist/types/models/ProgramLicenseAssignmentCreate.d.ts +70 -0
- package/dist/types/models/ProgramLicenseAssignmentDetail.d.ts +90 -0
- package/dist/types/models/ProgramLicenseCreateDetail.d.ts +61 -0
- package/dist/types/models/ProgramLicenseDetail.d.ts +90 -0
- package/dist/types/models/ProgramLicenseGroupAssignmentCreate.d.ts +56 -0
- package/dist/types/models/ProgramLicenseGroupAssignmentDetail.d.ts +85 -0
- package/dist/types/models/ProgramLicenseUpdateDetail.d.ts +76 -0
- package/dist/types/models/ProgramReviewInfoResponse.d.ts +17 -0
- package/dist/types/models/ProgramSearch.d.ts +28 -0
- package/dist/types/models/ProgramSuggestionBulkCreate.d.ts +21 -0
- package/dist/types/models/ProgramSuggestionCreate.d.ts +53 -0
- package/dist/types/models/ProgramSuggestionDetail.d.ts +53 -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 +7 -0
- package/dist/types/models/ReportedRoleCreateUpdateRequest.d.ts +21 -0
- package/dist/types/models/ReportedSkill.d.ts +7 -0
- package/dist/types/models/Resource.d.ts +22 -0
- package/dist/types/models/ResourceCompletion.d.ts +46 -0
- package/dist/types/models/ResourceCompletionRequest.d.ts +29 -0
- package/dist/types/models/ResourceCreateUpdate.d.ts +42 -0
- package/dist/types/models/ResourceDeleteResponse.d.ts +13 -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 +18 -0
- package/dist/types/models/RoleCreateUpdateRequest.d.ts +25 -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 +16 -0
- package/dist/types/models/SkillCreateUpdateRequest.d.ts +25 -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/UserLicenseAssignmentCreate.d.ts +37 -0
- package/dist/types/models/UserLicenseAssignmentDetail.d.ts +49 -0
- package/dist/types/models/UserLicenseCreate.d.ts +57 -0
- package/dist/types/models/UserLicenseDetail.d.ts +53 -0
- package/dist/types/models/UserLicenseGroupAssignmentCreate.d.ts +33 -0
- package/dist/types/models/UserLicenseGroupAssignmentDetail.d.ts +45 -0
- package/dist/types/models/UserLicenseUpdate.d.ts +61 -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/UserSearchResponse.d.ts +29 -0
- package/dist/types/models/UserSearchViewGetResponse.d.ts +6 -0
- package/dist/types/models/UserSkill.d.ts +22 -0
- package/dist/types/models/UserSkillPointInfoResponse.d.ts +10 -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 +4682 -0
- package/dist/types/services/CoreService.d.ts +638 -0
- package/dist/types/services/CredentialsService.d.ts +1189 -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/OrgsService.d.ts +262 -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/ProviderAssociationService.d.ts +16 -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 +352 -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 +402 -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/BlankCourseInvitationCreate.ts +26 -0
- package/src/models/BlankEnum.ts +7 -0
- package/src/models/BlankPlatformInvitationCreate.ts +26 -0
- package/src/models/BlankProgramInvitationCreate.ts +26 -0
- package/src/models/BlockSkillPointInfoRequest.ts +23 -0
- package/src/models/BlockSkillPointInfoResponse.ts +15 -0
- package/src/models/BulkCourseInvitationCreate.ts +19 -0
- package/src/models/BulkCourseInvitationResponse.ts +18 -0
- package/src/models/BulkCreateAssertion.ts +9 -0
- package/src/models/BulkPlatformInvitationCreate.ts +19 -0
- package/src/models/BulkPlatformInvitationResponse.ts +18 -0
- package/src/models/BulkProgramInvitationCreate.ts +19 -0
- package/src/models/BulkProgramInvitationResponse.ts +18 -0
- package/src/models/BulkSuggestionResponse.ts +18 -0
- package/src/models/CampaignEnablement.ts +13 -0
- package/src/models/CampaignExclusion.ts +13 -0
- package/src/models/CatalogAutoIncrementResponse.ts +30 -0
- package/src/models/CatalogAutoIncrementUpdateRequest.ts +22 -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/Course.ts +20 -0
- package/src/models/CourseAccessRequestCreate.ts +22 -0
- package/src/models/CourseAccessRequestDetail.ts +54 -0
- package/src/models/CourseAccessRequestStatusResponse.ts +22 -0
- package/src/models/CourseAccessRequestUpdate.ts +30 -0
- package/src/models/CourseCompletion.ts +71 -0
- package/src/models/CourseCompletionCatalogResponse.ts +16 -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/CourseCreateUpdate.ts +30 -0
- package/src/models/CourseDeleteResponse.ts +18 -0
- package/src/models/CourseEligibilityCheckResponse.ts +30 -0
- package/src/models/CourseEnrollmentSearchResponse.ts +58 -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/CourseGroupSuggestionCreate.ts +46 -0
- package/src/models/CourseGroupSuggestionDetail.ts +58 -0
- package/src/models/CourseInvitationCreate.ts +46 -0
- package/src/models/CourseInvitationDetail.ts +58 -0
- package/src/models/CourseInvitationRedemption.ts +30 -0
- package/src/models/CourseLicenseAssignmentCreate.ts +42 -0
- package/src/models/CourseLicenseAssignmentDetail.ts +54 -0
- package/src/models/CourseLicenseCreate.ts +66 -0
- package/src/models/CourseLicenseDetail.ts +58 -0
- package/src/models/CourseLicenseGroupAssignmentCreate.ts +38 -0
- package/src/models/CourseLicenseGroupAssignmentDetail.ts +50 -0
- package/src/models/CourseLicenseUpdate.ts +66 -0
- package/src/models/CourseMetadataSearchRequest.ts +22 -0
- package/src/models/CourseMetadataUpdateRequest.ts +22 -0
- package/src/models/CoursePoint.ts +12 -0
- package/src/models/CourseReviewInfoResponse.ts +22 -0
- package/src/models/CourseSkill.ts +13 -0
- package/src/models/CourseSkillPointInfoRequest.ts +23 -0
- package/src/models/CourseSkillPointInfoResponse.ts +15 -0
- package/src/models/CourseSuggestionBulkCreate.ts +22 -0
- package/src/models/CourseSuggestionCreate.ts +54 -0
- package/src/models/CourseSuggestionDetail.ts +58 -0
- package/src/models/Credential.ts +33 -0
- package/src/models/DesiredRole.ts +12 -0
- package/src/models/DesiredRoleCreateUpdateRequest.ts +26 -0
- package/src/models/DesiredSkill.ts +12 -0
- package/src/models/DesiredSkillCreateUpdateRequest.ts +26 -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/GlobalCatalogSearchResponse.ts +38 -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/PaginatedCourseAccessRequest.ts +27 -0
- package/src/models/PaginatedCourseGroupSuggestion.ts +27 -0
- package/src/models/PaginatedCourseInvitation.ts +27 -0
- package/src/models/PaginatedCourseLicense.ts +27 -0
- package/src/models/PaginatedCourseLicenseAssignment.ts +27 -0
- package/src/models/PaginatedCourseLicenseGroupAssignment.ts +27 -0
- package/src/models/PaginatedCourseSuggestion.ts +27 -0
- package/src/models/PaginatedPathwayGroupSuggestion.ts +27 -0
- package/src/models/PaginatedPathwaySuggestion.ts +27 -0
- package/src/models/PaginatedPlatformInvitation.ts +27 -0
- package/src/models/PaginatedPlatformLicense.ts +27 -0
- package/src/models/PaginatedProgramGroupSuggestion.ts +27 -0
- package/src/models/PaginatedProgramInvitation.ts +27 -0
- package/src/models/PaginatedProgramLicense.ts +36 -0
- package/src/models/PaginatedProgramLicenseAssignment.ts +36 -0
- package/src/models/PaginatedProgramLicenseGroupAssignment.ts +36 -0
- package/src/models/PaginatedProgramSuggestion.ts +27 -0
- package/src/models/PaginatedUserAppList.ts +12 -0
- package/src/models/PaginatedUserLicense.ts +27 -0
- package/src/models/PaginatedUserLicenseAssignment.ts +27 -0
- package/src/models/PaginatedUserLicenseGroupAssignment.ts +27 -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/Pathway.ts +33 -0
- package/src/models/PathwayCompletionResponse.ts +18 -0
- package/src/models/PathwayCreateUpdateRequest.ts +50 -0
- package/src/models/PathwayDeleteResponse.ts +18 -0
- package/src/models/PathwayEnrollment.ts +27 -0
- package/src/models/PathwayEnrollmentPlus.ts +31 -0
- package/src/models/PathwayEnrollmentRequest.ts +54 -0
- package/src/models/PathwayGroupSuggestionCreate.ts +46 -0
- package/src/models/PathwayGroupSuggestionDetail.ts +66 -0
- package/src/models/PathwaySelfEnrollmentRequest.ts +42 -0
- package/src/models/PathwaySuggestionBulkCreate.ts +26 -0
- package/src/models/PathwaySuggestionCreate.ts +58 -0
- package/src/models/PathwaySuggestionDetail.ts +66 -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/PlatformInvitationCreate.ts +46 -0
- package/src/models/PlatformInvitationDetail.ts +58 -0
- package/src/models/PlatformInvitationRedemption.ts +30 -0
- package/src/models/PlatformLicenseCreate.ts +58 -0
- package/src/models/PlatformLicenseDetail.ts +54 -0
- package/src/models/PlatformLicenseUpdate.ts +62 -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/PlatformSkillPointBulkRequest.ts +18 -0
- package/src/models/PlatformSkillPointBulkResponse.ts +18 -0
- package/src/models/PlatformSkillPointGroupRequest.ts +26 -0
- package/src/models/PlatformSkillPointRequest.ts +26 -0
- package/src/models/PlatformSkillPointResponse.ts +26 -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/ProgramCompletionResponse.ts +18 -0
- package/src/models/ProgramCoursePosition.ts +11 -0
- package/src/models/ProgramCreateUpdateRequest.ts +50 -0
- package/src/models/ProgramDeleteResponse.ts +18 -0
- package/src/models/ProgramEnrollment.ts +35 -0
- package/src/models/ProgramEnrollmentPlus.ts +39 -0
- package/src/models/ProgramGroupSuggestionCreate.ts +42 -0
- package/src/models/ProgramGroupSuggestionDetail.ts +58 -0
- package/src/models/ProgramInvitationCreate.ts +46 -0
- package/src/models/ProgramInvitationDetail.ts +58 -0
- package/src/models/ProgramInvitationRedemption.ts +30 -0
- package/src/models/ProgramLicenseAssignmentCreate.ts +75 -0
- package/src/models/ProgramLicenseAssignmentDetail.ts +95 -0
- package/src/models/ProgramLicenseCreateDetail.ts +66 -0
- package/src/models/ProgramLicenseDetail.ts +95 -0
- package/src/models/ProgramLicenseGroupAssignmentCreate.ts +61 -0
- package/src/models/ProgramLicenseGroupAssignmentDetail.ts +90 -0
- package/src/models/ProgramLicenseUpdateDetail.ts +81 -0
- package/src/models/ProgramReviewInfoResponse.ts +22 -0
- package/src/models/ProgramSearch.ts +33 -0
- package/src/models/ProgramSuggestionBulkCreate.ts +26 -0
- package/src/models/ProgramSuggestionCreate.ts +58 -0
- package/src/models/ProgramSuggestionDetail.ts +58 -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 +12 -0
- package/src/models/ReportedRoleCreateUpdateRequest.ts +26 -0
- package/src/models/ReportedSkill.ts +12 -0
- package/src/models/Resource.ts +27 -0
- package/src/models/ResourceCompletion.ts +51 -0
- package/src/models/ResourceCompletionRequest.ts +34 -0
- package/src/models/ResourceCreateUpdate.ts +47 -0
- package/src/models/ResourceDeleteResponse.ts +18 -0
- package/src/models/ResourcePoint.ts +12 -0
- package/src/models/RevenueByProduct.ts +11 -0
- package/src/models/Role.ts +23 -0
- package/src/models/RoleCreateUpdateRequest.ts +30 -0
- package/src/models/SendNotification.ts +11 -0
- package/src/models/SendResponse.ts +14 -0
- package/src/models/Skill.ts +21 -0
- package/src/models/SkillCreateUpdateRequest.ts +30 -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/UserLicenseAssignmentCreate.ts +42 -0
- package/src/models/UserLicenseAssignmentDetail.ts +54 -0
- package/src/models/UserLicenseCreate.ts +62 -0
- package/src/models/UserLicenseDetail.ts +58 -0
- package/src/models/UserLicenseGroupAssignmentCreate.ts +38 -0
- package/src/models/UserLicenseGroupAssignmentDetail.ts +50 -0
- package/src/models/UserLicenseUpdate.ts +66 -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/UserSearchResponse.ts +34 -0
- package/src/models/UserSearchViewGetResponse.ts +11 -0
- package/src/models/UserSkill.ts +27 -0
- package/src/models/UserSkillPointInfoResponse.ts +15 -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 +8300 -0
- package/src/services/CoreService.ts +1278 -0
- package/src/services/CredentialsService.ts +1656 -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/OrgsService.ts +596 -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/ProviderAssociationService.ts +32 -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 +550 -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,4682 @@
|
|
|
1
|
+
import type { BlankCourseInvitationCreate } from '../models/BlankCourseInvitationCreate';
|
|
2
|
+
import type { BlankPlatformInvitationCreate } from '../models/BlankPlatformInvitationCreate';
|
|
3
|
+
import type { BlankProgramInvitationCreate } from '../models/BlankProgramInvitationCreate';
|
|
4
|
+
import type { BlockSkillPointInfoRequest } from '../models/BlockSkillPointInfoRequest';
|
|
5
|
+
import type { BlockSkillPointInfoResponse } from '../models/BlockSkillPointInfoResponse';
|
|
6
|
+
import type { BulkCourseInvitationCreate } from '../models/BulkCourseInvitationCreate';
|
|
7
|
+
import type { BulkCourseInvitationResponse } from '../models/BulkCourseInvitationResponse';
|
|
8
|
+
import type { BulkPlatformInvitationCreate } from '../models/BulkPlatformInvitationCreate';
|
|
9
|
+
import type { BulkPlatformInvitationResponse } from '../models/BulkPlatformInvitationResponse';
|
|
10
|
+
import type { BulkProgramInvitationCreate } from '../models/BulkProgramInvitationCreate';
|
|
11
|
+
import type { BulkProgramInvitationResponse } from '../models/BulkProgramInvitationResponse';
|
|
12
|
+
import type { BulkSuggestionResponse } from '../models/BulkSuggestionResponse';
|
|
13
|
+
import type { CatalogAutoIncrementResponse } from '../models/CatalogAutoIncrementResponse';
|
|
14
|
+
import type { CatalogAutoIncrementUpdateRequest } from '../models/CatalogAutoIncrementUpdateRequest';
|
|
15
|
+
import type { Course } from '../models/Course';
|
|
16
|
+
import type { CourseAccessRequestCreate } from '../models/CourseAccessRequestCreate';
|
|
17
|
+
import type { CourseAccessRequestDetail } from '../models/CourseAccessRequestDetail';
|
|
18
|
+
import type { CourseAccessRequestStatusResponse } from '../models/CourseAccessRequestStatusResponse';
|
|
19
|
+
import type { CourseAccessRequestUpdate } from '../models/CourseAccessRequestUpdate';
|
|
20
|
+
import type { CourseCompletion } from '../models/CourseCompletion';
|
|
21
|
+
import type { CourseCompletionCatalogResponse } from '../models/CourseCompletionCatalogResponse';
|
|
22
|
+
import type { CourseCreateUpdate } from '../models/CourseCreateUpdate';
|
|
23
|
+
import type { CourseDeleteResponse } from '../models/CourseDeleteResponse';
|
|
24
|
+
import type { CourseEligibilityCheckResponse } from '../models/CourseEligibilityCheckResponse';
|
|
25
|
+
import type { CourseEnrollmentSearchResponse } from '../models/CourseEnrollmentSearchResponse';
|
|
26
|
+
import type { CourseGroupSuggestionCreate } from '../models/CourseGroupSuggestionCreate';
|
|
27
|
+
import type { CourseGroupSuggestionDetail } from '../models/CourseGroupSuggestionDetail';
|
|
28
|
+
import type { CourseInvitationCreate } from '../models/CourseInvitationCreate';
|
|
29
|
+
import type { CourseInvitationDetail } from '../models/CourseInvitationDetail';
|
|
30
|
+
import type { CourseInvitationRedemption } from '../models/CourseInvitationRedemption';
|
|
31
|
+
import type { CourseLicenseAssignmentCreate } from '../models/CourseLicenseAssignmentCreate';
|
|
32
|
+
import type { CourseLicenseAssignmentDetail } from '../models/CourseLicenseAssignmentDetail';
|
|
33
|
+
import type { CourseLicenseCreate } from '../models/CourseLicenseCreate';
|
|
34
|
+
import type { CourseLicenseDetail } from '../models/CourseLicenseDetail';
|
|
35
|
+
import type { CourseLicenseGroupAssignmentCreate } from '../models/CourseLicenseGroupAssignmentCreate';
|
|
36
|
+
import type { CourseLicenseGroupAssignmentDetail } from '../models/CourseLicenseGroupAssignmentDetail';
|
|
37
|
+
import type { CourseLicenseUpdate } from '../models/CourseLicenseUpdate';
|
|
38
|
+
import type { CourseMetadataSearchRequest } from '../models/CourseMetadataSearchRequest';
|
|
39
|
+
import type { CourseMetadataUpdateRequest } from '../models/CourseMetadataUpdateRequest';
|
|
40
|
+
import type { CourseReviewInfoResponse } from '../models/CourseReviewInfoResponse';
|
|
41
|
+
import type { CourseSkillPointInfoRequest } from '../models/CourseSkillPointInfoRequest';
|
|
42
|
+
import type { CourseSkillPointInfoResponse } from '../models/CourseSkillPointInfoResponse';
|
|
43
|
+
import type { CourseSuggestionBulkCreate } from '../models/CourseSuggestionBulkCreate';
|
|
44
|
+
import type { CourseSuggestionCreate } from '../models/CourseSuggestionCreate';
|
|
45
|
+
import type { CourseSuggestionDetail } from '../models/CourseSuggestionDetail';
|
|
46
|
+
import type { DesiredRole } from '../models/DesiredRole';
|
|
47
|
+
import type { DesiredRoleCreateUpdateRequest } from '../models/DesiredRoleCreateUpdateRequest';
|
|
48
|
+
import type { DesiredSkill } from '../models/DesiredSkill';
|
|
49
|
+
import type { DesiredSkillCreateUpdateRequest } from '../models/DesiredSkillCreateUpdateRequest';
|
|
50
|
+
import type { PaginatedCourseAccessRequest } from '../models/PaginatedCourseAccessRequest';
|
|
51
|
+
import type { PaginatedCourseGroupSuggestion } from '../models/PaginatedCourseGroupSuggestion';
|
|
52
|
+
import type { PaginatedCourseInvitation } from '../models/PaginatedCourseInvitation';
|
|
53
|
+
import type { PaginatedCourseLicense } from '../models/PaginatedCourseLicense';
|
|
54
|
+
import type { PaginatedCourseLicenseAssignment } from '../models/PaginatedCourseLicenseAssignment';
|
|
55
|
+
import type { PaginatedCourseLicenseGroupAssignment } from '../models/PaginatedCourseLicenseGroupAssignment';
|
|
56
|
+
import type { PaginatedCourseSuggestion } from '../models/PaginatedCourseSuggestion';
|
|
57
|
+
import type { PaginatedPathwayGroupSuggestion } from '../models/PaginatedPathwayGroupSuggestion';
|
|
58
|
+
import type { PaginatedPathwaySuggestion } from '../models/PaginatedPathwaySuggestion';
|
|
59
|
+
import type { PaginatedPlatformInvitation } from '../models/PaginatedPlatformInvitation';
|
|
60
|
+
import type { PaginatedPlatformLicense } from '../models/PaginatedPlatformLicense';
|
|
61
|
+
import type { PaginatedProgramGroupSuggestion } from '../models/PaginatedProgramGroupSuggestion';
|
|
62
|
+
import type { PaginatedProgramInvitation } from '../models/PaginatedProgramInvitation';
|
|
63
|
+
import type { PaginatedProgramLicense } from '../models/PaginatedProgramLicense';
|
|
64
|
+
import type { PaginatedProgramLicenseAssignment } from '../models/PaginatedProgramLicenseAssignment';
|
|
65
|
+
import type { PaginatedProgramLicenseGroupAssignment } from '../models/PaginatedProgramLicenseGroupAssignment';
|
|
66
|
+
import type { PaginatedProgramSuggestion } from '../models/PaginatedProgramSuggestion';
|
|
67
|
+
import type { PaginatedUserLicense } from '../models/PaginatedUserLicense';
|
|
68
|
+
import type { PaginatedUserLicenseAssignment } from '../models/PaginatedUserLicenseAssignment';
|
|
69
|
+
import type { PaginatedUserLicenseGroupAssignment } from '../models/PaginatedUserLicenseGroupAssignment';
|
|
70
|
+
import type { Pathway } from '../models/Pathway';
|
|
71
|
+
import type { PathwayCompletionResponse } from '../models/PathwayCompletionResponse';
|
|
72
|
+
import type { PathwayCreateUpdateRequest } from '../models/PathwayCreateUpdateRequest';
|
|
73
|
+
import type { PathwayDeleteResponse } from '../models/PathwayDeleteResponse';
|
|
74
|
+
import type { PathwayEnrollment } from '../models/PathwayEnrollment';
|
|
75
|
+
import type { PathwayEnrollmentPlus } from '../models/PathwayEnrollmentPlus';
|
|
76
|
+
import type { PathwayEnrollmentRequest } from '../models/PathwayEnrollmentRequest';
|
|
77
|
+
import type { PathwayGroupSuggestionCreate } from '../models/PathwayGroupSuggestionCreate';
|
|
78
|
+
import type { PathwayGroupSuggestionDetail } from '../models/PathwayGroupSuggestionDetail';
|
|
79
|
+
import type { PathwaySelfEnrollmentRequest } from '../models/PathwaySelfEnrollmentRequest';
|
|
80
|
+
import type { PathwaySuggestionBulkCreate } from '../models/PathwaySuggestionBulkCreate';
|
|
81
|
+
import type { PathwaySuggestionCreate } from '../models/PathwaySuggestionCreate';
|
|
82
|
+
import type { PathwaySuggestionDetail } from '../models/PathwaySuggestionDetail';
|
|
83
|
+
import type { PlatformInvitationCreate } from '../models/PlatformInvitationCreate';
|
|
84
|
+
import type { PlatformInvitationDetail } from '../models/PlatformInvitationDetail';
|
|
85
|
+
import type { PlatformInvitationRedemption } from '../models/PlatformInvitationRedemption';
|
|
86
|
+
import type { PlatformLicenseCreate } from '../models/PlatformLicenseCreate';
|
|
87
|
+
import type { PlatformLicenseDetail } from '../models/PlatformLicenseDetail';
|
|
88
|
+
import type { PlatformLicenseUpdate } from '../models/PlatformLicenseUpdate';
|
|
89
|
+
import type { PlatformSkillPointBulkRequest } from '../models/PlatformSkillPointBulkRequest';
|
|
90
|
+
import type { PlatformSkillPointBulkResponse } from '../models/PlatformSkillPointBulkResponse';
|
|
91
|
+
import type { PlatformSkillPointGroupRequest } from '../models/PlatformSkillPointGroupRequest';
|
|
92
|
+
import type { PlatformSkillPointRequest } from '../models/PlatformSkillPointRequest';
|
|
93
|
+
import type { PlatformSkillPointResponse } from '../models/PlatformSkillPointResponse';
|
|
94
|
+
import type { Program } from '../models/Program';
|
|
95
|
+
import type { ProgramCompletionResponse } from '../models/ProgramCompletionResponse';
|
|
96
|
+
import type { ProgramCreateUpdateRequest } from '../models/ProgramCreateUpdateRequest';
|
|
97
|
+
import type { ProgramDeleteResponse } from '../models/ProgramDeleteResponse';
|
|
98
|
+
import type { ProgramEnrollment } from '../models/ProgramEnrollment';
|
|
99
|
+
import type { ProgramEnrollmentPlus } from '../models/ProgramEnrollmentPlus';
|
|
100
|
+
import type { ProgramGroupSuggestionCreate } from '../models/ProgramGroupSuggestionCreate';
|
|
101
|
+
import type { ProgramGroupSuggestionDetail } from '../models/ProgramGroupSuggestionDetail';
|
|
102
|
+
import type { ProgramInvitationCreate } from '../models/ProgramInvitationCreate';
|
|
103
|
+
import type { ProgramInvitationDetail } from '../models/ProgramInvitationDetail';
|
|
104
|
+
import type { ProgramInvitationRedemption } from '../models/ProgramInvitationRedemption';
|
|
105
|
+
import type { ProgramLicenseAssignmentCreate } from '../models/ProgramLicenseAssignmentCreate';
|
|
106
|
+
import type { ProgramLicenseAssignmentDetail } from '../models/ProgramLicenseAssignmentDetail';
|
|
107
|
+
import type { ProgramLicenseCreateDetail } from '../models/ProgramLicenseCreateDetail';
|
|
108
|
+
import type { ProgramLicenseDetail } from '../models/ProgramLicenseDetail';
|
|
109
|
+
import type { ProgramLicenseGroupAssignmentCreate } from '../models/ProgramLicenseGroupAssignmentCreate';
|
|
110
|
+
import type { ProgramLicenseGroupAssignmentDetail } from '../models/ProgramLicenseGroupAssignmentDetail';
|
|
111
|
+
import type { ProgramLicenseUpdateDetail } from '../models/ProgramLicenseUpdateDetail';
|
|
112
|
+
import type { ProgramReviewInfoResponse } from '../models/ProgramReviewInfoResponse';
|
|
113
|
+
import type { ProgramSearch } from '../models/ProgramSearch';
|
|
114
|
+
import type { ProgramSuggestionBulkCreate } from '../models/ProgramSuggestionBulkCreate';
|
|
115
|
+
import type { ProgramSuggestionCreate } from '../models/ProgramSuggestionCreate';
|
|
116
|
+
import type { ProgramSuggestionDetail } from '../models/ProgramSuggestionDetail';
|
|
117
|
+
import type { ReportedRole } from '../models/ReportedRole';
|
|
118
|
+
import type { ReportedRoleCreateUpdateRequest } from '../models/ReportedRoleCreateUpdateRequest';
|
|
119
|
+
import type { ReportedSkill } from '../models/ReportedSkill';
|
|
120
|
+
import type { Resource } from '../models/Resource';
|
|
121
|
+
import type { ResourceCompletion } from '../models/ResourceCompletion';
|
|
122
|
+
import type { ResourceCompletionRequest } from '../models/ResourceCompletionRequest';
|
|
123
|
+
import type { ResourceCreateUpdate } from '../models/ResourceCreateUpdate';
|
|
124
|
+
import type { ResourceDeleteResponse } from '../models/ResourceDeleteResponse';
|
|
125
|
+
import type { Role } from '../models/Role';
|
|
126
|
+
import type { RoleCreateUpdateRequest } from '../models/RoleCreateUpdateRequest';
|
|
127
|
+
import type { Skill } from '../models/Skill';
|
|
128
|
+
import type { SkillCreateUpdateRequest } from '../models/SkillCreateUpdateRequest';
|
|
129
|
+
import type { UserLicenseAssignmentCreate } from '../models/UserLicenseAssignmentCreate';
|
|
130
|
+
import type { UserLicenseAssignmentDetail } from '../models/UserLicenseAssignmentDetail';
|
|
131
|
+
import type { UserLicenseCreate } from '../models/UserLicenseCreate';
|
|
132
|
+
import type { UserLicenseDetail } from '../models/UserLicenseDetail';
|
|
133
|
+
import type { UserLicenseGroupAssignmentCreate } from '../models/UserLicenseGroupAssignmentCreate';
|
|
134
|
+
import type { UserLicenseGroupAssignmentDetail } from '../models/UserLicenseGroupAssignmentDetail';
|
|
135
|
+
import type { UserLicenseUpdate } from '../models/UserLicenseUpdate';
|
|
136
|
+
import type { UserSkillPointInfoResponse } from '../models/UserSkillPointInfoResponse';
|
|
137
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
138
|
+
export declare class CatalogService {
|
|
139
|
+
/**
|
|
140
|
+
* Retrieve a paginated list of access requests
|
|
141
|
+
* @param page Page number for pagination
|
|
142
|
+
* @param pageSize Number of results per page
|
|
143
|
+
* @param platformKey The unique identifier for the platform
|
|
144
|
+
* @param platformOrg The organization identifier for the platform
|
|
145
|
+
* @param reviewed Filter by reviewed status
|
|
146
|
+
* @param sort Field to sort results by
|
|
147
|
+
* @returns PaginatedCourseAccessRequest
|
|
148
|
+
* @throws ApiError
|
|
149
|
+
*/
|
|
150
|
+
static catalogAccessRequestsCourseManageRetrieve(page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, reviewed?: boolean, sort?: string): CancelablePromise<PaginatedCourseAccessRequest>;
|
|
151
|
+
/**
|
|
152
|
+
* Update an existing access request (approve/reject)
|
|
153
|
+
* @param requestBody
|
|
154
|
+
* @param page Page number for pagination
|
|
155
|
+
* @param pageSize Number of results per page
|
|
156
|
+
* @param platformKey The unique identifier for the platform
|
|
157
|
+
* @param platformOrg The organization identifier for the platform
|
|
158
|
+
* @param reviewed Filter by reviewed status
|
|
159
|
+
* @param sort Field to sort results by
|
|
160
|
+
* @returns CourseAccessRequestDetail
|
|
161
|
+
* @throws ApiError
|
|
162
|
+
*/
|
|
163
|
+
static catalogAccessRequestsCourseManageCreate(requestBody: CourseAccessRequestUpdate, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, reviewed?: boolean, sort?: string): CancelablePromise<CourseAccessRequestDetail>;
|
|
164
|
+
/**
|
|
165
|
+
* Check if the user has an active access request for a course
|
|
166
|
+
* @param courseId The unique identifier for the course
|
|
167
|
+
* @param platformKey The unique identifier for the platform
|
|
168
|
+
* @param platformOrg The organization identifier for the platform
|
|
169
|
+
* @returns CourseAccessRequestStatusResponse
|
|
170
|
+
* @throws ApiError
|
|
171
|
+
*/
|
|
172
|
+
static catalogAccessRequestsCourseRequestRetrieve(courseId: string, platformKey?: string, platformOrg?: string): CancelablePromise<CourseAccessRequestStatusResponse>;
|
|
173
|
+
/**
|
|
174
|
+
* Create a new access request for a course
|
|
175
|
+
* @param courseId The unique identifier for the course
|
|
176
|
+
* @param requestBody
|
|
177
|
+
* @param platformKey The unique identifier for the platform
|
|
178
|
+
* @param platformOrg The organization identifier for the platform
|
|
179
|
+
* @returns CourseAccessRequestDetail
|
|
180
|
+
* @throws ApiError
|
|
181
|
+
*/
|
|
182
|
+
static catalogAccessRequestsCourseRequestCreate(courseId: string, requestBody: CourseAccessRequestCreate, platformKey?: string, platformOrg?: string): CancelablePromise<CourseAccessRequestDetail>;
|
|
183
|
+
/**
|
|
184
|
+
* GET
|
|
185
|
+
* Retrieve prerequisite eligibility info for user/course
|
|
186
|
+
*
|
|
187
|
+
* Params:
|
|
188
|
+
* user_id/username
|
|
189
|
+
* course_id
|
|
190
|
+
* @returns any No response body
|
|
191
|
+
* @throws ApiError
|
|
192
|
+
*/
|
|
193
|
+
static catalogConditionalsCourseEligibilityRetrieve(): CancelablePromise<any>;
|
|
194
|
+
/**
|
|
195
|
+
* GET
|
|
196
|
+
* Retrieve prerequisite info for course
|
|
197
|
+
*
|
|
198
|
+
* Params:
|
|
199
|
+
* course_id
|
|
200
|
+
*
|
|
201
|
+
* key_only
|
|
202
|
+
* @returns any No response body
|
|
203
|
+
* @throws ApiError
|
|
204
|
+
*/
|
|
205
|
+
static catalogConditionalsCoursePrerequisitesManageRetrieve(): CancelablePromise<any>;
|
|
206
|
+
/**
|
|
207
|
+
* Prerequisite bulk management view
|
|
208
|
+
*
|
|
209
|
+
* Params:
|
|
210
|
+
* course_id
|
|
211
|
+
*
|
|
212
|
+
* rules
|
|
213
|
+
* key_only
|
|
214
|
+
* @returns any No response body
|
|
215
|
+
* @throws ApiError
|
|
216
|
+
*/
|
|
217
|
+
static catalogConditionalsCoursePrerequisitesManageBulkCreate(): CancelablePromise<any>;
|
|
218
|
+
/**
|
|
219
|
+
* Retrieve courses matching specified filters.
|
|
220
|
+
* @param courseId Filter courses by their unique identifier
|
|
221
|
+
* @param org Filter courses by their associated organization
|
|
222
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
223
|
+
* @returns Course
|
|
224
|
+
* @throws ApiError
|
|
225
|
+
*/
|
|
226
|
+
static catalogCoursesList(courseId?: string, org?: string, slug?: string): CancelablePromise<Array<Course>>;
|
|
227
|
+
/**
|
|
228
|
+
* Add or update a course in the database.
|
|
229
|
+
* @param requestBody
|
|
230
|
+
* @param courseId Filter courses by their unique identifier
|
|
231
|
+
* @param org Filter courses by their associated organization
|
|
232
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
233
|
+
* @returns Course
|
|
234
|
+
* @throws ApiError
|
|
235
|
+
*/
|
|
236
|
+
static catalogCoursesCreate(requestBody: CourseCreateUpdate, courseId?: string, org?: string, slug?: string): CancelablePromise<Course>;
|
|
237
|
+
/**
|
|
238
|
+
* Remove a course from the database.
|
|
239
|
+
* @param courseId Filter courses by their unique identifier
|
|
240
|
+
* @param org Filter courses by their associated organization
|
|
241
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
242
|
+
* @returns CourseDeleteResponse
|
|
243
|
+
* @throws ApiError
|
|
244
|
+
*/
|
|
245
|
+
static catalogCoursesDestroy(courseId?: string, org?: string, slug?: string): CancelablePromise<CourseDeleteResponse>;
|
|
246
|
+
/**
|
|
247
|
+
* List courses that a user is eligible for.
|
|
248
|
+
* @param org Filter eligible courses by organization
|
|
249
|
+
* @param query Search term to filter eligible courses
|
|
250
|
+
* @param userId User ID to check eligibility for
|
|
251
|
+
* @param username Username to check eligibility for
|
|
252
|
+
* @returns Course
|
|
253
|
+
* @throws ApiError
|
|
254
|
+
*/
|
|
255
|
+
static catalogEligibilityCoursesList(org?: string, query?: string, userId?: string, username?: string): CancelablePromise<Array<Course>>;
|
|
256
|
+
/**
|
|
257
|
+
* Check whether a user is eligible to enroll in a specific course.
|
|
258
|
+
* @param courseId Course ID to check eligibility for
|
|
259
|
+
* @param localOnly Whether to check eligibility only within the local organization
|
|
260
|
+
* @param org Organization of the course
|
|
261
|
+
* @param userId User ID to check eligibility for
|
|
262
|
+
* @param username Username to check eligibility for
|
|
263
|
+
* @returns CourseEligibilityCheckResponse
|
|
264
|
+
* @throws ApiError
|
|
265
|
+
*/
|
|
266
|
+
static catalogEligibilityCoursesCheckRetrieve(courseId: string, localOnly?: boolean, org?: string, userId?: string, username?: string): CancelablePromise<CourseEligibilityCheckResponse>;
|
|
267
|
+
/**
|
|
268
|
+
* API View for searching course enrollments.
|
|
269
|
+
*
|
|
270
|
+
* This endpoint allows searching for course enrollments based on various filters such as user ID,
|
|
271
|
+
* username, email, course ID, slug, organization, and platform key. Results are paginated and
|
|
272
|
+
* include detailed enrollment information.
|
|
273
|
+
*
|
|
274
|
+
* Query Parameters:
|
|
275
|
+
* user_id (str, optional): Filter enrollments by user ID
|
|
276
|
+
* username (str, optional): Filter enrollments by username
|
|
277
|
+
* email (str, optional): Filter enrollments by user email
|
|
278
|
+
* course_id (str, optional): Filter enrollments by course ID
|
|
279
|
+
* slug (str, optional): Filter enrollments by course slug
|
|
280
|
+
* org (str, optional): Filter enrollments by organization
|
|
281
|
+
* platform_key (str, optional): Filter enrollments by platform key
|
|
282
|
+
* course_name (str, optional): Filter enrollments by course name (partial match)
|
|
283
|
+
* include_default_platform (bool, optional): Include enrollments from default platform
|
|
284
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
285
|
+
* page (int, optional): Page number for pagination
|
|
286
|
+
* page_size (int, optional): Number of items per page
|
|
287
|
+
*
|
|
288
|
+
* Methods:
|
|
289
|
+
* GET: Search for course enrollments with filtering and pagination
|
|
290
|
+
*
|
|
291
|
+
* Returns:
|
|
292
|
+
* GET: A paginated JSON response containing course enrollments:
|
|
293
|
+
* {
|
|
294
|
+
* "count": 42,
|
|
295
|
+
* "next": "https://api.example.com/api/catalog/enrollment/courses/search/?page=2",
|
|
296
|
+
* "previous": null,
|
|
297
|
+
* "results": [
|
|
298
|
+
* {
|
|
299
|
+
* "user_id": 123,
|
|
300
|
+
* "username": "student1",
|
|
301
|
+
* "email": "student1@example.com",
|
|
302
|
+
* "course_id": "course-v1:org+course+run",
|
|
303
|
+
* "active": true,
|
|
304
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
305
|
+
* "started": "2023-01-15T10:30:00Z",
|
|
306
|
+
* "ended": null,
|
|
307
|
+
* "expired": null,
|
|
308
|
+
* "metadata": {},
|
|
309
|
+
* "name": "John Doe",
|
|
310
|
+
* "course_name": "Introduction to Data Science"
|
|
311
|
+
* },
|
|
312
|
+
* ...
|
|
313
|
+
* ]
|
|
314
|
+
* }
|
|
315
|
+
*
|
|
316
|
+
* Error Responses:
|
|
317
|
+
* 400 Bad Request: If required parameters are missing or if enrollment search fails
|
|
318
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
319
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
320
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
321
|
+
*
|
|
322
|
+
* Access Control:
|
|
323
|
+
* - Requires IsDMAdmin, IsEdxUserReadOnly, or IsPlatformAdminOfUserReadOnly permission
|
|
324
|
+
* - Users can view their own enrollments
|
|
325
|
+
* - Platform admins can view enrollments for users in their platform
|
|
326
|
+
* - DM admins can view all enrollments
|
|
327
|
+
* @param courseId Filter enrollments by course ID
|
|
328
|
+
* @param courseName Filter enrollments by course name (partial match)
|
|
329
|
+
* @param email Filter enrollments by user email
|
|
330
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
331
|
+
* @param org Filter enrollments by organization
|
|
332
|
+
* @param page Page number for pagination
|
|
333
|
+
* @param pageSize Number of items per page
|
|
334
|
+
* @param platformKey Filter enrollments by platform key
|
|
335
|
+
* @param slug Filter enrollments by course slug
|
|
336
|
+
* @param sort Field to sort results by
|
|
337
|
+
* @param userId Filter enrollments by user ID
|
|
338
|
+
* @param username Filter enrollments by username
|
|
339
|
+
* @returns CourseEnrollmentSearchResponse
|
|
340
|
+
* @throws ApiError
|
|
341
|
+
*/
|
|
342
|
+
static catalogEnrollmentCoursesSearchRetrieve(courseId?: string, courseName?: string, email?: string, includeDefaultPlatform?: boolean, org?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string, userId?: string, username?: string): CancelablePromise<CourseEnrollmentSearchResponse>;
|
|
343
|
+
/**
|
|
344
|
+
* Search pathway enrollments. Requires user_id or username and pathway_id or slug.
|
|
345
|
+
* @param active Whether the enrollment should be active
|
|
346
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
347
|
+
* @param includeMetadata Include metadata in the response
|
|
348
|
+
* @param org Organization for the pathway
|
|
349
|
+
* @param pathwayId Pathway ID for enrollment
|
|
350
|
+
* @param pathwayKey Pathway key for enrollment
|
|
351
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
352
|
+
* @param platformKey Platform key for the pathway
|
|
353
|
+
* @param slug Pathway slug for enrollment
|
|
354
|
+
* @param userId User ID for enrollment
|
|
355
|
+
* @param username Username for enrollment
|
|
356
|
+
* @returns PathwayEnrollmentPlus
|
|
357
|
+
* @throws ApiError
|
|
358
|
+
*/
|
|
359
|
+
static catalogEnrollmentPathwaysRetrieve(active?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, pathwayUuid?: string, platformKey?: string, slug?: string, userId?: string, username?: string): CancelablePromise<PathwayEnrollmentPlus>;
|
|
360
|
+
/**
|
|
361
|
+
* Log user enrollment with a pathway.
|
|
362
|
+
* @param active Whether the enrollment should be active
|
|
363
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
364
|
+
* @param includeMetadata Include metadata in the response
|
|
365
|
+
* @param org Organization for the pathway
|
|
366
|
+
* @param pathwayId Pathway ID for enrollment
|
|
367
|
+
* @param pathwayKey Pathway key for enrollment
|
|
368
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
369
|
+
* @param platformKey Platform key for the pathway
|
|
370
|
+
* @param slug Pathway slug for enrollment
|
|
371
|
+
* @param userId User ID for enrollment
|
|
372
|
+
* @param username Username for enrollment
|
|
373
|
+
* @param requestBody
|
|
374
|
+
* @returns PathwayEnrollment
|
|
375
|
+
* @throws ApiError
|
|
376
|
+
*/
|
|
377
|
+
static catalogEnrollmentPathwaysCreate(active?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, pathwayUuid?: string, platformKey?: string, slug?: string, userId?: string, username?: string, requestBody?: PathwayEnrollmentRequest): CancelablePromise<PathwayEnrollment>;
|
|
378
|
+
/**
|
|
379
|
+
* Unenroll from a pathway. Deactivates enrollment.
|
|
380
|
+
* @param active Whether the enrollment should be active
|
|
381
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
382
|
+
* @param includeMetadata Include metadata in the response
|
|
383
|
+
* @param org Organization for the pathway
|
|
384
|
+
* @param pathwayId Pathway ID for enrollment
|
|
385
|
+
* @param pathwayKey Pathway key for enrollment
|
|
386
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
387
|
+
* @param platformKey Platform key for the pathway
|
|
388
|
+
* @param slug Pathway slug for enrollment
|
|
389
|
+
* @param userId User ID for enrollment
|
|
390
|
+
* @param username Username for enrollment
|
|
391
|
+
* @returns PathwayEnrollment
|
|
392
|
+
* @throws ApiError
|
|
393
|
+
*/
|
|
394
|
+
static catalogEnrollmentPathwaysDestroy(active?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, pathwayUuid?: string, platformKey?: string, slug?: string, userId?: string, username?: string): CancelablePromise<PathwayEnrollment>;
|
|
395
|
+
/**
|
|
396
|
+
* Search pathway enrollments based on user or pathway identifiers. Returns paginated enrollment results.
|
|
397
|
+
* @returns PathwayEnrollmentPlus
|
|
398
|
+
* @throws ApiError
|
|
399
|
+
*/
|
|
400
|
+
static catalogEnrollmentPathwaysSearchRetrieve(): CancelablePromise<PathwayEnrollmentPlus>;
|
|
401
|
+
/**
|
|
402
|
+
* Log user enrollment with a pathway.
|
|
403
|
+
* @param active Whether the enrollment should be active
|
|
404
|
+
* @param org Organization for the pathway
|
|
405
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
406
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
407
|
+
* @param platformKey Platform key for the pathway
|
|
408
|
+
* @param slug Pathway slug for self-enrollment
|
|
409
|
+
* @param userId User ID for self-enrollment
|
|
410
|
+
* @param username Username for self-enrollment
|
|
411
|
+
* @param requestBody
|
|
412
|
+
* @returns PathwayEnrollment
|
|
413
|
+
* @throws ApiError
|
|
414
|
+
*/
|
|
415
|
+
static catalogEnrollmentPathwaysSelfCreate(active?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, platformKey?: string, slug?: string, userId?: string, username?: string, requestBody?: PathwaySelfEnrollmentRequest): CancelablePromise<PathwayEnrollment>;
|
|
416
|
+
/**
|
|
417
|
+
* Unenroll from a pathway. Deactivates enrollment.
|
|
418
|
+
* @param active Whether the enrollment should be active
|
|
419
|
+
* @param org Organization for the pathway
|
|
420
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
421
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
422
|
+
* @param platformKey Platform key for the pathway
|
|
423
|
+
* @param slug Pathway slug for self-enrollment
|
|
424
|
+
* @param userId User ID for self-enrollment
|
|
425
|
+
* @param username Username for self-enrollment
|
|
426
|
+
* @returns PathwayEnrollment
|
|
427
|
+
* @throws ApiError
|
|
428
|
+
*/
|
|
429
|
+
static catalogEnrollmentPathwaysSelfDestroy(active?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, platformKey?: string, slug?: string, userId?: string, username?: string): CancelablePromise<PathwayEnrollment>;
|
|
430
|
+
/**
|
|
431
|
+
* Search program enrollments. Requires user_id or username and program_id or slug.
|
|
432
|
+
* @param active Whether the enrollment should be active
|
|
433
|
+
* @param expired Date when enrollment expires
|
|
434
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
435
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
436
|
+
* @param includeMetadata Include metadata in the response
|
|
437
|
+
* @param org Organization for the program
|
|
438
|
+
* @param platformKey Platform key for the program
|
|
439
|
+
* @param programId Program ID for enrollment
|
|
440
|
+
* @param programKey Program key for enrollment
|
|
441
|
+
* @param programType Program type (standard, platform, custom)
|
|
442
|
+
* @param slug Program slug for enrollment
|
|
443
|
+
* @param started Date when enrollment started
|
|
444
|
+
* @param userId User ID for enrollment
|
|
445
|
+
* @param username Username for enrollment
|
|
446
|
+
* @returns ProgramEnrollmentPlus
|
|
447
|
+
* @throws ApiError
|
|
448
|
+
*/
|
|
449
|
+
static catalogEnrollmentProgramsRetrieve(active?: boolean, expired?: string, ignoreExpiration?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, platformKey?: string, programId?: string, programKey?: string, programType?: string, slug?: string, started?: string, userId?: string, username?: string): CancelablePromise<ProgramEnrollmentPlus>;
|
|
450
|
+
/**
|
|
451
|
+
* Log user enrollment with a program.
|
|
452
|
+
* @param active Whether the enrollment should be active
|
|
453
|
+
* @param expired Date when enrollment expires
|
|
454
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
455
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
456
|
+
* @param includeMetadata Include metadata in the response
|
|
457
|
+
* @param org Organization for the program
|
|
458
|
+
* @param platformKey Platform key for the program
|
|
459
|
+
* @param programId Program ID for enrollment
|
|
460
|
+
* @param programKey Program key for enrollment
|
|
461
|
+
* @param programType Program type (standard, platform, custom)
|
|
462
|
+
* @param slug Program slug for enrollment
|
|
463
|
+
* @param started Date when enrollment started
|
|
464
|
+
* @param userId User ID for enrollment
|
|
465
|
+
* @param username Username for enrollment
|
|
466
|
+
* @param requestBody
|
|
467
|
+
* @returns ProgramEnrollment
|
|
468
|
+
* @throws ApiError
|
|
469
|
+
*/
|
|
470
|
+
static catalogEnrollmentProgramsCreate(active?: boolean, expired?: string, ignoreExpiration?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, platformKey?: string, programId?: string, programKey?: string, programType?: string, slug?: string, started?: string, userId?: string, username?: string, requestBody?: ProgramEnrollmentPlus): CancelablePromise<ProgramEnrollment>;
|
|
471
|
+
/**
|
|
472
|
+
* Unenroll from a program. Deactivates enrollment.
|
|
473
|
+
* @param active Whether the enrollment should be active
|
|
474
|
+
* @param expired Date when enrollment expires
|
|
475
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
476
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
477
|
+
* @param includeMetadata Include metadata in the response
|
|
478
|
+
* @param org Organization for the program
|
|
479
|
+
* @param platformKey Platform key for the program
|
|
480
|
+
* @param programId Program ID for enrollment
|
|
481
|
+
* @param programKey Program key for enrollment
|
|
482
|
+
* @param programType Program type (standard, platform, custom)
|
|
483
|
+
* @param slug Program slug for enrollment
|
|
484
|
+
* @param started Date when enrollment started
|
|
485
|
+
* @param userId User ID for enrollment
|
|
486
|
+
* @param username Username for enrollment
|
|
487
|
+
* @returns ProgramEnrollment
|
|
488
|
+
* @throws ApiError
|
|
489
|
+
*/
|
|
490
|
+
static catalogEnrollmentProgramsDestroy(active?: boolean, expired?: string, ignoreExpiration?: boolean, includeDefaultPlatform?: boolean, includeMetadata?: boolean, org?: string, platformKey?: string, programId?: string, programKey?: string, programType?: string, slug?: string, started?: string, userId?: string, username?: string): CancelablePromise<ProgramEnrollment>;
|
|
491
|
+
/**
|
|
492
|
+
* Search program enrollments based on user or program identifiers. Returns paginated enrollment results.
|
|
493
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
494
|
+
* @param org Filter enrollments by organization
|
|
495
|
+
* @param page Page number for pagination
|
|
496
|
+
* @param pageSize Number of items per page
|
|
497
|
+
* @param platformKey Filter enrollments by platform key
|
|
498
|
+
* @param programId Filter enrollments by program ID
|
|
499
|
+
* @param programType Filter by program type (standard, platform, custom)
|
|
500
|
+
* @param slug Filter enrollments by program slug
|
|
501
|
+
* @param sort Field to sort results by
|
|
502
|
+
* @param userId Filter enrollments by user ID
|
|
503
|
+
* @param username Filter enrollments by username
|
|
504
|
+
* @returns ProgramEnrollmentPlus
|
|
505
|
+
* @throws ApiError
|
|
506
|
+
*/
|
|
507
|
+
static catalogEnrollmentProgramsSearchRetrieve(includeDefaultPlatform?: boolean, org?: string, page?: number, pageSize?: number, platformKey?: string, programId?: string, programType?: string, slug?: string, sort?: string, userId?: string, username?: string): CancelablePromise<ProgramEnrollmentPlus>;
|
|
508
|
+
/**
|
|
509
|
+
* Log user enrollment with a program.
|
|
510
|
+
* @param active Whether the enrollment should be active
|
|
511
|
+
* @param expired Date when enrollment expires
|
|
512
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
513
|
+
* @param org Organization for the program
|
|
514
|
+
* @param platformKey Platform key for the program
|
|
515
|
+
* @param programId Program ID for self-enrollment
|
|
516
|
+
* @param programKey Program key for self-enrollment
|
|
517
|
+
* @param slug Program slug for self-enrollment
|
|
518
|
+
* @param started Date when enrollment started
|
|
519
|
+
* @param userId User ID for self-enrollment
|
|
520
|
+
* @param username Username for self-enrollment
|
|
521
|
+
* @param requestBody
|
|
522
|
+
* @returns ProgramEnrollment
|
|
523
|
+
* @throws ApiError
|
|
524
|
+
*/
|
|
525
|
+
static catalogEnrollmentProgramsSelfCreate(active?: boolean, expired?: string, ignoreExpiration?: boolean, org?: string, platformKey?: string, programId?: string, programKey?: string, slug?: string, started?: string, userId?: string, username?: string, requestBody?: ProgramEnrollment): CancelablePromise<ProgramEnrollment>;
|
|
526
|
+
/**
|
|
527
|
+
* Unenroll from a program. Deactivates enrollment.
|
|
528
|
+
* @param active Whether the enrollment should be active
|
|
529
|
+
* @param expired Date when enrollment expires
|
|
530
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
531
|
+
* @param org Organization for the program
|
|
532
|
+
* @param platformKey Platform key for the program
|
|
533
|
+
* @param programId Program ID for self-enrollment
|
|
534
|
+
* @param programKey Program key for self-enrollment
|
|
535
|
+
* @param slug Program slug for self-enrollment
|
|
536
|
+
* @param started Date when enrollment started
|
|
537
|
+
* @param userId User ID for self-enrollment
|
|
538
|
+
* @param username Username for self-enrollment
|
|
539
|
+
* @returns void
|
|
540
|
+
* @throws ApiError
|
|
541
|
+
*/
|
|
542
|
+
static catalogEnrollmentProgramsSelfDestroy(active?: boolean, expired?: string, ignoreExpiration?: boolean, org?: string, platformKey?: string, programId?: string, programKey?: string, slug?: string, started?: string, userId?: string, username?: string): CancelablePromise<void>;
|
|
543
|
+
/**
|
|
544
|
+
* Retrieve auto increment information for a specific platform.
|
|
545
|
+
* @returns CatalogAutoIncrementResponse
|
|
546
|
+
* @throws ApiError
|
|
547
|
+
*/
|
|
548
|
+
static catalogIncrementRetrieve(): CancelablePromise<CatalogAutoIncrementResponse>;
|
|
549
|
+
/**
|
|
550
|
+
* Update auto increment information and retrieve a new ID for a specific platform.
|
|
551
|
+
* @param requestBody
|
|
552
|
+
* @returns any
|
|
553
|
+
* @throws ApiError
|
|
554
|
+
*/
|
|
555
|
+
static catalogIncrementCreate(requestBody: CatalogAutoIncrementUpdateRequest): CancelablePromise<Record<string, any>>;
|
|
556
|
+
/**
|
|
557
|
+
* Retrieve a paginated list of course invitations
|
|
558
|
+
* @param active Filter by active status
|
|
559
|
+
* @param courseId Filter by course ID
|
|
560
|
+
* @param email Filter by user email
|
|
561
|
+
* @param key Alternative filter by platform key
|
|
562
|
+
* @param org Alternative filter by platform organization
|
|
563
|
+
* @param page Page number for pagination
|
|
564
|
+
* @param pageSize Number of results per page
|
|
565
|
+
* @param platformKey Filter by platform key
|
|
566
|
+
* @param platformOrg Filter by platform organization
|
|
567
|
+
* @param sort Field to sort results by
|
|
568
|
+
* @param source Filter by invitation source
|
|
569
|
+
* @param username Filter by username
|
|
570
|
+
* @param verbose Whether to include verbose output
|
|
571
|
+
* @returns PaginatedCourseInvitation
|
|
572
|
+
* @throws ApiError
|
|
573
|
+
*/
|
|
574
|
+
static catalogInvitationsCourseRetrieve(active?: boolean, courseId?: string, email?: string, key?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<PaginatedCourseInvitation>;
|
|
575
|
+
/**
|
|
576
|
+
* Create a new course invitation
|
|
577
|
+
* @param requestBody
|
|
578
|
+
* @param active Filter by active status
|
|
579
|
+
* @param courseId Filter by course ID
|
|
580
|
+
* @param email Filter by user email
|
|
581
|
+
* @param key Alternative filter by platform key
|
|
582
|
+
* @param org Alternative filter by platform organization
|
|
583
|
+
* @param page Page number for pagination
|
|
584
|
+
* @param pageSize Number of results per page
|
|
585
|
+
* @param platformKey Filter by platform key
|
|
586
|
+
* @param platformOrg Filter by platform organization
|
|
587
|
+
* @param sort Field to sort results by
|
|
588
|
+
* @param source Filter by invitation source
|
|
589
|
+
* @param username Filter by username
|
|
590
|
+
* @param verbose Whether to include verbose output
|
|
591
|
+
* @returns CourseInvitationDetail
|
|
592
|
+
* @throws ApiError
|
|
593
|
+
*/
|
|
594
|
+
static catalogInvitationsCourseCreate(requestBody: CourseInvitationCreate, active?: boolean, courseId?: string, email?: string, key?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<CourseInvitationDetail>;
|
|
595
|
+
/**
|
|
596
|
+
* Remove a course invitation: TBD
|
|
597
|
+
* @param active Filter by active status
|
|
598
|
+
* @param courseId Filter by course ID
|
|
599
|
+
* @param email Filter by user email
|
|
600
|
+
* @param key Alternative filter by platform key
|
|
601
|
+
* @param org Alternative filter by platform organization
|
|
602
|
+
* @param page Page number for pagination
|
|
603
|
+
* @param pageSize Number of results per page
|
|
604
|
+
* @param platformKey Filter by platform key
|
|
605
|
+
* @param platformOrg Filter by platform organization
|
|
606
|
+
* @param sort Field to sort results by
|
|
607
|
+
* @param source Filter by invitation source
|
|
608
|
+
* @param username Filter by username
|
|
609
|
+
* @param verbose Whether to include verbose output
|
|
610
|
+
* @returns any Invitation successfully deleted
|
|
611
|
+
* @throws ApiError
|
|
612
|
+
*/
|
|
613
|
+
static catalogInvitationsCourseDestroy(active?: boolean, courseId?: string, email?: string, key?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<any>;
|
|
614
|
+
/**
|
|
615
|
+
* Create multiple blank course invitations
|
|
616
|
+
* @param requestBody
|
|
617
|
+
* @returns BulkCourseInvitationResponse
|
|
618
|
+
* @throws ApiError
|
|
619
|
+
*/
|
|
620
|
+
static catalogInvitationsCourseBlankCreate(requestBody: BlankCourseInvitationCreate): CancelablePromise<BulkCourseInvitationResponse>;
|
|
621
|
+
/**
|
|
622
|
+
* Create multiple course invitations
|
|
623
|
+
* @param requestBody
|
|
624
|
+
* @returns BulkCourseInvitationResponse
|
|
625
|
+
* @throws ApiError
|
|
626
|
+
*/
|
|
627
|
+
static catalogInvitationsCourseBulkCreate(requestBody: BulkCourseInvitationCreate): CancelablePromise<BulkCourseInvitationResponse>;
|
|
628
|
+
/**
|
|
629
|
+
* Redeem a blank course invitation
|
|
630
|
+
* @param requestBody
|
|
631
|
+
* @returns CourseInvitationDetail
|
|
632
|
+
* @throws ApiError
|
|
633
|
+
*/
|
|
634
|
+
static catalogInvitationsCourseRedeemCreate(requestBody: CourseInvitationRedemption): CancelablePromise<CourseInvitationDetail>;
|
|
635
|
+
/**
|
|
636
|
+
* API View for managing platform invitations.
|
|
637
|
+
*
|
|
638
|
+
* This endpoint allows querying, creating, and deleting platform invitations for users.
|
|
639
|
+
*
|
|
640
|
+
* Query/Request Parameters:
|
|
641
|
+
* For GET:
|
|
642
|
+
* platform_key (str, optional): Filter by platform key
|
|
643
|
+
* org (str, optional): Filter by platform organization
|
|
644
|
+
* email (str, optional): Filter by user email
|
|
645
|
+
* source (str, optional): Filter by invitation source
|
|
646
|
+
* active (bool, optional): Filter by active status
|
|
647
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
648
|
+
* metadata fields: Any additional parameters will be treated as metadata filters
|
|
649
|
+
*
|
|
650
|
+
* For POST:
|
|
651
|
+
* platform_key (str, required): The platform to create an invitation for
|
|
652
|
+
* email (str, required): The email address to invite
|
|
653
|
+
* active (bool, optional): Whether the invitation is active
|
|
654
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
655
|
+
*
|
|
656
|
+
* For DELETE:
|
|
657
|
+
* id (int, required): The ID of the invitation to delete
|
|
658
|
+
* org (str, required): The platform organization for verification
|
|
659
|
+
*
|
|
660
|
+
* Methods:
|
|
661
|
+
* GET: Retrieve a paginated list of platform invitations
|
|
662
|
+
* POST: Create a new platform invitation
|
|
663
|
+
* DELETE: Remove a platform invitation
|
|
664
|
+
*
|
|
665
|
+
* Returns:
|
|
666
|
+
* GET: A paginated JSON response containing platform invitations:
|
|
667
|
+
* {
|
|
668
|
+
* "count": 10,
|
|
669
|
+
* "next": "https://example.com/api/catalog/invitations/platform/?page=2",
|
|
670
|
+
* "previous": null,
|
|
671
|
+
* "results": [
|
|
672
|
+
* {
|
|
673
|
+
* "id": 123,
|
|
674
|
+
* "user_id": 456,
|
|
675
|
+
* "username": "username",
|
|
676
|
+
* "email": "user@example.com",
|
|
677
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
678
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
679
|
+
* "source": "source",
|
|
680
|
+
* "redirect_to": "https://example.com",
|
|
681
|
+
* "expired": null,
|
|
682
|
+
* "active": true,
|
|
683
|
+
* "metadata": {},
|
|
684
|
+
* "platform_key": "platform1"
|
|
685
|
+
* },
|
|
686
|
+
* ...
|
|
687
|
+
* ]
|
|
688
|
+
* }
|
|
689
|
+
*
|
|
690
|
+
* POST: A JSON response containing the created invitation:
|
|
691
|
+
* {
|
|
692
|
+
* "id": 123,
|
|
693
|
+
* "user_id": 456,
|
|
694
|
+
* "username": "username",
|
|
695
|
+
* "email": "user@example.com",
|
|
696
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
697
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
698
|
+
* "source": "source",
|
|
699
|
+
* "redirect_to": "https://example.com",
|
|
700
|
+
* "expired": null,
|
|
701
|
+
* "active": true,
|
|
702
|
+
* "metadata": {},
|
|
703
|
+
* "platform_key": "platform1"
|
|
704
|
+
* }
|
|
705
|
+
*
|
|
706
|
+
* DELETE: A success response with status 200
|
|
707
|
+
*
|
|
708
|
+
* Error Responses:
|
|
709
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
710
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
711
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
712
|
+
* 404 Not Found: If the platform or invitation doesn't exist
|
|
713
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
714
|
+
*
|
|
715
|
+
* Access Control:
|
|
716
|
+
* - Requires IsDMAdmin or IsPlatformAdmin permission
|
|
717
|
+
* - Available to platform administrators and DM admins
|
|
718
|
+
* @param active Filter by active status
|
|
719
|
+
* @param email Filter by user email
|
|
720
|
+
* @param org Filter by platform organization
|
|
721
|
+
* @param page Page number for pagination
|
|
722
|
+
* @param pageSize Number of results per page
|
|
723
|
+
* @param platformKey Filter by platform key
|
|
724
|
+
* @param sort Field to sort results by
|
|
725
|
+
* @param source Filter by invitation source
|
|
726
|
+
* @param username Filter by username
|
|
727
|
+
* @param verbose Whether to include verbose output
|
|
728
|
+
* @returns PaginatedPlatformInvitation
|
|
729
|
+
* @throws ApiError
|
|
730
|
+
*/
|
|
731
|
+
static catalogInvitationsPlatformRetrieve(active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<PaginatedPlatformInvitation>;
|
|
732
|
+
/**
|
|
733
|
+
* Create a new platform invitation
|
|
734
|
+
* @param requestBody
|
|
735
|
+
* @param active Filter by active status
|
|
736
|
+
* @param email Filter by user email
|
|
737
|
+
* @param org Filter by platform organization
|
|
738
|
+
* @param page Page number for pagination
|
|
739
|
+
* @param pageSize Number of results per page
|
|
740
|
+
* @param platformKey Filter by platform key
|
|
741
|
+
* @param sort Field to sort results by
|
|
742
|
+
* @param source Filter by invitation source
|
|
743
|
+
* @param username Filter by username
|
|
744
|
+
* @param verbose Whether to include verbose output
|
|
745
|
+
* @returns PlatformInvitationDetail
|
|
746
|
+
* @throws ApiError
|
|
747
|
+
*/
|
|
748
|
+
static catalogInvitationsPlatformCreate(requestBody: PlatformInvitationCreate, active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<PlatformInvitationDetail>;
|
|
749
|
+
/**
|
|
750
|
+
* Remove a platform invitation: TBD
|
|
751
|
+
* @param active Filter by active status
|
|
752
|
+
* @param email Filter by user email
|
|
753
|
+
* @param org Filter by platform organization
|
|
754
|
+
* @param page Page number for pagination
|
|
755
|
+
* @param pageSize Number of results per page
|
|
756
|
+
* @param platformKey Filter by platform key
|
|
757
|
+
* @param sort Field to sort results by
|
|
758
|
+
* @param source Filter by invitation source
|
|
759
|
+
* @param username Filter by username
|
|
760
|
+
* @param verbose Whether to include verbose output
|
|
761
|
+
* @returns any Invitation successfully deleted
|
|
762
|
+
* @throws ApiError
|
|
763
|
+
*/
|
|
764
|
+
static catalogInvitationsPlatformDestroy(active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<any>;
|
|
765
|
+
/**
|
|
766
|
+
* Create multiple blank platform invitations
|
|
767
|
+
* @param requestBody
|
|
768
|
+
* @returns BulkPlatformInvitationResponse
|
|
769
|
+
* @throws ApiError
|
|
770
|
+
*/
|
|
771
|
+
static catalogInvitationsPlatformBlankCreate(requestBody: BlankPlatformInvitationCreate): CancelablePromise<BulkPlatformInvitationResponse>;
|
|
772
|
+
/**
|
|
773
|
+
* API View for bulk creating platform invitations.
|
|
774
|
+
*
|
|
775
|
+
* This endpoint allows creating multiple platform invitations in a single request.
|
|
776
|
+
*
|
|
777
|
+
* Request Parameters:
|
|
778
|
+
* invitation_data (list, required): List of invitation data objects, each containing:
|
|
779
|
+
* platform_key (str, required): The platform to create an invitation for
|
|
780
|
+
* email (str, required): The email address to invite
|
|
781
|
+
* active (bool, optional): Whether the invitation is active
|
|
782
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
783
|
+
* platform_key (str, required for platform admins): The platform key for permission validation
|
|
784
|
+
*
|
|
785
|
+
* Methods:
|
|
786
|
+
* POST: Create multiple platform invitations
|
|
787
|
+
*
|
|
788
|
+
* Returns:
|
|
789
|
+
* POST: A JSON response containing the creation results:
|
|
790
|
+
* {
|
|
791
|
+
* "successes": 5,
|
|
792
|
+
* "error_codes": []
|
|
793
|
+
* }
|
|
794
|
+
*
|
|
795
|
+
* Error Responses:
|
|
796
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
797
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
798
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
799
|
+
* 500 Internal Server Error: If an unexpected error occurs during creation
|
|
800
|
+
*
|
|
801
|
+
* Access Control:
|
|
802
|
+
* - Requires IsDMAdmin or IsPlatformAdmin permission
|
|
803
|
+
* - Available to platform administrators and DM admins
|
|
804
|
+
* @param requestBody
|
|
805
|
+
* @returns BulkPlatformInvitationResponse
|
|
806
|
+
* @throws ApiError
|
|
807
|
+
*/
|
|
808
|
+
static catalogInvitationsPlatformBulkCreate(requestBody: BulkPlatformInvitationCreate): CancelablePromise<BulkPlatformInvitationResponse>;
|
|
809
|
+
/**
|
|
810
|
+
* Check if a user has an active platform invitation
|
|
811
|
+
* @param email The email address to check for active invitations
|
|
812
|
+
* @returns any Active invitation exists for the email
|
|
813
|
+
* @throws ApiError
|
|
814
|
+
*/
|
|
815
|
+
static catalogInvitationsPlatformCheckRetrieve(email: string): CancelablePromise<any>;
|
|
816
|
+
/**
|
|
817
|
+
* Redeem a blank platform invitation
|
|
818
|
+
* @param requestBody
|
|
819
|
+
* @returns PlatformInvitationDetail
|
|
820
|
+
* @throws ApiError
|
|
821
|
+
*/
|
|
822
|
+
static catalogInvitationsPlatformRedeemCreate(requestBody: PlatformInvitationRedemption): CancelablePromise<PlatformInvitationDetail>;
|
|
823
|
+
/**
|
|
824
|
+
* API View for managing program invitations.
|
|
825
|
+
*
|
|
826
|
+
* This endpoint allows querying, creating, and deleting program invitations for users.
|
|
827
|
+
*
|
|
828
|
+
* Query/Request Parameters:
|
|
829
|
+
* For GET:
|
|
830
|
+
* program_key (str, optional): Filter by program key
|
|
831
|
+
* org (str, optional): Filter by platform organization
|
|
832
|
+
* email (str, optional): Filter by user email
|
|
833
|
+
* source (str, optional): Filter by invitation source
|
|
834
|
+
* active (bool, optional): Filter by active status
|
|
835
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
836
|
+
* metadata fields: Any additional parameters will be treated as metadata filters
|
|
837
|
+
*
|
|
838
|
+
* For POST:
|
|
839
|
+
* program_key (str, required): The program to create an invitation for
|
|
840
|
+
* email (str, required): The email address to invite
|
|
841
|
+
* active (bool, optional): Whether the invitation is active
|
|
842
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
843
|
+
*
|
|
844
|
+
* For DELETE:
|
|
845
|
+
* id (int, required): The ID of the invitation to delete
|
|
846
|
+
* org (str, required): The platform organization for verification
|
|
847
|
+
*
|
|
848
|
+
* Methods:
|
|
849
|
+
* GET: Retrieve a paginated list of program invitations
|
|
850
|
+
* POST: Create a new program invitation
|
|
851
|
+
* DELETE: Remove a program invitation
|
|
852
|
+
*
|
|
853
|
+
* Returns:
|
|
854
|
+
* GET: A paginated JSON response containing program invitations:
|
|
855
|
+
* {
|
|
856
|
+
* "count": 10,
|
|
857
|
+
* "next": "https://example.com/api/catalog/invitations/program/?page=2",
|
|
858
|
+
* "previous": null,
|
|
859
|
+
* "results": [
|
|
860
|
+
* {
|
|
861
|
+
* "id": 123,
|
|
862
|
+
* "user_id": 456,
|
|
863
|
+
* "username": "username",
|
|
864
|
+
* "email": "user@example.com",
|
|
865
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
866
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
867
|
+
* "source": "source",
|
|
868
|
+
* "redirect_to": "https://example.com",
|
|
869
|
+
* "expired": null,
|
|
870
|
+
* "active": true,
|
|
871
|
+
* "metadata": {},
|
|
872
|
+
* "program_key": "org+program1"
|
|
873
|
+
* },
|
|
874
|
+
* ...
|
|
875
|
+
* ]
|
|
876
|
+
* }
|
|
877
|
+
*
|
|
878
|
+
* POST: A JSON response containing the created invitation:
|
|
879
|
+
* {
|
|
880
|
+
* "id": 123,
|
|
881
|
+
* "user_id": 456,
|
|
882
|
+
* "username": "username",
|
|
883
|
+
* "email": "user@example.com",
|
|
884
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
885
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
886
|
+
* "source": "source",
|
|
887
|
+
* "redirect_to": "https://example.com",
|
|
888
|
+
* "expired": null,
|
|
889
|
+
* "active": true,
|
|
890
|
+
* "metadata": {},
|
|
891
|
+
* "program_key": "org+program1"
|
|
892
|
+
* }
|
|
893
|
+
*
|
|
894
|
+
* DELETE: A success response with status 200
|
|
895
|
+
*
|
|
896
|
+
* Error Responses:
|
|
897
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
898
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
899
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
900
|
+
* 404 Not Found: If the program or invitation doesn't exist
|
|
901
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
902
|
+
*
|
|
903
|
+
* Access Control:
|
|
904
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
|
|
905
|
+
* - Read-only access for platform admins, full access for DM admins and program-specific admins
|
|
906
|
+
* @param active Filter by active status
|
|
907
|
+
* @param email Filter by user email
|
|
908
|
+
* @param org Filter by platform organization
|
|
909
|
+
* @param page Page number for pagination
|
|
910
|
+
* @param pageSize Number of results per page
|
|
911
|
+
* @param programKey Filter by program key
|
|
912
|
+
* @param sort Field to sort results by
|
|
913
|
+
* @param source Filter by invitation source
|
|
914
|
+
* @param username Filter by username
|
|
915
|
+
* @param verbose Whether to include verbose output
|
|
916
|
+
* @returns PaginatedProgramInvitation
|
|
917
|
+
* @throws ApiError
|
|
918
|
+
*/
|
|
919
|
+
static catalogInvitationsProgramRetrieve(active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, programKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<PaginatedProgramInvitation>;
|
|
920
|
+
/**
|
|
921
|
+
* API View for managing program invitations.
|
|
922
|
+
*
|
|
923
|
+
* This endpoint allows querying, creating, and deleting program invitations for users.
|
|
924
|
+
*
|
|
925
|
+
* Query/Request Parameters:
|
|
926
|
+
* For GET:
|
|
927
|
+
* program_key (str, optional): Filter by program key
|
|
928
|
+
* org (str, optional): Filter by platform organization
|
|
929
|
+
* email (str, optional): Filter by user email
|
|
930
|
+
* source (str, optional): Filter by invitation source
|
|
931
|
+
* active (bool, optional): Filter by active status
|
|
932
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
933
|
+
* metadata fields: Any additional parameters will be treated as metadata filters
|
|
934
|
+
*
|
|
935
|
+
* For POST:
|
|
936
|
+
* program_key (str, required): The program to create an invitation for
|
|
937
|
+
* email (str, required): The email address to invite
|
|
938
|
+
* active (bool, optional): Whether the invitation is active
|
|
939
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
940
|
+
*
|
|
941
|
+
* For DELETE:
|
|
942
|
+
* id (int, required): The ID of the invitation to delete
|
|
943
|
+
* org (str, required): The platform organization for verification
|
|
944
|
+
*
|
|
945
|
+
* Methods:
|
|
946
|
+
* GET: Retrieve a paginated list of program invitations
|
|
947
|
+
* POST: Create a new program invitation
|
|
948
|
+
* DELETE: Remove a program invitation
|
|
949
|
+
*
|
|
950
|
+
* Returns:
|
|
951
|
+
* GET: A paginated JSON response containing program invitations:
|
|
952
|
+
* {
|
|
953
|
+
* "count": 10,
|
|
954
|
+
* "next": "https://example.com/api/catalog/invitations/program/?page=2",
|
|
955
|
+
* "previous": null,
|
|
956
|
+
* "results": [
|
|
957
|
+
* {
|
|
958
|
+
* "id": 123,
|
|
959
|
+
* "user_id": 456,
|
|
960
|
+
* "username": "username",
|
|
961
|
+
* "email": "user@example.com",
|
|
962
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
963
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
964
|
+
* "source": "source",
|
|
965
|
+
* "redirect_to": "https://example.com",
|
|
966
|
+
* "expired": null,
|
|
967
|
+
* "active": true,
|
|
968
|
+
* "metadata": {},
|
|
969
|
+
* "program_key": "org+program1"
|
|
970
|
+
* },
|
|
971
|
+
* ...
|
|
972
|
+
* ]
|
|
973
|
+
* }
|
|
974
|
+
*
|
|
975
|
+
* POST: A JSON response containing the created invitation:
|
|
976
|
+
* {
|
|
977
|
+
* "id": 123,
|
|
978
|
+
* "user_id": 456,
|
|
979
|
+
* "username": "username",
|
|
980
|
+
* "email": "user@example.com",
|
|
981
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
982
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
983
|
+
* "source": "source",
|
|
984
|
+
* "redirect_to": "https://example.com",
|
|
985
|
+
* "expired": null,
|
|
986
|
+
* "active": true,
|
|
987
|
+
* "metadata": {},
|
|
988
|
+
* "program_key": "org+program1"
|
|
989
|
+
* }
|
|
990
|
+
*
|
|
991
|
+
* DELETE: A success response with status 200
|
|
992
|
+
*
|
|
993
|
+
* Error Responses:
|
|
994
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
995
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
996
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
997
|
+
* 404 Not Found: If the program or invitation doesn't exist
|
|
998
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
999
|
+
*
|
|
1000
|
+
* Access Control:
|
|
1001
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
|
|
1002
|
+
* - Read-only access for platform admins, full access for DM admins and program-specific admins
|
|
1003
|
+
* @param requestBody
|
|
1004
|
+
* @param active Filter by active status
|
|
1005
|
+
* @param email Filter by user email
|
|
1006
|
+
* @param org Filter by platform organization
|
|
1007
|
+
* @param page Page number for pagination
|
|
1008
|
+
* @param pageSize Number of results per page
|
|
1009
|
+
* @param programKey Filter by program key
|
|
1010
|
+
* @param sort Field to sort results by
|
|
1011
|
+
* @param source Filter by invitation source
|
|
1012
|
+
* @param username Filter by username
|
|
1013
|
+
* @param verbose Whether to include verbose output
|
|
1014
|
+
* @returns ProgramInvitationDetail
|
|
1015
|
+
* @throws ApiError
|
|
1016
|
+
*/
|
|
1017
|
+
static catalogInvitationsProgramCreate(requestBody: ProgramInvitationCreate, active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, programKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<ProgramInvitationDetail>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Remove a program invitation: TBD
|
|
1020
|
+
* @param active Filter by active status
|
|
1021
|
+
* @param email Filter by user email
|
|
1022
|
+
* @param org Filter by platform organization
|
|
1023
|
+
* @param page Page number for pagination
|
|
1024
|
+
* @param pageSize Number of results per page
|
|
1025
|
+
* @param programKey Filter by program key
|
|
1026
|
+
* @param sort Field to sort results by
|
|
1027
|
+
* @param source Filter by invitation source
|
|
1028
|
+
* @param username Filter by username
|
|
1029
|
+
* @param verbose Whether to include verbose output
|
|
1030
|
+
* @returns any Invitation successfully deleted
|
|
1031
|
+
* @throws ApiError
|
|
1032
|
+
*/
|
|
1033
|
+
static catalogInvitationsProgramDestroy(active?: boolean, email?: string, org?: string, page?: number, pageSize?: number, programKey?: string, sort?: string, source?: string, username?: string, verbose?: boolean): CancelablePromise<any>;
|
|
1034
|
+
/**
|
|
1035
|
+
* API View for creating blank program invitations.
|
|
1036
|
+
*
|
|
1037
|
+
* This endpoint allows creating multiple blank program invitations (without user association)
|
|
1038
|
+
* that can be redeemed later.
|
|
1039
|
+
*
|
|
1040
|
+
* Request Parameters:
|
|
1041
|
+
* program_key (str, required): The program to create invitations for
|
|
1042
|
+
* source (str, required): The source identifier for the invitations
|
|
1043
|
+
* count (int, required): The number of blank invitations to create
|
|
1044
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
1045
|
+
*
|
|
1046
|
+
* Methods:
|
|
1047
|
+
* POST: Create multiple blank program invitations
|
|
1048
|
+
*
|
|
1049
|
+
* Returns:
|
|
1050
|
+
* POST: A JSON response containing the creation results:
|
|
1051
|
+
* {
|
|
1052
|
+
* "successes": 10,
|
|
1053
|
+
* "error_codes": []
|
|
1054
|
+
* }
|
|
1055
|
+
*
|
|
1056
|
+
* Error Responses:
|
|
1057
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1058
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1059
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1060
|
+
* 500 Internal Server Error: If an unexpected error occurs during creation
|
|
1061
|
+
*
|
|
1062
|
+
* Access Control:
|
|
1063
|
+
* - Requires IsDMAdmin or IsPlatformAdminForProgram permission
|
|
1064
|
+
* - Available to DM admins and platform admins for the specific program
|
|
1065
|
+
* @param requestBody
|
|
1066
|
+
* @returns BulkProgramInvitationResponse
|
|
1067
|
+
* @throws ApiError
|
|
1068
|
+
*/
|
|
1069
|
+
static catalogInvitationsProgramBlankCreate(requestBody: BlankProgramInvitationCreate): CancelablePromise<BulkProgramInvitationResponse>;
|
|
1070
|
+
/**
|
|
1071
|
+
* API View for bulk creation of program invitations.
|
|
1072
|
+
*
|
|
1073
|
+
* This endpoint allows creating multiple program invitations at once.
|
|
1074
|
+
*
|
|
1075
|
+
* Request Parameters:
|
|
1076
|
+
* invitation_data (list, required): List of invitation data objects, each containing:
|
|
1077
|
+
* program_key (str, required): The program to create an invitation for
|
|
1078
|
+
* email (str, required): The email address to invite
|
|
1079
|
+
* active (bool, optional): Whether the invitation is active
|
|
1080
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
1081
|
+
* platform_key (str, required for platform admins): The platform key for permission validation
|
|
1082
|
+
*
|
|
1083
|
+
* Methods:
|
|
1084
|
+
* POST: Create multiple program invitations
|
|
1085
|
+
*
|
|
1086
|
+
* Returns:
|
|
1087
|
+
* POST: A JSON response containing the creation results:
|
|
1088
|
+
* {
|
|
1089
|
+
* "successes": 5,
|
|
1090
|
+
* "error_codes": []
|
|
1091
|
+
* }
|
|
1092
|
+
*
|
|
1093
|
+
* Error Responses:
|
|
1094
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1095
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1096
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1097
|
+
* 500 Internal Server Error: If an unexpected error occurs during creation
|
|
1098
|
+
*
|
|
1099
|
+
* Access Control:
|
|
1100
|
+
* - Requires IsDMAdmin or IsPlatformAdmin permission
|
|
1101
|
+
* - Available to platform administrators and DM admins
|
|
1102
|
+
* @param requestBody
|
|
1103
|
+
* @returns BulkProgramInvitationResponse
|
|
1104
|
+
* @throws ApiError
|
|
1105
|
+
*/
|
|
1106
|
+
static catalogInvitationsProgramBulkCreate(requestBody: BulkProgramInvitationCreate): CancelablePromise<BulkProgramInvitationResponse>;
|
|
1107
|
+
/**
|
|
1108
|
+
* API View for redeeming blank program invitations.
|
|
1109
|
+
*
|
|
1110
|
+
* This endpoint allows redeeming a blank program invitation by associating it with a user.
|
|
1111
|
+
*
|
|
1112
|
+
* Request Parameters:
|
|
1113
|
+
* program_key (str, required): The program key for the invitation
|
|
1114
|
+
* source (str, required): The source identifier for the invitation
|
|
1115
|
+
* email (str, optional): The email to associate with the invitation
|
|
1116
|
+
* username (str, optional): The username to associate with the invitation
|
|
1117
|
+
* metadata fields: Any additional parameters will be added as metadata
|
|
1118
|
+
*
|
|
1119
|
+
* Methods:
|
|
1120
|
+
* POST: Redeem a blank program invitation
|
|
1121
|
+
*
|
|
1122
|
+
* Returns:
|
|
1123
|
+
* POST: A JSON response containing the redeemed invitation:
|
|
1124
|
+
* {
|
|
1125
|
+
* "id": 123,
|
|
1126
|
+
* "user_id": 456,
|
|
1127
|
+
* "username": "username",
|
|
1128
|
+
* "email": "user@example.com",
|
|
1129
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
1130
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
1131
|
+
* "source": "source",
|
|
1132
|
+
* "redirect_to": "https://example.com",
|
|
1133
|
+
* "expired": null,
|
|
1134
|
+
* "active": true,
|
|
1135
|
+
* "metadata": {},
|
|
1136
|
+
* "program_key": "org+program1"
|
|
1137
|
+
* }
|
|
1138
|
+
*
|
|
1139
|
+
* Error Responses:
|
|
1140
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1141
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1142
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1143
|
+
* 404 Not Found: If no blank invitation is available
|
|
1144
|
+
* 500 Internal Server Error: If an unexpected error occurs during redemption
|
|
1145
|
+
*
|
|
1146
|
+
* Access Control:
|
|
1147
|
+
* - Requires IsDMAdmin or IsPlatformAdminForProgram permission
|
|
1148
|
+
* - Available to DM admins and platform admins for the specific program
|
|
1149
|
+
* @param requestBody
|
|
1150
|
+
* @returns ProgramInvitationDetail
|
|
1151
|
+
* @throws ApiError
|
|
1152
|
+
*/
|
|
1153
|
+
static catalogInvitationsProgramRedeemCreate(requestBody: ProgramInvitationRedemption): CancelablePromise<ProgramInvitationDetail>;
|
|
1154
|
+
/**
|
|
1155
|
+
* Retrieve a paginated list of course licenses
|
|
1156
|
+
* @param active Filter by active status
|
|
1157
|
+
* @param courseId Filter by course ID
|
|
1158
|
+
* @param externalId Filter by external identifier
|
|
1159
|
+
* @param key Alternative filter by platform key
|
|
1160
|
+
* @param name Filter by license name (exact match)
|
|
1161
|
+
* @param org Alternative filter by platform organization
|
|
1162
|
+
* @param page Page number for pagination
|
|
1163
|
+
* @param pageSize Number of results per page
|
|
1164
|
+
* @param platformKey The unique identifier for the platform
|
|
1165
|
+
* @param platformOrg The organization identifier for the platform
|
|
1166
|
+
* @param query Search license names (contains)
|
|
1167
|
+
* @param sort Field to sort results by
|
|
1168
|
+
* @param source Filter by license source
|
|
1169
|
+
* @param verbose Include detailed assignment data in the response
|
|
1170
|
+
* @returns PaginatedCourseLicense
|
|
1171
|
+
* @throws ApiError
|
|
1172
|
+
*/
|
|
1173
|
+
static catalogLicensesCourseRetrieve(active?: boolean, courseId?: string, externalId?: string, key?: string, name?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, query?: string, sort?: string, source?: string, verbose?: boolean): CancelablePromise<PaginatedCourseLicense>;
|
|
1174
|
+
/**
|
|
1175
|
+
* Retrieve a paginated list of course license assignments
|
|
1176
|
+
* @param licenseId The ID of the course license
|
|
1177
|
+
* @param page Page number for pagination
|
|
1178
|
+
* @param pageSize Number of results per page
|
|
1179
|
+
* @param platformKey The unique identifier for the platform
|
|
1180
|
+
* @param platformOrg The organization identifier for the platform
|
|
1181
|
+
* @param sort Field to sort results by
|
|
1182
|
+
* @returns PaginatedCourseLicenseAssignment
|
|
1183
|
+
* @throws ApiError
|
|
1184
|
+
*/
|
|
1185
|
+
static catalogLicensesCourseAssignmentRetrieve(licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<PaginatedCourseLicenseAssignment>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Create or update a course license assignment
|
|
1188
|
+
* @param licenseId The ID of the course license
|
|
1189
|
+
* @param requestBody
|
|
1190
|
+
* @param page Page number for pagination
|
|
1191
|
+
* @param pageSize Number of results per page
|
|
1192
|
+
* @param platformKey The unique identifier for the platform
|
|
1193
|
+
* @param platformOrg The organization identifier for the platform
|
|
1194
|
+
* @param sort Field to sort results by
|
|
1195
|
+
* @returns CourseLicenseAssignmentDetail
|
|
1196
|
+
* @throws ApiError
|
|
1197
|
+
*/
|
|
1198
|
+
static catalogLicensesCourseAssignmentCreate(licenseId: number, requestBody: CourseLicenseAssignmentCreate, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<CourseLicenseAssignmentDetail>;
|
|
1199
|
+
/**
|
|
1200
|
+
* Remove a course license assignment
|
|
1201
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1202
|
+
* @param licenseId The ID of the course license
|
|
1203
|
+
* @param page Page number for pagination
|
|
1204
|
+
* @param pageSize Number of results per page
|
|
1205
|
+
* @param platformKey The unique identifier for the platform
|
|
1206
|
+
* @param platformOrg The organization identifier for the platform
|
|
1207
|
+
* @param sort Field to sort results by
|
|
1208
|
+
* @returns any Assignment successfully deleted
|
|
1209
|
+
* @throws ApiError
|
|
1210
|
+
*/
|
|
1211
|
+
static catalogLicensesCourseAssignmentDestroy(assignmentId: number, licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<any>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Retrieve a paginated list of course license group assignments
|
|
1214
|
+
* @param licenseId The ID of the course license
|
|
1215
|
+
* @param page Page number for pagination
|
|
1216
|
+
* @param pageSize Number of results per page
|
|
1217
|
+
* @param platformKey The unique identifier for the platform
|
|
1218
|
+
* @param platformOrg The organization identifier for the platform
|
|
1219
|
+
* @param sort Field to sort results by
|
|
1220
|
+
* @returns PaginatedCourseLicenseGroupAssignment
|
|
1221
|
+
* @throws ApiError
|
|
1222
|
+
*/
|
|
1223
|
+
static catalogLicensesCourseAssignmentGroupRetrieve(licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<PaginatedCourseLicenseGroupAssignment>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Create or update a course license group assignment
|
|
1226
|
+
* @param licenseId The ID of the course license
|
|
1227
|
+
* @param requestBody
|
|
1228
|
+
* @param page Page number for pagination
|
|
1229
|
+
* @param pageSize Number of results per page
|
|
1230
|
+
* @param platformKey The unique identifier for the platform
|
|
1231
|
+
* @param platformOrg The organization identifier for the platform
|
|
1232
|
+
* @param sort Field to sort results by
|
|
1233
|
+
* @returns CourseLicenseGroupAssignmentDetail
|
|
1234
|
+
* @throws ApiError
|
|
1235
|
+
*/
|
|
1236
|
+
static catalogLicensesCourseAssignmentGroupCreate(licenseId: number, requestBody: CourseLicenseGroupAssignmentCreate, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<CourseLicenseGroupAssignmentDetail>;
|
|
1237
|
+
/**
|
|
1238
|
+
* Remove a course license group assignment
|
|
1239
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1240
|
+
* @param licenseId The ID of the course license
|
|
1241
|
+
* @param page Page number for pagination
|
|
1242
|
+
* @param pageSize Number of results per page
|
|
1243
|
+
* @param platformKey The unique identifier for the platform
|
|
1244
|
+
* @param platformOrg The organization identifier for the platform
|
|
1245
|
+
* @param sort Field to sort results by
|
|
1246
|
+
* @returns any Assignment successfully deleted
|
|
1247
|
+
* @throws ApiError
|
|
1248
|
+
*/
|
|
1249
|
+
static catalogLicensesCourseAssignmentGroupDestroy(assignmentId: number, licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<any>;
|
|
1250
|
+
/**
|
|
1251
|
+
* Create a new course license
|
|
1252
|
+
* @param requestBody
|
|
1253
|
+
* @returns CourseLicenseDetail
|
|
1254
|
+
* @throws ApiError
|
|
1255
|
+
*/
|
|
1256
|
+
static catalogLicensesCourseCreateCreate(requestBody: CourseLicenseCreate): CancelablePromise<CourseLicenseDetail>;
|
|
1257
|
+
/**
|
|
1258
|
+
* Update an existing course license
|
|
1259
|
+
* @param requestBody
|
|
1260
|
+
* @returns CourseLicenseDetail
|
|
1261
|
+
* @throws ApiError
|
|
1262
|
+
*/
|
|
1263
|
+
static catalogLicensesCourseUpdateCreate(requestBody?: CourseLicenseUpdate): CancelablePromise<CourseLicenseDetail>;
|
|
1264
|
+
/**
|
|
1265
|
+
* Retrieve a paginated list of platform licenses
|
|
1266
|
+
* @param active Filter by active status
|
|
1267
|
+
* @param externalId Filter by external identifier
|
|
1268
|
+
* @param key Alternative filter by platform key
|
|
1269
|
+
* @param name Filter by license name (exact match)
|
|
1270
|
+
* @param page Page number for pagination
|
|
1271
|
+
* @param pageSize Number of results per page
|
|
1272
|
+
* @param platformKey The unique identifier for the platform
|
|
1273
|
+
* @param query Search license names (contains)
|
|
1274
|
+
* @param sort Field to sort results by
|
|
1275
|
+
* @param source Filter by license source
|
|
1276
|
+
* @param verbose Include detailed assignment data in the response
|
|
1277
|
+
* @returns PaginatedPlatformLicense
|
|
1278
|
+
* @throws ApiError
|
|
1279
|
+
*/
|
|
1280
|
+
static catalogLicensesPlatformRetrieve(active?: boolean, externalId?: string, key?: string, name?: string, page?: number, pageSize?: number, platformKey?: string, query?: string, sort?: string, source?: string, verbose?: boolean): CancelablePromise<PaginatedPlatformLicense>;
|
|
1281
|
+
/**
|
|
1282
|
+
* Create a new platform license
|
|
1283
|
+
* @param requestBody
|
|
1284
|
+
* @returns PlatformLicenseDetail
|
|
1285
|
+
* @throws ApiError
|
|
1286
|
+
*/
|
|
1287
|
+
static catalogLicensesPlatformCreateCreate(requestBody: PlatformLicenseCreate): CancelablePromise<PlatformLicenseDetail>;
|
|
1288
|
+
/**
|
|
1289
|
+
* Update an existing platform license
|
|
1290
|
+
* @param requestBody
|
|
1291
|
+
* @returns PlatformLicenseDetail
|
|
1292
|
+
* @throws ApiError
|
|
1293
|
+
*/
|
|
1294
|
+
static catalogLicensesPlatformUpdateCreate(requestBody?: PlatformLicenseUpdate): CancelablePromise<PlatformLicenseDetail>;
|
|
1295
|
+
/**
|
|
1296
|
+
* API View for managing program licenses.
|
|
1297
|
+
*
|
|
1298
|
+
* This endpoint allows retrieving program licenses with filtering and pagination support.
|
|
1299
|
+
*
|
|
1300
|
+
* Query Parameters:
|
|
1301
|
+
* platform_key (str, optional): The unique identifier for the platform
|
|
1302
|
+
* name (str, optional): Filter by license name (exact match)
|
|
1303
|
+
* source (str, optional): Filter by license source
|
|
1304
|
+
* active (bool, optional): Filter by active status
|
|
1305
|
+
* program_id (str, optional): Filter by program ID
|
|
1306
|
+
* query (str, optional): Search licenses by name (contains)
|
|
1307
|
+
* page (int, optional): Page number for pagination
|
|
1308
|
+
* page_size (int, optional): Number of items per page
|
|
1309
|
+
* verbose (bool, optional): Include additional details in response
|
|
1310
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
1311
|
+
*
|
|
1312
|
+
* Methods:
|
|
1313
|
+
* GET: Retrieve a paginated list of program licenses
|
|
1314
|
+
*
|
|
1315
|
+
* Returns:
|
|
1316
|
+
* GET: A paginated JSON response containing program licenses:
|
|
1317
|
+
* {
|
|
1318
|
+
* "count": 10,
|
|
1319
|
+
* "next": "https://example.com/api/catalog/licenses/program/?page=2",
|
|
1320
|
+
* "previous": null,
|
|
1321
|
+
* "results": [
|
|
1322
|
+
* {
|
|
1323
|
+
* "id": 123,
|
|
1324
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
1325
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
1326
|
+
* "expired": null,
|
|
1327
|
+
* "name": "Program License 2023",
|
|
1328
|
+
* "count": 100,
|
|
1329
|
+
* "active": true,
|
|
1330
|
+
* "metadata": {},
|
|
1331
|
+
* "source": "source",
|
|
1332
|
+
* "external_id": "ext-123",
|
|
1333
|
+
* "platform_key": "platform1",
|
|
1334
|
+
* "program_id": "program-v1:org+program+run",
|
|
1335
|
+
* "assignments": {
|
|
1336
|
+
* "total": 50,
|
|
1337
|
+
* "active": 45,
|
|
1338
|
+
* "pending": 5
|
|
1339
|
+
* }
|
|
1340
|
+
* },
|
|
1341
|
+
* ...
|
|
1342
|
+
* ]
|
|
1343
|
+
* }
|
|
1344
|
+
*
|
|
1345
|
+
* Error Responses:
|
|
1346
|
+
* 400 Bad Request: If query parameters are invalid
|
|
1347
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1348
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1349
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
1350
|
+
*
|
|
1351
|
+
* Access Control:
|
|
1352
|
+
* - Requires IsDMAdmin or IsPlatformAdminReadOnly permission
|
|
1353
|
+
* - Available to platform administrators (read-only) and DM admins
|
|
1354
|
+
* @param active Filter by active status
|
|
1355
|
+
* @param externalId Filter by external identifier
|
|
1356
|
+
* @param key Alternative filter by platform key
|
|
1357
|
+
* @param name Filter by license name (exact match)
|
|
1358
|
+
* @param org Alternative filter by platform organization
|
|
1359
|
+
* @param page Page number for pagination
|
|
1360
|
+
* @param pageSize Number of results per page
|
|
1361
|
+
* @param platformKey The unique identifier for the platform
|
|
1362
|
+
* @param platformOrg The organization identifier for the platform
|
|
1363
|
+
* @param programId Filter by program ID
|
|
1364
|
+
* @param query Search license names (contains)
|
|
1365
|
+
* @param sort Field to sort results by (e.g., '-id', 'created', '-created')
|
|
1366
|
+
* @param source Filter by license source
|
|
1367
|
+
* @param verbose Include detailed assignment data in the response
|
|
1368
|
+
* @returns PaginatedProgramLicense
|
|
1369
|
+
* @throws ApiError
|
|
1370
|
+
*/
|
|
1371
|
+
static catalogLicensesProgramRetrieve(active?: boolean, externalId?: string, key?: string, name?: string, org?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, programId?: string, query?: string, sort?: string, source?: string, verbose?: boolean): CancelablePromise<PaginatedProgramLicense>;
|
|
1372
|
+
/**
|
|
1373
|
+
* Retrieve a paginated list of program license assignments
|
|
1374
|
+
* @param licenseId The ID of the program license
|
|
1375
|
+
* @param active Filter by the active status of assignments
|
|
1376
|
+
* @param email Filter assignments for a specific email
|
|
1377
|
+
* @param fulfilled Filter by the fulfilled status of assignments
|
|
1378
|
+
* @param page Page number for pagination
|
|
1379
|
+
* @param pageSize Number of results per page
|
|
1380
|
+
* @param platformKey The unique identifier for the platform
|
|
1381
|
+
* @param platformOrg The organization identifier for the platform
|
|
1382
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1383
|
+
* @param userId Filter assignments for a specific user ID
|
|
1384
|
+
* @returns PaginatedProgramLicenseAssignment
|
|
1385
|
+
* @throws ApiError
|
|
1386
|
+
*/
|
|
1387
|
+
static catalogLicensesProgramAssignmentRetrieve(licenseId: number, active?: boolean, email?: string, fulfilled?: boolean, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<PaginatedProgramLicenseAssignment>;
|
|
1388
|
+
/**
|
|
1389
|
+
* Create or update a program license assignment
|
|
1390
|
+
* @param licenseId The ID of the program license
|
|
1391
|
+
* @param requestBody
|
|
1392
|
+
* @param active Filter by the active status of assignments
|
|
1393
|
+
* @param email Filter assignments for a specific email
|
|
1394
|
+
* @param fulfilled Filter by the fulfilled status of assignments
|
|
1395
|
+
* @param page Page number for pagination
|
|
1396
|
+
* @param pageSize Number of results per page
|
|
1397
|
+
* @param platformKey The unique identifier for the platform
|
|
1398
|
+
* @param platformOrg The organization identifier for the platform
|
|
1399
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1400
|
+
* @param userId Filter assignments for a specific user ID
|
|
1401
|
+
* @returns ProgramLicenseAssignmentDetail
|
|
1402
|
+
* @throws ApiError
|
|
1403
|
+
*/
|
|
1404
|
+
static catalogLicensesProgramAssignmentCreate(licenseId: number, requestBody: ProgramLicenseAssignmentCreate, active?: boolean, email?: string, fulfilled?: boolean, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<ProgramLicenseAssignmentDetail>;
|
|
1405
|
+
/**
|
|
1406
|
+
* Unassign single user from license
|
|
1407
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1408
|
+
* @param licenseId The ID of the program license
|
|
1409
|
+
* @param active Filter by the active status of assignments
|
|
1410
|
+
* @param email Filter assignments for a specific email
|
|
1411
|
+
* @param fulfilled Filter by the fulfilled status of assignments
|
|
1412
|
+
* @param page Page number for pagination
|
|
1413
|
+
* @param pageSize Number of results per page
|
|
1414
|
+
* @param platformKey The unique identifier for the platform (for permission validation)
|
|
1415
|
+
* @param platformOrg The organization identifier for the platform (for permission validation)
|
|
1416
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1417
|
+
* @param userId Filter assignments for a specific user ID
|
|
1418
|
+
* @returns any Assignment successfully deleted
|
|
1419
|
+
* @throws ApiError
|
|
1420
|
+
*/
|
|
1421
|
+
static catalogLicensesProgramAssignmentDestroy(assignmentId: number, licenseId: number, active?: boolean, email?: string, fulfilled?: boolean, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<any>;
|
|
1422
|
+
/**
|
|
1423
|
+
* Retrieve a paginated list of program license group assignments
|
|
1424
|
+
* @param licenseId The ID of the program license
|
|
1425
|
+
* @param active Filter by the active status of group assignments
|
|
1426
|
+
* @param fulfilled Filter by the fulfilled status of group assignments
|
|
1427
|
+
* @param groupId Filter assignments for a specific user group ID
|
|
1428
|
+
* @param page Page number for pagination
|
|
1429
|
+
* @param pageSize Number of results per page
|
|
1430
|
+
* @param platformKey The unique identifier for the platform
|
|
1431
|
+
* @param platformOrg The organization identifier for the platform
|
|
1432
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1433
|
+
* @returns PaginatedProgramLicenseGroupAssignment
|
|
1434
|
+
* @throws ApiError
|
|
1435
|
+
*/
|
|
1436
|
+
static catalogLicensesProgramAssignmentGroupRetrieve(licenseId: number, active?: boolean, fulfilled?: boolean, groupId?: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<PaginatedProgramLicenseGroupAssignment>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Create or update a program license group assignment
|
|
1439
|
+
* @param licenseId The ID of the program license
|
|
1440
|
+
* @param requestBody
|
|
1441
|
+
* @param active Filter by the active status of group assignments
|
|
1442
|
+
* @param fulfilled Filter by the fulfilled status of group assignments
|
|
1443
|
+
* @param groupId Filter assignments for a specific user group ID
|
|
1444
|
+
* @param page Page number for pagination
|
|
1445
|
+
* @param pageSize Number of results per page
|
|
1446
|
+
* @param platformKey The unique identifier for the platform
|
|
1447
|
+
* @param platformOrg The organization identifier for the platform
|
|
1448
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1449
|
+
* @returns ProgramLicenseGroupAssignmentDetail
|
|
1450
|
+
* @throws ApiError
|
|
1451
|
+
*/
|
|
1452
|
+
static catalogLicensesProgramAssignmentGroupCreate(licenseId: number, requestBody: ProgramLicenseGroupAssignmentCreate, active?: boolean, fulfilled?: boolean, groupId?: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<ProgramLicenseGroupAssignmentDetail>;
|
|
1453
|
+
/**
|
|
1454
|
+
* Remove a program license group assignment
|
|
1455
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1456
|
+
* @param licenseId The ID of the program license
|
|
1457
|
+
* @param active Filter by the active status of group assignments
|
|
1458
|
+
* @param fulfilled Filter by the fulfilled status of group assignments
|
|
1459
|
+
* @param groupId Filter assignments for a specific user group ID
|
|
1460
|
+
* @param page Page number for pagination
|
|
1461
|
+
* @param pageSize Number of results per page
|
|
1462
|
+
* @param platformKey The unique identifier for the platform (for permission validation)
|
|
1463
|
+
* @param platformOrg The organization identifier for the platform (for permission validation)
|
|
1464
|
+
* @param removeUserAssignments Whether to also remove individual user assignments that were created by this group assignment
|
|
1465
|
+
* @param sort Field to sort results by (e.g., 'id', '-id', 'created', '-created')
|
|
1466
|
+
* @returns any Assignment successfully deleted
|
|
1467
|
+
* @throws ApiError
|
|
1468
|
+
*/
|
|
1469
|
+
static catalogLicensesProgramAssignmentGroupDestroy(assignmentId: number, licenseId: number, active?: boolean, fulfilled?: boolean, groupId?: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, removeUserAssignments?: boolean, sort?: string): CancelablePromise<any>;
|
|
1470
|
+
/**
|
|
1471
|
+
* API View for creating program licenses.
|
|
1472
|
+
*
|
|
1473
|
+
* This endpoint allows administrators to create new program licenses with various configurations.
|
|
1474
|
+
*
|
|
1475
|
+
* Methods:
|
|
1476
|
+
* POST: Create a new program license
|
|
1477
|
+
*
|
|
1478
|
+
* Request Body:
|
|
1479
|
+
* A JSON object containing:
|
|
1480
|
+
* - platform_key (str, required): The platform to create a license for
|
|
1481
|
+
* - program_id (str, required): The program ID to create a license for
|
|
1482
|
+
* - name (str, optional): Display name for the license
|
|
1483
|
+
* - count (int, optional): Number of seats purchased (default: 0)
|
|
1484
|
+
* - started (datetime, optional): Date when license should begin
|
|
1485
|
+
* - expired (datetime, optional): Date when license should expire
|
|
1486
|
+
* - active (bool, optional): Whether the license is active (default: true)
|
|
1487
|
+
* - metadata (dict, optional): Additional license metadata
|
|
1488
|
+
* - enrollment_config (dict, optional): Additional enrollment configuration
|
|
1489
|
+
* - source (str, optional): Source identifier
|
|
1490
|
+
* - external_id (str, optional): External identifier (must be unique)
|
|
1491
|
+
*
|
|
1492
|
+
* Returns:
|
|
1493
|
+
* POST: A JSON response containing the created license:
|
|
1494
|
+
* {
|
|
1495
|
+
* "id": 123,
|
|
1496
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
1497
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
1498
|
+
* "expired": null,
|
|
1499
|
+
* "name": "Program License 2023",
|
|
1500
|
+
* "count": 100,
|
|
1501
|
+
* "active": true,
|
|
1502
|
+
* "metadata": {},
|
|
1503
|
+
* "source": "source",
|
|
1504
|
+
* "external_id": "ext-123",
|
|
1505
|
+
* "platform_key": "platform1",
|
|
1506
|
+
* "program_id": "program-v1:org+program+run"
|
|
1507
|
+
* }
|
|
1508
|
+
*
|
|
1509
|
+
* Error Responses:
|
|
1510
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1511
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1512
|
+
* 403 Forbidden: If the user does not have permission to create licenses
|
|
1513
|
+
* 500 Internal Server Error: If an unexpected error occurs during license creation
|
|
1514
|
+
*
|
|
1515
|
+
* Access Control:
|
|
1516
|
+
* - Requires IsDMAdmin permission
|
|
1517
|
+
* - Available only to DM administrators
|
|
1518
|
+
* @param requestBody
|
|
1519
|
+
* @returns ProgramLicenseDetail
|
|
1520
|
+
* @throws ApiError
|
|
1521
|
+
*/
|
|
1522
|
+
static catalogLicensesProgramCreateCreate(requestBody: ProgramLicenseCreateDetail): CancelablePromise<ProgramLicenseDetail>;
|
|
1523
|
+
/**
|
|
1524
|
+
* API View for updating existing program licenses.
|
|
1525
|
+
*
|
|
1526
|
+
* This endpoint allows administrators to update the properties of an existing program license.
|
|
1527
|
+
*
|
|
1528
|
+
* Methods:
|
|
1529
|
+
* POST: Update an existing program license
|
|
1530
|
+
*
|
|
1531
|
+
* Request Body:
|
|
1532
|
+
* A JSON object containing:
|
|
1533
|
+
* - license_id (int, optional): The ID of the license to update (required if external_id not provided)
|
|
1534
|
+
* - external_id (str, optional): External identifier of the license to update (required if license_id not provided)
|
|
1535
|
+
* - name (str, optional): Updated display name for the license
|
|
1536
|
+
* - count (int, optional): Updated number of seats purchased
|
|
1537
|
+
* - started (datetime, optional): Updated date when license should begin
|
|
1538
|
+
* - expired (datetime, optional): Updated date when license should expire
|
|
1539
|
+
* - active (bool, optional): Updated active status
|
|
1540
|
+
* - metadata (dict, optional): Updated additional license metadata
|
|
1541
|
+
* - enrollment_config (dict, optional): Updated enrollment configuration
|
|
1542
|
+
* - source (str, optional): Updated source identifier
|
|
1543
|
+
* - change_type (str, optional): Type of change being made (default: "update")
|
|
1544
|
+
*
|
|
1545
|
+
* Returns:
|
|
1546
|
+
* POST: A JSON response containing the updated license:
|
|
1547
|
+
* {
|
|
1548
|
+
* "id": 123,
|
|
1549
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
1550
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
1551
|
+
* "expired": "2024-06-15T14:30:00Z",
|
|
1552
|
+
* "name": "Updated Program License 2023",
|
|
1553
|
+
* "count": 150,
|
|
1554
|
+
* "active": true,
|
|
1555
|
+
* "metadata": {"updated": true},
|
|
1556
|
+
* "source": "updated-source",
|
|
1557
|
+
* "external_id": "ext-123",
|
|
1558
|
+
* "platform_key": "platform1",
|
|
1559
|
+
* "program_id": "program-v1:org+program+run"
|
|
1560
|
+
* }
|
|
1561
|
+
*
|
|
1562
|
+
* Error Responses:
|
|
1563
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1564
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1565
|
+
* 403 Forbidden: If the user does not have permission to update licenses
|
|
1566
|
+
* 404 Not Found: If the specified license doesn't exist
|
|
1567
|
+
* 500 Internal Server Error: If an unexpected error occurs during license update
|
|
1568
|
+
*
|
|
1569
|
+
* Access Control:
|
|
1570
|
+
* - Requires IsDMAdmin permission
|
|
1571
|
+
* - Available only to DM administrators
|
|
1572
|
+
*
|
|
1573
|
+
* Notes:
|
|
1574
|
+
* - Cannot update the platform or program associated with a license
|
|
1575
|
+
* - A license history record is automatically created for each update
|
|
1576
|
+
* @param requestBody
|
|
1577
|
+
* @returns ProgramLicenseDetail
|
|
1578
|
+
* @throws ApiError
|
|
1579
|
+
*/
|
|
1580
|
+
static catalogLicensesProgramUpdateCreate(requestBody?: ProgramLicenseUpdateDetail): CancelablePromise<ProgramLicenseDetail>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Retrieve a paginated list of user licenses
|
|
1583
|
+
* @param active Filter by active status
|
|
1584
|
+
* @param externalId Filter by external identifier
|
|
1585
|
+
* @param key Alternative filter by platform key
|
|
1586
|
+
* @param name Filter by license name (exact match)
|
|
1587
|
+
* @param page Page number for pagination
|
|
1588
|
+
* @param pageSize Number of results per page
|
|
1589
|
+
* @param platformKey The unique identifier for the platform
|
|
1590
|
+
* @param query Search license names (contains)
|
|
1591
|
+
* @param sort Field to sort results by
|
|
1592
|
+
* @param source Filter by license source
|
|
1593
|
+
* @param verbose Include detailed assignment data in the response
|
|
1594
|
+
* @returns PaginatedUserLicense
|
|
1595
|
+
* @throws ApiError
|
|
1596
|
+
*/
|
|
1597
|
+
static catalogLicensesUserRetrieve(active?: boolean, externalId?: string, key?: string, name?: string, page?: number, pageSize?: number, platformKey?: string, query?: string, sort?: string, source?: string, verbose?: boolean): CancelablePromise<PaginatedUserLicense>;
|
|
1598
|
+
/**
|
|
1599
|
+
* Retrieve a paginated list of user license assignments
|
|
1600
|
+
* @param licenseId The ID of the user license
|
|
1601
|
+
* @param page Page number for pagination
|
|
1602
|
+
* @param pageSize Number of results per page
|
|
1603
|
+
* @param platformKey The unique identifier for the platform
|
|
1604
|
+
* @param platformOrg The organization identifier for the platform
|
|
1605
|
+
* @param sort Field to sort results by
|
|
1606
|
+
* @returns PaginatedUserLicenseAssignment
|
|
1607
|
+
* @throws ApiError
|
|
1608
|
+
*/
|
|
1609
|
+
static catalogLicensesUserAssignmentRetrieve(licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<PaginatedUserLicenseAssignment>;
|
|
1610
|
+
/**
|
|
1611
|
+
* Create or update a user license assignment
|
|
1612
|
+
* @param licenseId The ID of the user license
|
|
1613
|
+
* @param requestBody
|
|
1614
|
+
* @param page Page number for pagination
|
|
1615
|
+
* @param pageSize Number of results per page
|
|
1616
|
+
* @param platformKey The unique identifier for the platform
|
|
1617
|
+
* @param platformOrg The organization identifier for the platform
|
|
1618
|
+
* @param sort Field to sort results by
|
|
1619
|
+
* @returns UserLicenseAssignmentDetail
|
|
1620
|
+
* @throws ApiError
|
|
1621
|
+
*/
|
|
1622
|
+
static catalogLicensesUserAssignmentCreate(licenseId: number, requestBody: UserLicenseAssignmentCreate, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<UserLicenseAssignmentDetail>;
|
|
1623
|
+
/**
|
|
1624
|
+
* Remove a user license assignment
|
|
1625
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1626
|
+
* @param licenseId The ID of the user license
|
|
1627
|
+
* @param page Page number for pagination
|
|
1628
|
+
* @param pageSize Number of results per page
|
|
1629
|
+
* @param platformKey The unique identifier for the platform
|
|
1630
|
+
* @param platformOrg The organization identifier for the platform
|
|
1631
|
+
* @param sort Field to sort results by
|
|
1632
|
+
* @returns any Assignment successfully deleted
|
|
1633
|
+
* @throws ApiError
|
|
1634
|
+
*/
|
|
1635
|
+
static catalogLicensesUserAssignmentDestroy(assignmentId: number, licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<any>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Check if a user has an active user license assignment
|
|
1638
|
+
* @param email The email address to check for active license assignments
|
|
1639
|
+
* @returns any Active license assignment exists for the email
|
|
1640
|
+
* @throws ApiError
|
|
1641
|
+
*/
|
|
1642
|
+
static catalogLicensesUserAssignmentCheckRetrieve(email: string): CancelablePromise<any>;
|
|
1643
|
+
/**
|
|
1644
|
+
* Retrieve a paginated list of user license group assignments
|
|
1645
|
+
* @param licenseId The ID of the user license
|
|
1646
|
+
* @param page Page number for pagination
|
|
1647
|
+
* @param pageSize Number of results per page
|
|
1648
|
+
* @param platformKey The unique identifier for the platform
|
|
1649
|
+
* @param platformOrg The organization identifier for the platform
|
|
1650
|
+
* @param sort Field to sort results by
|
|
1651
|
+
* @returns PaginatedUserLicenseGroupAssignment
|
|
1652
|
+
* @throws ApiError
|
|
1653
|
+
*/
|
|
1654
|
+
static catalogLicensesUserAssignmentGroupRetrieve(licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<PaginatedUserLicenseGroupAssignment>;
|
|
1655
|
+
/**
|
|
1656
|
+
* Create or update a user license group assignment
|
|
1657
|
+
* @param licenseId The ID of the user license
|
|
1658
|
+
* @param requestBody
|
|
1659
|
+
* @param page Page number for pagination
|
|
1660
|
+
* @param pageSize Number of results per page
|
|
1661
|
+
* @param platformKey The unique identifier for the platform
|
|
1662
|
+
* @param platformOrg The organization identifier for the platform
|
|
1663
|
+
* @param sort Field to sort results by
|
|
1664
|
+
* @returns UserLicenseGroupAssignmentDetail
|
|
1665
|
+
* @throws ApiError
|
|
1666
|
+
*/
|
|
1667
|
+
static catalogLicensesUserAssignmentGroupCreate(licenseId: number, requestBody: UserLicenseGroupAssignmentCreate, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<UserLicenseGroupAssignmentDetail>;
|
|
1668
|
+
/**
|
|
1669
|
+
* Remove a user license group assignment
|
|
1670
|
+
* @param assignmentId The ID of the assignment to delete
|
|
1671
|
+
* @param licenseId The ID of the user license
|
|
1672
|
+
* @param page Page number for pagination
|
|
1673
|
+
* @param pageSize Number of results per page
|
|
1674
|
+
* @param platformKey The unique identifier for the platform
|
|
1675
|
+
* @param platformOrg The organization identifier for the platform
|
|
1676
|
+
* @param sort Field to sort results by
|
|
1677
|
+
* @returns any Assignment successfully deleted
|
|
1678
|
+
* @throws ApiError
|
|
1679
|
+
*/
|
|
1680
|
+
static catalogLicensesUserAssignmentGroupDestroy(assignmentId: number, licenseId: number, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string): CancelablePromise<any>;
|
|
1681
|
+
/**
|
|
1682
|
+
* Create a new user license
|
|
1683
|
+
* @param requestBody
|
|
1684
|
+
* @returns UserLicenseDetail
|
|
1685
|
+
* @throws ApiError
|
|
1686
|
+
*/
|
|
1687
|
+
static catalogLicensesUserCreateCreate(requestBody: UserLicenseCreate): CancelablePromise<UserLicenseDetail>;
|
|
1688
|
+
/**
|
|
1689
|
+
* API View for updating existing user licenses.
|
|
1690
|
+
*
|
|
1691
|
+
* This endpoint allows administrators to update the properties of an existing user license.
|
|
1692
|
+
*
|
|
1693
|
+
* Methods:
|
|
1694
|
+
* POST: Update an existing user license
|
|
1695
|
+
*
|
|
1696
|
+
* Request Body:
|
|
1697
|
+
* A JSON object containing:
|
|
1698
|
+
* - license_id (int, optional): The ID of the license to update (required if external_id not provided)
|
|
1699
|
+
* - external_id (str, optional): External identifier of the license to update (required if license_id not provided)
|
|
1700
|
+
* - name (str, optional): Updated display name for the license
|
|
1701
|
+
* - count (int, optional): Updated number of seats purchased
|
|
1702
|
+
* - started (datetime, optional): Updated date when license should begin
|
|
1703
|
+
* - expired (datetime, optional): Updated date when license should expire
|
|
1704
|
+
* - active (bool, optional): Updated active status
|
|
1705
|
+
* - metadata (dict, optional): Updated additional license metadata
|
|
1706
|
+
* - enrollment_config (dict, optional): Updated enrollment configuration
|
|
1707
|
+
* - source (str, optional): Updated source identifier
|
|
1708
|
+
* - change_type (str, optional): Type of change being made (default: "update")
|
|
1709
|
+
*
|
|
1710
|
+
* Returns:
|
|
1711
|
+
* POST: A JSON response containing the updated license:
|
|
1712
|
+
* {
|
|
1713
|
+
* "id": 123,
|
|
1714
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
1715
|
+
* "started": "2023-06-15T14:30:00Z",
|
|
1716
|
+
* "expired": "2024-06-15T14:30:00Z",
|
|
1717
|
+
* "name": "Updated User License 2023",
|
|
1718
|
+
* "count": 150,
|
|
1719
|
+
* "active": true,
|
|
1720
|
+
* "metadata": {"updated": true},
|
|
1721
|
+
* "source": "updated-source",
|
|
1722
|
+
* "external_id": "ext-123",
|
|
1723
|
+
* "platform_key": "platform1"
|
|
1724
|
+
* }
|
|
1725
|
+
*
|
|
1726
|
+
* Error Responses:
|
|
1727
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
1728
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
1729
|
+
* 403 Forbidden: If the user does not have permission to update licenses
|
|
1730
|
+
* 404 Not Found: If the specified license doesn't exist
|
|
1731
|
+
* 500 Internal Server Error: If an unexpected error occurs during license update
|
|
1732
|
+
*
|
|
1733
|
+
* Access Control:
|
|
1734
|
+
* - Requires IsDMAdmin permission
|
|
1735
|
+
* - Available only to DM administrators
|
|
1736
|
+
*
|
|
1737
|
+
* Notes:
|
|
1738
|
+
* - Cannot update the platform associated with a license
|
|
1739
|
+
* - A license history record is automatically created for each update
|
|
1740
|
+
* @param requestBody
|
|
1741
|
+
* @returns UserLicenseDetail
|
|
1742
|
+
* @throws ApiError
|
|
1743
|
+
*/
|
|
1744
|
+
static catalogLicensesUserUpdateCreate(requestBody?: UserLicenseUpdate): CancelablePromise<UserLicenseDetail>;
|
|
1745
|
+
/**
|
|
1746
|
+
* Query metadata choices based on field_key, scope, and org parameters.
|
|
1747
|
+
* @param fieldKey The key of the field for which choices are being queried
|
|
1748
|
+
* @param org The organization context for the metadata choices
|
|
1749
|
+
* @param scope The scope within which to query the metadata choices (course, program, pathway, resource)
|
|
1750
|
+
* @returns any No response body
|
|
1751
|
+
* @throws ApiError
|
|
1752
|
+
*/
|
|
1753
|
+
static catalogMetadataChoicesRetrieve(fieldKey?: string, org?: string, scope?: string): CancelablePromise<any>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Retrieve metadata for a course.
|
|
1756
|
+
* @param courseId The course ID to get metadata for
|
|
1757
|
+
* @returns any No response body
|
|
1758
|
+
* @throws ApiError
|
|
1759
|
+
*/
|
|
1760
|
+
static catalogMetadataCourseRetrieve(courseId: string): CancelablePromise<any>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Update metadata for a course.
|
|
1763
|
+
* @param courseId The course ID to get metadata for
|
|
1764
|
+
* @param requestBody
|
|
1765
|
+
* @returns any No response body
|
|
1766
|
+
* @throws ApiError
|
|
1767
|
+
*/
|
|
1768
|
+
static catalogMetadataCourseCreate(courseId: string, requestBody: CourseMetadataUpdateRequest): CancelablePromise<any>;
|
|
1769
|
+
/**
|
|
1770
|
+
* Retrieve public metadata for a course.
|
|
1771
|
+
* @param courseId The course ID to get metadata for
|
|
1772
|
+
* @returns any No response body
|
|
1773
|
+
* @throws ApiError
|
|
1774
|
+
*/
|
|
1775
|
+
static catalogMetadataCoursePublicRetrieve(courseId: string): CancelablePromise<any>;
|
|
1776
|
+
/**
|
|
1777
|
+
* Retrieve public metadata for a course.
|
|
1778
|
+
* @param courseId The course ID to get metadata for
|
|
1779
|
+
* @param field
|
|
1780
|
+
* @returns any No response body
|
|
1781
|
+
* @throws ApiError
|
|
1782
|
+
*/
|
|
1783
|
+
static catalogMetadataCoursePublicRetrieve2(courseId: string, field: string): CancelablePromise<any>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Search for courses matching specified metadata filters.
|
|
1786
|
+
* @param requestBody
|
|
1787
|
+
* @returns any
|
|
1788
|
+
* @throws ApiError
|
|
1789
|
+
*/
|
|
1790
|
+
static catalogMetadataCourseSearchCreate(requestBody?: CourseMetadataSearchRequest): CancelablePromise<Record<string, any>>;
|
|
1791
|
+
/**
|
|
1792
|
+
* Retrieve metadata for a course.
|
|
1793
|
+
* @param courseId The course ID to get metadata for
|
|
1794
|
+
* @param field
|
|
1795
|
+
* @returns any No response body
|
|
1796
|
+
* @throws ApiError
|
|
1797
|
+
*/
|
|
1798
|
+
static catalogMetadataCourseRetrieve2(courseId: string, field: string): CancelablePromise<any>;
|
|
1799
|
+
/**
|
|
1800
|
+
* Update metadata for a course.
|
|
1801
|
+
* @param courseId The course ID to get metadata for
|
|
1802
|
+
* @param field
|
|
1803
|
+
* @param requestBody
|
|
1804
|
+
* @returns any No response body
|
|
1805
|
+
* @throws ApiError
|
|
1806
|
+
*/
|
|
1807
|
+
static catalogMetadataCourseCreate2(courseId: string, field: string, requestBody: CourseMetadataUpdateRequest): CancelablePromise<any>;
|
|
1808
|
+
/**
|
|
1809
|
+
* GET
|
|
1810
|
+
* Query program metadata.
|
|
1811
|
+
*
|
|
1812
|
+
* This method retrieves metadata for a specified program. The program is
|
|
1813
|
+
* identified by its program_id and organization (org). If the program_id
|
|
1814
|
+
* is not provided, a 400 status code is returned indicating a bad request.
|
|
1815
|
+
* If the program cannot be found, a 404 status code is returned.
|
|
1816
|
+
*
|
|
1817
|
+
* Params:
|
|
1818
|
+
* program_id: The unique identifier for the program.
|
|
1819
|
+
* org: The organization associated with the program.
|
|
1820
|
+
*
|
|
1821
|
+
* Returns:
|
|
1822
|
+
* A JSON response containing the program metadata if successful, or an
|
|
1823
|
+
* appropriate error status code.
|
|
1824
|
+
*
|
|
1825
|
+
* TODO: program-key compatibility
|
|
1826
|
+
* @returns any No response body
|
|
1827
|
+
* @throws ApiError
|
|
1828
|
+
*/
|
|
1829
|
+
static catalogMetadataProgramRetrieve(): CancelablePromise<any>;
|
|
1830
|
+
/**
|
|
1831
|
+
* POST
|
|
1832
|
+
* Update program metadata.
|
|
1833
|
+
*
|
|
1834
|
+
* This method updates the metadata for a specified program. The program is
|
|
1835
|
+
* identified by its program_id and organization (org). If the program_id
|
|
1836
|
+
* is not provided, a 400 status code is returned indicating a bad request.
|
|
1837
|
+
* If the program cannot be found, a 404 status code is returned. If the
|
|
1838
|
+
* field parameter is provided, a 404 status code is returned as field
|
|
1839
|
+
* updates are not supported.
|
|
1840
|
+
*
|
|
1841
|
+
* Params:
|
|
1842
|
+
* program_id: The unique identifier for the program.
|
|
1843
|
+
* org: The organization associated with the program.
|
|
1844
|
+
* metadata: The new metadata to update the program with.
|
|
1845
|
+
* update (optional): A flag indicating whether to update the metadata.
|
|
1846
|
+
*
|
|
1847
|
+
* Returns:
|
|
1848
|
+
* A JSON response containing the updated program metadata if successful,
|
|
1849
|
+
* or an appropriate error status code.
|
|
1850
|
+
*
|
|
1851
|
+
* TODO: program-key compatibility
|
|
1852
|
+
* @returns any No response body
|
|
1853
|
+
* @throws ApiError
|
|
1854
|
+
*/
|
|
1855
|
+
static catalogMetadataProgramCreate(): CancelablePromise<any>;
|
|
1856
|
+
/**
|
|
1857
|
+
* GET
|
|
1858
|
+
* Query public program metadata.
|
|
1859
|
+
*
|
|
1860
|
+
* This method retrieves public metadata for a specified program. It requires
|
|
1861
|
+
* a program ID and optionally an organization to identify the program. The
|
|
1862
|
+
* metadata is filtered to include only public fields.
|
|
1863
|
+
*
|
|
1864
|
+
* Params:
|
|
1865
|
+
* - program_id: The unique identifier for the program.
|
|
1866
|
+
* - org: The organization associated with the program.
|
|
1867
|
+
*
|
|
1868
|
+
* Returns:
|
|
1869
|
+
* - 200: Successfully retrieved the program metadata.
|
|
1870
|
+
* - 400: Bad request if the program ID is not provided.
|
|
1871
|
+
* - 404: Not found if the program or its metadata cannot be retrieved.
|
|
1872
|
+
*
|
|
1873
|
+
* TODO: Implement program-key compatibility for enhanced querying.
|
|
1874
|
+
* @returns any No response body
|
|
1875
|
+
* @throws ApiError
|
|
1876
|
+
*/
|
|
1877
|
+
static catalogMetadataProgramPublicRetrieve(): CancelablePromise<any>;
|
|
1878
|
+
/**
|
|
1879
|
+
* GET
|
|
1880
|
+
* Query public program metadata.
|
|
1881
|
+
*
|
|
1882
|
+
* This method retrieves public metadata for a specified program. It requires
|
|
1883
|
+
* a program ID and optionally an organization to identify the program. The
|
|
1884
|
+
* metadata is filtered to include only public fields.
|
|
1885
|
+
*
|
|
1886
|
+
* Params:
|
|
1887
|
+
* - program_id: The unique identifier for the program.
|
|
1888
|
+
* - org: The organization associated with the program.
|
|
1889
|
+
*
|
|
1890
|
+
* Returns:
|
|
1891
|
+
* - 200: Successfully retrieved the program metadata.
|
|
1892
|
+
* - 400: Bad request if the program ID is not provided.
|
|
1893
|
+
* - 404: Not found if the program or its metadata cannot be retrieved.
|
|
1894
|
+
*
|
|
1895
|
+
* TODO: Implement program-key compatibility for enhanced querying.
|
|
1896
|
+
* @param field
|
|
1897
|
+
* @returns any No response body
|
|
1898
|
+
* @throws ApiError
|
|
1899
|
+
*/
|
|
1900
|
+
static catalogMetadataProgramPublicRetrieve2(field: string): CancelablePromise<any>;
|
|
1901
|
+
/**
|
|
1902
|
+
* GET
|
|
1903
|
+
* Query program metadata.
|
|
1904
|
+
*
|
|
1905
|
+
* This method retrieves metadata for a specified program. The program is
|
|
1906
|
+
* identified by its program_id and organization (org). If the program_id
|
|
1907
|
+
* is not provided, a 400 status code is returned indicating a bad request.
|
|
1908
|
+
* If the program cannot be found, a 404 status code is returned.
|
|
1909
|
+
*
|
|
1910
|
+
* Params:
|
|
1911
|
+
* program_id: The unique identifier for the program.
|
|
1912
|
+
* org: The organization associated with the program.
|
|
1913
|
+
*
|
|
1914
|
+
* Returns:
|
|
1915
|
+
* A JSON response containing the program metadata if successful, or an
|
|
1916
|
+
* appropriate error status code.
|
|
1917
|
+
*
|
|
1918
|
+
* TODO: program-key compatibility
|
|
1919
|
+
* @param field
|
|
1920
|
+
* @returns any No response body
|
|
1921
|
+
* @throws ApiError
|
|
1922
|
+
*/
|
|
1923
|
+
static catalogMetadataProgramRetrieve2(field: string): CancelablePromise<any>;
|
|
1924
|
+
/**
|
|
1925
|
+
* POST
|
|
1926
|
+
* Update program metadata.
|
|
1927
|
+
*
|
|
1928
|
+
* This method updates the metadata for a specified program. The program is
|
|
1929
|
+
* identified by its program_id and organization (org). If the program_id
|
|
1930
|
+
* is not provided, a 400 status code is returned indicating a bad request.
|
|
1931
|
+
* If the program cannot be found, a 404 status code is returned. If the
|
|
1932
|
+
* field parameter is provided, a 404 status code is returned as field
|
|
1933
|
+
* updates are not supported.
|
|
1934
|
+
*
|
|
1935
|
+
* Params:
|
|
1936
|
+
* program_id: The unique identifier for the program.
|
|
1937
|
+
* org: The organization associated with the program.
|
|
1938
|
+
* metadata: The new metadata to update the program with.
|
|
1939
|
+
* update (optional): A flag indicating whether to update the metadata.
|
|
1940
|
+
*
|
|
1941
|
+
* Returns:
|
|
1942
|
+
* A JSON response containing the updated program metadata if successful,
|
|
1943
|
+
* or an appropriate error status code.
|
|
1944
|
+
*
|
|
1945
|
+
* TODO: program-key compatibility
|
|
1946
|
+
* @param field
|
|
1947
|
+
* @returns any No response body
|
|
1948
|
+
* @throws ApiError
|
|
1949
|
+
*/
|
|
1950
|
+
static catalogMetadataProgramCreate2(field: string): CancelablePromise<any>;
|
|
1951
|
+
/**
|
|
1952
|
+
* Retrieve catalog-compatible completion information for a user
|
|
1953
|
+
* @param userId The user identifier
|
|
1954
|
+
* @param fieldKey Specific field to include in the response
|
|
1955
|
+
* @returns CourseCompletionCatalogResponse
|
|
1956
|
+
* @throws ApiError
|
|
1957
|
+
*/
|
|
1958
|
+
static catalogMilestonesCompletionsCourseCatalogRetrieve(userId: number, fieldKey?: string): CancelablePromise<CourseCompletionCatalogResponse>;
|
|
1959
|
+
/**
|
|
1960
|
+
* Retrieve completion information for a specific user and course
|
|
1961
|
+
* @param courseId The course identifier (e.g., 'course-v1:org+code+run')
|
|
1962
|
+
* @param userId The user identifier
|
|
1963
|
+
* @returns CourseCompletion
|
|
1964
|
+
* @throws ApiError
|
|
1965
|
+
*/
|
|
1966
|
+
static catalogMilestonesCompletionsCourseManageRetrieve(courseId: string, userId: number): CancelablePromise<CourseCompletion>;
|
|
1967
|
+
/**
|
|
1968
|
+
* Create or update completion information for a specific user and course
|
|
1969
|
+
* @param courseId The course identifier (e.g., 'course-v1:org+code+run')
|
|
1970
|
+
* @param userId The user identifier
|
|
1971
|
+
* @param requestBody
|
|
1972
|
+
* @returns CourseCompletion
|
|
1973
|
+
* @throws ApiError
|
|
1974
|
+
*/
|
|
1975
|
+
static catalogMilestonesCompletionsCourseManageCreate(courseId: string, userId: number, requestBody: CourseCompletion): CancelablePromise<CourseCompletion>;
|
|
1976
|
+
/**
|
|
1977
|
+
* Retrieve pathway completion information
|
|
1978
|
+
* @param pathwayUuid The unique identifier for the pathway
|
|
1979
|
+
* @param userId The user identifier (either user_id or username required)
|
|
1980
|
+
* @param username The username (either user_id or username required)
|
|
1981
|
+
* @returns PathwayCompletionResponse
|
|
1982
|
+
* @throws ApiError
|
|
1983
|
+
*/
|
|
1984
|
+
static catalogMilestonesCompletionsPathwayQueryRetrieve(pathwayUuid: string, userId?: number, username?: string): CancelablePromise<PathwayCompletionResponse>;
|
|
1985
|
+
/**
|
|
1986
|
+
* Retrieve program completion information
|
|
1987
|
+
* @param programKey The unique identifier for the program
|
|
1988
|
+
* @param userId The user identifier (either user_id or username required)
|
|
1989
|
+
* @param username The username (either user_id or username required)
|
|
1990
|
+
* @returns ProgramCompletionResponse
|
|
1991
|
+
* @throws ApiError
|
|
1992
|
+
*/
|
|
1993
|
+
static catalogMilestonesCompletionsProgramQueryRetrieve(programKey: string, userId?: number, username?: string): CancelablePromise<ProgramCompletionResponse>;
|
|
1994
|
+
/**
|
|
1995
|
+
* Retrieve completion info for resource/user
|
|
1996
|
+
* @param resourceId The unique identifier for the resource
|
|
1997
|
+
* @param userId The ID of the user
|
|
1998
|
+
* @returns ResourceCompletion
|
|
1999
|
+
* @throws ApiError
|
|
2000
|
+
*/
|
|
2001
|
+
static catalogMilestonesCompletionsResourceManageRetrieve(resourceId: number, userId: number): CancelablePromise<ResourceCompletion>;
|
|
2002
|
+
/**
|
|
2003
|
+
* Create or update completion information for a specific resource and user
|
|
2004
|
+
* @param resourceId The unique identifier for the resource
|
|
2005
|
+
* @param userId The ID of the user
|
|
2006
|
+
* @param requestBody
|
|
2007
|
+
* @returns ResourceCompletion
|
|
2008
|
+
* @throws ApiError
|
|
2009
|
+
*/
|
|
2010
|
+
static catalogMilestonesCompletionsResourceManageCreate(resourceId: number, userId: number, requestBody: ResourceCompletionRequest): CancelablePromise<ResourceCompletion>;
|
|
2011
|
+
/**
|
|
2012
|
+
* Retrieve skill point information for a specific block
|
|
2013
|
+
* @param blockId ID of the block to retrieve skill point information for
|
|
2014
|
+
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
2015
|
+
* @returns BlockSkillPointInfoResponse
|
|
2016
|
+
* @throws ApiError
|
|
2017
|
+
*/
|
|
2018
|
+
static catalogMilestonesSkillPointsBlockRetrieve(blockId: string, getObj?: boolean): CancelablePromise<BlockSkillPointInfoResponse>;
|
|
2019
|
+
/**
|
|
2020
|
+
* Update skill point information for a specific block
|
|
2021
|
+
* @param blockId ID of the block to retrieve skill point information for
|
|
2022
|
+
* @param requestBody
|
|
2023
|
+
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
2024
|
+
* @returns any Successfully updated skill points
|
|
2025
|
+
* @throws ApiError
|
|
2026
|
+
*/
|
|
2027
|
+
static catalogMilestonesSkillPointsBlockCreate(blockId: string, requestBody: BlockSkillPointInfoRequest, getObj?: boolean): CancelablePromise<any>;
|
|
2028
|
+
/**
|
|
2029
|
+
* Retrieve skill point information for a specific course
|
|
2030
|
+
* @param courseId ID of the course to retrieve skill point information for
|
|
2031
|
+
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
2032
|
+
* @returns CourseSkillPointInfoResponse
|
|
2033
|
+
* @throws ApiError
|
|
2034
|
+
*/
|
|
2035
|
+
static catalogMilestonesSkillPointsCourseRetrieve(courseId: string, getObj?: boolean): CancelablePromise<CourseSkillPointInfoResponse>;
|
|
2036
|
+
/**
|
|
2037
|
+
* Update skill point information for a specific course
|
|
2038
|
+
* @param courseId ID of the course to retrieve skill point information for
|
|
2039
|
+
* @param requestBody
|
|
2040
|
+
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
2041
|
+
* @returns any Successfully updated skill points
|
|
2042
|
+
* @throws ApiError
|
|
2043
|
+
*/
|
|
2044
|
+
static catalogMilestonesSkillPointsCourseCreate(courseId: string, requestBody: CourseSkillPointInfoRequest, getObj?: boolean): CancelablePromise<any>;
|
|
2045
|
+
/**
|
|
2046
|
+
* Retrieve paginated list of platform skill points
|
|
2047
|
+
* @param departmentMode If True, filters results by department user permissions
|
|
2048
|
+
* @param platformKey Platform key identifier
|
|
2049
|
+
* @param platformOrg Platform organization identifier
|
|
2050
|
+
* @param query Search query for filtering skill points by user or skill name
|
|
2051
|
+
* @param sort Sort field for results. Default: '-id'
|
|
2052
|
+
* @returns PlatformSkillPointResponse
|
|
2053
|
+
* @throws ApiError
|
|
2054
|
+
*/
|
|
2055
|
+
static catalogMilestonesSkillPointsPlatformRetrieve(departmentMode?: boolean, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PlatformSkillPointResponse>;
|
|
2056
|
+
/**
|
|
2057
|
+
* Update platform skill points for a user
|
|
2058
|
+
* @param requestBody
|
|
2059
|
+
* @param departmentMode If True, filters results by department user permissions
|
|
2060
|
+
* @param platformKey Platform key identifier
|
|
2061
|
+
* @param platformOrg Platform organization identifier
|
|
2062
|
+
* @param query Search query for filtering skill points by user or skill name
|
|
2063
|
+
* @param sort Sort field for results. Default: '-id'
|
|
2064
|
+
* @returns any Successfully updated skill points
|
|
2065
|
+
* @throws ApiError
|
|
2066
|
+
*/
|
|
2067
|
+
static catalogMilestonesSkillPointsPlatformCreate(requestBody: PlatformSkillPointRequest, departmentMode?: boolean, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Delete a platform skill point entry
|
|
2070
|
+
* @param skillPointId ID of the skill point to delete
|
|
2071
|
+
* @param departmentMode If True, filters results by department user permissions
|
|
2072
|
+
* @param platformKey Platform key identifier
|
|
2073
|
+
* @param platformOrg Platform organization identifier
|
|
2074
|
+
* @param query Search query for filtering skill points by user or skill name
|
|
2075
|
+
* @param sort Sort field for results. Default: '-id'
|
|
2076
|
+
* @returns any Successfully deleted skill point
|
|
2077
|
+
* @throws ApiError
|
|
2078
|
+
*/
|
|
2079
|
+
static catalogMilestonesSkillPointsPlatformDestroy(skillPointId: number, departmentMode?: boolean, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
2080
|
+
/**
|
|
2081
|
+
* Bulk create/update platform skill points
|
|
2082
|
+
* @param requestBody
|
|
2083
|
+
* @returns PlatformSkillPointBulkResponse
|
|
2084
|
+
* @throws ApiError
|
|
2085
|
+
*/
|
|
2086
|
+
static catalogMilestonesSkillPointsPlatformBulkCreate(requestBody: PlatformSkillPointBulkRequest): CancelablePromise<PlatformSkillPointBulkResponse>;
|
|
2087
|
+
/**
|
|
2088
|
+
* Update skill points for all users in a group
|
|
2089
|
+
* @param requestBody
|
|
2090
|
+
* @returns any Successfully updated group skill points
|
|
2091
|
+
* @throws ApiError
|
|
2092
|
+
*/
|
|
2093
|
+
static catalogMilestonesSkillPointsPlatformGroupCreate(requestBody: PlatformSkillPointGroupRequest): CancelablePromise<any>;
|
|
2094
|
+
/**
|
|
2095
|
+
* Retrieve skill point information for a specific user
|
|
2096
|
+
* @param userId ID of the user to retrieve skill point information for
|
|
2097
|
+
* @param username Username to retrieve skill point information for
|
|
2098
|
+
* @returns UserSkillPointInfoResponse
|
|
2099
|
+
* @throws ApiError
|
|
2100
|
+
*/
|
|
2101
|
+
static catalogMilestonesSkillPointsUserRetrieve(userId?: number, username?: string): CancelablePromise<UserSkillPointInfoResponse>;
|
|
2102
|
+
/**
|
|
2103
|
+
* Retrieve pathways matching query. Limited parameters.
|
|
2104
|
+
* @returns Pathway
|
|
2105
|
+
* @throws ApiError
|
|
2106
|
+
*/
|
|
2107
|
+
static catalogPathwaysList(): CancelablePromise<Array<Pathway>>;
|
|
2108
|
+
/**
|
|
2109
|
+
* Add or update a pathway.
|
|
2110
|
+
* @param requestBody
|
|
2111
|
+
* @returns Pathway
|
|
2112
|
+
* @throws ApiError
|
|
2113
|
+
*/
|
|
2114
|
+
static catalogPathwaysCreate(requestBody: PathwayCreateUpdateRequest): CancelablePromise<Pathway>;
|
|
2115
|
+
/**
|
|
2116
|
+
* Remove a pathway from the database.
|
|
2117
|
+
* @returns PathwayDeleteResponse
|
|
2118
|
+
* @throws ApiError
|
|
2119
|
+
*/
|
|
2120
|
+
static catalogPathwaysDestroy(): CancelablePromise<PathwayDeleteResponse>;
|
|
2121
|
+
/**
|
|
2122
|
+
* Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.
|
|
2123
|
+
* @returns Program
|
|
2124
|
+
* @throws ApiError
|
|
2125
|
+
*/
|
|
2126
|
+
static catalogProgramsList(): CancelablePromise<Array<Program>>;
|
|
2127
|
+
/**
|
|
2128
|
+
* Add or update a program. Accepts a list of courses and updates or creates a program.
|
|
2129
|
+
* @param requestBody
|
|
2130
|
+
* @returns Program
|
|
2131
|
+
* @throws ApiError
|
|
2132
|
+
*/
|
|
2133
|
+
static catalogProgramsCreate(requestBody: ProgramCreateUpdateRequest): CancelablePromise<Program>;
|
|
2134
|
+
/**
|
|
2135
|
+
* Remove a program from the database. Requires program_id and org as parameters.
|
|
2136
|
+
* @returns ProgramDeleteResponse
|
|
2137
|
+
* @throws ApiError
|
|
2138
|
+
*/
|
|
2139
|
+
static catalogProgramsDestroy(): CancelablePromise<ProgramDeleteResponse>;
|
|
2140
|
+
/**
|
|
2141
|
+
* GET
|
|
2142
|
+
* Get a 'next' course
|
|
2143
|
+
*
|
|
2144
|
+
* This method retrieves the next recommended course for a user based on the provided parameters.
|
|
2145
|
+
* It expects the following parameters in the request query:
|
|
2146
|
+
* - user_id: The ID of the user for whom the next course is being recommended.
|
|
2147
|
+
* - course_id: The ID of the current course.
|
|
2148
|
+
* - org: The organization associated with the course.
|
|
2149
|
+
*
|
|
2150
|
+
* Returns:
|
|
2151
|
+
* - A serialized representation of the next course if found, with a status code of 200.
|
|
2152
|
+
* - A status code of 400 if the course_id is not provided.
|
|
2153
|
+
* - A status code of 200 with a None response if no next course is found.
|
|
2154
|
+
*
|
|
2155
|
+
* Error Conditions:
|
|
2156
|
+
* - Returns a 400 status code if the course_id is missing from the request parameters.
|
|
2157
|
+
*
|
|
2158
|
+
* Side Effects:
|
|
2159
|
+
* - None
|
|
2160
|
+
* @param courseId Current course ID
|
|
2161
|
+
* @param org Organization to filter recommendations
|
|
2162
|
+
* @param userId User ID for personalized recommendations
|
|
2163
|
+
* @returns Course
|
|
2164
|
+
* @throws ApiError
|
|
2165
|
+
*/
|
|
2166
|
+
static catalogRecommendationCoursesRetrieve(courseId: string, org?: string, userId?: string): CancelablePromise<Course>;
|
|
2167
|
+
/**
|
|
2168
|
+
* Retrieve resources matching query. Limited parameters.
|
|
2169
|
+
* @param id Resource ID
|
|
2170
|
+
* @param itemId Item ID associated with the resource
|
|
2171
|
+
* @param key Platform key
|
|
2172
|
+
* @param name Resource name
|
|
2173
|
+
* @param org Platform organization
|
|
2174
|
+
* @param platformKey Platform key (alternative to key)
|
|
2175
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
2176
|
+
* @param resourceType Type of resource
|
|
2177
|
+
* @param userId User ID who owns the resource
|
|
2178
|
+
* @param username Username who owns the resource
|
|
2179
|
+
* @returns Resource
|
|
2180
|
+
* @throws ApiError
|
|
2181
|
+
*/
|
|
2182
|
+
static catalogResourcesList(id?: number, itemId?: string, key?: string, name?: string, org?: string, platformKey?: string, platformOrg?: string, resourceType?: string, userId?: number, username?: string): CancelablePromise<Array<Resource>>;
|
|
2183
|
+
/**
|
|
2184
|
+
* Create or update a resource with optional image upload
|
|
2185
|
+
* Create or update a resource. For updates, include the resource ID.
|
|
2186
|
+
* @param formData
|
|
2187
|
+
* @param id Resource ID
|
|
2188
|
+
* @param itemId Item ID associated with the resource
|
|
2189
|
+
* @param key Platform key
|
|
2190
|
+
* @param name Resource name
|
|
2191
|
+
* @param org Platform organization
|
|
2192
|
+
* @param platformKey Platform key (alternative to key)
|
|
2193
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
2194
|
+
* @param resourceType Type of resource
|
|
2195
|
+
* @param userId User ID who owns the resource
|
|
2196
|
+
* @param username Username who owns the resource
|
|
2197
|
+
* @returns Resource
|
|
2198
|
+
* @throws ApiError
|
|
2199
|
+
*/
|
|
2200
|
+
static catalogResourcesCreate(formData: ResourceCreateUpdate, id?: number, itemId?: string, key?: string, name?: string, org?: string, platformKey?: string, platformOrg?: string, resourceType?: string, userId?: number, username?: string): CancelablePromise<Resource>;
|
|
2201
|
+
/**
|
|
2202
|
+
* Remove a resource from the database.
|
|
2203
|
+
* @param id Resource ID
|
|
2204
|
+
* @param itemId Item ID associated with the resource
|
|
2205
|
+
* @param key Platform key
|
|
2206
|
+
* @param name Resource name
|
|
2207
|
+
* @param org Platform organization
|
|
2208
|
+
* @param platformKey Platform key (alternative to key)
|
|
2209
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
2210
|
+
* @param resourceType Type of resource
|
|
2211
|
+
* @param userId User ID who owns the resource
|
|
2212
|
+
* @param username Username who owns the resource
|
|
2213
|
+
* @returns ResourceDeleteResponse
|
|
2214
|
+
* @throws ApiError
|
|
2215
|
+
*/
|
|
2216
|
+
static catalogResourcesDestroy(id?: number, itemId?: string, key?: string, name?: string, org?: string, platformKey?: string, platformOrg?: string, resourceType?: string, userId?: number, username?: string): CancelablePromise<ResourceDeleteResponse>;
|
|
2217
|
+
/**
|
|
2218
|
+
* API View for querying course reviews.
|
|
2219
|
+
*
|
|
2220
|
+
* This endpoint allows users to retrieve course reviews with filtering by course, user,
|
|
2221
|
+
* and platform. Results are paginated and include detailed review information.
|
|
2222
|
+
*
|
|
2223
|
+
* Query Parameters:
|
|
2224
|
+
* course_id (str, optional): Filter reviews by course ID
|
|
2225
|
+
* user_id (str/int, optional): Filter reviews by user ID
|
|
2226
|
+
* platform_key (str, optional): Filter reviews by platform key
|
|
2227
|
+
* platform_org (str, optional): Filter reviews by platform organization
|
|
2228
|
+
* org (str, optional): Alias for platform_org
|
|
2229
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
2230
|
+
* page (int, optional): Page number for pagination
|
|
2231
|
+
* page_size (int, optional): Number of items per page
|
|
2232
|
+
*
|
|
2233
|
+
* Methods:
|
|
2234
|
+
* GET: Retrieve a paginated list of course reviews with filtering
|
|
2235
|
+
*
|
|
2236
|
+
* Returns:
|
|
2237
|
+
* GET: A paginated JSON response containing course reviews:
|
|
2238
|
+
* {
|
|
2239
|
+
* "count": 15,
|
|
2240
|
+
* "next": "https://api.example.com/api/catalog/reviews/course/?page=2",
|
|
2241
|
+
* "previous": null,
|
|
2242
|
+
* "results": [
|
|
2243
|
+
* {
|
|
2244
|
+
* "user_id": 123,
|
|
2245
|
+
* "username": "student1",
|
|
2246
|
+
* "content": "This course was excellent and very informative.",
|
|
2247
|
+
* "rating": 4.5,
|
|
2248
|
+
* "title": "Great Course!",
|
|
2249
|
+
* "visible": true,
|
|
2250
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2251
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2252
|
+
* "course_id": "course-v1:org+course+run"
|
|
2253
|
+
* },
|
|
2254
|
+
* ...
|
|
2255
|
+
* ]
|
|
2256
|
+
* }
|
|
2257
|
+
*
|
|
2258
|
+
* Error Responses:
|
|
2259
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2260
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2261
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
2262
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
2263
|
+
*
|
|
2264
|
+
* Access Control:
|
|
2265
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForCourse permission
|
|
2266
|
+
* - Platform admins can view reviews for courses in their platform (read-only)
|
|
2267
|
+
* - DM admins can view all reviews
|
|
2268
|
+
* @returns any No response body
|
|
2269
|
+
* @throws ApiError
|
|
2270
|
+
*/
|
|
2271
|
+
static catalogReviewsCourseRetrieve(): CancelablePromise<any>;
|
|
2272
|
+
/**
|
|
2273
|
+
* Retrieve aggregate review information for a course.
|
|
2274
|
+
* @param courseId The course ID to get review information for
|
|
2275
|
+
* @returns CourseReviewInfoResponse
|
|
2276
|
+
* @throws ApiError
|
|
2277
|
+
*/
|
|
2278
|
+
static catalogReviewsCourseInfoRetrieve(courseId: string): CancelablePromise<CourseReviewInfoResponse>;
|
|
2279
|
+
/**
|
|
2280
|
+
* API View for creating, updating, and deleting course reviews.
|
|
2281
|
+
*
|
|
2282
|
+
* This endpoint allows users to create, update, or delete their own course reviews.
|
|
2283
|
+
*
|
|
2284
|
+
* Methods:
|
|
2285
|
+
* POST: Create or update a course review
|
|
2286
|
+
* DELETE: Delete a course review
|
|
2287
|
+
*
|
|
2288
|
+
* Request Body (POST):
|
|
2289
|
+
* A JSON object containing:
|
|
2290
|
+
* - course_id (str, required): The course ID to review
|
|
2291
|
+
* - username (str, required): The username of the reviewer
|
|
2292
|
+
* - rating (float, optional): The rating value (typically 1-5)
|
|
2293
|
+
* - title (str, optional): The review title
|
|
2294
|
+
* - content (str, optional): The review content/text
|
|
2295
|
+
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
2296
|
+
*
|
|
2297
|
+
* Query Parameters (DELETE):
|
|
2298
|
+
* course_id (str, required): The course ID of the review to delete
|
|
2299
|
+
* username (str, required): The username of the reviewer
|
|
2300
|
+
*
|
|
2301
|
+
* Returns:
|
|
2302
|
+
* POST: A JSON response containing the created/updated review:
|
|
2303
|
+
* {
|
|
2304
|
+
* "user_id": 123,
|
|
2305
|
+
* "username": "student1",
|
|
2306
|
+
* "content": "This course was excellent and very informative.",
|
|
2307
|
+
* "rating": 4.5,
|
|
2308
|
+
* "title": "Great Course!",
|
|
2309
|
+
* "visible": true,
|
|
2310
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2311
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2312
|
+
* "course_id": "course-v1:org+course+run"
|
|
2313
|
+
* }
|
|
2314
|
+
*
|
|
2315
|
+
* DELETE: A success response with status 200
|
|
2316
|
+
*
|
|
2317
|
+
* Error Responses:
|
|
2318
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2319
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2320
|
+
* 403 Forbidden: If the user does not have permission to manage this review
|
|
2321
|
+
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
2322
|
+
*
|
|
2323
|
+
* Access Control:
|
|
2324
|
+
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
2325
|
+
* - Users can create, update, or delete their own reviews
|
|
2326
|
+
* - DM admins can manage all reviews
|
|
2327
|
+
* @returns any No response body
|
|
2328
|
+
* @throws ApiError
|
|
2329
|
+
*/
|
|
2330
|
+
static catalogReviewsCourseUpdateCreate(): CancelablePromise<any>;
|
|
2331
|
+
/**
|
|
2332
|
+
* API View for creating, updating, and deleting course reviews.
|
|
2333
|
+
*
|
|
2334
|
+
* This endpoint allows users to create, update, or delete their own course reviews.
|
|
2335
|
+
*
|
|
2336
|
+
* Methods:
|
|
2337
|
+
* POST: Create or update a course review
|
|
2338
|
+
* DELETE: Delete a course review
|
|
2339
|
+
*
|
|
2340
|
+
* Request Body (POST):
|
|
2341
|
+
* A JSON object containing:
|
|
2342
|
+
* - course_id (str, required): The course ID to review
|
|
2343
|
+
* - username (str, required): The username of the reviewer
|
|
2344
|
+
* - rating (float, optional): The rating value (typically 1-5)
|
|
2345
|
+
* - title (str, optional): The review title
|
|
2346
|
+
* - content (str, optional): The review content/text
|
|
2347
|
+
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
2348
|
+
*
|
|
2349
|
+
* Query Parameters (DELETE):
|
|
2350
|
+
* course_id (str, required): The course ID of the review to delete
|
|
2351
|
+
* username (str, required): The username of the reviewer
|
|
2352
|
+
*
|
|
2353
|
+
* Returns:
|
|
2354
|
+
* POST: A JSON response containing the created/updated review:
|
|
2355
|
+
* {
|
|
2356
|
+
* "user_id": 123,
|
|
2357
|
+
* "username": "student1",
|
|
2358
|
+
* "content": "This course was excellent and very informative.",
|
|
2359
|
+
* "rating": 4.5,
|
|
2360
|
+
* "title": "Great Course!",
|
|
2361
|
+
* "visible": true,
|
|
2362
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2363
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2364
|
+
* "course_id": "course-v1:org+course+run"
|
|
2365
|
+
* }
|
|
2366
|
+
*
|
|
2367
|
+
* DELETE: A success response with status 200
|
|
2368
|
+
*
|
|
2369
|
+
* Error Responses:
|
|
2370
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2371
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2372
|
+
* 403 Forbidden: If the user does not have permission to manage this review
|
|
2373
|
+
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
2374
|
+
*
|
|
2375
|
+
* Access Control:
|
|
2376
|
+
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
2377
|
+
* - Users can create, update, or delete their own reviews
|
|
2378
|
+
* - DM admins can manage all reviews
|
|
2379
|
+
* @returns void
|
|
2380
|
+
* @throws ApiError
|
|
2381
|
+
*/
|
|
2382
|
+
static catalogReviewsCourseUpdateDestroy(): CancelablePromise<void>;
|
|
2383
|
+
/**
|
|
2384
|
+
* API View for querying program reviews.
|
|
2385
|
+
*
|
|
2386
|
+
* This endpoint allows users to retrieve program reviews with filtering by program, user,
|
|
2387
|
+
* and platform. Results are paginated and include detailed review information.
|
|
2388
|
+
*
|
|
2389
|
+
* Query Parameters:
|
|
2390
|
+
* program_id (str, optional): Filter reviews by program ID
|
|
2391
|
+
* platform_key (str, optional): Filter reviews by platform key
|
|
2392
|
+
* platform_org (str, optional): Filter reviews by platform organization
|
|
2393
|
+
* org (str, optional): Alias for platform_org
|
|
2394
|
+
* user_id (str/int, optional): Filter reviews by user ID
|
|
2395
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
2396
|
+
* page (int, optional): Page number for pagination
|
|
2397
|
+
* page_size (int, optional): Number of items per page
|
|
2398
|
+
*
|
|
2399
|
+
* Methods:
|
|
2400
|
+
* GET: Retrieve a paginated list of program reviews with filtering
|
|
2401
|
+
*
|
|
2402
|
+
* Returns:
|
|
2403
|
+
* GET: A paginated JSON response containing program reviews:
|
|
2404
|
+
* {
|
|
2405
|
+
* "count": 15,
|
|
2406
|
+
* "next": "https://api.example.com/api/catalog/reviews/program/?page=2",
|
|
2407
|
+
* "previous": null,
|
|
2408
|
+
* "results": [
|
|
2409
|
+
* {
|
|
2410
|
+
* "user_id": 123,
|
|
2411
|
+
* "username": "student1",
|
|
2412
|
+
* "content": "This program was comprehensive and well-structured.",
|
|
2413
|
+
* "rating": 4.5,
|
|
2414
|
+
* "title": "Excellent Program",
|
|
2415
|
+
* "visible": true,
|
|
2416
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2417
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2418
|
+
* "program_key": "program-v1:org+program123"
|
|
2419
|
+
* },
|
|
2420
|
+
* ...
|
|
2421
|
+
* ]
|
|
2422
|
+
* }
|
|
2423
|
+
*
|
|
2424
|
+
* Error Responses:
|
|
2425
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2426
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2427
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
2428
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
2429
|
+
*
|
|
2430
|
+
* Access Control:
|
|
2431
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
|
|
2432
|
+
* - Platform admins can view reviews for programs in their platform (read-only)
|
|
2433
|
+
* - DM admins can view all reviews
|
|
2434
|
+
* @returns any No response body
|
|
2435
|
+
* @throws ApiError
|
|
2436
|
+
*/
|
|
2437
|
+
static catalogReviewsProgramRetrieve(): CancelablePromise<any>;
|
|
2438
|
+
/**
|
|
2439
|
+
* Retrieve aggregate review information for a program.
|
|
2440
|
+
* @param programKey The program key to get review information for
|
|
2441
|
+
* @returns ProgramReviewInfoResponse
|
|
2442
|
+
* @throws ApiError
|
|
2443
|
+
*/
|
|
2444
|
+
static catalogReviewsProgramInfoRetrieve(programKey: string): CancelablePromise<ProgramReviewInfoResponse>;
|
|
2445
|
+
/**
|
|
2446
|
+
* API View for creating, updating, and deleting program reviews.
|
|
2447
|
+
*
|
|
2448
|
+
* This endpoint allows users to create, update, or delete their own program reviews.
|
|
2449
|
+
*
|
|
2450
|
+
* Methods:
|
|
2451
|
+
* POST: Create or update a program review
|
|
2452
|
+
* DELETE: Delete a program review
|
|
2453
|
+
*
|
|
2454
|
+
* Request Body (POST):
|
|
2455
|
+
* A JSON object containing:
|
|
2456
|
+
* - program_key (str, required): The program key to review (format: program-v1:org+program_id)
|
|
2457
|
+
* - username (str, required): The username of the reviewer
|
|
2458
|
+
* - rating (float, optional): The rating value (typically 1-5)
|
|
2459
|
+
* - title (str, optional): The review title
|
|
2460
|
+
* - content (str, optional): The review content/text
|
|
2461
|
+
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
2462
|
+
*
|
|
2463
|
+
* Query Parameters (DELETE):
|
|
2464
|
+
* program_key (str, required): The program key of the review to delete
|
|
2465
|
+
* username (str, required): The username of the reviewer
|
|
2466
|
+
*
|
|
2467
|
+
* Returns:
|
|
2468
|
+
* POST: A JSON response containing the created/updated review:
|
|
2469
|
+
* {
|
|
2470
|
+
* "user_id": 123,
|
|
2471
|
+
* "username": "student1",
|
|
2472
|
+
* "content": "This program was comprehensive and well-structured.",
|
|
2473
|
+
* "rating": 4.5,
|
|
2474
|
+
* "title": "Excellent Program",
|
|
2475
|
+
* "visible": true,
|
|
2476
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2477
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2478
|
+
* "program_key": "program-v1:org+program123"
|
|
2479
|
+
* }
|
|
2480
|
+
*
|
|
2481
|
+
* DELETE: A success response with status 200
|
|
2482
|
+
*
|
|
2483
|
+
* Error Responses:
|
|
2484
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2485
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2486
|
+
* 403 Forbidden: If the user does not have permission to manage this review
|
|
2487
|
+
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
2488
|
+
*
|
|
2489
|
+
* Access Control:
|
|
2490
|
+
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
2491
|
+
* - Users can create, update, or delete their own reviews
|
|
2492
|
+
* - DM admins can manage all reviews
|
|
2493
|
+
* @returns any No response body
|
|
2494
|
+
* @throws ApiError
|
|
2495
|
+
*/
|
|
2496
|
+
static catalogReviewsProgramUpdateCreate(): CancelablePromise<any>;
|
|
2497
|
+
/**
|
|
2498
|
+
* API View for creating, updating, and deleting program reviews.
|
|
2499
|
+
*
|
|
2500
|
+
* This endpoint allows users to create, update, or delete their own program reviews.
|
|
2501
|
+
*
|
|
2502
|
+
* Methods:
|
|
2503
|
+
* POST: Create or update a program review
|
|
2504
|
+
* DELETE: Delete a program review
|
|
2505
|
+
*
|
|
2506
|
+
* Request Body (POST):
|
|
2507
|
+
* A JSON object containing:
|
|
2508
|
+
* - program_key (str, required): The program key to review (format: program-v1:org+program_id)
|
|
2509
|
+
* - username (str, required): The username of the reviewer
|
|
2510
|
+
* - rating (float, optional): The rating value (typically 1-5)
|
|
2511
|
+
* - title (str, optional): The review title
|
|
2512
|
+
* - content (str, optional): The review content/text
|
|
2513
|
+
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
2514
|
+
*
|
|
2515
|
+
* Query Parameters (DELETE):
|
|
2516
|
+
* program_key (str, required): The program key of the review to delete
|
|
2517
|
+
* username (str, required): The username of the reviewer
|
|
2518
|
+
*
|
|
2519
|
+
* Returns:
|
|
2520
|
+
* POST: A JSON response containing the created/updated review:
|
|
2521
|
+
* {
|
|
2522
|
+
* "user_id": 123,
|
|
2523
|
+
* "username": "student1",
|
|
2524
|
+
* "content": "This program was comprehensive and well-structured.",
|
|
2525
|
+
* "rating": 4.5,
|
|
2526
|
+
* "title": "Excellent Program",
|
|
2527
|
+
* "visible": true,
|
|
2528
|
+
* "created": "2023-01-15T10:30:00Z",
|
|
2529
|
+
* "modified": "2023-01-15T10:30:00Z",
|
|
2530
|
+
* "program_key": "program-v1:org+program123"
|
|
2531
|
+
* }
|
|
2532
|
+
*
|
|
2533
|
+
* DELETE: A success response with status 200
|
|
2534
|
+
*
|
|
2535
|
+
* Error Responses:
|
|
2536
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2537
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2538
|
+
* 403 Forbidden: If the user does not have permission to manage this review
|
|
2539
|
+
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
2540
|
+
*
|
|
2541
|
+
* Access Control:
|
|
2542
|
+
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
2543
|
+
* - Users can create, update, or delete their own reviews
|
|
2544
|
+
* - DM admins can manage all reviews
|
|
2545
|
+
* @returns void
|
|
2546
|
+
* @throws ApiError
|
|
2547
|
+
*/
|
|
2548
|
+
static catalogReviewsProgramUpdateDestroy(): CancelablePromise<void>;
|
|
2549
|
+
/**
|
|
2550
|
+
* Retrieve roles matching query parameters. Supports filtering by name, id, and slug.
|
|
2551
|
+
* @param id Role ID
|
|
2552
|
+
* @param name Role name
|
|
2553
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
2554
|
+
* @param page Page number for pagination
|
|
2555
|
+
* @param pageSize Number of items per page
|
|
2556
|
+
* @param platformKey Platform key
|
|
2557
|
+
* @param slug Role slug
|
|
2558
|
+
* @param sort Field to sort results by
|
|
2559
|
+
* @returns Role
|
|
2560
|
+
* @throws ApiError
|
|
2561
|
+
*/
|
|
2562
|
+
static catalogRolesRetrieve(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Role>;
|
|
2563
|
+
/**
|
|
2564
|
+
* Add a new role or update an existing role based on provided data.
|
|
2565
|
+
* @param requestBody
|
|
2566
|
+
* @param id Role ID
|
|
2567
|
+
* @param name Role name
|
|
2568
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
2569
|
+
* @param page Page number for pagination
|
|
2570
|
+
* @param pageSize Number of items per page
|
|
2571
|
+
* @param platformKey Platform key
|
|
2572
|
+
* @param slug Role slug
|
|
2573
|
+
* @param sort Field to sort results by
|
|
2574
|
+
* @returns Role
|
|
2575
|
+
* @throws ApiError
|
|
2576
|
+
*/
|
|
2577
|
+
static catalogRolesCreate(requestBody: RoleCreateUpdateRequest, id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Role>;
|
|
2578
|
+
/**
|
|
2579
|
+
* Retrieve desired roles for a user.
|
|
2580
|
+
* @param userId User ID
|
|
2581
|
+
* @param username Username
|
|
2582
|
+
* @returns DesiredRole
|
|
2583
|
+
* @throws ApiError
|
|
2584
|
+
*/
|
|
2585
|
+
static catalogRolesDesiredRetrieve(userId?: number, username?: string): CancelablePromise<DesiredRole>;
|
|
2586
|
+
/**
|
|
2587
|
+
* Add or update desired roles for a user.
|
|
2588
|
+
* @param requestBody
|
|
2589
|
+
* @param userId User ID
|
|
2590
|
+
* @param username Username
|
|
2591
|
+
* @returns DesiredRole
|
|
2592
|
+
* @throws ApiError
|
|
2593
|
+
*/
|
|
2594
|
+
static catalogRolesDesiredCreate(requestBody: DesiredRoleCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<DesiredRole>;
|
|
2595
|
+
/**
|
|
2596
|
+
* Add or update a role through the public API (when enabled).
|
|
2597
|
+
* @param requestBody
|
|
2598
|
+
* @returns Role
|
|
2599
|
+
* @throws ApiError
|
|
2600
|
+
*/
|
|
2601
|
+
static catalogRolesPublicCreate(requestBody: RoleCreateUpdateRequest): CancelablePromise<Role>;
|
|
2602
|
+
/**
|
|
2603
|
+
* Retrieve reported roles for a user.
|
|
2604
|
+
* @param userId User ID
|
|
2605
|
+
* @param username Username
|
|
2606
|
+
* @returns ReportedRole
|
|
2607
|
+
* @throws ApiError
|
|
2608
|
+
*/
|
|
2609
|
+
static catalogRolesReportedRetrieve(userId?: number, username?: string): CancelablePromise<ReportedRole>;
|
|
2610
|
+
/**
|
|
2611
|
+
* Add or update reported roles for a user.
|
|
2612
|
+
* @param requestBody
|
|
2613
|
+
* @param userId User ID
|
|
2614
|
+
* @param username Username
|
|
2615
|
+
* @returns ReportedRole
|
|
2616
|
+
* @throws ApiError
|
|
2617
|
+
*/
|
|
2618
|
+
static catalogRolesReportedCreate(requestBody: ReportedRoleCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<ReportedRole>;
|
|
2619
|
+
/**
|
|
2620
|
+
* POST
|
|
2621
|
+
* Retrieve programs matching query.
|
|
2622
|
+
*
|
|
2623
|
+
* Params:
|
|
2624
|
+
* query: The search term used to filter programs.
|
|
2625
|
+
* org: The organization to which the programs belong.
|
|
2626
|
+
*
|
|
2627
|
+
* Returns:
|
|
2628
|
+
* A JSON response containing a list of programs that match the search criteria.
|
|
2629
|
+
*
|
|
2630
|
+
* Error Conditions:
|
|
2631
|
+
* - If the request data is malformed or missing required fields, a 400 Bad Request may be returned.
|
|
2632
|
+
* - If there is an issue with the database query, a 500 Internal Server Error may be returned.
|
|
2633
|
+
*
|
|
2634
|
+
* Side Effects:
|
|
2635
|
+
* - None
|
|
2636
|
+
*
|
|
2637
|
+
* Special Return Codes:
|
|
2638
|
+
* - A 200 status code indicates successful retrieval of programs matching the query.
|
|
2639
|
+
* @param requestBody
|
|
2640
|
+
* @param org The organization to which the programs belong
|
|
2641
|
+
* @param query The search term used to filter programs
|
|
2642
|
+
* @returns ProgramSearch
|
|
2643
|
+
* @throws ApiError
|
|
2644
|
+
*/
|
|
2645
|
+
static catalogSearchProgramsCreate(requestBody: ProgramSearch, org?: string, query?: string): CancelablePromise<ProgramSearch>;
|
|
2646
|
+
/**
|
|
2647
|
+
* Retrieve skills matching query. Limited parameters.
|
|
2648
|
+
* @param id Skill ID
|
|
2649
|
+
* @param name Skill name
|
|
2650
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
2651
|
+
* @param page Page number for pagination
|
|
2652
|
+
* @param pageSize Number of items per page
|
|
2653
|
+
* @param platformKey Platform key
|
|
2654
|
+
* @param slug Skill slug
|
|
2655
|
+
* @param sort Field to sort results by
|
|
2656
|
+
* @returns Skill
|
|
2657
|
+
* @throws ApiError
|
|
2658
|
+
*/
|
|
2659
|
+
static catalogSkillsRetrieve(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Skill>;
|
|
2660
|
+
/**
|
|
2661
|
+
* Add or update a skill.
|
|
2662
|
+
* @param id Skill ID
|
|
2663
|
+
* @param name Skill name
|
|
2664
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
2665
|
+
* @param page Page number for pagination
|
|
2666
|
+
* @param pageSize Number of items per page
|
|
2667
|
+
* @param platformKey Platform key
|
|
2668
|
+
* @param slug Skill slug
|
|
2669
|
+
* @param sort Field to sort results by
|
|
2670
|
+
* @param requestBody
|
|
2671
|
+
* @returns Skill
|
|
2672
|
+
* @throws ApiError
|
|
2673
|
+
*/
|
|
2674
|
+
static catalogSkillsCreate(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string, requestBody?: Skill): CancelablePromise<Skill>;
|
|
2675
|
+
/**
|
|
2676
|
+
* Retrieve desired skills for a user.
|
|
2677
|
+
* @param userId User ID
|
|
2678
|
+
* @param username Username
|
|
2679
|
+
* @returns DesiredSkill
|
|
2680
|
+
* @throws ApiError
|
|
2681
|
+
*/
|
|
2682
|
+
static catalogSkillsDesiredRetrieve(userId?: number, username?: string): CancelablePromise<DesiredSkill>;
|
|
2683
|
+
/**
|
|
2684
|
+
* Add or update desired skills for a user.
|
|
2685
|
+
* @param requestBody
|
|
2686
|
+
* @param userId User ID
|
|
2687
|
+
* @param username Username
|
|
2688
|
+
* @returns DesiredSkill
|
|
2689
|
+
* @throws ApiError
|
|
2690
|
+
*/
|
|
2691
|
+
static catalogSkillsDesiredCreate(requestBody: DesiredSkillCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<DesiredSkill>;
|
|
2692
|
+
/**
|
|
2693
|
+
* Add or update a skill.
|
|
2694
|
+
* @param requestBody
|
|
2695
|
+
* @returns Skill
|
|
2696
|
+
* @throws ApiError
|
|
2697
|
+
*/
|
|
2698
|
+
static catalogSkillsPublicCreate(requestBody: SkillCreateUpdateRequest): CancelablePromise<Skill>;
|
|
2699
|
+
/**
|
|
2700
|
+
* GET
|
|
2701
|
+
* Retrieve desired skills for user
|
|
2702
|
+
*
|
|
2703
|
+
* Params:
|
|
2704
|
+
* name
|
|
2705
|
+
* id
|
|
2706
|
+
* slug
|
|
2707
|
+
*
|
|
2708
|
+
* This method retrieves the skills reported by a user. It requires either
|
|
2709
|
+
* a user_id or username to identify the user. If the user is found and has
|
|
2710
|
+
* reported skills, the first reported skill is serialized and returned with
|
|
2711
|
+
* a status code of 200. If no skills are found, a status code of 400 is returned.
|
|
2712
|
+
*
|
|
2713
|
+
* Error Conditions:
|
|
2714
|
+
* - If the user cannot be identified, a 400 status code is returned.
|
|
2715
|
+
* - If no reported skills exist for the user, a 400 status code is returned.
|
|
2716
|
+
* @param userId User ID
|
|
2717
|
+
* @param username Username
|
|
2718
|
+
* @returns ReportedSkill
|
|
2719
|
+
* @throws ApiError
|
|
2720
|
+
*/
|
|
2721
|
+
static catalogSkillsReportedRetrieve(userId?: number, username?: string): CancelablePromise<ReportedSkill>;
|
|
2722
|
+
/**
|
|
2723
|
+
* POST
|
|
2724
|
+
* Add or update a skill.
|
|
2725
|
+
*
|
|
2726
|
+
* Params:
|
|
2727
|
+
* user_id/username
|
|
2728
|
+
* skills
|
|
2729
|
+
* data
|
|
2730
|
+
*
|
|
2731
|
+
* This method allows adding or updating a user's reported skills. It requires
|
|
2732
|
+
* either a user_id or username to identify the user, along with a list of skills
|
|
2733
|
+
* and additional data. If the user is identified and the skills are successfully
|
|
2734
|
+
* saved, the serialized skill data is returned. A status code of 201 indicates
|
|
2735
|
+
* that a new skill was created, while a status code of 200 indicates an update
|
|
2736
|
+
* to an existing skill.
|
|
2737
|
+
*
|
|
2738
|
+
* Error Conditions:
|
|
2739
|
+
* - If the user cannot be identified, a 400 status code is returned.
|
|
2740
|
+
* - If the skills cannot be saved, a 400 status code is returned.
|
|
2741
|
+
*
|
|
2742
|
+
* Side Effects:
|
|
2743
|
+
* - If a new skill is created, it will be persisted in the database.
|
|
2744
|
+
* - If an existing skill is updated, the changes will be saved in the database.
|
|
2745
|
+
* @param requestBody
|
|
2746
|
+
* @param userId User ID
|
|
2747
|
+
* @param username Username
|
|
2748
|
+
* @returns ReportedSkill
|
|
2749
|
+
* @throws ApiError
|
|
2750
|
+
*/
|
|
2751
|
+
static catalogSkillsReportedCreate(requestBody: ReportedSkill, userId?: number, username?: string): CancelablePromise<ReportedSkill>;
|
|
2752
|
+
/**
|
|
2753
|
+
* API View for managing course suggestions.
|
|
2754
|
+
*
|
|
2755
|
+
* This endpoint allows administrators to view, create, update, and delete course suggestions
|
|
2756
|
+
* for users within a platform.
|
|
2757
|
+
*
|
|
2758
|
+
* Query Parameters (GET):
|
|
2759
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
2760
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
2761
|
+
* query (str, optional): Search term to filter suggestions
|
|
2762
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
2763
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
2764
|
+
* page (int, optional): Page number for pagination
|
|
2765
|
+
* page_size (int, optional): Number of items per page
|
|
2766
|
+
*
|
|
2767
|
+
* Methods:
|
|
2768
|
+
* GET: Retrieve a paginated list of course suggestions for a platform
|
|
2769
|
+
* POST: Create or update a course suggestion
|
|
2770
|
+
* DELETE: Remove a course suggestion
|
|
2771
|
+
*
|
|
2772
|
+
* Request Body (POST):
|
|
2773
|
+
* A JSON object containing:
|
|
2774
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
2775
|
+
* - course_id (str, required): The course ID to suggest
|
|
2776
|
+
* - user_id (str/int, required): The user to suggest the course to
|
|
2777
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
2778
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
2779
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
2780
|
+
*
|
|
2781
|
+
* Query Parameters (DELETE):
|
|
2782
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
2783
|
+
*
|
|
2784
|
+
* Returns:
|
|
2785
|
+
* GET: A paginated JSON response containing course suggestions:
|
|
2786
|
+
* {
|
|
2787
|
+
* "count": 10,
|
|
2788
|
+
* "next": "https://example.com/api/catalog/suggestions/course/manage/?page=2",
|
|
2789
|
+
* "previous": null,
|
|
2790
|
+
* "results": [
|
|
2791
|
+
* {
|
|
2792
|
+
* "id": 123,
|
|
2793
|
+
* "user_id": 456,
|
|
2794
|
+
* "username": "student1",
|
|
2795
|
+
* "name": "Student Name",
|
|
2796
|
+
* "platform_key": "platform1",
|
|
2797
|
+
* "accepted": false,
|
|
2798
|
+
* "visible": true,
|
|
2799
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
2800
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
2801
|
+
* "metadata": {},
|
|
2802
|
+
* "course_id": "course-v1:org+course+run",
|
|
2803
|
+
* "course_name": "Introduction to Programming"
|
|
2804
|
+
* },
|
|
2805
|
+
* ...
|
|
2806
|
+
* ]
|
|
2807
|
+
* }
|
|
2808
|
+
*
|
|
2809
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
2810
|
+
* {
|
|
2811
|
+
* "id": 123,
|
|
2812
|
+
* "user_id": 456,
|
|
2813
|
+
* "username": "student1",
|
|
2814
|
+
* "name": "Student Name",
|
|
2815
|
+
* "platform_key": "platform1",
|
|
2816
|
+
* "accepted": false,
|
|
2817
|
+
* "visible": true,
|
|
2818
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
2819
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
2820
|
+
* "metadata": {},
|
|
2821
|
+
* "course_id": "course-v1:org+course+run",
|
|
2822
|
+
* "course_name": "Introduction to Programming"
|
|
2823
|
+
* }
|
|
2824
|
+
*
|
|
2825
|
+
* DELETE: A success response with status 200
|
|
2826
|
+
*
|
|
2827
|
+
* Error Responses:
|
|
2828
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
2829
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2830
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
2831
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
2832
|
+
*
|
|
2833
|
+
* Access Control:
|
|
2834
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
2835
|
+
* - Platform admins can manage suggestions for their platform
|
|
2836
|
+
* - Department admins can manage suggestions for their departments
|
|
2837
|
+
* - DM admins can manage all suggestions
|
|
2838
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
2839
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
2840
|
+
* @param page Page number for pagination
|
|
2841
|
+
* @param pageSize Number of items per page
|
|
2842
|
+
* @param platformOrg The organization identifier for the platform
|
|
2843
|
+
* @param query Search term to filter suggestions
|
|
2844
|
+
* @param sort Field to sort results by
|
|
2845
|
+
* @returns PaginatedCourseSuggestion
|
|
2846
|
+
* @throws ApiError
|
|
2847
|
+
*/
|
|
2848
|
+
static catalogSuggestionsCourseManageRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedCourseSuggestion>;
|
|
2849
|
+
/**
|
|
2850
|
+
* API View for managing course suggestions.
|
|
2851
|
+
*
|
|
2852
|
+
* This endpoint allows administrators to view, create, update, and delete course suggestions
|
|
2853
|
+
* for users within a platform.
|
|
2854
|
+
*
|
|
2855
|
+
* Query Parameters (GET):
|
|
2856
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
2857
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
2858
|
+
* query (str, optional): Search term to filter suggestions
|
|
2859
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
2860
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
2861
|
+
* page (int, optional): Page number for pagination
|
|
2862
|
+
* page_size (int, optional): Number of items per page
|
|
2863
|
+
*
|
|
2864
|
+
* Methods:
|
|
2865
|
+
* GET: Retrieve a paginated list of course suggestions for a platform
|
|
2866
|
+
* POST: Create or update a course suggestion
|
|
2867
|
+
* DELETE: Remove a course suggestion
|
|
2868
|
+
*
|
|
2869
|
+
* Request Body (POST):
|
|
2870
|
+
* A JSON object containing:
|
|
2871
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
2872
|
+
* - course_id (str, required): The course ID to suggest
|
|
2873
|
+
* - user_id (str/int, required): The user to suggest the course to
|
|
2874
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
2875
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
2876
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
2877
|
+
*
|
|
2878
|
+
* Query Parameters (DELETE):
|
|
2879
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
2880
|
+
*
|
|
2881
|
+
* Returns:
|
|
2882
|
+
* GET: A paginated JSON response containing course suggestions:
|
|
2883
|
+
* {
|
|
2884
|
+
* "count": 10,
|
|
2885
|
+
* "next": "https://example.com/api/catalog/suggestions/course/manage/?page=2",
|
|
2886
|
+
* "previous": null,
|
|
2887
|
+
* "results": [
|
|
2888
|
+
* {
|
|
2889
|
+
* "id": 123,
|
|
2890
|
+
* "user_id": 456,
|
|
2891
|
+
* "username": "student1",
|
|
2892
|
+
* "name": "Student Name",
|
|
2893
|
+
* "platform_key": "platform1",
|
|
2894
|
+
* "accepted": false,
|
|
2895
|
+
* "visible": true,
|
|
2896
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
2897
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
2898
|
+
* "metadata": {},
|
|
2899
|
+
* "course_id": "course-v1:org+course+run",
|
|
2900
|
+
* "course_name": "Introduction to Programming"
|
|
2901
|
+
* },
|
|
2902
|
+
* ...
|
|
2903
|
+
* ]
|
|
2904
|
+
* }
|
|
2905
|
+
*
|
|
2906
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
2907
|
+
* {
|
|
2908
|
+
* "id": 123,
|
|
2909
|
+
* "user_id": 456,
|
|
2910
|
+
* "username": "student1",
|
|
2911
|
+
* "name": "Student Name",
|
|
2912
|
+
* "platform_key": "platform1",
|
|
2913
|
+
* "accepted": false,
|
|
2914
|
+
* "visible": true,
|
|
2915
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
2916
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
2917
|
+
* "metadata": {},
|
|
2918
|
+
* "course_id": "course-v1:org+course+run",
|
|
2919
|
+
* "course_name": "Introduction to Programming"
|
|
2920
|
+
* }
|
|
2921
|
+
*
|
|
2922
|
+
* DELETE: A success response with status 200
|
|
2923
|
+
*
|
|
2924
|
+
* Error Responses:
|
|
2925
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
2926
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2927
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
2928
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
2929
|
+
*
|
|
2930
|
+
* Access Control:
|
|
2931
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
2932
|
+
* - Platform admins can manage suggestions for their platform
|
|
2933
|
+
* - Department admins can manage suggestions for their departments
|
|
2934
|
+
* - DM admins can manage all suggestions
|
|
2935
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
2936
|
+
* @param requestBody
|
|
2937
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
2938
|
+
* @param page Page number for pagination
|
|
2939
|
+
* @param pageSize Number of items per page
|
|
2940
|
+
* @param platformOrg The organization identifier for the platform
|
|
2941
|
+
* @param query Search term to filter suggestions
|
|
2942
|
+
* @param sort Field to sort results by
|
|
2943
|
+
* @returns CourseSuggestionDetail
|
|
2944
|
+
* @throws ApiError
|
|
2945
|
+
*/
|
|
2946
|
+
static catalogSuggestionsCourseManageCreate(platformKey: string, requestBody: CourseSuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<CourseSuggestionDetail>;
|
|
2947
|
+
/**
|
|
2948
|
+
* Delete single suggestion
|
|
2949
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
2950
|
+
* @param suggestionId The ID of the suggestion to delete
|
|
2951
|
+
* @param departmentMode Flag to ensure department admins can call the API
|
|
2952
|
+
* @param page Page number for pagination
|
|
2953
|
+
* @param pageSize Number of items per page
|
|
2954
|
+
* @param platformOrg The organization identifier for the platform
|
|
2955
|
+
* @param query Search term to filter suggestions
|
|
2956
|
+
* @param sort Field to sort results by
|
|
2957
|
+
* @returns any Success - suggestion deleted
|
|
2958
|
+
* @throws ApiError
|
|
2959
|
+
*/
|
|
2960
|
+
static catalogSuggestionsCourseManageDestroy(platformKey: string, suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
2961
|
+
/**
|
|
2962
|
+
* API View for bulk management of course suggestions.
|
|
2963
|
+
*
|
|
2964
|
+
* This endpoint allows administrators to create multiple course suggestions at once.
|
|
2965
|
+
*
|
|
2966
|
+
* Methods:
|
|
2967
|
+
* POST: Create multiple course suggestions in bulk
|
|
2968
|
+
*
|
|
2969
|
+
* Request Body:
|
|
2970
|
+
* A JSON object containing:
|
|
2971
|
+
* - platform_key (str, required): The platform for the suggestions
|
|
2972
|
+
* - suggestion_data (list, required): List of suggestion objects, each containing:
|
|
2973
|
+
* - course_id (str, required): The course ID to suggest
|
|
2974
|
+
* - user_id (str/int, required): The user to suggest the course to
|
|
2975
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
2976
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
2977
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
2978
|
+
*
|
|
2979
|
+
* Returns:
|
|
2980
|
+
* POST: A JSON response containing the operation results:
|
|
2981
|
+
* {
|
|
2982
|
+
* "successes": 15,
|
|
2983
|
+
* "error_codes": []
|
|
2984
|
+
* }
|
|
2985
|
+
*
|
|
2986
|
+
* Error Responses:
|
|
2987
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
2988
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
2989
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
2990
|
+
* 500 Internal Server Error: If an unexpected error occurs during bulk creation
|
|
2991
|
+
*
|
|
2992
|
+
* Access Control:
|
|
2993
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
2994
|
+
* - Platform admins can create suggestions for their platform
|
|
2995
|
+
* - Department admins can create suggestions for their departments
|
|
2996
|
+
* - DM admins can create suggestions for any platform
|
|
2997
|
+
* @param requestBody
|
|
2998
|
+
* @returns BulkSuggestionResponse
|
|
2999
|
+
* @throws ApiError
|
|
3000
|
+
*/
|
|
3001
|
+
static catalogSuggestionsCourseManageBulkCreate(requestBody: CourseSuggestionBulkCreate): CancelablePromise<BulkSuggestionResponse>;
|
|
3002
|
+
/**
|
|
3003
|
+
* API View for managing course group suggestions.
|
|
3004
|
+
*
|
|
3005
|
+
* This endpoint allows administrators to view, create, and delete course suggestions
|
|
3006
|
+
* for groups of users within a platform.
|
|
3007
|
+
*
|
|
3008
|
+
* Query Parameters (GET):
|
|
3009
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3010
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3011
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3012
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3013
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3014
|
+
* page (int, optional): Page number for pagination
|
|
3015
|
+
* page_size (int, optional): Number of items per page
|
|
3016
|
+
*
|
|
3017
|
+
* Methods:
|
|
3018
|
+
* GET: Retrieve a paginated list of course group suggestions for a platform
|
|
3019
|
+
* POST: Create or update a course group suggestion
|
|
3020
|
+
* DELETE: Remove a course group suggestion
|
|
3021
|
+
*
|
|
3022
|
+
* Request Body (POST):
|
|
3023
|
+
* A JSON object containing:
|
|
3024
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3025
|
+
* - course_id (str, required): The course ID to suggest
|
|
3026
|
+
* - group_id (str/int, required): The group to suggest the course to
|
|
3027
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3028
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3029
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3030
|
+
*
|
|
3031
|
+
* Query Parameters (DELETE):
|
|
3032
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3033
|
+
*
|
|
3034
|
+
* Returns:
|
|
3035
|
+
* GET: A paginated JSON response containing course group suggestions:
|
|
3036
|
+
* {
|
|
3037
|
+
* "count": 5,
|
|
3038
|
+
* "next": "https://example.com/api/catalog/suggestions/course/group/?page=2",
|
|
3039
|
+
* "previous": null,
|
|
3040
|
+
* "results": [
|
|
3041
|
+
* {
|
|
3042
|
+
* "id": 123,
|
|
3043
|
+
* "group_id": 789,
|
|
3044
|
+
* "group_name": "Engineering Team",
|
|
3045
|
+
* "platform_key": "platform1",
|
|
3046
|
+
* "accepted": false,
|
|
3047
|
+
* "visible": true,
|
|
3048
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3049
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3050
|
+
* "metadata": {},
|
|
3051
|
+
* "course_id": "course-v1:org+course+run",
|
|
3052
|
+
* "course_name": "Introduction to Programming",
|
|
3053
|
+
* "user_count": 25
|
|
3054
|
+
* },
|
|
3055
|
+
* ...
|
|
3056
|
+
* ]
|
|
3057
|
+
* }
|
|
3058
|
+
*
|
|
3059
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3060
|
+
* {
|
|
3061
|
+
* "id": 123,
|
|
3062
|
+
* "group_id": 789,
|
|
3063
|
+
* "group_name": "Engineering Team",
|
|
3064
|
+
* "platform_key": "platform1",
|
|
3065
|
+
* "accepted": false,
|
|
3066
|
+
* "visible": true,
|
|
3067
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3068
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3069
|
+
* "metadata": {},
|
|
3070
|
+
* "course_id": "course-v1:org+course+run",
|
|
3071
|
+
* "course_name": "Introduction to Programming",
|
|
3072
|
+
* "user_count": 25
|
|
3073
|
+
* }
|
|
3074
|
+
*
|
|
3075
|
+
* DELETE: A success response with status 200
|
|
3076
|
+
*
|
|
3077
|
+
* Error Responses:
|
|
3078
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3079
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3080
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3081
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3082
|
+
*
|
|
3083
|
+
* Access Control:
|
|
3084
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3085
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3086
|
+
* - Department admins can manage group suggestions for their departments
|
|
3087
|
+
* - DM admins can manage all group suggestions
|
|
3088
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3089
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3090
|
+
* @param page Page number for pagination
|
|
3091
|
+
* @param pageSize Number of items per page
|
|
3092
|
+
* @param platformOrg The organization identifier for the platform
|
|
3093
|
+
* @param query Search term to filter group suggestions
|
|
3094
|
+
* @param sort Field to sort results by
|
|
3095
|
+
* @returns PaginatedCourseGroupSuggestion
|
|
3096
|
+
* @throws ApiError
|
|
3097
|
+
*/
|
|
3098
|
+
static catalogSuggestionsCourseManageGroupRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedCourseGroupSuggestion>;
|
|
3099
|
+
/**
|
|
3100
|
+
* API View for managing course group suggestions.
|
|
3101
|
+
*
|
|
3102
|
+
* This endpoint allows administrators to view, create, and delete course suggestions
|
|
3103
|
+
* for groups of users within a platform.
|
|
3104
|
+
*
|
|
3105
|
+
* Query Parameters (GET):
|
|
3106
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3107
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3108
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3109
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3110
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3111
|
+
* page (int, optional): Page number for pagination
|
|
3112
|
+
* page_size (int, optional): Number of items per page
|
|
3113
|
+
*
|
|
3114
|
+
* Methods:
|
|
3115
|
+
* GET: Retrieve a paginated list of course group suggestions for a platform
|
|
3116
|
+
* POST: Create or update a course group suggestion
|
|
3117
|
+
* DELETE: Remove a course group suggestion
|
|
3118
|
+
*
|
|
3119
|
+
* Request Body (POST):
|
|
3120
|
+
* A JSON object containing:
|
|
3121
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3122
|
+
* - course_id (str, required): The course ID to suggest
|
|
3123
|
+
* - group_id (str/int, required): The group to suggest the course to
|
|
3124
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3125
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3126
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3127
|
+
*
|
|
3128
|
+
* Query Parameters (DELETE):
|
|
3129
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3130
|
+
*
|
|
3131
|
+
* Returns:
|
|
3132
|
+
* GET: A paginated JSON response containing course group suggestions:
|
|
3133
|
+
* {
|
|
3134
|
+
* "count": 5,
|
|
3135
|
+
* "next": "https://example.com/api/catalog/suggestions/course/group/?page=2",
|
|
3136
|
+
* "previous": null,
|
|
3137
|
+
* "results": [
|
|
3138
|
+
* {
|
|
3139
|
+
* "id": 123,
|
|
3140
|
+
* "group_id": 789,
|
|
3141
|
+
* "group_name": "Engineering Team",
|
|
3142
|
+
* "platform_key": "platform1",
|
|
3143
|
+
* "accepted": false,
|
|
3144
|
+
* "visible": true,
|
|
3145
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3146
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3147
|
+
* "metadata": {},
|
|
3148
|
+
* "course_id": "course-v1:org+course+run",
|
|
3149
|
+
* "course_name": "Introduction to Programming",
|
|
3150
|
+
* "user_count": 25
|
|
3151
|
+
* },
|
|
3152
|
+
* ...
|
|
3153
|
+
* ]
|
|
3154
|
+
* }
|
|
3155
|
+
*
|
|
3156
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3157
|
+
* {
|
|
3158
|
+
* "id": 123,
|
|
3159
|
+
* "group_id": 789,
|
|
3160
|
+
* "group_name": "Engineering Team",
|
|
3161
|
+
* "platform_key": "platform1",
|
|
3162
|
+
* "accepted": false,
|
|
3163
|
+
* "visible": true,
|
|
3164
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3165
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3166
|
+
* "metadata": {},
|
|
3167
|
+
* "course_id": "course-v1:org+course+run",
|
|
3168
|
+
* "course_name": "Introduction to Programming",
|
|
3169
|
+
* "user_count": 25
|
|
3170
|
+
* }
|
|
3171
|
+
*
|
|
3172
|
+
* DELETE: A success response with status 200
|
|
3173
|
+
*
|
|
3174
|
+
* Error Responses:
|
|
3175
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3176
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3177
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3178
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3179
|
+
*
|
|
3180
|
+
* Access Control:
|
|
3181
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3182
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3183
|
+
* - Department admins can manage group suggestions for their departments
|
|
3184
|
+
* - DM admins can manage all group suggestions
|
|
3185
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3186
|
+
* @param requestBody
|
|
3187
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3188
|
+
* @param page Page number for pagination
|
|
3189
|
+
* @param pageSize Number of items per page
|
|
3190
|
+
* @param platformOrg The organization identifier for the platform
|
|
3191
|
+
* @param query Search term to filter group suggestions
|
|
3192
|
+
* @param sort Field to sort results by
|
|
3193
|
+
* @returns CourseGroupSuggestionDetail
|
|
3194
|
+
* @throws ApiError
|
|
3195
|
+
*/
|
|
3196
|
+
static catalogSuggestionsCourseManageGroupCreate(platformKey: string, requestBody: CourseGroupSuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<CourseGroupSuggestionDetail>;
|
|
3197
|
+
/**
|
|
3198
|
+
* API View for managing course group suggestions.
|
|
3199
|
+
*
|
|
3200
|
+
* This endpoint allows administrators to view, create, and delete course suggestions
|
|
3201
|
+
* for groups of users within a platform.
|
|
3202
|
+
*
|
|
3203
|
+
* Query Parameters (GET):
|
|
3204
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3205
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3206
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3207
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3208
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3209
|
+
* page (int, optional): Page number for pagination
|
|
3210
|
+
* page_size (int, optional): Number of items per page
|
|
3211
|
+
*
|
|
3212
|
+
* Methods:
|
|
3213
|
+
* GET: Retrieve a paginated list of course group suggestions for a platform
|
|
3214
|
+
* POST: Create or update a course group suggestion
|
|
3215
|
+
* DELETE: Remove a course group suggestion
|
|
3216
|
+
*
|
|
3217
|
+
* Request Body (POST):
|
|
3218
|
+
* A JSON object containing:
|
|
3219
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3220
|
+
* - course_id (str, required): The course ID to suggest
|
|
3221
|
+
* - group_id (str/int, required): The group to suggest the course to
|
|
3222
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3223
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3224
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3225
|
+
*
|
|
3226
|
+
* Query Parameters (DELETE):
|
|
3227
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3228
|
+
*
|
|
3229
|
+
* Returns:
|
|
3230
|
+
* GET: A paginated JSON response containing course group suggestions:
|
|
3231
|
+
* {
|
|
3232
|
+
* "count": 5,
|
|
3233
|
+
* "next": "https://example.com/api/catalog/suggestions/course/group/?page=2",
|
|
3234
|
+
* "previous": null,
|
|
3235
|
+
* "results": [
|
|
3236
|
+
* {
|
|
3237
|
+
* "id": 123,
|
|
3238
|
+
* "group_id": 789,
|
|
3239
|
+
* "group_name": "Engineering Team",
|
|
3240
|
+
* "platform_key": "platform1",
|
|
3241
|
+
* "accepted": false,
|
|
3242
|
+
* "visible": true,
|
|
3243
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3244
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3245
|
+
* "metadata": {},
|
|
3246
|
+
* "course_id": "course-v1:org+course+run",
|
|
3247
|
+
* "course_name": "Introduction to Programming",
|
|
3248
|
+
* "user_count": 25
|
|
3249
|
+
* },
|
|
3250
|
+
* ...
|
|
3251
|
+
* ]
|
|
3252
|
+
* }
|
|
3253
|
+
*
|
|
3254
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3255
|
+
* {
|
|
3256
|
+
* "id": 123,
|
|
3257
|
+
* "group_id": 789,
|
|
3258
|
+
* "group_name": "Engineering Team",
|
|
3259
|
+
* "platform_key": "platform1",
|
|
3260
|
+
* "accepted": false,
|
|
3261
|
+
* "visible": true,
|
|
3262
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3263
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3264
|
+
* "metadata": {},
|
|
3265
|
+
* "course_id": "course-v1:org+course+run",
|
|
3266
|
+
* "course_name": "Introduction to Programming",
|
|
3267
|
+
* "user_count": 25
|
|
3268
|
+
* }
|
|
3269
|
+
*
|
|
3270
|
+
* DELETE: A success response with status 200
|
|
3271
|
+
*
|
|
3272
|
+
* Error Responses:
|
|
3273
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3274
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3275
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3276
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3277
|
+
*
|
|
3278
|
+
* Access Control:
|
|
3279
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3280
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3281
|
+
* - Department admins can manage group suggestions for their departments
|
|
3282
|
+
* - DM admins can manage all group suggestions
|
|
3283
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3284
|
+
* @param suggestionId The ID of the group suggestion to delete
|
|
3285
|
+
* @param departmentMode Flag to ensure department admins can call the API
|
|
3286
|
+
* @param page Page number for pagination
|
|
3287
|
+
* @param pageSize Number of items per page
|
|
3288
|
+
* @param platformOrg The organization identifier for the platform
|
|
3289
|
+
* @param query Search term to filter group suggestions
|
|
3290
|
+
* @param sort Field to sort results by
|
|
3291
|
+
* @returns any Success - group suggestion deleted
|
|
3292
|
+
* @throws ApiError
|
|
3293
|
+
*/
|
|
3294
|
+
static catalogSuggestionsCourseManageGroupDestroy(platformKey: string, suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
3295
|
+
/**
|
|
3296
|
+
* API View for retrieving course suggestions for a specific user.
|
|
3297
|
+
*
|
|
3298
|
+
* This endpoint allows users to view course suggestions that have been made for them,
|
|
3299
|
+
* with support for filtering by platform and pagination.
|
|
3300
|
+
*
|
|
3301
|
+
* Query Parameters:
|
|
3302
|
+
* user (str, required): Username or user ID to retrieve suggestions for
|
|
3303
|
+
* platform_key (str, optional): Filter suggestions by platform key
|
|
3304
|
+
* platform_org (str, optional): Filter suggestions by platform organization
|
|
3305
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
3306
|
+
* page (int, optional): Page number for pagination
|
|
3307
|
+
* page_size (int, optional): Number of items per page
|
|
3308
|
+
*
|
|
3309
|
+
* Methods:
|
|
3310
|
+
* GET: Retrieve a paginated list of course suggestions for a user
|
|
3311
|
+
*
|
|
3312
|
+
* Returns:
|
|
3313
|
+
* GET: A paginated JSON response containing course suggestions:
|
|
3314
|
+
* {
|
|
3315
|
+
* "count": 10,
|
|
3316
|
+
* "next": "https://example.com/api/catalog/suggestions/course/user/?page=2",
|
|
3317
|
+
* "previous": null,
|
|
3318
|
+
* "results": [
|
|
3319
|
+
* {
|
|
3320
|
+
* "id": 123,
|
|
3321
|
+
* "user_id": 456,
|
|
3322
|
+
* "username": "student1",
|
|
3323
|
+
* "name": "Student Name",
|
|
3324
|
+
* "platform_key": "platform1",
|
|
3325
|
+
* "accepted": false,
|
|
3326
|
+
* "visible": true,
|
|
3327
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3328
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3329
|
+
* "metadata": {},
|
|
3330
|
+
* "course_id": "course-v1:org+course+run",
|
|
3331
|
+
* "course_name": "Introduction to Programming"
|
|
3332
|
+
* },
|
|
3333
|
+
* ...
|
|
3334
|
+
* ]
|
|
3335
|
+
* }
|
|
3336
|
+
*
|
|
3337
|
+
* Error Responses:
|
|
3338
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion retrieval fails
|
|
3339
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3340
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
3341
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3342
|
+
*
|
|
3343
|
+
* Access Control:
|
|
3344
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsEdxUserReadOnly permission
|
|
3345
|
+
* - Users can view their own suggestions
|
|
3346
|
+
* - Platform admins can view suggestions for users in their platform (read-only)
|
|
3347
|
+
* - DM admins can view all suggestions
|
|
3348
|
+
* @param user Username or user ID to retrieve suggestions for
|
|
3349
|
+
* @param email Email to retrieve suggestions for
|
|
3350
|
+
* @param page Page number for pagination
|
|
3351
|
+
* @param pageSize Number of items per page
|
|
3352
|
+
* @param platformKey Filter suggestions by platform key
|
|
3353
|
+
* @param platformOrg Filter suggestions by platform organization
|
|
3354
|
+
* @param sort Field to sort results by
|
|
3355
|
+
* @param userId User ID to retrieve suggestions for
|
|
3356
|
+
* @returns PaginatedCourseSuggestion
|
|
3357
|
+
* @throws ApiError
|
|
3358
|
+
*/
|
|
3359
|
+
static catalogSuggestionsCourseUserRetrieve(user: string, email?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<PaginatedCourseSuggestion>;
|
|
3360
|
+
/**
|
|
3361
|
+
* API View for managing pathway suggestions.
|
|
3362
|
+
*
|
|
3363
|
+
* This endpoint allows administrators to view, create, update, and delete pathway suggestions
|
|
3364
|
+
* for users within a platform.
|
|
3365
|
+
*
|
|
3366
|
+
* Query Parameters (GET):
|
|
3367
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
3368
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3369
|
+
* query (str, optional): Search term to filter suggestions
|
|
3370
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
3371
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3372
|
+
* page (int, optional): Page number for pagination
|
|
3373
|
+
* page_size (int, optional): Number of items per page
|
|
3374
|
+
*
|
|
3375
|
+
* Methods:
|
|
3376
|
+
* GET: Retrieve a paginated list of pathway suggestions for a platform
|
|
3377
|
+
* POST: Create or update a pathway suggestion
|
|
3378
|
+
* DELETE: Remove a pathway suggestion
|
|
3379
|
+
*
|
|
3380
|
+
* Request Body (POST):
|
|
3381
|
+
* A JSON object containing:
|
|
3382
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
3383
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3384
|
+
* - user_id (str/int, required): The user to suggest the pathway to
|
|
3385
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3386
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3387
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3388
|
+
*
|
|
3389
|
+
* Query Parameters (DELETE):
|
|
3390
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
3391
|
+
*
|
|
3392
|
+
* Returns:
|
|
3393
|
+
* GET: A paginated JSON response containing pathway suggestions:
|
|
3394
|
+
* {
|
|
3395
|
+
* "count": 10,
|
|
3396
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/manage/?page=2",
|
|
3397
|
+
* "previous": null,
|
|
3398
|
+
* "results": [
|
|
3399
|
+
* {
|
|
3400
|
+
* "id": 123,
|
|
3401
|
+
* "user_id": 456,
|
|
3402
|
+
* "username": "student1",
|
|
3403
|
+
* "name": "Student Name",
|
|
3404
|
+
* "platform_key": "platform1",
|
|
3405
|
+
* "accepted": false,
|
|
3406
|
+
* "visible": true,
|
|
3407
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3408
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3409
|
+
* "metadata": {},
|
|
3410
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3411
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3412
|
+
* "pathway_name": "Data Science Pathway",
|
|
3413
|
+
* "pathway_platform_key": "platform1"
|
|
3414
|
+
* },
|
|
3415
|
+
* ...
|
|
3416
|
+
* ]
|
|
3417
|
+
* }
|
|
3418
|
+
*
|
|
3419
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
3420
|
+
* {
|
|
3421
|
+
* "id": 123,
|
|
3422
|
+
* "user_id": 456,
|
|
3423
|
+
* "username": "student1",
|
|
3424
|
+
* "name": "Student Name",
|
|
3425
|
+
* "platform_key": "platform1",
|
|
3426
|
+
* "accepted": false,
|
|
3427
|
+
* "visible": true,
|
|
3428
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3429
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3430
|
+
* "metadata": {},
|
|
3431
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3432
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3433
|
+
* "pathway_name": "Data Science Pathway",
|
|
3434
|
+
* "pathway_platform_key": "platform1"
|
|
3435
|
+
* }
|
|
3436
|
+
*
|
|
3437
|
+
* DELETE: A success response with status 200
|
|
3438
|
+
*
|
|
3439
|
+
* Error Responses:
|
|
3440
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
3441
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3442
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
3443
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3444
|
+
*
|
|
3445
|
+
* Access Control:
|
|
3446
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3447
|
+
* - Platform admins can manage suggestions for their platform
|
|
3448
|
+
* - Department admins can manage suggestions for their departments
|
|
3449
|
+
* - DM admins can manage all suggestions
|
|
3450
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
3451
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3452
|
+
* @param page Page number for pagination
|
|
3453
|
+
* @param pageSize Number of items per page
|
|
3454
|
+
* @param platformOrg The organization identifier for the platform
|
|
3455
|
+
* @param query Search term to filter suggestions
|
|
3456
|
+
* @param sort Field to sort results by
|
|
3457
|
+
* @returns PaginatedPathwaySuggestion
|
|
3458
|
+
* @throws ApiError
|
|
3459
|
+
*/
|
|
3460
|
+
static catalogSuggestionsPathwayManageRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedPathwaySuggestion>;
|
|
3461
|
+
/**
|
|
3462
|
+
* API View for managing pathway suggestions.
|
|
3463
|
+
*
|
|
3464
|
+
* This endpoint allows administrators to view, create, update, and delete pathway suggestions
|
|
3465
|
+
* for users within a platform.
|
|
3466
|
+
*
|
|
3467
|
+
* Query Parameters (GET):
|
|
3468
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
3469
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3470
|
+
* query (str, optional): Search term to filter suggestions
|
|
3471
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
3472
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3473
|
+
* page (int, optional): Page number for pagination
|
|
3474
|
+
* page_size (int, optional): Number of items per page
|
|
3475
|
+
*
|
|
3476
|
+
* Methods:
|
|
3477
|
+
* GET: Retrieve a paginated list of pathway suggestions for a platform
|
|
3478
|
+
* POST: Create or update a pathway suggestion
|
|
3479
|
+
* DELETE: Remove a pathway suggestion
|
|
3480
|
+
*
|
|
3481
|
+
* Request Body (POST):
|
|
3482
|
+
* A JSON object containing:
|
|
3483
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
3484
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3485
|
+
* - user_id (str/int, required): The user to suggest the pathway to
|
|
3486
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3487
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3488
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3489
|
+
*
|
|
3490
|
+
* Query Parameters (DELETE):
|
|
3491
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
3492
|
+
*
|
|
3493
|
+
* Returns:
|
|
3494
|
+
* GET: A paginated JSON response containing pathway suggestions:
|
|
3495
|
+
* {
|
|
3496
|
+
* "count": 10,
|
|
3497
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/manage/?page=2",
|
|
3498
|
+
* "previous": null,
|
|
3499
|
+
* "results": [
|
|
3500
|
+
* {
|
|
3501
|
+
* "id": 123,
|
|
3502
|
+
* "user_id": 456,
|
|
3503
|
+
* "username": "student1",
|
|
3504
|
+
* "name": "Student Name",
|
|
3505
|
+
* "platform_key": "platform1",
|
|
3506
|
+
* "accepted": false,
|
|
3507
|
+
* "visible": true,
|
|
3508
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3509
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3510
|
+
* "metadata": {},
|
|
3511
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3512
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3513
|
+
* "pathway_name": "Data Science Pathway",
|
|
3514
|
+
* "pathway_platform_key": "platform1"
|
|
3515
|
+
* },
|
|
3516
|
+
* ...
|
|
3517
|
+
* ]
|
|
3518
|
+
* }
|
|
3519
|
+
*
|
|
3520
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
3521
|
+
* {
|
|
3522
|
+
* "id": 123,
|
|
3523
|
+
* "user_id": 456,
|
|
3524
|
+
* "username": "student1",
|
|
3525
|
+
* "name": "Student Name",
|
|
3526
|
+
* "platform_key": "platform1",
|
|
3527
|
+
* "accepted": false,
|
|
3528
|
+
* "visible": true,
|
|
3529
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3530
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3531
|
+
* "metadata": {},
|
|
3532
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3533
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3534
|
+
* "pathway_name": "Data Science Pathway",
|
|
3535
|
+
* "pathway_platform_key": "platform1"
|
|
3536
|
+
* }
|
|
3537
|
+
*
|
|
3538
|
+
* DELETE: A success response with status 200
|
|
3539
|
+
*
|
|
3540
|
+
* Error Responses:
|
|
3541
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
3542
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3543
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
3544
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3545
|
+
*
|
|
3546
|
+
* Access Control:
|
|
3547
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3548
|
+
* - Platform admins can manage suggestions for their platform
|
|
3549
|
+
* - Department admins can manage suggestions for their departments
|
|
3550
|
+
* - DM admins can manage all suggestions
|
|
3551
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
3552
|
+
* @param requestBody
|
|
3553
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3554
|
+
* @param page Page number for pagination
|
|
3555
|
+
* @param pageSize Number of items per page
|
|
3556
|
+
* @param platformOrg The organization identifier for the platform
|
|
3557
|
+
* @param query Search term to filter suggestions
|
|
3558
|
+
* @param sort Field to sort results by
|
|
3559
|
+
* @returns PathwaySuggestionDetail
|
|
3560
|
+
* @throws ApiError
|
|
3561
|
+
*/
|
|
3562
|
+
static catalogSuggestionsPathwayManageCreate(platformKey: string, requestBody: PathwaySuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PathwaySuggestionDetail>;
|
|
3563
|
+
/**
|
|
3564
|
+
* Delete single suggestion
|
|
3565
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
3566
|
+
* @param suggestionId The ID of the suggestion to delete
|
|
3567
|
+
* @param departmentMode Flag to ensure department admins can call the API
|
|
3568
|
+
* @param page Page number for pagination
|
|
3569
|
+
* @param pageSize Number of items per page
|
|
3570
|
+
* @param platformOrg The organization identifier for the platform
|
|
3571
|
+
* @param query Search term to filter suggestions
|
|
3572
|
+
* @param sort Field to sort results by
|
|
3573
|
+
* @returns any Success - suggestion deleted
|
|
3574
|
+
* @throws ApiError
|
|
3575
|
+
*/
|
|
3576
|
+
static catalogSuggestionsPathwayManageDestroy(platformKey: string, suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
3577
|
+
/**
|
|
3578
|
+
* API View for bulk creation of pathway suggestions.
|
|
3579
|
+
*
|
|
3580
|
+
* This endpoint allows administrators to create multiple pathway suggestions at once.
|
|
3581
|
+
*
|
|
3582
|
+
* Methods:
|
|
3583
|
+
* POST: Create multiple pathway suggestions in a single request
|
|
3584
|
+
*
|
|
3585
|
+
* Request Body:
|
|
3586
|
+
* A JSON object containing:
|
|
3587
|
+
* - platform_key (str, required): The platform for the suggestions
|
|
3588
|
+
* - suggestion_data (list, required): List of suggestion objects, each containing:
|
|
3589
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3590
|
+
* - user_id (str/int, required): The user to suggest the pathway to
|
|
3591
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3592
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3593
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3594
|
+
*
|
|
3595
|
+
* Returns:
|
|
3596
|
+
* POST: A JSON response containing the operation results:
|
|
3597
|
+
* {
|
|
3598
|
+
* "successes": 15,
|
|
3599
|
+
* "error_codes": []
|
|
3600
|
+
* }
|
|
3601
|
+
*
|
|
3602
|
+
* Error Responses:
|
|
3603
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
3604
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3605
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
3606
|
+
* 500 Internal Server Error: If an unexpected error occurs during bulk creation
|
|
3607
|
+
*
|
|
3608
|
+
* Access Control:
|
|
3609
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3610
|
+
* - Platform admins can create suggestions for their platform
|
|
3611
|
+
* - Department admins can create suggestions for their departments
|
|
3612
|
+
* - DM admins can create suggestions for any platform
|
|
3613
|
+
* @param requestBody
|
|
3614
|
+
* @returns BulkSuggestionResponse
|
|
3615
|
+
* @throws ApiError
|
|
3616
|
+
*/
|
|
3617
|
+
static catalogSuggestionsPathwayManageBulkCreate(requestBody: PathwaySuggestionBulkCreate): CancelablePromise<BulkSuggestionResponse>;
|
|
3618
|
+
/**
|
|
3619
|
+
* API View for managing pathway group suggestions.
|
|
3620
|
+
*
|
|
3621
|
+
* This endpoint allows administrators to view, create, and delete pathway suggestions
|
|
3622
|
+
* for groups of users within a platform.
|
|
3623
|
+
*
|
|
3624
|
+
* Query Parameters (GET):
|
|
3625
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3626
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3627
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3628
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3629
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3630
|
+
* page (int, optional): Page number for pagination
|
|
3631
|
+
* page_size (int, optional): Number of items per page
|
|
3632
|
+
*
|
|
3633
|
+
* Methods:
|
|
3634
|
+
* GET: Retrieve a paginated list of pathway group suggestions for a platform
|
|
3635
|
+
* POST: Create or update a pathway group suggestion
|
|
3636
|
+
* DELETE: Remove a pathway group suggestion
|
|
3637
|
+
*
|
|
3638
|
+
* Request Body (POST):
|
|
3639
|
+
* A JSON object containing:
|
|
3640
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3641
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3642
|
+
* - group_id (str/int, required): The group to suggest the pathway to
|
|
3643
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3644
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3645
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3646
|
+
*
|
|
3647
|
+
* Query Parameters (DELETE):
|
|
3648
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3649
|
+
*
|
|
3650
|
+
* Returns:
|
|
3651
|
+
* GET: A paginated JSON response containing pathway group suggestions:
|
|
3652
|
+
* {
|
|
3653
|
+
* "count": 5,
|
|
3654
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/group/?page=2",
|
|
3655
|
+
* "previous": null,
|
|
3656
|
+
* "results": [
|
|
3657
|
+
* {
|
|
3658
|
+
* "id": 123,
|
|
3659
|
+
* "group_id": 789,
|
|
3660
|
+
* "group_name": "Engineering Team",
|
|
3661
|
+
* "platform_key": "platform1",
|
|
3662
|
+
* "accepted": false,
|
|
3663
|
+
* "visible": true,
|
|
3664
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3665
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3666
|
+
* "metadata": {},
|
|
3667
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3668
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3669
|
+
* "pathway_name": "Data Science Pathway",
|
|
3670
|
+
* "pathway_platform_key": "platform1",
|
|
3671
|
+
* "user_count": 25
|
|
3672
|
+
* },
|
|
3673
|
+
* ...
|
|
3674
|
+
* ]
|
|
3675
|
+
* }
|
|
3676
|
+
*
|
|
3677
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3678
|
+
* {
|
|
3679
|
+
* "id": 123,
|
|
3680
|
+
* "group_id": 789,
|
|
3681
|
+
* "group_name": "Engineering Team",
|
|
3682
|
+
* "platform_key": "platform1",
|
|
3683
|
+
* "accepted": false,
|
|
3684
|
+
* "visible": true,
|
|
3685
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3686
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3687
|
+
* "metadata": {},
|
|
3688
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3689
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3690
|
+
* "pathway_name": "Data Science Pathway",
|
|
3691
|
+
* "pathway_platform_key": "platform1",
|
|
3692
|
+
* "user_count": 25
|
|
3693
|
+
* }
|
|
3694
|
+
*
|
|
3695
|
+
* DELETE: A success response with status 200
|
|
3696
|
+
*
|
|
3697
|
+
* Error Responses:
|
|
3698
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3699
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3700
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3701
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3702
|
+
*
|
|
3703
|
+
* Access Control:
|
|
3704
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3705
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3706
|
+
* - Department admins can manage group suggestions for their departments
|
|
3707
|
+
* - DM admins can manage all group suggestions
|
|
3708
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3709
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3710
|
+
* @param page Page number for pagination
|
|
3711
|
+
* @param pageSize Number of items per page
|
|
3712
|
+
* @param platformOrg The organization identifier for the platform
|
|
3713
|
+
* @param query Search term to filter group suggestions
|
|
3714
|
+
* @param sort Field to sort results by
|
|
3715
|
+
* @returns PaginatedPathwayGroupSuggestion
|
|
3716
|
+
* @throws ApiError
|
|
3717
|
+
*/
|
|
3718
|
+
static catalogSuggestionsPathwayManageGroupRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedPathwayGroupSuggestion>;
|
|
3719
|
+
/**
|
|
3720
|
+
* API View for managing pathway group suggestions.
|
|
3721
|
+
*
|
|
3722
|
+
* This endpoint allows administrators to view, create, and delete pathway suggestions
|
|
3723
|
+
* for groups of users within a platform.
|
|
3724
|
+
*
|
|
3725
|
+
* Query Parameters (GET):
|
|
3726
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3727
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3728
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3729
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3730
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3731
|
+
* page (int, optional): Page number for pagination
|
|
3732
|
+
* page_size (int, optional): Number of items per page
|
|
3733
|
+
*
|
|
3734
|
+
* Methods:
|
|
3735
|
+
* GET: Retrieve a paginated list of pathway group suggestions for a platform
|
|
3736
|
+
* POST: Create or update a pathway group suggestion
|
|
3737
|
+
* DELETE: Remove a pathway group suggestion
|
|
3738
|
+
*
|
|
3739
|
+
* Request Body (POST):
|
|
3740
|
+
* A JSON object containing:
|
|
3741
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3742
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3743
|
+
* - group_id (str/int, required): The group to suggest the pathway to
|
|
3744
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3745
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3746
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3747
|
+
*
|
|
3748
|
+
* Query Parameters (DELETE):
|
|
3749
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3750
|
+
*
|
|
3751
|
+
* Returns:
|
|
3752
|
+
* GET: A paginated JSON response containing pathway group suggestions:
|
|
3753
|
+
* {
|
|
3754
|
+
* "count": 5,
|
|
3755
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/group/?page=2",
|
|
3756
|
+
* "previous": null,
|
|
3757
|
+
* "results": [
|
|
3758
|
+
* {
|
|
3759
|
+
* "id": 123,
|
|
3760
|
+
* "group_id": 789,
|
|
3761
|
+
* "group_name": "Engineering Team",
|
|
3762
|
+
* "platform_key": "platform1",
|
|
3763
|
+
* "accepted": false,
|
|
3764
|
+
* "visible": true,
|
|
3765
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3766
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3767
|
+
* "metadata": {},
|
|
3768
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3769
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3770
|
+
* "pathway_name": "Data Science Pathway",
|
|
3771
|
+
* "pathway_platform_key": "platform1",
|
|
3772
|
+
* "user_count": 25
|
|
3773
|
+
* },
|
|
3774
|
+
* ...
|
|
3775
|
+
* ]
|
|
3776
|
+
* }
|
|
3777
|
+
*
|
|
3778
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3779
|
+
* {
|
|
3780
|
+
* "id": 123,
|
|
3781
|
+
* "group_id": 789,
|
|
3782
|
+
* "group_name": "Engineering Team",
|
|
3783
|
+
* "platform_key": "platform1",
|
|
3784
|
+
* "accepted": false,
|
|
3785
|
+
* "visible": true,
|
|
3786
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3787
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3788
|
+
* "metadata": {},
|
|
3789
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3790
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3791
|
+
* "pathway_name": "Data Science Pathway",
|
|
3792
|
+
* "pathway_platform_key": "platform1",
|
|
3793
|
+
* "user_count": 25
|
|
3794
|
+
* }
|
|
3795
|
+
*
|
|
3796
|
+
* DELETE: A success response with status 200
|
|
3797
|
+
*
|
|
3798
|
+
* Error Responses:
|
|
3799
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3800
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3801
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3802
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3803
|
+
*
|
|
3804
|
+
* Access Control:
|
|
3805
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3806
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3807
|
+
* - Department admins can manage group suggestions for their departments
|
|
3808
|
+
* - DM admins can manage all group suggestions
|
|
3809
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3810
|
+
* @param requestBody
|
|
3811
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
3812
|
+
* @param page Page number for pagination
|
|
3813
|
+
* @param pageSize Number of items per page
|
|
3814
|
+
* @param platformOrg The organization identifier for the platform
|
|
3815
|
+
* @param query Search term to filter group suggestions
|
|
3816
|
+
* @param sort Field to sort results by
|
|
3817
|
+
* @returns PathwayGroupSuggestionDetail
|
|
3818
|
+
* @throws ApiError
|
|
3819
|
+
*/
|
|
3820
|
+
static catalogSuggestionsPathwayManageGroupCreate(platformKey: string, requestBody: PathwayGroupSuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PathwayGroupSuggestionDetail>;
|
|
3821
|
+
/**
|
|
3822
|
+
* API View for managing pathway group suggestions.
|
|
3823
|
+
*
|
|
3824
|
+
* This endpoint allows administrators to view, create, and delete pathway suggestions
|
|
3825
|
+
* for groups of users within a platform.
|
|
3826
|
+
*
|
|
3827
|
+
* Query Parameters (GET):
|
|
3828
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
3829
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3830
|
+
* query (str, optional): Search term to filter group suggestions
|
|
3831
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
3832
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
3833
|
+
* page (int, optional): Page number for pagination
|
|
3834
|
+
* page_size (int, optional): Number of items per page
|
|
3835
|
+
*
|
|
3836
|
+
* Methods:
|
|
3837
|
+
* GET: Retrieve a paginated list of pathway group suggestions for a platform
|
|
3838
|
+
* POST: Create or update a pathway group suggestion
|
|
3839
|
+
* DELETE: Remove a pathway group suggestion
|
|
3840
|
+
*
|
|
3841
|
+
* Request Body (POST):
|
|
3842
|
+
* A JSON object containing:
|
|
3843
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
3844
|
+
* - pathway_id (str, required): The pathway ID to suggest
|
|
3845
|
+
* - group_id (str/int, required): The group to suggest the pathway to
|
|
3846
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
3847
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
3848
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
3849
|
+
*
|
|
3850
|
+
* Query Parameters (DELETE):
|
|
3851
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
3852
|
+
*
|
|
3853
|
+
* Returns:
|
|
3854
|
+
* GET: A paginated JSON response containing pathway group suggestions:
|
|
3855
|
+
* {
|
|
3856
|
+
* "count": 5,
|
|
3857
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/group/?page=2",
|
|
3858
|
+
* "previous": null,
|
|
3859
|
+
* "results": [
|
|
3860
|
+
* {
|
|
3861
|
+
* "id": 123,
|
|
3862
|
+
* "group_id": 789,
|
|
3863
|
+
* "group_name": "Engineering Team",
|
|
3864
|
+
* "platform_key": "platform1",
|
|
3865
|
+
* "accepted": false,
|
|
3866
|
+
* "visible": true,
|
|
3867
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3868
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3869
|
+
* "metadata": {},
|
|
3870
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3871
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3872
|
+
* "pathway_name": "Data Science Pathway",
|
|
3873
|
+
* "pathway_platform_key": "platform1",
|
|
3874
|
+
* "user_count": 25
|
|
3875
|
+
* },
|
|
3876
|
+
* ...
|
|
3877
|
+
* ]
|
|
3878
|
+
* }
|
|
3879
|
+
*
|
|
3880
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
3881
|
+
* {
|
|
3882
|
+
* "id": 123,
|
|
3883
|
+
* "group_id": 789,
|
|
3884
|
+
* "group_name": "Engineering Team",
|
|
3885
|
+
* "platform_key": "platform1",
|
|
3886
|
+
* "accepted": false,
|
|
3887
|
+
* "visible": true,
|
|
3888
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3889
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3890
|
+
* "metadata": {},
|
|
3891
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3892
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3893
|
+
* "pathway_name": "Data Science Pathway",
|
|
3894
|
+
* "pathway_platform_key": "platform1",
|
|
3895
|
+
* "user_count": 25
|
|
3896
|
+
* }
|
|
3897
|
+
*
|
|
3898
|
+
* DELETE: A success response with status 200
|
|
3899
|
+
*
|
|
3900
|
+
* Error Responses:
|
|
3901
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
3902
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3903
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
3904
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3905
|
+
*
|
|
3906
|
+
* Access Control:
|
|
3907
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
3908
|
+
* - Platform admins can manage group suggestions for their platform
|
|
3909
|
+
* - Department admins can manage group suggestions for their departments
|
|
3910
|
+
* - DM admins can manage all group suggestions
|
|
3911
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
3912
|
+
* @param suggestionId The ID of the group suggestion to delete
|
|
3913
|
+
* @param departmentMode Flag to ensure department admins can call the API
|
|
3914
|
+
* @param page Page number for pagination
|
|
3915
|
+
* @param pageSize Number of items per page
|
|
3916
|
+
* @param platformOrg The organization identifier for the platform
|
|
3917
|
+
* @param query Search term to filter group suggestions
|
|
3918
|
+
* @param sort Field to sort results by
|
|
3919
|
+
* @returns any Success - group suggestion deleted
|
|
3920
|
+
* @throws ApiError
|
|
3921
|
+
*/
|
|
3922
|
+
static catalogSuggestionsPathwayManageGroupDestroy(platformKey: string, suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
3923
|
+
/**
|
|
3924
|
+
* API View for retrieving pathway suggestions for a specific user.
|
|
3925
|
+
*
|
|
3926
|
+
* This endpoint allows users to view pathway suggestions that have been made for them,
|
|
3927
|
+
* with support for filtering by platform and pagination.
|
|
3928
|
+
*
|
|
3929
|
+
* Query Parameters:
|
|
3930
|
+
* user (str, required): Username or user ID to retrieve suggestions for
|
|
3931
|
+
* platform_key (str, optional): Filter suggestions by platform key
|
|
3932
|
+
* platform_org (str, optional): Filter suggestions by platform organization
|
|
3933
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
3934
|
+
* page (int, optional): Page number for pagination
|
|
3935
|
+
* page_size (int, optional): Number of items per page
|
|
3936
|
+
*
|
|
3937
|
+
* Methods:
|
|
3938
|
+
* GET: Retrieve a paginated list of pathway suggestions for a user
|
|
3939
|
+
*
|
|
3940
|
+
* Returns:
|
|
3941
|
+
* GET: A paginated JSON response containing pathway suggestions:
|
|
3942
|
+
* {
|
|
3943
|
+
* "count": 10,
|
|
3944
|
+
* "next": "https://example.com/api/catalog/suggestions/pathway/user/?page=2",
|
|
3945
|
+
* "previous": null,
|
|
3946
|
+
* "results": [
|
|
3947
|
+
* {
|
|
3948
|
+
* "id": 123,
|
|
3949
|
+
* "user_id": 456,
|
|
3950
|
+
* "username": "student1",
|
|
3951
|
+
* "name": "Student Name",
|
|
3952
|
+
* "platform_key": "platform1",
|
|
3953
|
+
* "accepted": false,
|
|
3954
|
+
* "visible": true,
|
|
3955
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
3956
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
3957
|
+
* "metadata": {},
|
|
3958
|
+
* "pathway_id": "pathway-v1:org+pathway+run",
|
|
3959
|
+
* "pathway_uuid": "12345678-1234-5678-1234-567812345678",
|
|
3960
|
+
* "pathway_name": "Data Science Pathway",
|
|
3961
|
+
* "pathway_platform_key": "platform1"
|
|
3962
|
+
* },
|
|
3963
|
+
* ...
|
|
3964
|
+
* ]
|
|
3965
|
+
* }
|
|
3966
|
+
*
|
|
3967
|
+
* Error Responses:
|
|
3968
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion retrieval fails
|
|
3969
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
3970
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
3971
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
3972
|
+
*
|
|
3973
|
+
* Access Control:
|
|
3974
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsEdxUserReadOnly permission
|
|
3975
|
+
* - Users can view their own suggestions
|
|
3976
|
+
* - Platform admins can view suggestions for users in their platform (read-only)
|
|
3977
|
+
* - DM admins can view all suggestions
|
|
3978
|
+
* @param username Username or user ID to retrieve suggestions for
|
|
3979
|
+
* @param email Email to retrieve suggestions for
|
|
3980
|
+
* @param page Page number for pagination
|
|
3981
|
+
* @param pageSize Number of items per page
|
|
3982
|
+
* @param platformKey Filter suggestions by platform key
|
|
3983
|
+
* @param platformOrg Filter suggestions by platform organization
|
|
3984
|
+
* @param sort Field to sort results by
|
|
3985
|
+
* @param userId User ID to retrieve suggestions for
|
|
3986
|
+
* @returns PaginatedPathwaySuggestion
|
|
3987
|
+
* @throws ApiError
|
|
3988
|
+
*/
|
|
3989
|
+
static catalogSuggestionsPathwayUserRetrieve(username: string, email?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<PaginatedPathwaySuggestion>;
|
|
3990
|
+
/**
|
|
3991
|
+
* API View for managing program suggestions.
|
|
3992
|
+
*
|
|
3993
|
+
* This endpoint allows administrators to view, create, update, and delete program suggestions
|
|
3994
|
+
* for users within a platform.
|
|
3995
|
+
*
|
|
3996
|
+
* Query Parameters (GET):
|
|
3997
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
3998
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
3999
|
+
* query (str, optional): Search term to filter suggestions
|
|
4000
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
4001
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4002
|
+
* page (int, optional): Page number for pagination
|
|
4003
|
+
* page_size (int, optional): Number of items per page
|
|
4004
|
+
*
|
|
4005
|
+
* Methods:
|
|
4006
|
+
* GET: Retrieve a paginated list of program suggestions for a platform
|
|
4007
|
+
* POST: Create or update a program suggestion
|
|
4008
|
+
* DELETE: Remove a program suggestion
|
|
4009
|
+
*
|
|
4010
|
+
* Request Body (POST):
|
|
4011
|
+
* A JSON object containing:
|
|
4012
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
4013
|
+
* - program_key (str, required): The program key to suggest
|
|
4014
|
+
* - user_id (str/int, required): The user to suggest the program to
|
|
4015
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4016
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4017
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4018
|
+
*
|
|
4019
|
+
* Query Parameters (DELETE):
|
|
4020
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
4021
|
+
*
|
|
4022
|
+
* Returns:
|
|
4023
|
+
* GET: A paginated JSON response containing program suggestions:
|
|
4024
|
+
* {
|
|
4025
|
+
* "count": 10,
|
|
4026
|
+
* "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2",
|
|
4027
|
+
* "previous": null,
|
|
4028
|
+
* "results": [
|
|
4029
|
+
* {
|
|
4030
|
+
* "id": 123,
|
|
4031
|
+
* "user_id": 456,
|
|
4032
|
+
* "username": "student1",
|
|
4033
|
+
* "name": "Student Name",
|
|
4034
|
+
* "platform_key": "platform1",
|
|
4035
|
+
* "accepted": false,
|
|
4036
|
+
* "visible": true,
|
|
4037
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4038
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4039
|
+
* "metadata": {},
|
|
4040
|
+
* "program_key": "program-v1:org+program+run",
|
|
4041
|
+
* "program_name": "Data Science Program"
|
|
4042
|
+
* },
|
|
4043
|
+
* ...
|
|
4044
|
+
* ]
|
|
4045
|
+
* }
|
|
4046
|
+
*
|
|
4047
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
4048
|
+
* {
|
|
4049
|
+
* "id": 123,
|
|
4050
|
+
* "user_id": 456,
|
|
4051
|
+
* "username": "student1",
|
|
4052
|
+
* "name": "Student Name",
|
|
4053
|
+
* "platform_key": "platform1",
|
|
4054
|
+
* "accepted": false,
|
|
4055
|
+
* "visible": true,
|
|
4056
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4057
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4058
|
+
* "metadata": {},
|
|
4059
|
+
* "program_key": "program-v1:org+program+run",
|
|
4060
|
+
* "program_name": "Data Science Program"
|
|
4061
|
+
* }
|
|
4062
|
+
*
|
|
4063
|
+
* DELETE: A success response with status 200
|
|
4064
|
+
*
|
|
4065
|
+
* Error Responses:
|
|
4066
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
4067
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4068
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
4069
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4070
|
+
*
|
|
4071
|
+
* Access Control:
|
|
4072
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4073
|
+
* - Platform admins can manage suggestions for their platform
|
|
4074
|
+
* - Department admins can manage suggestions for their departments
|
|
4075
|
+
* - DM admins can manage all suggestions
|
|
4076
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
4077
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
4078
|
+
* @param page Page number for pagination
|
|
4079
|
+
* @param pageSize Number of items per page
|
|
4080
|
+
* @param platformOrg The organization identifier for the platform
|
|
4081
|
+
* @param query Search term to filter suggestions
|
|
4082
|
+
* @param sort Field to sort results by
|
|
4083
|
+
* @returns PaginatedProgramSuggestion
|
|
4084
|
+
* @throws ApiError
|
|
4085
|
+
*/
|
|
4086
|
+
static catalogSuggestionsProgramManageRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedProgramSuggestion>;
|
|
4087
|
+
/**
|
|
4088
|
+
* API View for managing program suggestions.
|
|
4089
|
+
*
|
|
4090
|
+
* This endpoint allows administrators to view, create, update, and delete program suggestions
|
|
4091
|
+
* for users within a platform.
|
|
4092
|
+
*
|
|
4093
|
+
* Query Parameters (GET):
|
|
4094
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
4095
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
4096
|
+
* query (str, optional): Search term to filter suggestions
|
|
4097
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
4098
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4099
|
+
* page (int, optional): Page number for pagination
|
|
4100
|
+
* page_size (int, optional): Number of items per page
|
|
4101
|
+
*
|
|
4102
|
+
* Methods:
|
|
4103
|
+
* GET: Retrieve a paginated list of program suggestions for a platform
|
|
4104
|
+
* POST: Create or update a program suggestion
|
|
4105
|
+
* DELETE: Remove a program suggestion
|
|
4106
|
+
*
|
|
4107
|
+
* Request Body (POST):
|
|
4108
|
+
* A JSON object containing:
|
|
4109
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
4110
|
+
* - program_key (str, required): The program key to suggest
|
|
4111
|
+
* - user_id (str/int, required): The user to suggest the program to
|
|
4112
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4113
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4114
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4115
|
+
*
|
|
4116
|
+
* Query Parameters (DELETE):
|
|
4117
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
4118
|
+
*
|
|
4119
|
+
* Returns:
|
|
4120
|
+
* GET: A paginated JSON response containing program suggestions:
|
|
4121
|
+
* {
|
|
4122
|
+
* "count": 10,
|
|
4123
|
+
* "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2",
|
|
4124
|
+
* "previous": null,
|
|
4125
|
+
* "results": [
|
|
4126
|
+
* {
|
|
4127
|
+
* "id": 123,
|
|
4128
|
+
* "user_id": 456,
|
|
4129
|
+
* "username": "student1",
|
|
4130
|
+
* "name": "Student Name",
|
|
4131
|
+
* "platform_key": "platform1",
|
|
4132
|
+
* "accepted": false,
|
|
4133
|
+
* "visible": true,
|
|
4134
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4135
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4136
|
+
* "metadata": {},
|
|
4137
|
+
* "program_key": "program-v1:org+program+run",
|
|
4138
|
+
* "program_name": "Data Science Program"
|
|
4139
|
+
* },
|
|
4140
|
+
* ...
|
|
4141
|
+
* ]
|
|
4142
|
+
* }
|
|
4143
|
+
*
|
|
4144
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
4145
|
+
* {
|
|
4146
|
+
* "id": 123,
|
|
4147
|
+
* "user_id": 456,
|
|
4148
|
+
* "username": "student1",
|
|
4149
|
+
* "name": "Student Name",
|
|
4150
|
+
* "platform_key": "platform1",
|
|
4151
|
+
* "accepted": false,
|
|
4152
|
+
* "visible": true,
|
|
4153
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4154
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4155
|
+
* "metadata": {},
|
|
4156
|
+
* "program_key": "program-v1:org+program+run",
|
|
4157
|
+
* "program_name": "Data Science Program"
|
|
4158
|
+
* }
|
|
4159
|
+
*
|
|
4160
|
+
* DELETE: A success response with status 200
|
|
4161
|
+
*
|
|
4162
|
+
* Error Responses:
|
|
4163
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
4164
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4165
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
4166
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4167
|
+
*
|
|
4168
|
+
* Access Control:
|
|
4169
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4170
|
+
* - Platform admins can manage suggestions for their platform
|
|
4171
|
+
* - Department admins can manage suggestions for their departments
|
|
4172
|
+
* - DM admins can manage all suggestions
|
|
4173
|
+
* @param platformKey The platform to retrieve suggestions for
|
|
4174
|
+
* @param requestBody
|
|
4175
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
4176
|
+
* @param page Page number for pagination
|
|
4177
|
+
* @param pageSize Number of items per page
|
|
4178
|
+
* @param platformOrg The organization identifier for the platform
|
|
4179
|
+
* @param query Search term to filter suggestions
|
|
4180
|
+
* @param sort Field to sort results by
|
|
4181
|
+
* @returns ProgramSuggestionDetail
|
|
4182
|
+
* @throws ApiError
|
|
4183
|
+
*/
|
|
4184
|
+
static catalogSuggestionsProgramManageCreate(platformKey: string, requestBody: ProgramSuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<ProgramSuggestionDetail>;
|
|
4185
|
+
/**
|
|
4186
|
+
* API View for managing program suggestions.
|
|
4187
|
+
*
|
|
4188
|
+
* This endpoint allows administrators to view, create, update, and delete program suggestions
|
|
4189
|
+
* for users within a platform.
|
|
4190
|
+
*
|
|
4191
|
+
* Query Parameters (GET):
|
|
4192
|
+
* platform_key (str, required): The platform to retrieve suggestions for
|
|
4193
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
4194
|
+
* query (str, optional): Search term to filter suggestions
|
|
4195
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
4196
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4197
|
+
* page (int, optional): Page number for pagination
|
|
4198
|
+
* page_size (int, optional): Number of items per page
|
|
4199
|
+
*
|
|
4200
|
+
* Methods:
|
|
4201
|
+
* GET: Retrieve a paginated list of program suggestions for a platform
|
|
4202
|
+
* POST: Create or update a program suggestion
|
|
4203
|
+
* DELETE: Remove a program suggestion
|
|
4204
|
+
*
|
|
4205
|
+
* Request Body (POST):
|
|
4206
|
+
* A JSON object containing:
|
|
4207
|
+
* - platform_key (str, required): The platform for the suggestion
|
|
4208
|
+
* - program_key (str, required): The program key to suggest
|
|
4209
|
+
* - user_id (str/int, required): The user to suggest the program to
|
|
4210
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4211
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4212
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4213
|
+
*
|
|
4214
|
+
* Query Parameters (DELETE):
|
|
4215
|
+
* suggestion_id (int, required): The ID of the suggestion to delete
|
|
4216
|
+
*
|
|
4217
|
+
* Returns:
|
|
4218
|
+
* GET: A paginated JSON response containing program suggestions:
|
|
4219
|
+
* {
|
|
4220
|
+
* "count": 10,
|
|
4221
|
+
* "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2",
|
|
4222
|
+
* "previous": null,
|
|
4223
|
+
* "results": [
|
|
4224
|
+
* {
|
|
4225
|
+
* "id": 123,
|
|
4226
|
+
* "user_id": 456,
|
|
4227
|
+
* "username": "student1",
|
|
4228
|
+
* "name": "Student Name",
|
|
4229
|
+
* "platform_key": "platform1",
|
|
4230
|
+
* "accepted": false,
|
|
4231
|
+
* "visible": true,
|
|
4232
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4233
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4234
|
+
* "metadata": {},
|
|
4235
|
+
* "program_key": "program-v1:org+program+run",
|
|
4236
|
+
* "program_name": "Data Science Program"
|
|
4237
|
+
* },
|
|
4238
|
+
* ...
|
|
4239
|
+
* ]
|
|
4240
|
+
* }
|
|
4241
|
+
*
|
|
4242
|
+
* POST: A JSON response containing the created/updated suggestion:
|
|
4243
|
+
* {
|
|
4244
|
+
* "id": 123,
|
|
4245
|
+
* "user_id": 456,
|
|
4246
|
+
* "username": "student1",
|
|
4247
|
+
* "name": "Student Name",
|
|
4248
|
+
* "platform_key": "platform1",
|
|
4249
|
+
* "accepted": false,
|
|
4250
|
+
* "visible": true,
|
|
4251
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4252
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4253
|
+
* "metadata": {},
|
|
4254
|
+
* "program_key": "program-v1:org+program+run",
|
|
4255
|
+
* "program_name": "Data Science Program"
|
|
4256
|
+
* }
|
|
4257
|
+
*
|
|
4258
|
+
* DELETE: A success response with status 200
|
|
4259
|
+
*
|
|
4260
|
+
* Error Responses:
|
|
4261
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail
|
|
4262
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4263
|
+
* 403 Forbidden: If the user does not have permission to manage suggestions
|
|
4264
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4265
|
+
*
|
|
4266
|
+
* Access Control:
|
|
4267
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4268
|
+
* - Platform admins can manage suggestions for their platform
|
|
4269
|
+
* - Department admins can manage suggestions for their departments
|
|
4270
|
+
* - DM admins can manage all suggestions
|
|
4271
|
+
* @param suggestionId The ID of the suggestion to delete
|
|
4272
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
4273
|
+
* @param page Page number for pagination
|
|
4274
|
+
* @param pageSize Number of items per page
|
|
4275
|
+
* @param platformKey The platform to delete the suggestion from
|
|
4276
|
+
* @param platformOrg The organization identifier for the platform
|
|
4277
|
+
* @param query Search term to filter suggestions
|
|
4278
|
+
* @param sort Field to sort results by
|
|
4279
|
+
* @returns any Success - suggestion deleted
|
|
4280
|
+
* @throws ApiError
|
|
4281
|
+
*/
|
|
4282
|
+
static catalogSuggestionsProgramManageDestroy(suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
4283
|
+
/**
|
|
4284
|
+
* API View for bulk creation of program suggestions.
|
|
4285
|
+
*
|
|
4286
|
+
* This endpoint allows administrators to create multiple program suggestions at once.
|
|
4287
|
+
*
|
|
4288
|
+
* Methods:
|
|
4289
|
+
* POST: Create multiple program suggestions in bulk
|
|
4290
|
+
*
|
|
4291
|
+
* Request Body:
|
|
4292
|
+
* A JSON object containing:
|
|
4293
|
+
* - platform_key (str, required): The platform for the suggestions
|
|
4294
|
+
* - suggestion_data (array, required): Array of suggestion objects with:
|
|
4295
|
+
* - program_key (str, required): The program key to suggest
|
|
4296
|
+
* - user_id (str/int, required): The user to suggest the program to
|
|
4297
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4298
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4299
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4300
|
+
*
|
|
4301
|
+
* Returns:
|
|
4302
|
+
* POST: A JSON response containing the results of the bulk operation:
|
|
4303
|
+
* {
|
|
4304
|
+
* "successes": 15,
|
|
4305
|
+
* "error_codes": []
|
|
4306
|
+
* }
|
|
4307
|
+
*
|
|
4308
|
+
* Error Responses:
|
|
4309
|
+
* 400 Bad Request: If required parameters are missing or invalid
|
|
4310
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4311
|
+
* 403 Forbidden: If the user does not have permission to create suggestions
|
|
4312
|
+
* 500 Internal Server Error: If an unexpected error occurs during bulk creation
|
|
4313
|
+
*
|
|
4314
|
+
* Access Control:
|
|
4315
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4316
|
+
* - Platform admins can create suggestions for their platform
|
|
4317
|
+
* - Department admins can create suggestions for their departments
|
|
4318
|
+
* - DM admins can create suggestions for all platforms
|
|
4319
|
+
* @param requestBody
|
|
4320
|
+
* @returns BulkSuggestionResponse
|
|
4321
|
+
* @throws ApiError
|
|
4322
|
+
*/
|
|
4323
|
+
static catalogSuggestionsProgramManageBulkCreate(requestBody: ProgramSuggestionBulkCreate): CancelablePromise<BulkSuggestionResponse>;
|
|
4324
|
+
/**
|
|
4325
|
+
* API View for managing program group suggestions.
|
|
4326
|
+
*
|
|
4327
|
+
* This endpoint allows administrators to view, create, and delete program suggestions
|
|
4328
|
+
* for groups of users within a platform.
|
|
4329
|
+
*
|
|
4330
|
+
* Query Parameters (GET):
|
|
4331
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
4332
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
4333
|
+
* query (str, optional): Search term to filter group suggestions
|
|
4334
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
4335
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4336
|
+
* page (int, optional): Page number for pagination
|
|
4337
|
+
* page_size (int, optional): Number of items per page
|
|
4338
|
+
*
|
|
4339
|
+
* Methods:
|
|
4340
|
+
* GET: Retrieve a paginated list of program group suggestions for a platform
|
|
4341
|
+
* POST: Create or update a program group suggestion
|
|
4342
|
+
* DELETE: Remove a program group suggestion
|
|
4343
|
+
*
|
|
4344
|
+
* Request Body (POST):
|
|
4345
|
+
* A JSON object containing:
|
|
4346
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
4347
|
+
* - program_key (str, required): The program key to suggest
|
|
4348
|
+
* - group_id (str/int, required): The group to suggest the program to
|
|
4349
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4350
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4351
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4352
|
+
*
|
|
4353
|
+
* Query Parameters (DELETE):
|
|
4354
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
4355
|
+
*
|
|
4356
|
+
* Returns:
|
|
4357
|
+
* GET: A paginated JSON response containing program group suggestions:
|
|
4358
|
+
* {
|
|
4359
|
+
* "count": 5,
|
|
4360
|
+
* "next": "https://example.com/api/catalog/suggestions/program/group/?page=2",
|
|
4361
|
+
* "previous": null,
|
|
4362
|
+
* "results": [
|
|
4363
|
+
* {
|
|
4364
|
+
* "id": 123,
|
|
4365
|
+
* "group_id": 789,
|
|
4366
|
+
* "group_name": "Engineering Team",
|
|
4367
|
+
* "platform_key": "platform1",
|
|
4368
|
+
* "accepted": false,
|
|
4369
|
+
* "visible": true,
|
|
4370
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4371
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4372
|
+
* "metadata": {},
|
|
4373
|
+
* "program_key": "program-v1:org+program+run",
|
|
4374
|
+
* "program_name": "Data Science Program",
|
|
4375
|
+
* "user_count": 25
|
|
4376
|
+
* },
|
|
4377
|
+
* ...
|
|
4378
|
+
* ]
|
|
4379
|
+
* }
|
|
4380
|
+
*
|
|
4381
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
4382
|
+
* {
|
|
4383
|
+
* "id": 123,
|
|
4384
|
+
* "group_id": 789,
|
|
4385
|
+
* "group_name": "Engineering Team",
|
|
4386
|
+
* "platform_key": "platform1",
|
|
4387
|
+
* "accepted": false,
|
|
4388
|
+
* "visible": true,
|
|
4389
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4390
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4391
|
+
* "metadata": {},
|
|
4392
|
+
* "program_key": "program-v1:org+program+run",
|
|
4393
|
+
* "program_name": "Data Science Program",
|
|
4394
|
+
* "user_count": 25
|
|
4395
|
+
* }
|
|
4396
|
+
*
|
|
4397
|
+
* DELETE: A success response with status 200
|
|
4398
|
+
*
|
|
4399
|
+
* Error Responses:
|
|
4400
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
4401
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4402
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
4403
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4404
|
+
*
|
|
4405
|
+
* Access Control:
|
|
4406
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4407
|
+
* - Platform admins can manage group suggestions for their platform
|
|
4408
|
+
* - Department admins can manage group suggestions for their departments
|
|
4409
|
+
* - DM admins can manage all group suggestions
|
|
4410
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
4411
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
4412
|
+
* @param page Page number for pagination
|
|
4413
|
+
* @param pageSize Number of items per page
|
|
4414
|
+
* @param platformOrg The organization identifier for the platform
|
|
4415
|
+
* @param query Search term to filter group suggestions
|
|
4416
|
+
* @param sort Field to sort results by
|
|
4417
|
+
* @returns PaginatedProgramGroupSuggestion
|
|
4418
|
+
* @throws ApiError
|
|
4419
|
+
*/
|
|
4420
|
+
static catalogSuggestionsProgramManageGroupRetrieve(platformKey: string, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<PaginatedProgramGroupSuggestion>;
|
|
4421
|
+
/**
|
|
4422
|
+
* API View for managing program group suggestions.
|
|
4423
|
+
*
|
|
4424
|
+
* This endpoint allows administrators to view, create, and delete program suggestions
|
|
4425
|
+
* for groups of users within a platform.
|
|
4426
|
+
*
|
|
4427
|
+
* Query Parameters (GET):
|
|
4428
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
4429
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
4430
|
+
* query (str, optional): Search term to filter group suggestions
|
|
4431
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
4432
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4433
|
+
* page (int, optional): Page number for pagination
|
|
4434
|
+
* page_size (int, optional): Number of items per page
|
|
4435
|
+
*
|
|
4436
|
+
* Methods:
|
|
4437
|
+
* GET: Retrieve a paginated list of program group suggestions for a platform
|
|
4438
|
+
* POST: Create or update a program group suggestion
|
|
4439
|
+
* DELETE: Remove a program group suggestion
|
|
4440
|
+
*
|
|
4441
|
+
* Request Body (POST):
|
|
4442
|
+
* A JSON object containing:
|
|
4443
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
4444
|
+
* - program_key (str, required): The program key to suggest
|
|
4445
|
+
* - group_id (str/int, required): The group to suggest the program to
|
|
4446
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4447
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4448
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4449
|
+
*
|
|
4450
|
+
* Query Parameters (DELETE):
|
|
4451
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
4452
|
+
*
|
|
4453
|
+
* Returns:
|
|
4454
|
+
* GET: A paginated JSON response containing program group suggestions:
|
|
4455
|
+
* {
|
|
4456
|
+
* "count": 5,
|
|
4457
|
+
* "next": "https://example.com/api/catalog/suggestions/program/group/?page=2",
|
|
4458
|
+
* "previous": null,
|
|
4459
|
+
* "results": [
|
|
4460
|
+
* {
|
|
4461
|
+
* "id": 123,
|
|
4462
|
+
* "group_id": 789,
|
|
4463
|
+
* "group_name": "Engineering Team",
|
|
4464
|
+
* "platform_key": "platform1",
|
|
4465
|
+
* "accepted": false,
|
|
4466
|
+
* "visible": true,
|
|
4467
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4468
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4469
|
+
* "metadata": {},
|
|
4470
|
+
* "program_key": "program-v1:org+program+run",
|
|
4471
|
+
* "program_name": "Data Science Program",
|
|
4472
|
+
* "user_count": 25
|
|
4473
|
+
* },
|
|
4474
|
+
* ...
|
|
4475
|
+
* ]
|
|
4476
|
+
* }
|
|
4477
|
+
*
|
|
4478
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
4479
|
+
* {
|
|
4480
|
+
* "id": 123,
|
|
4481
|
+
* "group_id": 789,
|
|
4482
|
+
* "group_name": "Engineering Team",
|
|
4483
|
+
* "platform_key": "platform1",
|
|
4484
|
+
* "accepted": false,
|
|
4485
|
+
* "visible": true,
|
|
4486
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4487
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4488
|
+
* "metadata": {},
|
|
4489
|
+
* "program_key": "program-v1:org+program+run",
|
|
4490
|
+
* "program_name": "Data Science Program",
|
|
4491
|
+
* "user_count": 25
|
|
4492
|
+
* }
|
|
4493
|
+
*
|
|
4494
|
+
* DELETE: A success response with status 200
|
|
4495
|
+
*
|
|
4496
|
+
* Error Responses:
|
|
4497
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
4498
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4499
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
4500
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4501
|
+
*
|
|
4502
|
+
* Access Control:
|
|
4503
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4504
|
+
* - Platform admins can manage group suggestions for their platform
|
|
4505
|
+
* - Department admins can manage group suggestions for their departments
|
|
4506
|
+
* - DM admins can manage all group suggestions
|
|
4507
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
4508
|
+
* @param requestBody
|
|
4509
|
+
* @param departmentMode Filter suggestions by department admin access
|
|
4510
|
+
* @param page Page number for pagination
|
|
4511
|
+
* @param pageSize Number of items per page
|
|
4512
|
+
* @param platformOrg The organization identifier for the platform
|
|
4513
|
+
* @param query Search term to filter group suggestions
|
|
4514
|
+
* @param sort Field to sort results by
|
|
4515
|
+
* @returns ProgramGroupSuggestionDetail
|
|
4516
|
+
* @throws ApiError
|
|
4517
|
+
*/
|
|
4518
|
+
static catalogSuggestionsProgramManageGroupCreate(platformKey: string, requestBody: ProgramGroupSuggestionCreate, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<ProgramGroupSuggestionDetail>;
|
|
4519
|
+
/**
|
|
4520
|
+
* API View for managing program group suggestions.
|
|
4521
|
+
*
|
|
4522
|
+
* This endpoint allows administrators to view, create, and delete program suggestions
|
|
4523
|
+
* for groups of users within a platform.
|
|
4524
|
+
*
|
|
4525
|
+
* Query Parameters (GET):
|
|
4526
|
+
* platform_key (str, required): The platform to retrieve group suggestions for
|
|
4527
|
+
* platform_org (str, optional): The organization identifier for the platform
|
|
4528
|
+
* query (str, optional): Search term to filter group suggestions
|
|
4529
|
+
* sort (str, optional): Field to sort results by (default: 'id')
|
|
4530
|
+
* department_mode (bool, optional): Filter suggestions by department admin access
|
|
4531
|
+
* page (int, optional): Page number for pagination
|
|
4532
|
+
* page_size (int, optional): Number of items per page
|
|
4533
|
+
*
|
|
4534
|
+
* Methods:
|
|
4535
|
+
* GET: Retrieve a paginated list of program group suggestions for a platform
|
|
4536
|
+
* POST: Create or update a program group suggestion
|
|
4537
|
+
* DELETE: Remove a program group suggestion
|
|
4538
|
+
*
|
|
4539
|
+
* Request Body (POST):
|
|
4540
|
+
* A JSON object containing:
|
|
4541
|
+
* - platform_key (str, required): The platform for the group suggestion
|
|
4542
|
+
* - program_key (str, required): The program key to suggest
|
|
4543
|
+
* - group_id (str/int, required): The group to suggest the program to
|
|
4544
|
+
* - accepted (bool, optional): Whether the suggestion is accepted
|
|
4545
|
+
* - visible (bool, optional): Whether the suggestion is visible
|
|
4546
|
+
* - metadata (dict, optional): Additional suggestion metadata
|
|
4547
|
+
*
|
|
4548
|
+
* Query Parameters (DELETE):
|
|
4549
|
+
* suggestion_id (int, required): The ID of the group suggestion to delete
|
|
4550
|
+
*
|
|
4551
|
+
* Returns:
|
|
4552
|
+
* GET: A paginated JSON response containing program group suggestions:
|
|
4553
|
+
* {
|
|
4554
|
+
* "count": 5,
|
|
4555
|
+
* "next": "https://example.com/api/catalog/suggestions/program/group/?page=2",
|
|
4556
|
+
* "previous": null,
|
|
4557
|
+
* "results": [
|
|
4558
|
+
* {
|
|
4559
|
+
* "id": 123,
|
|
4560
|
+
* "group_id": 789,
|
|
4561
|
+
* "group_name": "Engineering Team",
|
|
4562
|
+
* "platform_key": "platform1",
|
|
4563
|
+
* "accepted": false,
|
|
4564
|
+
* "visible": true,
|
|
4565
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4566
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4567
|
+
* "metadata": {},
|
|
4568
|
+
* "program_key": "program-v1:org+program+run",
|
|
4569
|
+
* "program_name": "Data Science Program",
|
|
4570
|
+
* "user_count": 25
|
|
4571
|
+
* },
|
|
4572
|
+
* ...
|
|
4573
|
+
* ]
|
|
4574
|
+
* }
|
|
4575
|
+
*
|
|
4576
|
+
* POST: A JSON response containing the created/updated group suggestion:
|
|
4577
|
+
* {
|
|
4578
|
+
* "id": 123,
|
|
4579
|
+
* "group_id": 789,
|
|
4580
|
+
* "group_name": "Engineering Team",
|
|
4581
|
+
* "platform_key": "platform1",
|
|
4582
|
+
* "accepted": false,
|
|
4583
|
+
* "visible": true,
|
|
4584
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4585
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4586
|
+
* "metadata": {},
|
|
4587
|
+
* "program_key": "program-v1:org+program+run",
|
|
4588
|
+
* "program_name": "Data Science Program",
|
|
4589
|
+
* "user_count": 25
|
|
4590
|
+
* }
|
|
4591
|
+
*
|
|
4592
|
+
* DELETE: A success response with status 200
|
|
4593
|
+
*
|
|
4594
|
+
* Error Responses:
|
|
4595
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail
|
|
4596
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4597
|
+
* 403 Forbidden: If the user does not have permission to manage group suggestions
|
|
4598
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4599
|
+
*
|
|
4600
|
+
* Access Control:
|
|
4601
|
+
* - Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
|
|
4602
|
+
* - Platform admins can manage group suggestions for their platform
|
|
4603
|
+
* - Department admins can manage group suggestions for their departments
|
|
4604
|
+
* - DM admins can manage all group suggestions
|
|
4605
|
+
* @param platformKey The platform to retrieve group suggestions for
|
|
4606
|
+
* @param suggestionId The ID of the group suggestion to delete
|
|
4607
|
+
* @param departmentMode Flag to ensure department admins can call the API
|
|
4608
|
+
* @param page Page number for pagination
|
|
4609
|
+
* @param pageSize Number of items per page
|
|
4610
|
+
* @param platformOrg The organization identifier for the platform
|
|
4611
|
+
* @param query Search term to filter group suggestions
|
|
4612
|
+
* @param sort Field to sort results by
|
|
4613
|
+
* @returns any Success - group suggestion deleted
|
|
4614
|
+
* @throws ApiError
|
|
4615
|
+
*/
|
|
4616
|
+
static catalogSuggestionsProgramManageGroupDestroy(platformKey: string, suggestionId: number, departmentMode?: boolean, page?: number, pageSize?: number, platformOrg?: string, query?: string, sort?: string): CancelablePromise<any>;
|
|
4617
|
+
/**
|
|
4618
|
+
* API View for retrieving program suggestions for a specific user.
|
|
4619
|
+
*
|
|
4620
|
+
* This endpoint allows users to view program suggestions that have been made for them,
|
|
4621
|
+
* with support for filtering by platform and pagination.
|
|
4622
|
+
*
|
|
4623
|
+
* Query Parameters:
|
|
4624
|
+
* user (str, required): Username or user ID to retrieve suggestions for
|
|
4625
|
+
* platform_key (str, optional): Filter suggestions by platform key
|
|
4626
|
+
* platform_org (str, optional): Filter suggestions by platform organization
|
|
4627
|
+
* sort (str, optional): Field to sort results by (default: '-id')
|
|
4628
|
+
* page (int, optional): Page number for pagination
|
|
4629
|
+
* page_size (int, optional): Number of items per page
|
|
4630
|
+
*
|
|
4631
|
+
* Methods:
|
|
4632
|
+
* GET: Retrieve a paginated list of program suggestions for a user
|
|
4633
|
+
*
|
|
4634
|
+
* Returns:
|
|
4635
|
+
* GET: A paginated JSON response containing program suggestions:
|
|
4636
|
+
* {
|
|
4637
|
+
* "count": 10,
|
|
4638
|
+
* "next": "https://example.com/api/catalog/suggestions/program/user/?page=2",
|
|
4639
|
+
* "previous": null,
|
|
4640
|
+
* "results": [
|
|
4641
|
+
* {
|
|
4642
|
+
* "id": 123,
|
|
4643
|
+
* "user_id": 456,
|
|
4644
|
+
* "username": "student1",
|
|
4645
|
+
* "name": "Student Name",
|
|
4646
|
+
* "platform_key": "platform1",
|
|
4647
|
+
* "accepted": false,
|
|
4648
|
+
* "visible": true,
|
|
4649
|
+
* "created": "2023-06-15T14:30:00Z",
|
|
4650
|
+
* "modified": "2023-06-15T14:30:00Z",
|
|
4651
|
+
* "metadata": {},
|
|
4652
|
+
* "program_key": "program-v1:org+program+run",
|
|
4653
|
+
* "program_name": "Data Science Program"
|
|
4654
|
+
* },
|
|
4655
|
+
* ...
|
|
4656
|
+
* ]
|
|
4657
|
+
* }
|
|
4658
|
+
*
|
|
4659
|
+
* Error Responses:
|
|
4660
|
+
* 400 Bad Request: If required parameters are missing or invalid, or if suggestion retrieval fails
|
|
4661
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
4662
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
4663
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
4664
|
+
*
|
|
4665
|
+
* Access Control:
|
|
4666
|
+
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsEdxUserReadOnly permission
|
|
4667
|
+
* - Users can view their own suggestions
|
|
4668
|
+
* - Platform admins can view suggestions for users in their platform (read-only)
|
|
4669
|
+
* - DM admins can view all suggestions
|
|
4670
|
+
* @param username Username or user ID to retrieve suggestions for
|
|
4671
|
+
* @param email Email to retrieve suggestions for
|
|
4672
|
+
* @param page Page number for pagination
|
|
4673
|
+
* @param pageSize Number of items per page
|
|
4674
|
+
* @param platformKey Filter suggestions by platform key
|
|
4675
|
+
* @param platformOrg Filter suggestions by platform organization
|
|
4676
|
+
* @param sort Field to sort results by
|
|
4677
|
+
* @param userId User ID to retrieve suggestions for
|
|
4678
|
+
* @returns PaginatedProgramSuggestion
|
|
4679
|
+
* @throws ApiError
|
|
4680
|
+
*/
|
|
4681
|
+
static catalogSuggestionsProgramUserRetrieve(username: string, email?: string, page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, sort?: string, userId?: number): CancelablePromise<PaginatedProgramSuggestion>;
|
|
4682
|
+
}
|