@iblai/iblai-api 3.38.8-core → 3.38.9-ai-plus
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/dist/index.cjs.js +17316 -746
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +17309 -747
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +17316 -746
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +340 -1
- package/dist/types/models/AIGeneratedImage.d.ts +13 -0
- package/dist/types/models/AIUserProfileMemoryRelation.d.ts +4 -0
- package/dist/types/models/AIUserProfileRequest.d.ts +4 -0
- package/dist/types/models/APITokenCost.d.ts +14 -0
- package/dist/types/models/AccessEnum.d.ts +8 -0
- package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
- package/dist/types/models/AnalyticsOverview.d.ts +7 -0
- package/dist/types/models/Answer.d.ts +11 -0
- package/dist/types/models/AssumedKnowledge.d.ts +4 -0
- package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
- package/dist/types/models/AudioToTextRequest.d.ts +3 -0
- package/dist/types/models/AudioToTextResponse.d.ts +3 -0
- package/dist/types/models/Bot.d.ts +15 -0
- package/dist/types/models/BotCommand.d.ts +6 -0
- package/dist/types/models/BotCreate.d.ts +12 -0
- package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
- package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
- package/dist/types/models/CatalogAutoIncrementResponse.d.ts +25 -0
- package/dist/types/models/CatalogAutoIncrementUpdateRequest.d.ts +17 -0
- package/dist/types/models/ChatHistory.d.ts +8 -0
- package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
- package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
- package/dist/types/models/ChatHistoryItem.d.ts +5 -0
- package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
- package/dist/types/models/ChatSessionRequest.d.ts +10 -0
- package/dist/types/models/ChatSessionResponse.d.ts +5 -0
- package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
- package/dist/types/models/ComponentBlock.d.ts +9 -0
- package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
- package/dist/types/models/ConversationMessage.d.ts +11 -0
- package/dist/types/models/ConversationRating.d.ts +6 -0
- package/dist/types/models/ConversationSummary.d.ts +5 -0
- package/dist/types/models/ConversationVolume.d.ts +4 -0
- package/dist/types/models/Conversations.d.ts +28 -0
- package/dist/types/models/Cost.d.ts +3 -0
- package/dist/types/models/CostPerTenant.d.ts +6 -0
- package/dist/types/models/Course.d.ts +15 -0
- package/dist/types/models/CourseCreateUpdate.d.ts +25 -0
- package/dist/types/models/CourseCreationTask.d.ts +31 -0
- package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
- package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -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/CourseMetadataSearchRequest.d.ts +17 -0
- package/dist/types/models/CourseMetadataUpdateRequest.d.ts +17 -0
- package/dist/types/models/CourseReviewInfoResponse.d.ts +17 -0
- package/dist/types/models/CredentialRequest.d.ts +14 -0
- package/dist/types/models/CrontabSchedule.d.ts +22 -0
- package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
- package/dist/types/models/DataSet.d.ts +21 -0
- package/dist/types/models/DataSetCreate.d.ts +12 -0
- package/dist/types/models/DataSetStatusEnum.d.ts +12 -0
- package/dist/types/models/DateRange.d.ts +4 -0
- package/dist/types/models/DesiredRole.d.ts +3 -0
- package/dist/types/models/DesiredRoleCreateUpdateRequest.d.ts +21 -0
- package/dist/types/models/DesiredSkill.d.ts +3 -0
- package/dist/types/models/DesiredSkillCreateUpdateRequest.d.ts +21 -0
- package/dist/types/models/DiscordConfig.d.ts +7 -0
- package/dist/types/models/DiscordUserConfig.d.ts +10 -0
- package/dist/types/models/DiscordWebhook.d.ts +6 -0
- package/dist/types/models/Document.d.ts +41 -0
- package/dist/types/models/DocumentFacet.d.ts +17 -0
- package/dist/types/models/DocumentSearchResponse.d.ts +35 -0
- package/dist/types/models/EdxCourse.d.ts +11 -0
- package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
- package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
- package/dist/types/models/EmailPromptDetail.d.ts +13 -0
- package/dist/types/models/EmailPromptList.d.ts +11 -0
- package/dist/types/models/EmailPromptSummary.d.ts +5 -0
- package/dist/types/models/FreeUsageCount.d.ts +3 -0
- package/dist/types/models/FullCourse.d.ts +13 -0
- package/dist/types/models/GlobalCatalogSearchResponse.d.ts +33 -0
- package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
- package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
- package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
- package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
- package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
- package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
- package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
- package/dist/types/models/InputQuestion.d.ts +6 -0
- package/dist/types/models/IntegrationCredential.d.ts +8 -0
- package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
- package/dist/types/models/JobRun.d.ts +11 -0
- package/dist/types/models/KindEnum.d.ts +10 -0
- package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
- package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
- package/dist/types/models/LLMModelForTenant.d.ts +6 -0
- package/dist/types/models/LLMQuestion.d.ts +15 -0
- package/dist/types/models/LLMResponse.d.ts +14 -0
- package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
- package/dist/types/models/LanguagesView.d.ts +5 -0
- package/dist/types/models/LinkCourseRequest.d.ts +3 -0
- package/dist/types/models/LinkCourseResponse.d.ts +5 -0
- package/dist/types/models/MCPServer.d.ts +21 -0
- package/dist/types/models/MemoryComponentData.d.ts +5 -0
- package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
- package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
- package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
- package/dist/types/models/MemoryProgress.d.ts +8 -0
- package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
- package/dist/types/models/MemoryStatusView.d.ts +6 -0
- package/dist/types/models/Mentor.d.ts +80 -0
- package/dist/types/models/MentorAudience.d.ts +5 -0
- package/dist/types/models/MentorCategory.d.ts +9 -0
- package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
- package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
- package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
- package/dist/types/models/MentorCreate.d.ts +79 -0
- package/dist/types/models/MentorCustomVoice.d.ts +4 -0
- package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
- package/dist/types/models/MentorData.d.ts +7 -0
- package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
- package/dist/types/models/MentorEval.d.ts +11 -0
- package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
- package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
- package/dist/types/models/MentorEvalReport.d.ts +10 -0
- package/dist/types/models/MentorEvalRequest.d.ts +8 -0
- package/dist/types/models/MentorFacet.d.ts +17 -0
- package/dist/types/models/MentorFork.d.ts +5 -0
- package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
- package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +43 -0
- package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
- package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
- package/dist/types/models/MentorMetadata.d.ts +5 -0
- package/dist/types/models/MentorScenario.d.ts +6 -0
- package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
- package/dist/types/models/MentorSearchResponse.d.ts +35 -0
- package/dist/types/models/MentorSession.d.ts +4 -0
- package/dist/types/models/MentorSettings.d.ts +54 -0
- package/dist/types/models/MentorSettingsPublic.d.ts +43 -0
- package/dist/types/models/MentorSettingsRequest.d.ts +58 -0
- package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
- package/dist/types/models/MentorWizard.d.ts +4 -0
- package/dist/types/models/MessageStatistics.d.ts +5 -0
- package/dist/types/models/MessageView.d.ts +10 -0
- package/dist/types/models/MessageViewRequest.d.ts +7 -0
- package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
- package/dist/types/models/Metadata.d.ts +5 -0
- package/dist/types/models/MetricChange.d.ts +4 -0
- package/dist/types/models/ModelCost.d.ts +4 -0
- package/dist/types/models/ModerationLog.d.ts +11 -0
- package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
- package/dist/types/models/NotificationSource.d.ts +2 -2
- package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
- package/dist/types/models/NullEnum.d.ts +1 -0
- package/dist/types/models/PageContent.d.ts +6 -0
- package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
- package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
- package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
- package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
- package/dist/types/models/PaginatedDataSetList.d.ts +7 -0
- package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
- package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
- package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
- package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
- package/dist/types/models/PaginatedMCPServerList.d.ts +7 -0
- package/dist/types/models/PaginatedMentorList.d.ts +7 -0
- package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
- package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
- package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
- package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
- package/dist/types/models/PaginatedSectionList.d.ts +7 -0
- package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
- package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
- package/dist/types/models/PaginatedTrainingList.d.ts +7 -0
- package/dist/types/models/PaginatedUnitList.d.ts +7 -0
- package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
- package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
- package/dist/types/models/PatchedBotCommand.d.ts +6 -0
- package/dist/types/models/PatchedBotCreate.d.ts +12 -0
- package/dist/types/models/PatchedConversations.d.ts +28 -0
- package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
- package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
- package/dist/types/models/PatchedDataSet.d.ts +21 -0
- package/dist/types/models/PatchedDiscordConfig.d.ts +7 -0
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +10 -0
- package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
- package/dist/types/models/PatchedMCPServer.d.ts +21 -0
- package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
- package/dist/types/models/PatchedMentorCreate.d.ts +79 -0
- package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
- package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
- package/dist/types/models/PatchedPrompt.d.ts +22 -0
- package/dist/types/models/PatchedSection.d.ts +9 -0
- package/dist/types/models/PatchedSlackConfig.d.ts +8 -0
- package/dist/types/models/PatchedSlackUserConfig.d.ts +17 -0
- package/dist/types/models/PatchedSubSection.d.ts +9 -0
- package/dist/types/models/PatchedTeamsConfig.d.ts +7 -0
- package/dist/types/models/PatchedTrainingCreate.d.ts +31 -0
- package/dist/types/models/PatchedUnit.d.ts +11 -0
- package/dist/types/models/PatchedWebexConfig.d.ts +10 -0
- package/dist/types/models/PatchedWhatsappConfig.d.ts +11 -0
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +10 -0
- package/dist/types/models/Pathway.d.ts +28 -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/PathwaySelfEnrollmentRequest.d.ts +37 -0
- package/dist/types/models/PeriodicAgent.d.ts +42 -0
- package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
- package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
- package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
- package/dist/types/models/PeriodicTask.d.ts +21 -0
- package/dist/types/models/PieChartData.d.ts +5 -0
- package/dist/types/models/PieChartSegment.d.ts +4 -0
- package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
- package/dist/types/models/PinnedMessageGet.d.ts +7 -0
- package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
- package/dist/types/models/PlayWrightScript.d.ts +12 -0
- package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
- package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
- package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -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/ProgramReviewInfoResponse.d.ts +17 -0
- package/dist/types/models/ProgramSearch.d.ts +28 -0
- package/dist/types/models/Prompt.d.ts +22 -0
- package/dist/types/models/PromptCategory.d.ts +7 -0
- package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
- package/dist/types/models/Provider05cEnum.d.ts +14 -0
- package/dist/types/models/Provider63aEnum.d.ts +6 -0
- package/dist/types/models/QuestionCardTag.d.ts +8 -0
- package/dist/types/models/QuestionRequest.d.ts +15 -0
- package/dist/types/models/QuestionResponse.d.ts +10 -0
- package/dist/types/models/RatingEnum.d.ts +8 -0
- package/dist/types/models/RatingRecord.d.ts +4 -0
- package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
- package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
- package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
- package/dist/types/models/RelatedText.d.ts +3 -0
- package/dist/types/models/ReportedRole.d.ts +3 -0
- package/dist/types/models/ReportedRoleCreateUpdateRequest.d.ts +21 -0
- package/dist/types/models/ReportedSkill.d.ts +3 -0
- package/dist/types/models/RequestDataVariable.d.ts +14 -0
- package/dist/types/models/ResourceDeleteResponse.d.ts +13 -0
- package/dist/types/models/ResourceScrappedData.d.ts +13 -0
- package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
- package/dist/types/models/ResponseDataVariable.d.ts +14 -0
- package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
- package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
- package/dist/types/models/RetrieveTask.d.ts +3 -0
- package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
- package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
- package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
- package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
- package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
- package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
- package/dist/types/models/Role.d.ts +12 -1
- package/dist/types/models/RoleCreateUpdateRequest.d.ts +25 -0
- package/dist/types/models/RunMentorEval.d.ts +3 -0
- package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
- package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
- package/dist/types/models/Section.d.ts +9 -0
- package/dist/types/models/SectionWithChildren.d.ts +11 -0
- package/dist/types/models/SeedMentorsView.d.ts +3 -0
- package/dist/types/models/SentimentSummary.d.ts +4 -0
- package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
- package/dist/types/models/SessionDetail.d.ts +6 -0
- package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
- package/dist/types/models/ShellLogs.d.ts +3 -0
- package/dist/types/models/Skill.d.ts +10 -1
- package/dist/types/models/SkillCreateUpdateRequest.d.ts +25 -0
- package/dist/types/models/SlackConfig.d.ts +8 -0
- package/dist/types/models/SlackUserConfig.d.ts +17 -0
- package/dist/types/models/SlackWebhook.d.ts +6 -0
- package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
- package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
- package/dist/types/models/StarMentor.d.ts +7 -0
- package/dist/types/models/Status6eeEnum.d.ts +12 -0
- package/dist/types/models/Step.d.ts +9 -0
- package/dist/types/models/StepStatusEnum.d.ts +10 -0
- package/dist/types/models/StudentChatMessage.d.ts +4 -0
- package/dist/types/models/StylesView.d.ts +4 -0
- package/dist/types/models/SubSection.d.ts +9 -0
- package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
- package/dist/types/models/TagsView.d.ts +5 -0
- package/dist/types/models/TargetSystemEnum.d.ts +8 -0
- package/dist/types/models/TaskView.d.ts +3 -0
- package/dist/types/models/TeamsConfig.d.ts +7 -0
- package/dist/types/models/TeamsWebhook.d.ts +17 -0
- package/dist/types/models/TemplateMentor.d.ts +9 -0
- package/dist/types/models/TenantMentorTraces.d.ts +6 -0
- package/dist/types/models/ThemeEnum.d.ts +8 -0
- package/dist/types/models/TonesView.d.ts +4 -0
- package/dist/types/models/ToolResponse.d.ts +9 -0
- package/dist/types/models/TopicModel.d.ts +3 -0
- package/dist/types/models/TopicRecord.d.ts +4 -0
- package/dist/types/models/TopicStatistics.d.ts +7 -0
- package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
- package/dist/types/models/TopicSummaryView.d.ts +4 -0
- package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
- package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
- package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
- package/dist/types/models/TrainDocumentViewResponse.d.ts +14 -0
- package/dist/types/models/Training.d.ts +41 -0
- package/dist/types/models/TrainingCreate.d.ts +31 -0
- package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
- package/dist/types/models/TransportEnum.d.ts +8 -0
- package/dist/types/models/TrendEntry.d.ts +4 -0
- package/dist/types/models/TriggerRequest.d.ts +5 -0
- package/dist/types/models/TriggerResponse.d.ts +6 -0
- package/dist/types/models/TypeC42Enum.d.ts +8 -0
- package/dist/types/models/Unit.d.ts +11 -0
- package/dist/types/models/UnitWithChildren.d.ts +13 -0
- package/dist/types/models/UseMainCreds.d.ts +3 -0
- package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
- package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
- package/dist/types/models/UserChatByPeriod.d.ts +4 -0
- package/dist/types/models/UserChatFeedback.d.ts +14 -0
- package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
- package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
- package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
- package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
- package/dist/types/models/UserCountRecord.d.ts +4 -0
- package/dist/types/models/UserEdxMemory.d.ts +15 -0
- package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
- package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
- package/dist/types/models/UserMetric.d.ts +4 -0
- package/dist/types/models/UserMetricsResponse.d.ts +7 -0
- package/dist/types/models/UserSearchResponse.d.ts +29 -0
- package/dist/types/models/UserSentimentCountView.d.ts +4 -0
- package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
- package/dist/types/models/VectorResult.d.ts +8 -0
- package/dist/types/models/Voice.d.ts +9 -0
- package/dist/types/models/VoiceProviderEnum.d.ts +10 -0
- package/dist/types/models/WebResource.d.ts +9 -0
- package/dist/types/models/WebResourceCard.d.ts +7 -0
- package/dist/types/models/WebResourcesQuery.d.ts +3 -0
- package/dist/types/models/WebexConfig.d.ts +10 -0
- package/dist/types/models/WebexWebhook.d.ts +4 -0
- package/dist/types/models/WhatAppWebHook.d.ts +3 -0
- package/dist/types/models/WhatsappConfig.d.ts +11 -0
- package/dist/types/models/WhatsappUserConfig.d.ts +10 -0
- package/dist/types/services/AiAccountService.d.ts +294 -0
- package/dist/types/services/AiAnalyticsService.d.ts +2801 -0
- package/dist/types/services/AiBotService.d.ts +486 -0
- package/dist/types/services/AiFinetuningService.d.ts +162 -0
- package/dist/types/services/AiIndexService.d.ts +344 -0
- package/dist/types/services/AiMarketingService.d.ts +34 -0
- package/dist/types/services/AiMentorService.d.ts +4235 -0
- package/dist/types/services/AiPromptService.d.ts +920 -0
- package/dist/types/services/CatalogService.d.ts +424 -463
- package/dist/types/services/SearchService.d.ts +605 -21
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +340 -1
- package/src/models/AIGeneratedImage.ts +18 -0
- package/src/models/AIUserProfileMemoryRelation.ts +9 -0
- package/src/models/AIUserProfileRequest.ts +9 -0
- package/src/models/APITokenCost.ts +19 -0
- package/src/models/AccessEnum.ts +12 -0
- package/src/models/AlignMentorBubbleEnum.ts +12 -0
- package/src/models/AnalyticsOverview.ts +12 -0
- package/src/models/Answer.ts +16 -0
- package/src/models/AssumedKnowledge.ts +9 -0
- package/src/models/AssumedKnowledgeLevel.ts +9 -0
- package/src/models/AudioToTextRequest.ts +8 -0
- package/src/models/AudioToTextResponse.ts +8 -0
- package/src/models/Bot.ts +20 -0
- package/src/models/BotCommand.ts +11 -0
- package/src/models/BotCreate.ts +17 -0
- package/src/models/CallAuthenticationRequest.ts +18 -0
- package/src/models/CallAuthenticationResponse.ts +26 -0
- package/src/models/CatalogAutoIncrementResponse.ts +30 -0
- package/src/models/CatalogAutoIncrementUpdateRequest.ts +22 -0
- package/src/models/ChatHistory.ts +13 -0
- package/src/models/ChatHistoryFilterData.ts +14 -0
- package/src/models/ChatHistoryFilterUser.ts +10 -0
- package/src/models/ChatHistoryItem.ts +10 -0
- package/src/models/ChatHistorySessionId.ts +8 -0
- package/src/models/ChatSessionRequest.ts +15 -0
- package/src/models/ChatSessionResponse.ts +10 -0
- package/src/models/CheckDocumentTrainingStatus.ts +15 -0
- package/src/models/ComponentBlock.ts +14 -0
- package/src/models/ComponentBlockTypeEnum.ts +12 -0
- package/src/models/ConversationMessage.ts +16 -0
- package/src/models/ConversationRating.ts +11 -0
- package/src/models/ConversationSummary.ts +10 -0
- package/src/models/ConversationVolume.ts +9 -0
- package/src/models/Conversations.ts +33 -0
- package/src/models/Cost.ts +8 -0
- package/src/models/CostPerTenant.ts +11 -0
- package/src/models/Course.ts +20 -0
- package/src/models/CourseCreateUpdate.ts +30 -0
- package/src/models/CourseCreationTask.ts +36 -0
- package/src/models/CourseCreationTaskFile.ts +12 -0
- package/src/models/CourseCreationTaskStatusEnum.ts +20 -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/CourseMetadataSearchRequest.ts +22 -0
- package/src/models/CourseMetadataUpdateRequest.ts +22 -0
- package/src/models/CourseReviewInfoResponse.ts +22 -0
- package/src/models/CredentialRequest.ts +19 -0
- package/src/models/CrontabSchedule.ts +27 -0
- package/src/models/CustomInstructionResponse.ts +18 -0
- package/src/models/DataSet.ts +26 -0
- package/src/models/DataSetCreate.ts +17 -0
- package/src/models/DataSetStatusEnum.ts +16 -0
- package/src/models/DateRange.ts +9 -0
- package/src/models/DesiredRole.ts +3 -0
- package/src/models/DesiredRoleCreateUpdateRequest.ts +26 -0
- package/src/models/DesiredSkill.ts +3 -0
- package/src/models/DesiredSkillCreateUpdateRequest.ts +26 -0
- package/src/models/DiscordConfig.ts +12 -0
- package/src/models/DiscordUserConfig.ts +15 -0
- package/src/models/DiscordWebhook.ts +11 -0
- package/src/models/Document.ts +46 -0
- package/src/models/DocumentFacet.ts +22 -0
- package/src/models/DocumentSearchResponse.ts +40 -0
- package/src/models/EdxCourse.ts +16 -0
- package/src/models/ElevenlabsCustomVoice.ts +9 -0
- package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
- package/src/models/EmailPromptDetail.ts +18 -0
- package/src/models/EmailPromptList.ts +16 -0
- package/src/models/EmailPromptSummary.ts +10 -0
- package/src/models/FreeUsageCount.ts +8 -0
- package/src/models/FullCourse.ts +18 -0
- package/src/models/GlobalCatalogSearchResponse.ts +38 -0
- package/src/models/GreetingMethodEnum.ts +12 -0
- package/src/models/GuidedPromptsResponse.ts +8 -0
- package/src/models/HeygenMarketingVideoDetail.ts +13 -0
- package/src/models/HeygenMarketingVideoList.ts +11 -0
- package/src/models/IBLAIPlatformMeta.ts +8 -0
- package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
- package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
- package/src/models/InputQuestion.ts +11 -0
- package/src/models/IntegrationCredential.ts +13 -0
- package/src/models/IntialQuestionAnswer.ts +8 -0
- package/src/models/JobRun.ts +16 -0
- package/src/models/KindEnum.ts +14 -0
- package/src/models/LLMCredentialRequest.ts +19 -0
- package/src/models/LLMCredentialResponse.ts +13 -0
- package/src/models/LLMModelForTenant.ts +11 -0
- package/src/models/LLMQuestion.ts +20 -0
- package/src/models/LLMResponse.ts +19 -0
- package/src/models/LLMTracesListResponse.ts +10 -0
- package/src/models/LanguagesView.ts +10 -0
- package/src/models/LinkCourseRequest.ts +8 -0
- package/src/models/LinkCourseResponse.ts +10 -0
- package/src/models/MCPServer.ts +26 -0
- package/src/models/MemoryComponentData.ts +10 -0
- package/src/models/MemoryComponentMemory.ts +9 -0
- package/src/models/MemoryComponentMemoryDetail.ts +13 -0
- package/src/models/MemoryComponentResponse.ts +10 -0
- package/src/models/MemoryProgress.ts +13 -0
- package/src/models/MemoryStatusRequestView.ts +11 -0
- package/src/models/MemoryStatusView.ts +11 -0
- package/src/models/Mentor.ts +85 -0
- package/src/models/MentorAudience.ts +10 -0
- package/src/models/MentorCategory.ts +14 -0
- package/src/models/MentorCategoryCreate.ts +16 -0
- package/src/models/MentorCategoryGroup.ts +16 -0
- package/src/models/MentorCategoryGroupCreate.ts +16 -0
- package/src/models/MentorCreate.ts +84 -0
- package/src/models/MentorCustomVoice.ts +9 -0
- package/src/models/MentorCustomVoiceResponse.ts +9 -0
- package/src/models/MentorData.ts +12 -0
- package/src/models/MentorDetailAnalytics.ts +11 -0
- package/src/models/MentorEval.ts +16 -0
- package/src/models/MentorEvalQuestion.ts +10 -0
- package/src/models/MentorEvalQuestionRequest.ts +9 -0
- package/src/models/MentorEvalReport.ts +15 -0
- package/src/models/MentorEvalRequest.ts +13 -0
- package/src/models/MentorFacet.ts +22 -0
- package/src/models/MentorFork.ts +10 -0
- package/src/models/MentorFromTemplateRequest.ts +9 -0
- package/src/models/MentorFromTemplateWithSettingRequest.ts +48 -0
- package/src/models/MentorMemorySettingsRequest.ts +11 -0
- package/src/models/MentorMemorySettingsResponse.ts +11 -0
- package/src/models/MentorMetadata.ts +10 -0
- package/src/models/MentorScenario.ts +11 -0
- package/src/models/MentorScenarioPrompt.ts +10 -0
- package/src/models/MentorSearchResponse.ts +40 -0
- package/src/models/MentorSession.ts +9 -0
- package/src/models/MentorSettings.ts +59 -0
- package/src/models/MentorSettingsPublic.ts +48 -0
- package/src/models/MentorSettingsRequest.ts +63 -0
- package/src/models/MentorVisibilityEnum.ts +14 -0
- package/src/models/MentorWizard.ts +9 -0
- package/src/models/MessageStatistics.ts +10 -0
- package/src/models/MessageView.ts +15 -0
- package/src/models/MessageViewRequest.ts +12 -0
- package/src/models/MessageViewUpdatResponse.ts +8 -0
- package/src/models/Metadata.ts +10 -0
- package/src/models/MetricChange.ts +9 -0
- package/src/models/ModelCost.ts +9 -0
- package/src/models/ModerationLog.ts +16 -0
- package/src/models/NoChatMessagesFound.ts +8 -0
- package/src/models/NotificationSource.ts +2 -2
- package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
- package/src/models/NullEnum.ts +7 -0
- package/src/models/PageContent.ts +11 -0
- package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
- package/src/models/PaginatedConversationsList.ts +12 -0
- package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
- package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
- package/src/models/PaginatedDataSetList.ts +12 -0
- package/src/models/PaginatedEdxCourseList.ts +12 -0
- package/src/models/PaginatedEmailPromptListList.ts +12 -0
- package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
- package/src/models/PaginatedJobRunList.ts +12 -0
- package/src/models/PaginatedMCPServerList.ts +12 -0
- package/src/models/PaginatedMentorList.ts +12 -0
- package/src/models/PaginatedModerationLogList.ts +12 -0
- package/src/models/PaginatedPeriodicAgentList.ts +12 -0
- package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
- package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
- package/src/models/PaginatedSectionList.ts +12 -0
- package/src/models/PaginatedSubSectionList.ts +12 -0
- package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
- package/src/models/PaginatedTrainingList.ts +12 -0
- package/src/models/PaginatedUnitList.ts +12 -0
- package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
- package/src/models/PaginatedVoiceList.ts +12 -0
- package/src/models/PatchedBotCommand.ts +11 -0
- package/src/models/PatchedBotCreate.ts +17 -0
- package/src/models/PatchedConversations.ts +33 -0
- package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
- package/src/models/PatchedCredentialRequest.ts +19 -0
- package/src/models/PatchedDataSet.ts +26 -0
- package/src/models/PatchedDiscordConfig.ts +12 -0
- package/src/models/PatchedDiscordUserConfig.ts +15 -0
- package/src/models/PatchedLLMCredentialRequest.ts +19 -0
- package/src/models/PatchedMCPServer.ts +26 -0
- package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
- package/src/models/PatchedMentorCreate.ts +84 -0
- package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
- package/src/models/PatchedPlayWrightScript.ts +17 -0
- package/src/models/PatchedPrompt.ts +27 -0
- package/src/models/PatchedSection.ts +14 -0
- package/src/models/PatchedSlackConfig.ts +13 -0
- package/src/models/PatchedSlackUserConfig.ts +22 -0
- package/src/models/PatchedSubSection.ts +14 -0
- package/src/models/PatchedTeamsConfig.ts +12 -0
- package/src/models/PatchedTrainingCreate.ts +36 -0
- package/src/models/PatchedUnit.ts +16 -0
- package/src/models/PatchedWebexConfig.ts +15 -0
- package/src/models/PatchedWhatsappConfig.ts +16 -0
- package/src/models/PatchedWhatsappUserConfig.ts +15 -0
- package/src/models/Pathway.ts +33 -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/PathwaySelfEnrollmentRequest.ts +42 -0
- package/src/models/PeriodicAgent.ts +47 -0
- package/src/models/PeriodicAgentCreate.ts +46 -0
- package/src/models/PeriodicAgentLog.ts +16 -0
- package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
- package/src/models/PeriodicTask.ts +26 -0
- package/src/models/PieChartData.ts +10 -0
- package/src/models/PieChartSegment.ts +9 -0
- package/src/models/PinnedMessageCreate.ts +14 -0
- package/src/models/PinnedMessageGet.ts +12 -0
- package/src/models/PinnedMessageRequest.ts +11 -0
- package/src/models/PlayWrightScript.ts +17 -0
- package/src/models/PredictiveAnalyticsRequest.ts +9 -0
- package/src/models/PredictiveAnalyticsResponse.ts +9 -0
- package/src/models/PreviousAgentStatusEnum.ts +16 -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/ProgramReviewInfoResponse.ts +22 -0
- package/src/models/ProgramSearch.ts +33 -0
- package/src/models/Prompt.ts +27 -0
- package/src/models/PromptCategory.ts +12 -0
- package/src/models/PromptVisibilityEnum.ts +14 -0
- package/src/models/Provider05cEnum.ts +18 -0
- package/src/models/Provider63aEnum.ts +10 -0
- package/src/models/QuestionCardTag.ts +13 -0
- package/src/models/QuestionRequest.ts +20 -0
- package/src/models/QuestionResponse.ts +15 -0
- package/src/models/RatingEnum.ts +12 -0
- package/src/models/RatingRecord.ts +9 -0
- package/src/models/RecentlyAccessedMentor.ts +13 -0
- package/src/models/RecommendCourseBlock.ts +8 -0
- package/src/models/RecommendCourseResponse.ts +8 -0
- package/src/models/RelatedText.ts +8 -0
- package/src/models/ReportedRole.ts +3 -0
- package/src/models/ReportedRoleCreateUpdateRequest.ts +26 -0
- package/src/models/ReportedSkill.ts +3 -0
- package/src/models/RequestDataVariable.ts +19 -0
- package/src/models/ResourceDeleteResponse.ts +18 -0
- package/src/models/ResourceScrappedData.ts +18 -0
- package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
- package/src/models/ResponseDataVariable.ts +19 -0
- package/src/models/RetreiverTrainViewRequest.ts +15 -0
- package/src/models/RetreiverTrainViewResponse.ts +11 -0
- package/src/models/RetrieveTask.ts +8 -0
- package/src/models/RetrieverDocumentEmbedding.ts +22 -0
- package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
- package/src/models/RetrieverRequestSearch.ts +15 -0
- package/src/models/RetrieverRequestSearchDocument.ts +15 -0
- package/src/models/RetrieverResponseSearch.ts +12 -0
- package/src/models/ReuestDataVariableList.ts +9 -0
- package/src/models/Role.ts +12 -1
- package/src/models/RoleCreateUpdateRequest.ts +30 -0
- package/src/models/RunMentorEval.ts +8 -0
- package/src/models/ScanWebhookRequest.ts +11 -0
- package/src/models/ScanWebhookResponse.ts +8 -0
- package/src/models/Section.ts +14 -0
- package/src/models/SectionWithChildren.ts +16 -0
- package/src/models/SeedMentorsView.ts +8 -0
- package/src/models/SentimentSummary.ts +9 -0
- package/src/models/SessionBrowserScreenshot.ts +13 -0
- package/src/models/SessionDetail.ts +11 -0
- package/src/models/SessionMemoryStorage.ts +11 -0
- package/src/models/ShellLogs.ts +8 -0
- package/src/models/Skill.ts +10 -1
- package/src/models/SkillCreateUpdateRequest.ts +30 -0
- package/src/models/SlackConfig.ts +13 -0
- package/src/models/SlackUserConfig.ts +22 -0
- package/src/models/SlackWebhook.ts +11 -0
- package/src/models/SpacedRepetitionLearningPath.ts +8 -0
- package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
- package/src/models/StarMentor.ts +12 -0
- package/src/models/Status6eeEnum.ts +16 -0
- package/src/models/Step.ts +14 -0
- package/src/models/StepStatusEnum.ts +14 -0
- package/src/models/StudentChatMessage.ts +9 -0
- package/src/models/StylesView.ts +9 -0
- package/src/models/SubSection.ts +14 -0
- package/src/models/SubSectionWithChildren.ts +16 -0
- package/src/models/TagsView.ts +10 -0
- package/src/models/TargetSystemEnum.ts +12 -0
- package/src/models/TaskView.ts +8 -0
- package/src/models/TeamsConfig.ts +12 -0
- package/src/models/TeamsWebhook.ts +22 -0
- package/src/models/TemplateMentor.ts +14 -0
- package/src/models/TenantMentorTraces.ts +11 -0
- package/src/models/ThemeEnum.ts +12 -0
- package/src/models/TonesView.ts +9 -0
- package/src/models/ToolResponse.ts +14 -0
- package/src/models/TopicModel.ts +8 -0
- package/src/models/TopicRecord.ts +9 -0
- package/src/models/TopicStatistics.ts +12 -0
- package/src/models/TopicStatisticsResponse.ts +11 -0
- package/src/models/TopicSummaryView.ts +9 -0
- package/src/models/TrainChatSessionDocumentView.ts +11 -0
- package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
- package/src/models/TrainDocumentViewRequest.ts +47 -0
- package/src/models/TrainDocumentViewResponse.ts +19 -0
- package/src/models/Training.ts +46 -0
- package/src/models/TrainingCreate.ts +36 -0
- package/src/models/TrainingStatusEnum.ts +16 -0
- package/src/models/TransportEnum.ts +12 -0
- package/src/models/TrendEntry.ts +9 -0
- package/src/models/TriggerRequest.ts +10 -0
- package/src/models/TriggerResponse.ts +11 -0
- package/src/models/TypeC42Enum.ts +12 -0
- package/src/models/Unit.ts +16 -0
- package/src/models/UnitWithChildren.ts +18 -0
- package/src/models/UseMainCreds.ts +8 -0
- package/src/models/UserAllChatMemoryView.ts +12 -0
- package/src/models/UserCatalogItemMemoryView.ts +19 -0
- package/src/models/UserChatByPeriod.ts +9 -0
- package/src/models/UserChatFeedback.ts +19 -0
- package/src/models/UserChatFeedbackCount.ts +9 -0
- package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
- package/src/models/UserChatMemoryStatusView.ts +11 -0
- package/src/models/UserChatMemoryUpdateView.ts +15 -0
- package/src/models/UserCountRecord.ts +9 -0
- package/src/models/UserEdxMemory.ts +20 -0
- package/src/models/UserMemoryContextRequest.ts +18 -0
- package/src/models/UserMemoryContextResponse.ts +17 -0
- package/src/models/UserMetric.ts +9 -0
- package/src/models/UserMetricsResponse.ts +12 -0
- package/src/models/UserSearchResponse.ts +34 -0
- package/src/models/UserSentimentCountView.ts +9 -0
- package/src/models/UserTrendByPeriod.ts +10 -0
- package/src/models/VectorResult.ts +13 -0
- package/src/models/Voice.ts +14 -0
- package/src/models/VoiceProviderEnum.ts +14 -0
- package/src/models/WebResource.ts +14 -0
- package/src/models/WebResourceCard.ts +12 -0
- package/src/models/WebResourcesQuery.ts +8 -0
- package/src/models/WebexConfig.ts +15 -0
- package/src/models/WebexWebhook.ts +9 -0
- package/src/models/WhatAppWebHook.ts +8 -0
- package/src/models/WhatsappConfig.ts +16 -0
- package/src/models/WhatsappUserConfig.ts +15 -0
- package/src/services/AiAccountService.ts +479 -0
- package/src/services/AiAnalyticsService.ts +5198 -0
- package/src/services/AiBotService.ts +1174 -0
- package/src/services/AiFinetuningService.ts +402 -0
- package/src/services/AiIndexService.ts +598 -0
- package/src/services/AiMarketingService.ts +87 -0
- package/src/services/AiMentorService.ts +7977 -0
- package/src/services/AiPromptService.ts +1771 -0
- package/src/services/CatalogService.ts +1191 -457
- package/src/services/SearchService.ts +1215 -285
|
@@ -1,5 +1,41 @@
|
|
|
1
|
+
import type { CatalogAutoIncrementResponse } from '../models/CatalogAutoIncrementResponse';
|
|
2
|
+
import type { CatalogAutoIncrementUpdateRequest } from '../models/CatalogAutoIncrementUpdateRequest';
|
|
3
|
+
import type { Course } from '../models/Course';
|
|
4
|
+
import type { CourseCreateUpdate } from '../models/CourseCreateUpdate';
|
|
5
|
+
import type { CourseDeleteResponse } from '../models/CourseDeleteResponse';
|
|
6
|
+
import type { CourseEligibilityCheckResponse } from '../models/CourseEligibilityCheckResponse';
|
|
7
|
+
import type { CourseEnrollmentSearchResponse } from '../models/CourseEnrollmentSearchResponse';
|
|
8
|
+
import type { CourseMetadataSearchRequest } from '../models/CourseMetadataSearchRequest';
|
|
9
|
+
import type { CourseMetadataUpdateRequest } from '../models/CourseMetadataUpdateRequest';
|
|
10
|
+
import type { CourseReviewInfoResponse } from '../models/CourseReviewInfoResponse';
|
|
11
|
+
import type { DesiredRole } from '../models/DesiredRole';
|
|
12
|
+
import type { DesiredRoleCreateUpdateRequest } from '../models/DesiredRoleCreateUpdateRequest';
|
|
13
|
+
import type { DesiredSkill } from '../models/DesiredSkill';
|
|
14
|
+
import type { DesiredSkillCreateUpdateRequest } from '../models/DesiredSkillCreateUpdateRequest';
|
|
15
|
+
import type { Pathway } from '../models/Pathway';
|
|
16
|
+
import type { PathwayCreateUpdateRequest } from '../models/PathwayCreateUpdateRequest';
|
|
17
|
+
import type { PathwayDeleteResponse } from '../models/PathwayDeleteResponse';
|
|
18
|
+
import type { PathwayEnrollment } from '../models/PathwayEnrollment';
|
|
19
|
+
import type { PathwayEnrollmentPlus } from '../models/PathwayEnrollmentPlus';
|
|
20
|
+
import type { PathwayEnrollmentRequest } from '../models/PathwayEnrollmentRequest';
|
|
21
|
+
import type { PathwaySelfEnrollmentRequest } from '../models/PathwaySelfEnrollmentRequest';
|
|
22
|
+
import type { Program } from '../models/Program';
|
|
23
|
+
import type { ProgramCreateUpdateRequest } from '../models/ProgramCreateUpdateRequest';
|
|
24
|
+
import type { ProgramDeleteResponse } from '../models/ProgramDeleteResponse';
|
|
25
|
+
import type { ProgramEnrollment } from '../models/ProgramEnrollment';
|
|
26
|
+
import type { ProgramEnrollmentPlus } from '../models/ProgramEnrollmentPlus';
|
|
27
|
+
import type { ProgramReviewInfoResponse } from '../models/ProgramReviewInfoResponse';
|
|
28
|
+
import type { ProgramSearch } from '../models/ProgramSearch';
|
|
29
|
+
import type { ReportedRole } from '../models/ReportedRole';
|
|
30
|
+
import type { ReportedRoleCreateUpdateRequest } from '../models/ReportedRoleCreateUpdateRequest';
|
|
31
|
+
import type { ReportedSkill } from '../models/ReportedSkill';
|
|
1
32
|
import type { Resource } from '../models/Resource';
|
|
2
33
|
import type { ResourceCreateUpdate } from '../models/ResourceCreateUpdate';
|
|
34
|
+
import type { ResourceDeleteResponse } from '../models/ResourceDeleteResponse';
|
|
35
|
+
import type { Role } from '../models/Role';
|
|
36
|
+
import type { RoleCreateUpdateRequest } from '../models/RoleCreateUpdateRequest';
|
|
37
|
+
import type { Skill } from '../models/Skill';
|
|
38
|
+
import type { SkillCreateUpdateRequest } from '../models/SkillCreateUpdateRequest';
|
|
3
39
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
40
|
export declare class CatalogService {
|
|
5
41
|
/**
|
|
@@ -290,101 +326,54 @@ export declare class CatalogService {
|
|
|
290
326
|
*/
|
|
291
327
|
static catalogConditionalsCoursePrerequisitesManageBulkCreate(): CancelablePromise<any>;
|
|
292
328
|
/**
|
|
293
|
-
* Retrieve courses matching
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
* org (str, optional): Filter courses by their associated organization
|
|
299
|
-
*
|
|
300
|
-
* Returns:
|
|
301
|
-
* A list of courses matching the provided filters. If no filters are provided,
|
|
302
|
-
* all courses are returned.
|
|
303
|
-
* @returns any No response body
|
|
329
|
+
* Retrieve courses matching specified filters.
|
|
330
|
+
* @param courseId Filter courses by their unique identifier
|
|
331
|
+
* @param org Filter courses by their associated organization
|
|
332
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
333
|
+
* @returns Course
|
|
304
334
|
* @throws ApiError
|
|
305
335
|
*/
|
|
306
|
-
static
|
|
336
|
+
static catalogCoursesList(courseId?: string, org?: string, slug?: string): CancelablePromise<Array<Course>>;
|
|
307
337
|
/**
|
|
308
338
|
* Add or update a course in the database.
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
* Returns:
|
|
316
|
-
* A JSON representation of the course that was added or updated.
|
|
317
|
-
* Status code 201 if the course was newly created.
|
|
318
|
-
* Status code 200 if the course already existed and was updated.
|
|
319
|
-
*
|
|
320
|
-
* Error Responses:
|
|
321
|
-
* 400 Bad Request: If the course could not be created or updated due to invalid data
|
|
322
|
-
* @returns any No response body
|
|
339
|
+
* @param requestBody
|
|
340
|
+
* @param courseId Filter courses by their unique identifier
|
|
341
|
+
* @param org Filter courses by their associated organization
|
|
342
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
343
|
+
* @returns Course
|
|
323
344
|
* @throws ApiError
|
|
324
345
|
*/
|
|
325
|
-
static catalogCoursesCreate(): CancelablePromise<
|
|
346
|
+
static catalogCoursesCreate(requestBody: CourseCreateUpdate, courseId?: string, org?: string, slug?: string): CancelablePromise<Course>;
|
|
326
347
|
/**
|
|
327
348
|
* Remove a course from the database.
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
* Returns:
|
|
333
|
-
* A JSON object containing the count of deleted items and their type.
|
|
334
|
-
* Status code 200 upon successful deletion.
|
|
335
|
-
*
|
|
336
|
-
* Error Responses:
|
|
337
|
-
* 400 Bad Request: If the required parameters are not provided or if no course
|
|
338
|
-
* matches the given filters
|
|
339
|
-
* @returns void
|
|
349
|
+
* @param courseId Filter courses by their unique identifier
|
|
350
|
+
* @param org Filter courses by their associated organization
|
|
351
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
352
|
+
* @returns CourseDeleteResponse
|
|
340
353
|
* @throws ApiError
|
|
341
354
|
*/
|
|
342
|
-
static catalogCoursesDestroy(): CancelablePromise<
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
* Params:
|
|
352
|
-
* - user_id/username: Identifies the user whose eligible courses are to be listed.
|
|
353
|
-
* - org: (Optional) Filters courses by organization.
|
|
354
|
-
* - query: (Optional) A search term to filter the courses.
|
|
355
|
-
*
|
|
356
|
-
* Returns:
|
|
357
|
-
* - A 200 status code with a list of serialized course data if courses are found.
|
|
358
|
-
* - A 200 status code with an empty list if no eligible courses are found.
|
|
359
|
-
* - A 400 status code if the user_id or username is not provided or invalid.
|
|
360
|
-
*
|
|
361
|
-
* Side Effects:
|
|
362
|
-
* - If a username is provided instead of a user_id, the method attempts to retrieve the user_id from the username.
|
|
363
|
-
* @returns any No response body
|
|
355
|
+
static catalogCoursesDestroy(courseId?: string, org?: string, slug?: string): CancelablePromise<CourseDeleteResponse>;
|
|
356
|
+
/**
|
|
357
|
+
* List courses that a user is eligible for.
|
|
358
|
+
* @param org Filter eligible courses by organization
|
|
359
|
+
* @param query Search term to filter eligible courses
|
|
360
|
+
* @param userId User ID to check eligibility for
|
|
361
|
+
* @param username Username to check eligibility for
|
|
362
|
+
* @returns Course
|
|
364
363
|
* @throws ApiError
|
|
365
364
|
*/
|
|
366
|
-
static
|
|
367
|
-
/**
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* local_only: A flag indicating whether to check eligibility only within the local organization.
|
|
376
|
-
*
|
|
377
|
-
* Returns:
|
|
378
|
-
* - 200: If eligibility information is successfully retrieved.
|
|
379
|
-
* - 400: If required parameters are missing.
|
|
380
|
-
* - 500: If there is an error retrieving eligibility information.
|
|
381
|
-
*
|
|
382
|
-
* Side Effects:
|
|
383
|
-
* - If 'username' is provided instead of 'user_id', the method attempts to resolve the user_id from the username.
|
|
384
|
-
* @returns any No response body
|
|
365
|
+
static catalogEligibilityCoursesList(org?: string, query?: string, userId?: string, username?: string): CancelablePromise<Array<Course>>;
|
|
366
|
+
/**
|
|
367
|
+
* Check whether a user is eligible to enroll in a specific course.
|
|
368
|
+
* @param courseId Course ID to check eligibility for
|
|
369
|
+
* @param localOnly Whether to check eligibility only within the local organization
|
|
370
|
+
* @param org Organization of the course
|
|
371
|
+
* @param userId User ID to check eligibility for
|
|
372
|
+
* @param username Username to check eligibility for
|
|
373
|
+
* @returns CourseEligibilityCheckResponse
|
|
385
374
|
* @throws ApiError
|
|
386
375
|
*/
|
|
387
|
-
static catalogEligibilityCoursesCheckRetrieve(): CancelablePromise<
|
|
376
|
+
static catalogEligibilityCoursesCheckRetrieve(courseId: string, localOnly?: boolean, org?: string, userId?: string, username?: string): CancelablePromise<CourseEligibilityCheckResponse>;
|
|
388
377
|
/**
|
|
389
378
|
* API View for searching course enrollments.
|
|
390
379
|
*
|
|
@@ -445,94 +434,235 @@ export declare class CatalogService {
|
|
|
445
434
|
* - Users can view their own enrollments
|
|
446
435
|
* - Platform admins can view enrollments for users in their platform
|
|
447
436
|
* - DM admins can view all enrollments
|
|
448
|
-
* @
|
|
437
|
+
* @param courseId Filter enrollments by course ID
|
|
438
|
+
* @param courseName Filter enrollments by course name (partial match)
|
|
439
|
+
* @param email Filter enrollments by user email
|
|
440
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
441
|
+
* @param org Filter enrollments by organization
|
|
442
|
+
* @param page Page number for pagination
|
|
443
|
+
* @param pageSize Number of items per page
|
|
444
|
+
* @param platformKey Filter enrollments by platform key
|
|
445
|
+
* @param slug Filter enrollments by course slug
|
|
446
|
+
* @param sort Field to sort results by
|
|
447
|
+
* @param userId Filter enrollments by user ID
|
|
448
|
+
* @param username Filter enrollments by username
|
|
449
|
+
* @returns CourseEnrollmentSearchResponse
|
|
449
450
|
* @throws ApiError
|
|
450
451
|
*/
|
|
451
|
-
static catalogEnrollmentCoursesSearchRetrieve(): CancelablePromise<
|
|
452
|
+
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>;
|
|
452
453
|
/**
|
|
453
454
|
* Search pathway enrollments. Requires user_id or username and pathway_id or slug.
|
|
454
|
-
* @
|
|
455
|
+
* @param active Whether the enrollment should be active
|
|
456
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
457
|
+
* @param includeMetadata Include metadata in the response
|
|
458
|
+
* @param org Organization for the pathway
|
|
459
|
+
* @param pathwayId Pathway ID for enrollment
|
|
460
|
+
* @param pathwayKey Pathway key for enrollment
|
|
461
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
462
|
+
* @param platformKey Platform key for the pathway
|
|
463
|
+
* @param slug Pathway slug for enrollment
|
|
464
|
+
* @param userId User ID for enrollment
|
|
465
|
+
* @param username Username for enrollment
|
|
466
|
+
* @returns PathwayEnrollmentPlus
|
|
455
467
|
* @throws ApiError
|
|
456
468
|
*/
|
|
457
|
-
static catalogEnrollmentPathwaysRetrieve(): CancelablePromise<
|
|
469
|
+
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>;
|
|
458
470
|
/**
|
|
459
471
|
* Log user enrollment with a pathway.
|
|
460
|
-
* @
|
|
472
|
+
* @param active Whether the enrollment should be active
|
|
473
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
474
|
+
* @param includeMetadata Include metadata in the response
|
|
475
|
+
* @param org Organization for the pathway
|
|
476
|
+
* @param pathwayId Pathway ID for enrollment
|
|
477
|
+
* @param pathwayKey Pathway key for enrollment
|
|
478
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
479
|
+
* @param platformKey Platform key for the pathway
|
|
480
|
+
* @param slug Pathway slug for enrollment
|
|
481
|
+
* @param userId User ID for enrollment
|
|
482
|
+
* @param username Username for enrollment
|
|
483
|
+
* @param requestBody
|
|
484
|
+
* @returns PathwayEnrollment
|
|
461
485
|
* @throws ApiError
|
|
462
486
|
*/
|
|
463
|
-
static catalogEnrollmentPathwaysCreate(): CancelablePromise<
|
|
487
|
+
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>;
|
|
464
488
|
/**
|
|
465
489
|
* Unenroll from a pathway. Deactivates enrollment.
|
|
466
|
-
* @
|
|
490
|
+
* @param active Whether the enrollment should be active
|
|
491
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
492
|
+
* @param includeMetadata Include metadata in the response
|
|
493
|
+
* @param org Organization for the pathway
|
|
494
|
+
* @param pathwayId Pathway ID for enrollment
|
|
495
|
+
* @param pathwayKey Pathway key for enrollment
|
|
496
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
497
|
+
* @param platformKey Platform key for the pathway
|
|
498
|
+
* @param slug Pathway slug for enrollment
|
|
499
|
+
* @param userId User ID for enrollment
|
|
500
|
+
* @param username Username for enrollment
|
|
501
|
+
* @returns PathwayEnrollment
|
|
467
502
|
* @throws ApiError
|
|
468
503
|
*/
|
|
469
|
-
static catalogEnrollmentPathwaysDestroy(): CancelablePromise<
|
|
504
|
+
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>;
|
|
470
505
|
/**
|
|
471
506
|
* Search pathway enrollments based on user or pathway identifiers. Returns paginated enrollment results.
|
|
472
|
-
* @returns
|
|
507
|
+
* @returns PathwayEnrollmentPlus
|
|
473
508
|
* @throws ApiError
|
|
474
509
|
*/
|
|
475
|
-
static catalogEnrollmentPathwaysSearchRetrieve(): CancelablePromise<
|
|
510
|
+
static catalogEnrollmentPathwaysSearchRetrieve(): CancelablePromise<PathwayEnrollmentPlus>;
|
|
476
511
|
/**
|
|
477
512
|
* Log user enrollment with a pathway.
|
|
478
|
-
* @
|
|
513
|
+
* @param active Whether the enrollment should be active
|
|
514
|
+
* @param org Organization for the pathway
|
|
515
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
516
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
517
|
+
* @param platformKey Platform key for the pathway
|
|
518
|
+
* @param slug Pathway slug for self-enrollment
|
|
519
|
+
* @param userId User ID for self-enrollment
|
|
520
|
+
* @param username Username for self-enrollment
|
|
521
|
+
* @param requestBody
|
|
522
|
+
* @returns PathwayEnrollment
|
|
479
523
|
* @throws ApiError
|
|
480
524
|
*/
|
|
481
|
-
static catalogEnrollmentPathwaysSelfCreate(): CancelablePromise<
|
|
525
|
+
static catalogEnrollmentPathwaysSelfCreate(active?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, platformKey?: string, slug?: string, userId?: string, username?: string, requestBody?: PathwaySelfEnrollmentRequest): CancelablePromise<PathwayEnrollment>;
|
|
482
526
|
/**
|
|
483
527
|
* Unenroll from a pathway. Deactivates enrollment.
|
|
484
|
-
* @
|
|
528
|
+
* @param active Whether the enrollment should be active
|
|
529
|
+
* @param org Organization for the pathway
|
|
530
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
531
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
532
|
+
* @param platformKey Platform key for the pathway
|
|
533
|
+
* @param slug Pathway slug for self-enrollment
|
|
534
|
+
* @param userId User ID for self-enrollment
|
|
535
|
+
* @param username Username for self-enrollment
|
|
536
|
+
* @returns PathwayEnrollment
|
|
485
537
|
* @throws ApiError
|
|
486
538
|
*/
|
|
487
|
-
static catalogEnrollmentPathwaysSelfDestroy(): CancelablePromise<
|
|
539
|
+
static catalogEnrollmentPathwaysSelfDestroy(active?: boolean, org?: string, pathwayId?: string, pathwayKey?: string, platformKey?: string, slug?: string, userId?: string, username?: string): CancelablePromise<PathwayEnrollment>;
|
|
488
540
|
/**
|
|
489
541
|
* Search program enrollments. Requires user_id or username and program_id or slug.
|
|
490
|
-
* @
|
|
542
|
+
* @param active Whether the enrollment should be active
|
|
543
|
+
* @param expired Date when enrollment expires
|
|
544
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
545
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
546
|
+
* @param includeMetadata Include metadata in the response
|
|
547
|
+
* @param org Organization for the program
|
|
548
|
+
* @param platformKey Platform key for the program
|
|
549
|
+
* @param programId Program ID for enrollment
|
|
550
|
+
* @param programKey Program key for enrollment
|
|
551
|
+
* @param programType Program type (standard, platform, custom)
|
|
552
|
+
* @param slug Program slug for enrollment
|
|
553
|
+
* @param started Date when enrollment started
|
|
554
|
+
* @param userId User ID for enrollment
|
|
555
|
+
* @param username Username for enrollment
|
|
556
|
+
* @returns ProgramEnrollmentPlus
|
|
491
557
|
* @throws ApiError
|
|
492
558
|
*/
|
|
493
|
-
static catalogEnrollmentProgramsRetrieve(): CancelablePromise<
|
|
559
|
+
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>;
|
|
494
560
|
/**
|
|
495
561
|
* Log user enrollment with a program.
|
|
496
|
-
* @
|
|
562
|
+
* @param active Whether the enrollment should be active
|
|
563
|
+
* @param expired Date when enrollment expires
|
|
564
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
565
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
566
|
+
* @param includeMetadata Include metadata in the response
|
|
567
|
+
* @param org Organization for the program
|
|
568
|
+
* @param platformKey Platform key for the program
|
|
569
|
+
* @param programId Program ID for enrollment
|
|
570
|
+
* @param programKey Program key for enrollment
|
|
571
|
+
* @param programType Program type (standard, platform, custom)
|
|
572
|
+
* @param slug Program slug for enrollment
|
|
573
|
+
* @param started Date when enrollment started
|
|
574
|
+
* @param userId User ID for enrollment
|
|
575
|
+
* @param username Username for enrollment
|
|
576
|
+
* @param requestBody
|
|
577
|
+
* @returns ProgramEnrollment
|
|
497
578
|
* @throws ApiError
|
|
498
579
|
*/
|
|
499
|
-
static catalogEnrollmentProgramsCreate(): CancelablePromise<
|
|
580
|
+
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>;
|
|
500
581
|
/**
|
|
501
582
|
* Unenroll from a program. Deactivates enrollment.
|
|
502
|
-
* @
|
|
583
|
+
* @param active Whether the enrollment should be active
|
|
584
|
+
* @param expired Date when enrollment expires
|
|
585
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
586
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
587
|
+
* @param includeMetadata Include metadata in the response
|
|
588
|
+
* @param org Organization for the program
|
|
589
|
+
* @param platformKey Platform key for the program
|
|
590
|
+
* @param programId Program ID for enrollment
|
|
591
|
+
* @param programKey Program key for enrollment
|
|
592
|
+
* @param programType Program type (standard, platform, custom)
|
|
593
|
+
* @param slug Program slug for enrollment
|
|
594
|
+
* @param started Date when enrollment started
|
|
595
|
+
* @param userId User ID for enrollment
|
|
596
|
+
* @param username Username for enrollment
|
|
597
|
+
* @returns ProgramEnrollment
|
|
503
598
|
* @throws ApiError
|
|
504
599
|
*/
|
|
505
|
-
static catalogEnrollmentProgramsDestroy(): CancelablePromise<
|
|
600
|
+
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>;
|
|
506
601
|
/**
|
|
507
602
|
* Search program enrollments based on user or program identifiers. Returns paginated enrollment results.
|
|
508
|
-
* @
|
|
603
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
604
|
+
* @param org Filter enrollments by organization
|
|
605
|
+
* @param page Page number for pagination
|
|
606
|
+
* @param pageSize Number of items per page
|
|
607
|
+
* @param platformKey Filter enrollments by platform key
|
|
608
|
+
* @param programId Filter enrollments by program ID
|
|
609
|
+
* @param programType Filter by program type (standard, platform, custom)
|
|
610
|
+
* @param slug Filter enrollments by program slug
|
|
611
|
+
* @param sort Field to sort results by
|
|
612
|
+
* @param userId Filter enrollments by user ID
|
|
613
|
+
* @param username Filter enrollments by username
|
|
614
|
+
* @returns ProgramEnrollmentPlus
|
|
509
615
|
* @throws ApiError
|
|
510
616
|
*/
|
|
511
|
-
static catalogEnrollmentProgramsSearchRetrieve(): CancelablePromise<
|
|
617
|
+
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>;
|
|
512
618
|
/**
|
|
513
619
|
* Log user enrollment with a program.
|
|
514
|
-
* @
|
|
620
|
+
* @param active Whether the enrollment should be active
|
|
621
|
+
* @param expired Date when enrollment expires
|
|
622
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
623
|
+
* @param org Organization for the program
|
|
624
|
+
* @param platformKey Platform key for the program
|
|
625
|
+
* @param programId Program ID for self-enrollment
|
|
626
|
+
* @param programKey Program key for self-enrollment
|
|
627
|
+
* @param slug Program slug for self-enrollment
|
|
628
|
+
* @param started Date when enrollment started
|
|
629
|
+
* @param userId User ID for self-enrollment
|
|
630
|
+
* @param username Username for self-enrollment
|
|
631
|
+
* @param requestBody
|
|
632
|
+
* @returns ProgramEnrollment
|
|
515
633
|
* @throws ApiError
|
|
516
634
|
*/
|
|
517
|
-
static catalogEnrollmentProgramsSelfCreate(): CancelablePromise<
|
|
635
|
+
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>;
|
|
518
636
|
/**
|
|
519
637
|
* Unenroll from a program. Deactivates enrollment.
|
|
638
|
+
* @param active Whether the enrollment should be active
|
|
639
|
+
* @param expired Date when enrollment expires
|
|
640
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
641
|
+
* @param org Organization for the program
|
|
642
|
+
* @param platformKey Platform key for the program
|
|
643
|
+
* @param programId Program ID for self-enrollment
|
|
644
|
+
* @param programKey Program key for self-enrollment
|
|
645
|
+
* @param slug Program slug for self-enrollment
|
|
646
|
+
* @param started Date when enrollment started
|
|
647
|
+
* @param userId User ID for self-enrollment
|
|
648
|
+
* @param username Username for self-enrollment
|
|
520
649
|
* @returns void
|
|
521
650
|
* @throws ApiError
|
|
522
651
|
*/
|
|
523
|
-
static catalogEnrollmentProgramsSelfDestroy(): CancelablePromise<void>;
|
|
652
|
+
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>;
|
|
524
653
|
/**
|
|
525
654
|
* Retrieve auto increment information for a specific platform.
|
|
526
|
-
* @returns
|
|
655
|
+
* @returns CatalogAutoIncrementResponse
|
|
527
656
|
* @throws ApiError
|
|
528
657
|
*/
|
|
529
|
-
static catalogIncrementRetrieve(): CancelablePromise<
|
|
658
|
+
static catalogIncrementRetrieve(): CancelablePromise<CatalogAutoIncrementResponse>;
|
|
530
659
|
/**
|
|
531
660
|
* Update auto increment information and retrieve a new ID for a specific platform.
|
|
532
|
-
* @
|
|
661
|
+
* @param requestBody
|
|
662
|
+
* @returns any
|
|
533
663
|
* @throws ApiError
|
|
534
664
|
*/
|
|
535
|
-
static catalogIncrementCreate(): CancelablePromise<any
|
|
665
|
+
static catalogIncrementCreate(requestBody: CatalogAutoIncrementUpdateRequest): CancelablePromise<Record<string, any>>;
|
|
536
666
|
/**
|
|
537
667
|
* API View for managing course invitations.
|
|
538
668
|
*
|
|
@@ -3774,153 +3904,67 @@ export declare class CatalogService {
|
|
|
3774
3904
|
static catalogLicensesUserUpdateCreate(): CancelablePromise<any>;
|
|
3775
3905
|
/**
|
|
3776
3906
|
* Query metadata choices based on field_key, scope, and org parameters.
|
|
3907
|
+
* @param fieldKey The key of the field for which choices are being queried
|
|
3908
|
+
* @param org The organization context for the metadata choices
|
|
3909
|
+
* @param scope The scope within which to query the metadata choices (course, program, pathway, resource)
|
|
3777
3910
|
* @returns any No response body
|
|
3778
3911
|
* @throws ApiError
|
|
3779
3912
|
*/
|
|
3780
|
-
static catalogMetadataChoicesRetrieve(): CancelablePromise<any>;
|
|
3913
|
+
static catalogMetadataChoicesRetrieve(fieldKey?: string, org?: string, scope?: string): CancelablePromise<any>;
|
|
3781
3914
|
/**
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
3784
|
-
*
|
|
3785
|
-
* This method retrieves metadata for a specified course. The course_id must be provided
|
|
3786
|
-
* as a query parameter. If the course is not found, a 400 status code is returned.
|
|
3787
|
-
* If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
|
|
3788
|
-
* the metadata is returned with a 200 status code.
|
|
3789
|
-
*
|
|
3790
|
-
* Params:
|
|
3791
|
-
* course_id: The ID of the course for which metadata is being queried.
|
|
3915
|
+
* Retrieve metadata for a course.
|
|
3916
|
+
* @param courseId The course ID to get metadata for
|
|
3792
3917
|
* @returns any No response body
|
|
3793
3918
|
* @throws ApiError
|
|
3794
3919
|
*/
|
|
3795
|
-
static catalogMetadataCourseRetrieve(): CancelablePromise<any>;
|
|
3920
|
+
static catalogMetadataCourseRetrieve(courseId: string): CancelablePromise<any>;
|
|
3796
3921
|
/**
|
|
3797
|
-
*
|
|
3798
|
-
*
|
|
3799
|
-
*
|
|
3800
|
-
* This method updates the metadata for a specified course. The course_id and metadata
|
|
3801
|
-
* must be provided in the request data. An optional 'update' parameter can be provided
|
|
3802
|
-
* to specify whether to overwrite existing metadata. If the course is not found, a 400
|
|
3803
|
-
* status code is returned. If the field parameter is provided, a 404 status code is returned
|
|
3804
|
-
* as field updates are not supported. On successful update, the updated metadata is returned
|
|
3805
|
-
* with a 200 status code. If the update fails, a 400 status code is returned.
|
|
3806
|
-
*
|
|
3807
|
-
* Params:
|
|
3808
|
-
* course_id: The ID of the course for which metadata is being updated.
|
|
3809
|
-
* metadata: The new metadata to update the course with.
|
|
3810
|
-
* update (optional): A boolean indicating whether to overwrite existing metadata.
|
|
3922
|
+
* Update metadata for a course.
|
|
3923
|
+
* @param courseId The course ID to get metadata for
|
|
3924
|
+
* @param requestBody
|
|
3811
3925
|
* @returns any No response body
|
|
3812
3926
|
* @throws ApiError
|
|
3813
3927
|
*/
|
|
3814
|
-
static catalogMetadataCourseCreate(): CancelablePromise<any>;
|
|
3928
|
+
static catalogMetadataCourseCreate(courseId: string, requestBody: CourseMetadataUpdateRequest): CancelablePromise<any>;
|
|
3815
3929
|
/**
|
|
3816
|
-
*
|
|
3817
|
-
*
|
|
3818
|
-
*
|
|
3819
|
-
* This method retrieves and returns the public metadata for a specified course.
|
|
3820
|
-
* It requires a 'course_id' parameter to identify the course for which metadata is requested.
|
|
3821
|
-
*
|
|
3822
|
-
* CAUTION: Does not factor in course visibility.
|
|
3823
|
-
*
|
|
3824
|
-
* Params:
|
|
3825
|
-
* course_id: The unique identifier for the course whose metadata is being queried.
|
|
3826
|
-
*
|
|
3827
|
-
* Returns:
|
|
3828
|
-
* - 200: Successfully retrieved the course metadata.
|
|
3829
|
-
* - 400: The course ID provided does not correspond to any existing course.
|
|
3830
|
-
* - 404: Metadata retrieval failed for the specified course.
|
|
3831
|
-
*
|
|
3832
|
-
* Side Effects:
|
|
3833
|
-
* - Logs debug information if the course is not found or if metadata retrieval fails.
|
|
3930
|
+
* Retrieve public metadata for a course.
|
|
3931
|
+
* @param courseId The course ID to get metadata for
|
|
3834
3932
|
* @returns any No response body
|
|
3835
3933
|
* @throws ApiError
|
|
3836
3934
|
*/
|
|
3837
|
-
static catalogMetadataCoursePublicRetrieve(): CancelablePromise<any>;
|
|
3935
|
+
static catalogMetadataCoursePublicRetrieve(courseId: string): CancelablePromise<any>;
|
|
3838
3936
|
/**
|
|
3839
|
-
*
|
|
3840
|
-
*
|
|
3841
|
-
*
|
|
3842
|
-
* This method retrieves and returns the public metadata for a specified course.
|
|
3843
|
-
* It requires a 'course_id' parameter to identify the course for which metadata is requested.
|
|
3844
|
-
*
|
|
3845
|
-
* CAUTION: Does not factor in course visibility.
|
|
3846
|
-
*
|
|
3847
|
-
* Params:
|
|
3848
|
-
* course_id: The unique identifier for the course whose metadata is being queried.
|
|
3849
|
-
*
|
|
3850
|
-
* Returns:
|
|
3851
|
-
* - 200: Successfully retrieved the course metadata.
|
|
3852
|
-
* - 400: The course ID provided does not correspond to any existing course.
|
|
3853
|
-
* - 404: Metadata retrieval failed for the specified course.
|
|
3854
|
-
*
|
|
3855
|
-
* Side Effects:
|
|
3856
|
-
* - Logs debug information if the course is not found or if metadata retrieval fails.
|
|
3937
|
+
* Retrieve public metadata for a course.
|
|
3938
|
+
* @param courseId The course ID to get metadata for
|
|
3857
3939
|
* @param field
|
|
3858
3940
|
* @returns any No response body
|
|
3859
3941
|
* @throws ApiError
|
|
3860
3942
|
*/
|
|
3861
|
-
static catalogMetadataCoursePublicRetrieve2(field: string): CancelablePromise<any>;
|
|
3943
|
+
static catalogMetadataCoursePublicRetrieve2(courseId: string, field: string): CancelablePromise<any>;
|
|
3862
3944
|
/**
|
|
3863
|
-
*
|
|
3864
|
-
*
|
|
3865
|
-
*
|
|
3866
|
-
* Return course info for courses matching course query
|
|
3867
|
-
*
|
|
3868
|
-
* Params:
|
|
3869
|
-
* <filters>
|
|
3870
|
-
*
|
|
3871
|
-
* This method accepts a set of filters in the request body to query the course metadata.
|
|
3872
|
-
* It returns a list of courses that match the provided filters.
|
|
3873
|
-
*
|
|
3874
|
-
* Error Conditions:
|
|
3875
|
-
* - Returns a 400 status code if the search filters are empty or invalid.
|
|
3876
|
-
* - Returns a 500 status code if an unexpected error occurs during the query process.
|
|
3877
|
-
*
|
|
3878
|
-
* Side Effects:
|
|
3879
|
-
* - Logs an error if the search filters are empty.
|
|
3880
|
-
* - Logs an exception if the filters are invalid or if an unexpected error occurs.
|
|
3881
|
-
*
|
|
3882
|
-
* Special Return Codes:
|
|
3883
|
-
* - A 200 status code indicates successful retrieval of course metadata.
|
|
3884
|
-
* @returns any No response body
|
|
3945
|
+
* Search for courses matching specified metadata filters.
|
|
3946
|
+
* @param requestBody
|
|
3947
|
+
* @returns any
|
|
3885
3948
|
* @throws ApiError
|
|
3886
3949
|
*/
|
|
3887
|
-
static catalogMetadataCourseSearchCreate(): CancelablePromise<any
|
|
3950
|
+
static catalogMetadataCourseSearchCreate(requestBody?: CourseMetadataSearchRequest): CancelablePromise<Record<string, any>>;
|
|
3888
3951
|
/**
|
|
3889
|
-
*
|
|
3890
|
-
*
|
|
3891
|
-
*
|
|
3892
|
-
* This method retrieves metadata for a specified course. The course_id must be provided
|
|
3893
|
-
* as a query parameter. If the course is not found, a 400 status code is returned.
|
|
3894
|
-
* If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
|
|
3895
|
-
* the metadata is returned with a 200 status code.
|
|
3896
|
-
*
|
|
3897
|
-
* Params:
|
|
3898
|
-
* course_id: The ID of the course for which metadata is being queried.
|
|
3952
|
+
* Retrieve metadata for a course.
|
|
3953
|
+
* @param courseId The course ID to get metadata for
|
|
3899
3954
|
* @param field
|
|
3900
3955
|
* @returns any No response body
|
|
3901
3956
|
* @throws ApiError
|
|
3902
3957
|
*/
|
|
3903
|
-
static catalogMetadataCourseRetrieve2(field: string): CancelablePromise<any>;
|
|
3958
|
+
static catalogMetadataCourseRetrieve2(courseId: string, field: string): CancelablePromise<any>;
|
|
3904
3959
|
/**
|
|
3905
|
-
*
|
|
3906
|
-
*
|
|
3907
|
-
*
|
|
3908
|
-
* This method updates the metadata for a specified course. The course_id and metadata
|
|
3909
|
-
* must be provided in the request data. An optional 'update' parameter can be provided
|
|
3910
|
-
* to specify whether to overwrite existing metadata. If the course is not found, a 400
|
|
3911
|
-
* status code is returned. If the field parameter is provided, a 404 status code is returned
|
|
3912
|
-
* as field updates are not supported. On successful update, the updated metadata is returned
|
|
3913
|
-
* with a 200 status code. If the update fails, a 400 status code is returned.
|
|
3914
|
-
*
|
|
3915
|
-
* Params:
|
|
3916
|
-
* course_id: The ID of the course for which metadata is being updated.
|
|
3917
|
-
* metadata: The new metadata to update the course with.
|
|
3918
|
-
* update (optional): A boolean indicating whether to overwrite existing metadata.
|
|
3960
|
+
* Update metadata for a course.
|
|
3961
|
+
* @param courseId The course ID to get metadata for
|
|
3919
3962
|
* @param field
|
|
3963
|
+
* @param requestBody
|
|
3920
3964
|
* @returns any No response body
|
|
3921
3965
|
* @throws ApiError
|
|
3922
3966
|
*/
|
|
3923
|
-
static catalogMetadataCourseCreate2(field: string): CancelablePromise<any>;
|
|
3967
|
+
static catalogMetadataCourseCreate2(courseId: string, field: string, requestBody: CourseMetadataUpdateRequest): CancelablePromise<any>;
|
|
3924
3968
|
/**
|
|
3925
3969
|
* GET
|
|
3926
3970
|
* Query program metadata.
|
|
@@ -4405,40 +4449,42 @@ export declare class CatalogService {
|
|
|
4405
4449
|
static catalogMilestonesSkillPointsUserRetrieve(): CancelablePromise<any>;
|
|
4406
4450
|
/**
|
|
4407
4451
|
* Retrieve pathways matching query. Limited parameters.
|
|
4408
|
-
* @returns
|
|
4452
|
+
* @returns Pathway
|
|
4409
4453
|
* @throws ApiError
|
|
4410
4454
|
*/
|
|
4411
|
-
static
|
|
4455
|
+
static catalogPathwaysList(): CancelablePromise<Array<Pathway>>;
|
|
4412
4456
|
/**
|
|
4413
4457
|
* Add or update a pathway.
|
|
4414
|
-
* @
|
|
4458
|
+
* @param requestBody
|
|
4459
|
+
* @returns Pathway
|
|
4415
4460
|
* @throws ApiError
|
|
4416
4461
|
*/
|
|
4417
|
-
static catalogPathwaysCreate(): CancelablePromise<
|
|
4462
|
+
static catalogPathwaysCreate(requestBody: PathwayCreateUpdateRequest): CancelablePromise<Pathway>;
|
|
4418
4463
|
/**
|
|
4419
4464
|
* Remove a pathway from the database.
|
|
4420
|
-
* @returns
|
|
4465
|
+
* @returns PathwayDeleteResponse
|
|
4421
4466
|
* @throws ApiError
|
|
4422
4467
|
*/
|
|
4423
|
-
static catalogPathwaysDestroy(): CancelablePromise<
|
|
4468
|
+
static catalogPathwaysDestroy(): CancelablePromise<PathwayDeleteResponse>;
|
|
4424
4469
|
/**
|
|
4425
4470
|
* Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.
|
|
4426
|
-
* @returns
|
|
4471
|
+
* @returns Program
|
|
4427
4472
|
* @throws ApiError
|
|
4428
4473
|
*/
|
|
4429
|
-
static
|
|
4474
|
+
static catalogProgramsList(): CancelablePromise<Array<Program>>;
|
|
4430
4475
|
/**
|
|
4431
4476
|
* Add or update a program. Accepts a list of courses and updates or creates a program.
|
|
4432
|
-
* @
|
|
4477
|
+
* @param requestBody
|
|
4478
|
+
* @returns Program
|
|
4433
4479
|
* @throws ApiError
|
|
4434
4480
|
*/
|
|
4435
|
-
static catalogProgramsCreate(): CancelablePromise<
|
|
4481
|
+
static catalogProgramsCreate(requestBody: ProgramCreateUpdateRequest): CancelablePromise<Program>;
|
|
4436
4482
|
/**
|
|
4437
4483
|
* Remove a program from the database. Requires program_id and org as parameters.
|
|
4438
|
-
* @returns
|
|
4484
|
+
* @returns ProgramDeleteResponse
|
|
4439
4485
|
* @throws ApiError
|
|
4440
4486
|
*/
|
|
4441
|
-
static catalogProgramsDestroy(): CancelablePromise<
|
|
4487
|
+
static catalogProgramsDestroy(): CancelablePromise<ProgramDeleteResponse>;
|
|
4442
4488
|
/**
|
|
4443
4489
|
* GET
|
|
4444
4490
|
* Get a 'next' course
|
|
@@ -4459,69 +4505,63 @@ export declare class CatalogService {
|
|
|
4459
4505
|
*
|
|
4460
4506
|
* Side Effects:
|
|
4461
4507
|
* - None
|
|
4462
|
-
* @
|
|
4508
|
+
* @param courseId Current course ID
|
|
4509
|
+
* @param org Organization to filter recommendations
|
|
4510
|
+
* @param userId User ID for personalized recommendations
|
|
4511
|
+
* @returns Course
|
|
4463
4512
|
* @throws ApiError
|
|
4464
4513
|
*/
|
|
4465
|
-
static catalogRecommendationCoursesRetrieve(): CancelablePromise<
|
|
4514
|
+
static catalogRecommendationCoursesRetrieve(courseId: string, org?: string, userId?: string): CancelablePromise<Course>;
|
|
4466
4515
|
/**
|
|
4467
|
-
* GET
|
|
4468
4516
|
* Retrieve resources matching query. Limited parameters.
|
|
4469
|
-
*
|
|
4470
|
-
*
|
|
4471
|
-
*
|
|
4472
|
-
*
|
|
4473
|
-
*
|
|
4474
|
-
*
|
|
4475
|
-
*
|
|
4476
|
-
*
|
|
4477
|
-
*
|
|
4478
|
-
*
|
|
4479
|
-
*
|
|
4480
|
-
* This method retrieves resources based on the provided query parameters.
|
|
4481
|
-
* It filters the resources using the allowed parameters and returns a serialized list of resources.
|
|
4482
|
-
*
|
|
4483
|
-
* Error Conditions:
|
|
4484
|
-
* - If no resources match the query, an empty list is returned.
|
|
4485
|
-
*
|
|
4486
|
-
* Side Effects:
|
|
4487
|
-
* - None
|
|
4488
|
-
* @returns any No response body
|
|
4517
|
+
* @param id Resource ID
|
|
4518
|
+
* @param itemId Item ID associated with the resource
|
|
4519
|
+
* @param key Platform key
|
|
4520
|
+
* @param name Resource name
|
|
4521
|
+
* @param org Platform organization
|
|
4522
|
+
* @param platformKey Platform key (alternative to key)
|
|
4523
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
4524
|
+
* @param resourceType Type of resource
|
|
4525
|
+
* @param userId User ID who owns the resource
|
|
4526
|
+
* @param username Username who owns the resource
|
|
4527
|
+
* @returns Resource
|
|
4489
4528
|
* @throws ApiError
|
|
4490
4529
|
*/
|
|
4491
|
-
static
|
|
4530
|
+
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>>;
|
|
4492
4531
|
/**
|
|
4493
4532
|
* Create or update a resource with optional image upload
|
|
4494
4533
|
* Create or update a resource. For updates, include the resource ID.
|
|
4495
4534
|
* @param formData
|
|
4535
|
+
* @param id Resource ID
|
|
4536
|
+
* @param itemId Item ID associated with the resource
|
|
4537
|
+
* @param key Platform key
|
|
4538
|
+
* @param name Resource name
|
|
4539
|
+
* @param org Platform organization
|
|
4540
|
+
* @param platformKey Platform key (alternative to key)
|
|
4541
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
4542
|
+
* @param resourceType Type of resource
|
|
4543
|
+
* @param userId User ID who owns the resource
|
|
4544
|
+
* @param username Username who owns the resource
|
|
4496
4545
|
* @returns Resource
|
|
4497
4546
|
* @throws ApiError
|
|
4498
4547
|
*/
|
|
4499
|
-
static catalogResourcesCreate(formData: ResourceCreateUpdate): CancelablePromise<Resource>;
|
|
4548
|
+
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>;
|
|
4500
4549
|
/**
|
|
4501
|
-
* DELETE
|
|
4502
4550
|
* Remove a resource from the database.
|
|
4503
|
-
*
|
|
4504
|
-
*
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4507
|
-
*
|
|
4508
|
-
*
|
|
4509
|
-
*
|
|
4510
|
-
*
|
|
4511
|
-
*
|
|
4512
|
-
*
|
|
4513
|
-
*
|
|
4514
|
-
*
|
|
4515
|
-
* Error Conditions:
|
|
4516
|
-
* - If required parameters are missing, a 400 status is returned.
|
|
4517
|
-
* - If no resources match the query, the count will be zero.
|
|
4518
|
-
*
|
|
4519
|
-
* Side Effects:
|
|
4520
|
-
* - The specified resource is removed from the database.
|
|
4521
|
-
* @returns void
|
|
4551
|
+
* @param id Resource ID
|
|
4552
|
+
* @param itemId Item ID associated with the resource
|
|
4553
|
+
* @param key Platform key
|
|
4554
|
+
* @param name Resource name
|
|
4555
|
+
* @param org Platform organization
|
|
4556
|
+
* @param platformKey Platform key (alternative to key)
|
|
4557
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
4558
|
+
* @param resourceType Type of resource
|
|
4559
|
+
* @param userId User ID who owns the resource
|
|
4560
|
+
* @param username Username who owns the resource
|
|
4561
|
+
* @returns ResourceDeleteResponse
|
|
4522
4562
|
* @throws ApiError
|
|
4523
4563
|
*/
|
|
4524
|
-
static catalogResourcesDestroy(): CancelablePromise<
|
|
4564
|
+
static catalogResourcesDestroy(id?: number, itemId?: string, key?: string, name?: string, org?: string, platformKey?: string, platformOrg?: string, resourceType?: string, userId?: number, username?: string): CancelablePromise<ResourceDeleteResponse>;
|
|
4525
4565
|
/**
|
|
4526
4566
|
* API View for querying course reviews.
|
|
4527
4567
|
*
|
|
@@ -4578,14 +4618,12 @@ export declare class CatalogService {
|
|
|
4578
4618
|
*/
|
|
4579
4619
|
static catalogReviewsCourseRetrieve(): CancelablePromise<any>;
|
|
4580
4620
|
/**
|
|
4581
|
-
*
|
|
4582
|
-
*
|
|
4583
|
-
*
|
|
4584
|
-
* course_id
|
|
4585
|
-
* @returns any No response body
|
|
4621
|
+
* Retrieve aggregate review information for a course.
|
|
4622
|
+
* @param courseId The course ID to get review information for
|
|
4623
|
+
* @returns CourseReviewInfoResponse
|
|
4586
4624
|
* @throws ApiError
|
|
4587
4625
|
*/
|
|
4588
|
-
static catalogReviewsCourseInfoRetrieve(): CancelablePromise<
|
|
4626
|
+
static catalogReviewsCourseInfoRetrieve(courseId: string): CancelablePromise<CourseReviewInfoResponse>;
|
|
4589
4627
|
/**
|
|
4590
4628
|
* API View for creating, updating, and deleting course reviews.
|
|
4591
4629
|
*
|
|
@@ -4746,14 +4784,12 @@ export declare class CatalogService {
|
|
|
4746
4784
|
*/
|
|
4747
4785
|
static catalogReviewsProgramRetrieve(): CancelablePromise<any>;
|
|
4748
4786
|
/**
|
|
4749
|
-
*
|
|
4750
|
-
*
|
|
4751
|
-
*
|
|
4752
|
-
* program_key
|
|
4753
|
-
* @returns any No response body
|
|
4787
|
+
* Retrieve aggregate review information for a program.
|
|
4788
|
+
* @param programKey The program key to get review information for
|
|
4789
|
+
* @returns ProgramReviewInfoResponse
|
|
4754
4790
|
* @throws ApiError
|
|
4755
4791
|
*/
|
|
4756
|
-
static catalogReviewsProgramInfoRetrieve(): CancelablePromise<
|
|
4792
|
+
static catalogReviewsProgramInfoRetrieve(programKey: string): CancelablePromise<ProgramReviewInfoResponse>;
|
|
4757
4793
|
/**
|
|
4758
4794
|
* API View for creating, updating, and deleting program reviews.
|
|
4759
4795
|
*
|
|
@@ -4860,125 +4896,74 @@ export declare class CatalogService {
|
|
|
4860
4896
|
static catalogReviewsProgramUpdateDestroy(): CancelablePromise<void>;
|
|
4861
4897
|
/**
|
|
4862
4898
|
* Retrieve roles matching query parameters. Supports filtering by name, id, and slug.
|
|
4863
|
-
* @
|
|
4899
|
+
* @param id Role ID
|
|
4900
|
+
* @param name Role name
|
|
4901
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
4902
|
+
* @param page Page number for pagination
|
|
4903
|
+
* @param pageSize Number of items per page
|
|
4904
|
+
* @param platformKey Platform key
|
|
4905
|
+
* @param slug Role slug
|
|
4906
|
+
* @param sort Field to sort results by
|
|
4907
|
+
* @returns Role
|
|
4864
4908
|
* @throws ApiError
|
|
4865
4909
|
*/
|
|
4866
|
-
static catalogRolesRetrieve(): CancelablePromise<
|
|
4910
|
+
static catalogRolesRetrieve(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Role>;
|
|
4867
4911
|
/**
|
|
4868
4912
|
* Add a new role or update an existing role based on provided data.
|
|
4869
|
-
* @
|
|
4913
|
+
* @param requestBody
|
|
4914
|
+
* @param id Role ID
|
|
4915
|
+
* @param name Role name
|
|
4916
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
4917
|
+
* @param page Page number for pagination
|
|
4918
|
+
* @param pageSize Number of items per page
|
|
4919
|
+
* @param platformKey Platform key
|
|
4920
|
+
* @param slug Role slug
|
|
4921
|
+
* @param sort Field to sort results by
|
|
4922
|
+
* @returns Role
|
|
4870
4923
|
* @throws ApiError
|
|
4871
4924
|
*/
|
|
4872
|
-
static catalogRolesCreate(): CancelablePromise<
|
|
4925
|
+
static catalogRolesCreate(requestBody: RoleCreateUpdateRequest, id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Role>;
|
|
4873
4926
|
/**
|
|
4874
4927
|
* Retrieve desired roles for a user.
|
|
4875
|
-
*
|
|
4876
|
-
*
|
|
4877
|
-
*
|
|
4878
|
-
* If no roles are found, it returns a status of 400 indicating a bad request.
|
|
4879
|
-
*
|
|
4880
|
-
* Error Conditions:
|
|
4881
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
4882
|
-
* - If no desired roles exist for the user, a 400 status is returned.
|
|
4883
|
-
*
|
|
4884
|
-
* Side Effects:
|
|
4885
|
-
* - None
|
|
4886
|
-
* @returns any No response body
|
|
4928
|
+
* @param userId User ID
|
|
4929
|
+
* @param username Username
|
|
4930
|
+
* @returns DesiredRole
|
|
4887
4931
|
* @throws ApiError
|
|
4888
4932
|
*/
|
|
4889
|
-
static catalogRolesDesiredRetrieve(): CancelablePromise<
|
|
4933
|
+
static catalogRolesDesiredRetrieve(userId?: number, username?: string): CancelablePromise<DesiredRole>;
|
|
4890
4934
|
/**
|
|
4891
|
-
*
|
|
4892
|
-
*
|
|
4893
|
-
*
|
|
4894
|
-
*
|
|
4895
|
-
*
|
|
4896
|
-
* - skills: The skills associated with the desired role.
|
|
4897
|
-
* - data: Additional data related to the desired role.
|
|
4898
|
-
*
|
|
4899
|
-
* This method allows adding or updating a user's desired roles. It accepts user identification
|
|
4900
|
-
* and role data in the request body. If the role is successfully created, it returns the serialized
|
|
4901
|
-
* role data with a status of 201. If the role is updated, it returns the serialized role data with
|
|
4902
|
-
* a status of 200. If the operation fails, it returns a status of 400.
|
|
4903
|
-
*
|
|
4904
|
-
* Error Conditions:
|
|
4905
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
4906
|
-
* - If the role cannot be created or updated, a 400 status is returned.
|
|
4907
|
-
*
|
|
4908
|
-
* Side Effects:
|
|
4909
|
-
* - Creates or updates the desired roles for the specified user.
|
|
4910
|
-
* @returns any No response body
|
|
4935
|
+
* Add or update desired roles for a user.
|
|
4936
|
+
* @param requestBody
|
|
4937
|
+
* @param userId User ID
|
|
4938
|
+
* @param username Username
|
|
4939
|
+
* @returns DesiredRole
|
|
4911
4940
|
* @throws ApiError
|
|
4912
4941
|
*/
|
|
4913
|
-
static catalogRolesDesiredCreate(): CancelablePromise<
|
|
4942
|
+
static catalogRolesDesiredCreate(requestBody: DesiredRoleCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<DesiredRole>;
|
|
4914
4943
|
/**
|
|
4915
|
-
* Add or update a role.
|
|
4916
|
-
*
|
|
4917
|
-
*
|
|
4918
|
-
* It checks if public role creation is allowed, and if not, returns a 404 status.
|
|
4919
|
-
* If the request is made by a user token, the user is logged.
|
|
4920
|
-
*
|
|
4921
|
-
* Params:
|
|
4922
|
-
* - id: Identifier for the role.
|
|
4923
|
-
* - name: Name of the role.
|
|
4924
|
-
* - slug: A short label for the role.
|
|
4925
|
-
* - data: Additional data for the role.
|
|
4926
|
-
*
|
|
4927
|
-
* Returns:
|
|
4928
|
-
* - 201 status code if a new role is created.
|
|
4929
|
-
* - 200 status code if an existing role is updated.
|
|
4930
|
-
* - 400 status code if the role creation or update fails.
|
|
4931
|
-
* - 404 status code if public role creation is not allowed.
|
|
4932
|
-
*
|
|
4933
|
-
* Side Effects:
|
|
4934
|
-
* - Logs the user if the request is made by a user token.
|
|
4935
|
-
* @returns any No response body
|
|
4944
|
+
* Add or update a role through the public API (when enabled).
|
|
4945
|
+
* @param requestBody
|
|
4946
|
+
* @returns Role
|
|
4936
4947
|
* @throws ApiError
|
|
4937
4948
|
*/
|
|
4938
|
-
static catalogRolesPublicCreate(): CancelablePromise<
|
|
4949
|
+
static catalogRolesPublicCreate(requestBody: RoleCreateUpdateRequest): CancelablePromise<Role>;
|
|
4939
4950
|
/**
|
|
4940
|
-
*
|
|
4941
|
-
*
|
|
4942
|
-
*
|
|
4943
|
-
*
|
|
4944
|
-
* - name: The name of the role.
|
|
4945
|
-
* - id: The ID of the role.
|
|
4946
|
-
* - slug: The slug of the role.
|
|
4947
|
-
*
|
|
4948
|
-
* Returns:
|
|
4949
|
-
* - 200: If the role is found, returns the serialized role data.
|
|
4950
|
-
* - 400: If no role is found for the user.
|
|
4951
|
-
*
|
|
4952
|
-
* Error Conditions:
|
|
4953
|
-
* - If the user cannot be found using the provided user_id or username, a 400 status is returned.
|
|
4954
|
-
* @returns any No response body
|
|
4951
|
+
* Retrieve reported roles for a user.
|
|
4952
|
+
* @param userId User ID
|
|
4953
|
+
* @param username Username
|
|
4954
|
+
* @returns ReportedRole
|
|
4955
4955
|
* @throws ApiError
|
|
4956
4956
|
*/
|
|
4957
|
-
static catalogRolesReportedRetrieve(): CancelablePromise<
|
|
4957
|
+
static catalogRolesReportedRetrieve(userId?: number, username?: string): CancelablePromise<ReportedRole>;
|
|
4958
4958
|
/**
|
|
4959
|
-
*
|
|
4960
|
-
*
|
|
4961
|
-
*
|
|
4962
|
-
*
|
|
4963
|
-
*
|
|
4964
|
-
* - skills: The skills associated with the role.
|
|
4965
|
-
* - data: Additional data related to the role.
|
|
4966
|
-
*
|
|
4967
|
-
* Returns:
|
|
4968
|
-
* - 201: If a new role is created, returns the serialized role data.
|
|
4969
|
-
* - 200: If an existing role is updated, returns the serialized role data.
|
|
4970
|
-
* - 400: If the role cannot be saved or updated.
|
|
4971
|
-
*
|
|
4972
|
-
* Error Conditions:
|
|
4973
|
-
* - If the user cannot be found using the provided user_id or username, a 400 status is returned.
|
|
4974
|
-
* - If the role cannot be saved or updated, a 400 status is returned.
|
|
4975
|
-
*
|
|
4976
|
-
* Side Effects:
|
|
4977
|
-
* - Creates a new role or updates an existing role for the user.
|
|
4978
|
-
* @returns any No response body
|
|
4959
|
+
* Add or update reported roles for a user.
|
|
4960
|
+
* @param requestBody
|
|
4961
|
+
* @param userId User ID
|
|
4962
|
+
* @param username Username
|
|
4963
|
+
* @returns ReportedRole
|
|
4979
4964
|
* @throws ApiError
|
|
4980
4965
|
*/
|
|
4981
|
-
static catalogRolesReportedCreate(): CancelablePromise<
|
|
4966
|
+
static catalogRolesReportedCreate(requestBody: ReportedRoleCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<ReportedRole>;
|
|
4982
4967
|
/**
|
|
4983
4968
|
* POST
|
|
4984
4969
|
* Retrieve programs matching query.
|
|
@@ -4999,95 +4984,66 @@ export declare class CatalogService {
|
|
|
4999
4984
|
*
|
|
5000
4985
|
* Special Return Codes:
|
|
5001
4986
|
* - A 200 status code indicates successful retrieval of programs matching the query.
|
|
5002
|
-
* @
|
|
4987
|
+
* @param requestBody
|
|
4988
|
+
* @param org The organization to which the programs belong
|
|
4989
|
+
* @param query The search term used to filter programs
|
|
4990
|
+
* @returns ProgramSearch
|
|
5003
4991
|
* @throws ApiError
|
|
5004
4992
|
*/
|
|
5005
|
-
static catalogSearchProgramsCreate(): CancelablePromise<
|
|
4993
|
+
static catalogSearchProgramsCreate(requestBody: ProgramSearch, org?: string, query?: string): CancelablePromise<ProgramSearch>;
|
|
5006
4994
|
/**
|
|
5007
4995
|
* Retrieve skills matching query. Limited parameters.
|
|
5008
|
-
* @
|
|
4996
|
+
* @param id Skill ID
|
|
4997
|
+
* @param name Skill name
|
|
4998
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
4999
|
+
* @param page Page number for pagination
|
|
5000
|
+
* @param pageSize Number of items per page
|
|
5001
|
+
* @param platformKey Platform key
|
|
5002
|
+
* @param slug Skill slug
|
|
5003
|
+
* @param sort Field to sort results by
|
|
5004
|
+
* @returns Skill
|
|
5009
5005
|
* @throws ApiError
|
|
5010
5006
|
*/
|
|
5011
|
-
static catalogSkillsRetrieve(): CancelablePromise<
|
|
5007
|
+
static catalogSkillsRetrieve(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string): CancelablePromise<Skill>;
|
|
5012
5008
|
/**
|
|
5013
5009
|
* Add or update a skill.
|
|
5014
|
-
* @
|
|
5010
|
+
* @param id Skill ID
|
|
5011
|
+
* @param name Skill name
|
|
5012
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
5013
|
+
* @param page Page number for pagination
|
|
5014
|
+
* @param pageSize Number of items per page
|
|
5015
|
+
* @param platformKey Platform key
|
|
5016
|
+
* @param slug Skill slug
|
|
5017
|
+
* @param sort Field to sort results by
|
|
5018
|
+
* @param requestBody
|
|
5019
|
+
* @returns Skill
|
|
5015
5020
|
* @throws ApiError
|
|
5016
5021
|
*/
|
|
5017
|
-
static catalogSkillsCreate(): CancelablePromise<
|
|
5022
|
+
static catalogSkillsCreate(id?: number, name?: string, nameIexact?: string, page?: number, pageSize?: number, platformKey?: string, slug?: string, sort?: string, requestBody?: Skill): CancelablePromise<Skill>;
|
|
5018
5023
|
/**
|
|
5019
|
-
* GET
|
|
5020
5024
|
* Retrieve desired skills for a user.
|
|
5021
|
-
*
|
|
5022
|
-
*
|
|
5023
|
-
*
|
|
5024
|
-
*
|
|
5025
|
-
* Params:
|
|
5026
|
-
* - name: The name of the skill to retrieve.
|
|
5027
|
-
* - id: The unique identifier of the skill.
|
|
5028
|
-
* - slug: A slug representation of the skill.
|
|
5029
|
-
*
|
|
5030
|
-
* Returns:
|
|
5031
|
-
* - 200: A successful response containing the serialized desired skill data.
|
|
5032
|
-
* - 400: If the user is not found or no desired skills exist for the user.
|
|
5033
|
-
*
|
|
5034
|
-
* Error Conditions:
|
|
5035
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5036
|
-
* - If no desired skills are found for the identified user, a 400 status is returned.
|
|
5037
|
-
* @returns any No response body
|
|
5025
|
+
* @param userId User ID
|
|
5026
|
+
* @param username Username
|
|
5027
|
+
* @returns DesiredSkill
|
|
5038
5028
|
* @throws ApiError
|
|
5039
5029
|
*/
|
|
5040
|
-
static catalogSkillsDesiredRetrieve(): CancelablePromise<
|
|
5030
|
+
static catalogSkillsDesiredRetrieve(userId?: number, username?: string): CancelablePromise<DesiredSkill>;
|
|
5041
5031
|
/**
|
|
5042
|
-
*
|
|
5043
|
-
*
|
|
5044
|
-
*
|
|
5045
|
-
*
|
|
5046
|
-
*
|
|
5047
|
-
* to be added or updated.
|
|
5048
|
-
*
|
|
5049
|
-
* Params:
|
|
5050
|
-
* - user_id/username: Identifies the user for whom the skills are to be added or updated.
|
|
5051
|
-
* - skills: A list of skills to be added or updated.
|
|
5052
|
-
* - data: Additional data related to the skills.
|
|
5053
|
-
*
|
|
5054
|
-
* Returns:
|
|
5055
|
-
* - 201: If a new skill is successfully created.
|
|
5056
|
-
* - 200: If an existing skill is successfully updated.
|
|
5057
|
-
* - 400: If the user cannot be identified or the skill cannot be saved.
|
|
5058
|
-
*
|
|
5059
|
-
* Error Conditions:
|
|
5060
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5061
|
-
* - If the skill cannot be saved due to any reason, a 400 status is returned.
|
|
5062
|
-
*
|
|
5063
|
-
* Side Effects:
|
|
5064
|
-
* - This method may create a new skill entry or update an existing one in the database.
|
|
5065
|
-
* @returns any No response body
|
|
5032
|
+
* Add or update desired skills for a user.
|
|
5033
|
+
* @param requestBody
|
|
5034
|
+
* @param userId User ID
|
|
5035
|
+
* @param username Username
|
|
5036
|
+
* @returns DesiredSkill
|
|
5066
5037
|
* @throws ApiError
|
|
5067
5038
|
*/
|
|
5068
|
-
static catalogSkillsDesiredCreate(): CancelablePromise<
|
|
5039
|
+
static catalogSkillsDesiredCreate(requestBody: DesiredSkillCreateUpdateRequest, userId?: number, username?: string): CancelablePromise<DesiredSkill>;
|
|
5069
5040
|
/**
|
|
5070
|
-
* POST
|
|
5071
5041
|
* Add or update a skill.
|
|
5072
|
-
*
|
|
5073
|
-
*
|
|
5074
|
-
* - id: The unique identifier for the skill.
|
|
5075
|
-
* - name: The name of the skill.
|
|
5076
|
-
* - slug: A URL-friendly version of the skill name.
|
|
5077
|
-
* - data: Additional data related to the skill.
|
|
5078
|
-
*
|
|
5079
|
-
* If the `ALLOW_PUBLIC_SKILL_CREATE` setting is disabled, the method will return a 404 status code, indicating that the creation of new skills is not allowed.
|
|
5080
|
-
*
|
|
5081
|
-
* If the request is made by a user with a valid token, the user will be logged.
|
|
5082
|
-
*
|
|
5083
|
-
* Returns:
|
|
5084
|
-
* - 201 status code if a new skill is created successfully.
|
|
5085
|
-
* - 200 status code if an existing skill is updated successfully.
|
|
5086
|
-
* - 400 status code if the skill creation or update fails.
|
|
5087
|
-
* @returns any No response body
|
|
5042
|
+
* @param requestBody
|
|
5043
|
+
* @returns Skill
|
|
5088
5044
|
* @throws ApiError
|
|
5089
5045
|
*/
|
|
5090
|
-
static catalogSkillsPublicCreate(): CancelablePromise<
|
|
5046
|
+
static catalogSkillsPublicCreate(requestBody: SkillCreateUpdateRequest): CancelablePromise<Skill>;
|
|
5091
5047
|
/**
|
|
5092
5048
|
* GET
|
|
5093
5049
|
* Retrieve desired skills for user
|
|
@@ -5105,10 +5061,12 @@ export declare class CatalogService {
|
|
|
5105
5061
|
* Error Conditions:
|
|
5106
5062
|
* - If the user cannot be identified, a 400 status code is returned.
|
|
5107
5063
|
* - If no reported skills exist for the user, a 400 status code is returned.
|
|
5108
|
-
* @
|
|
5064
|
+
* @param userId User ID
|
|
5065
|
+
* @param username Username
|
|
5066
|
+
* @returns ReportedSkill
|
|
5109
5067
|
* @throws ApiError
|
|
5110
5068
|
*/
|
|
5111
|
-
static catalogSkillsReportedRetrieve(): CancelablePromise<
|
|
5069
|
+
static catalogSkillsReportedRetrieve(userId?: number, username?: string): CancelablePromise<ReportedSkill>;
|
|
5112
5070
|
/**
|
|
5113
5071
|
* POST
|
|
5114
5072
|
* Add or update a skill.
|
|
@@ -5132,10 +5090,13 @@ export declare class CatalogService {
|
|
|
5132
5090
|
* Side Effects:
|
|
5133
5091
|
* - If a new skill is created, it will be persisted in the database.
|
|
5134
5092
|
* - If an existing skill is updated, the changes will be saved in the database.
|
|
5135
|
-
* @
|
|
5093
|
+
* @param requestBody
|
|
5094
|
+
* @param userId User ID
|
|
5095
|
+
* @param username Username
|
|
5096
|
+
* @returns ReportedSkill
|
|
5136
5097
|
* @throws ApiError
|
|
5137
5098
|
*/
|
|
5138
|
-
static catalogSkillsReportedCreate(): CancelablePromise<
|
|
5099
|
+
static catalogSkillsReportedCreate(requestBody: ReportedSkill, userId?: number, username?: string): CancelablePromise<ReportedSkill>;
|
|
5139
5100
|
/**
|
|
5140
5101
|
* API View for managing course suggestions.
|
|
5141
5102
|
*
|