@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
|
@@ -2,8 +2,44 @@
|
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
|
+
import type { CatalogAutoIncrementResponse } from '../models/CatalogAutoIncrementResponse';
|
|
6
|
+
import type { CatalogAutoIncrementUpdateRequest } from '../models/CatalogAutoIncrementUpdateRequest';
|
|
7
|
+
import type { Course } from '../models/Course';
|
|
8
|
+
import type { CourseCreateUpdate } from '../models/CourseCreateUpdate';
|
|
9
|
+
import type { CourseDeleteResponse } from '../models/CourseDeleteResponse';
|
|
10
|
+
import type { CourseEligibilityCheckResponse } from '../models/CourseEligibilityCheckResponse';
|
|
11
|
+
import type { CourseEnrollmentSearchResponse } from '../models/CourseEnrollmentSearchResponse';
|
|
12
|
+
import type { CourseMetadataSearchRequest } from '../models/CourseMetadataSearchRequest';
|
|
13
|
+
import type { CourseMetadataUpdateRequest } from '../models/CourseMetadataUpdateRequest';
|
|
14
|
+
import type { CourseReviewInfoResponse } from '../models/CourseReviewInfoResponse';
|
|
15
|
+
import type { DesiredRole } from '../models/DesiredRole';
|
|
16
|
+
import type { DesiredRoleCreateUpdateRequest } from '../models/DesiredRoleCreateUpdateRequest';
|
|
17
|
+
import type { DesiredSkill } from '../models/DesiredSkill';
|
|
18
|
+
import type { DesiredSkillCreateUpdateRequest } from '../models/DesiredSkillCreateUpdateRequest';
|
|
19
|
+
import type { Pathway } from '../models/Pathway';
|
|
20
|
+
import type { PathwayCreateUpdateRequest } from '../models/PathwayCreateUpdateRequest';
|
|
21
|
+
import type { PathwayDeleteResponse } from '../models/PathwayDeleteResponse';
|
|
22
|
+
import type { PathwayEnrollment } from '../models/PathwayEnrollment';
|
|
23
|
+
import type { PathwayEnrollmentPlus } from '../models/PathwayEnrollmentPlus';
|
|
24
|
+
import type { PathwayEnrollmentRequest } from '../models/PathwayEnrollmentRequest';
|
|
25
|
+
import type { PathwaySelfEnrollmentRequest } from '../models/PathwaySelfEnrollmentRequest';
|
|
26
|
+
import type { Program } from '../models/Program';
|
|
27
|
+
import type { ProgramCreateUpdateRequest } from '../models/ProgramCreateUpdateRequest';
|
|
28
|
+
import type { ProgramDeleteResponse } from '../models/ProgramDeleteResponse';
|
|
29
|
+
import type { ProgramEnrollment } from '../models/ProgramEnrollment';
|
|
30
|
+
import type { ProgramEnrollmentPlus } from '../models/ProgramEnrollmentPlus';
|
|
31
|
+
import type { ProgramReviewInfoResponse } from '../models/ProgramReviewInfoResponse';
|
|
32
|
+
import type { ProgramSearch } from '../models/ProgramSearch';
|
|
33
|
+
import type { ReportedRole } from '../models/ReportedRole';
|
|
34
|
+
import type { ReportedRoleCreateUpdateRequest } from '../models/ReportedRoleCreateUpdateRequest';
|
|
35
|
+
import type { ReportedSkill } from '../models/ReportedSkill';
|
|
5
36
|
import type { Resource } from '../models/Resource';
|
|
6
37
|
import type { ResourceCreateUpdate } from '../models/ResourceCreateUpdate';
|
|
38
|
+
import type { ResourceDeleteResponse } from '../models/ResourceDeleteResponse';
|
|
39
|
+
import type { Role } from '../models/Role';
|
|
40
|
+
import type { RoleCreateUpdateRequest } from '../models/RoleCreateUpdateRequest';
|
|
41
|
+
import type { Skill } from '../models/Skill';
|
|
42
|
+
import type { SkillCreateUpdateRequest } from '../models/SkillCreateUpdateRequest';
|
|
7
43
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
44
|
import { OpenAPI } from '../core/OpenAPI';
|
|
9
45
|
import { request as __request } from '../core/request';
|
|
@@ -331,124 +367,147 @@ export class CatalogService {
|
|
|
331
367
|
});
|
|
332
368
|
}
|
|
333
369
|
/**
|
|
334
|
-
* Retrieve courses matching
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
* org (str, optional): Filter courses by their associated organization
|
|
340
|
-
*
|
|
341
|
-
* Returns:
|
|
342
|
-
* A list of courses matching the provided filters. If no filters are provided,
|
|
343
|
-
* all courses are returned.
|
|
344
|
-
* @returns any No response body
|
|
370
|
+
* Retrieve courses matching specified filters.
|
|
371
|
+
* @param courseId Filter courses by their unique identifier
|
|
372
|
+
* @param org Filter courses by their associated organization
|
|
373
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
374
|
+
* @returns Course
|
|
345
375
|
* @throws ApiError
|
|
346
376
|
*/
|
|
347
|
-
public static
|
|
377
|
+
public static catalogCoursesList(
|
|
378
|
+
courseId?: string,
|
|
379
|
+
org?: string,
|
|
380
|
+
slug?: string,
|
|
381
|
+
): CancelablePromise<Array<Course>> {
|
|
348
382
|
return __request(OpenAPI, {
|
|
349
383
|
method: 'GET',
|
|
350
384
|
url: '/api/catalog/courses/',
|
|
385
|
+
query: {
|
|
386
|
+
'course_id': courseId,
|
|
387
|
+
'org': org,
|
|
388
|
+
'slug': slug,
|
|
389
|
+
},
|
|
390
|
+
errors: {
|
|
391
|
+
400: `No response body`,
|
|
392
|
+
},
|
|
351
393
|
});
|
|
352
394
|
}
|
|
353
395
|
/**
|
|
354
396
|
* Add or update a course in the database.
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
* Returns:
|
|
362
|
-
* A JSON representation of the course that was added or updated.
|
|
363
|
-
* Status code 201 if the course was newly created.
|
|
364
|
-
* Status code 200 if the course already existed and was updated.
|
|
365
|
-
*
|
|
366
|
-
* Error Responses:
|
|
367
|
-
* 400 Bad Request: If the course could not be created or updated due to invalid data
|
|
368
|
-
* @returns any No response body
|
|
397
|
+
* @param requestBody
|
|
398
|
+
* @param courseId Filter courses by their unique identifier
|
|
399
|
+
* @param org Filter courses by their associated organization
|
|
400
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
401
|
+
* @returns Course
|
|
369
402
|
* @throws ApiError
|
|
370
403
|
*/
|
|
371
|
-
public static catalogCoursesCreate(
|
|
404
|
+
public static catalogCoursesCreate(
|
|
405
|
+
requestBody: CourseCreateUpdate,
|
|
406
|
+
courseId?: string,
|
|
407
|
+
org?: string,
|
|
408
|
+
slug?: string,
|
|
409
|
+
): CancelablePromise<Course> {
|
|
372
410
|
return __request(OpenAPI, {
|
|
373
411
|
method: 'POST',
|
|
374
412
|
url: '/api/catalog/courses/',
|
|
413
|
+
query: {
|
|
414
|
+
'course_id': courseId,
|
|
415
|
+
'org': org,
|
|
416
|
+
'slug': slug,
|
|
417
|
+
},
|
|
418
|
+
body: requestBody,
|
|
419
|
+
mediaType: 'application/json',
|
|
420
|
+
errors: {
|
|
421
|
+
400: `No response body`,
|
|
422
|
+
},
|
|
375
423
|
});
|
|
376
424
|
}
|
|
377
425
|
/**
|
|
378
426
|
* Remove a course from the database.
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
* Returns:
|
|
384
|
-
* A JSON object containing the count of deleted items and their type.
|
|
385
|
-
* Status code 200 upon successful deletion.
|
|
386
|
-
*
|
|
387
|
-
* Error Responses:
|
|
388
|
-
* 400 Bad Request: If the required parameters are not provided or if no course
|
|
389
|
-
* matches the given filters
|
|
390
|
-
* @returns void
|
|
427
|
+
* @param courseId Filter courses by their unique identifier
|
|
428
|
+
* @param org Filter courses by their associated organization
|
|
429
|
+
* @param slug Filter courses by their slug (case-insensitive)
|
|
430
|
+
* @returns CourseDeleteResponse
|
|
391
431
|
* @throws ApiError
|
|
392
432
|
*/
|
|
393
|
-
public static catalogCoursesDestroy(
|
|
433
|
+
public static catalogCoursesDestroy(
|
|
434
|
+
courseId?: string,
|
|
435
|
+
org?: string,
|
|
436
|
+
slug?: string,
|
|
437
|
+
): CancelablePromise<CourseDeleteResponse> {
|
|
394
438
|
return __request(OpenAPI, {
|
|
395
439
|
method: 'DELETE',
|
|
396
440
|
url: '/api/catalog/courses/',
|
|
441
|
+
query: {
|
|
442
|
+
'course_id': courseId,
|
|
443
|
+
'org': org,
|
|
444
|
+
'slug': slug,
|
|
445
|
+
},
|
|
446
|
+
errors: {
|
|
447
|
+
400: `No response body`,
|
|
448
|
+
},
|
|
397
449
|
});
|
|
398
450
|
}
|
|
399
451
|
/**
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* Params:
|
|
408
|
-
* - user_id/username: Identifies the user whose eligible courses are to be listed.
|
|
409
|
-
* - org: (Optional) Filters courses by organization.
|
|
410
|
-
* - query: (Optional) A search term to filter the courses.
|
|
411
|
-
*
|
|
412
|
-
* Returns:
|
|
413
|
-
* - A 200 status code with a list of serialized course data if courses are found.
|
|
414
|
-
* - A 200 status code with an empty list if no eligible courses are found.
|
|
415
|
-
* - A 400 status code if the user_id or username is not provided or invalid.
|
|
416
|
-
*
|
|
417
|
-
* Side Effects:
|
|
418
|
-
* - If a username is provided instead of a user_id, the method attempts to retrieve the user_id from the username.
|
|
419
|
-
* @returns any No response body
|
|
452
|
+
* List courses that a user is eligible for.
|
|
453
|
+
* @param org Filter eligible courses by organization
|
|
454
|
+
* @param query Search term to filter eligible courses
|
|
455
|
+
* @param userId User ID to check eligibility for
|
|
456
|
+
* @param username Username to check eligibility for
|
|
457
|
+
* @returns Course
|
|
420
458
|
* @throws ApiError
|
|
421
459
|
*/
|
|
422
|
-
public static
|
|
460
|
+
public static catalogEligibilityCoursesList(
|
|
461
|
+
org?: string,
|
|
462
|
+
query?: string,
|
|
463
|
+
userId?: string,
|
|
464
|
+
username?: string,
|
|
465
|
+
): CancelablePromise<Array<Course>> {
|
|
423
466
|
return __request(OpenAPI, {
|
|
424
467
|
method: 'GET',
|
|
425
468
|
url: '/api/catalog/eligibility/courses/',
|
|
469
|
+
query: {
|
|
470
|
+
'org': org,
|
|
471
|
+
'query': query,
|
|
472
|
+
'user_id': userId,
|
|
473
|
+
'username': username,
|
|
474
|
+
},
|
|
475
|
+
errors: {
|
|
476
|
+
400: `No response body`,
|
|
477
|
+
},
|
|
426
478
|
});
|
|
427
479
|
}
|
|
428
480
|
/**
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
* local_only: A flag indicating whether to check eligibility only within the local organization.
|
|
437
|
-
*
|
|
438
|
-
* Returns:
|
|
439
|
-
* - 200: If eligibility information is successfully retrieved.
|
|
440
|
-
* - 400: If required parameters are missing.
|
|
441
|
-
* - 500: If there is an error retrieving eligibility information.
|
|
442
|
-
*
|
|
443
|
-
* Side Effects:
|
|
444
|
-
* - If 'username' is provided instead of 'user_id', the method attempts to resolve the user_id from the username.
|
|
445
|
-
* @returns any No response body
|
|
481
|
+
* Check whether a user is eligible to enroll in a specific course.
|
|
482
|
+
* @param courseId Course ID to check eligibility for
|
|
483
|
+
* @param localOnly Whether to check eligibility only within the local organization
|
|
484
|
+
* @param org Organization of the course
|
|
485
|
+
* @param userId User ID to check eligibility for
|
|
486
|
+
* @param username Username to check eligibility for
|
|
487
|
+
* @returns CourseEligibilityCheckResponse
|
|
446
488
|
* @throws ApiError
|
|
447
489
|
*/
|
|
448
|
-
public static catalogEligibilityCoursesCheckRetrieve(
|
|
490
|
+
public static catalogEligibilityCoursesCheckRetrieve(
|
|
491
|
+
courseId: string,
|
|
492
|
+
localOnly?: boolean,
|
|
493
|
+
org?: string,
|
|
494
|
+
userId?: string,
|
|
495
|
+
username?: string,
|
|
496
|
+
): CancelablePromise<CourseEligibilityCheckResponse> {
|
|
449
497
|
return __request(OpenAPI, {
|
|
450
498
|
method: 'GET',
|
|
451
499
|
url: '/api/catalog/eligibility/courses/check/',
|
|
500
|
+
query: {
|
|
501
|
+
'course_id': courseId,
|
|
502
|
+
'local_only': localOnly,
|
|
503
|
+
'org': org,
|
|
504
|
+
'user_id': userId,
|
|
505
|
+
'username': username,
|
|
506
|
+
},
|
|
507
|
+
errors: {
|
|
508
|
+
400: `No response body`,
|
|
509
|
+
500: `No response body`,
|
|
510
|
+
},
|
|
452
511
|
});
|
|
453
512
|
}
|
|
454
513
|
/**
|
|
@@ -511,54 +570,205 @@ export class CatalogService {
|
|
|
511
570
|
* - Users can view their own enrollments
|
|
512
571
|
* - Platform admins can view enrollments for users in their platform
|
|
513
572
|
* - DM admins can view all enrollments
|
|
514
|
-
* @
|
|
573
|
+
* @param courseId Filter enrollments by course ID
|
|
574
|
+
* @param courseName Filter enrollments by course name (partial match)
|
|
575
|
+
* @param email Filter enrollments by user email
|
|
576
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
577
|
+
* @param org Filter enrollments by organization
|
|
578
|
+
* @param page Page number for pagination
|
|
579
|
+
* @param pageSize Number of items per page
|
|
580
|
+
* @param platformKey Filter enrollments by platform key
|
|
581
|
+
* @param slug Filter enrollments by course slug
|
|
582
|
+
* @param sort Field to sort results by
|
|
583
|
+
* @param userId Filter enrollments by user ID
|
|
584
|
+
* @param username Filter enrollments by username
|
|
585
|
+
* @returns CourseEnrollmentSearchResponse
|
|
515
586
|
* @throws ApiError
|
|
516
587
|
*/
|
|
517
|
-
public static catalogEnrollmentCoursesSearchRetrieve(
|
|
588
|
+
public static catalogEnrollmentCoursesSearchRetrieve(
|
|
589
|
+
courseId?: string,
|
|
590
|
+
courseName?: string,
|
|
591
|
+
email?: string,
|
|
592
|
+
includeDefaultPlatform?: boolean,
|
|
593
|
+
org?: string,
|
|
594
|
+
page?: number,
|
|
595
|
+
pageSize?: number,
|
|
596
|
+
platformKey?: string,
|
|
597
|
+
slug?: string,
|
|
598
|
+
sort: string = '-id',
|
|
599
|
+
userId?: string,
|
|
600
|
+
username?: string,
|
|
601
|
+
): CancelablePromise<CourseEnrollmentSearchResponse> {
|
|
518
602
|
return __request(OpenAPI, {
|
|
519
603
|
method: 'GET',
|
|
520
604
|
url: '/api/catalog/enrollment/courses/search/',
|
|
605
|
+
query: {
|
|
606
|
+
'course_id': courseId,
|
|
607
|
+
'course_name': courseName,
|
|
608
|
+
'email': email,
|
|
609
|
+
'include_default_platform': includeDefaultPlatform,
|
|
610
|
+
'org': org,
|
|
611
|
+
'page': page,
|
|
612
|
+
'page_size': pageSize,
|
|
613
|
+
'platform_key': platformKey,
|
|
614
|
+
'slug': slug,
|
|
615
|
+
'sort': sort,
|
|
616
|
+
'user_id': userId,
|
|
617
|
+
'username': username,
|
|
618
|
+
},
|
|
521
619
|
});
|
|
522
620
|
}
|
|
523
621
|
/**
|
|
524
622
|
* Search pathway enrollments. Requires user_id or username and pathway_id or slug.
|
|
525
|
-
* @
|
|
623
|
+
* @param active Whether the enrollment should be active
|
|
624
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
625
|
+
* @param includeMetadata Include metadata in the response
|
|
626
|
+
* @param org Organization for the pathway
|
|
627
|
+
* @param pathwayId Pathway ID for enrollment
|
|
628
|
+
* @param pathwayKey Pathway key for enrollment
|
|
629
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
630
|
+
* @param platformKey Platform key for the pathway
|
|
631
|
+
* @param slug Pathway slug for enrollment
|
|
632
|
+
* @param userId User ID for enrollment
|
|
633
|
+
* @param username Username for enrollment
|
|
634
|
+
* @returns PathwayEnrollmentPlus
|
|
526
635
|
* @throws ApiError
|
|
527
636
|
*/
|
|
528
|
-
public static catalogEnrollmentPathwaysRetrieve(
|
|
637
|
+
public static catalogEnrollmentPathwaysRetrieve(
|
|
638
|
+
active: boolean = true,
|
|
639
|
+
includeDefaultPlatform?: boolean,
|
|
640
|
+
includeMetadata: boolean = true,
|
|
641
|
+
org?: string,
|
|
642
|
+
pathwayId?: string,
|
|
643
|
+
pathwayKey?: string,
|
|
644
|
+
pathwayUuid?: string,
|
|
645
|
+
platformKey?: string,
|
|
646
|
+
slug?: string,
|
|
647
|
+
userId?: string,
|
|
648
|
+
username?: string,
|
|
649
|
+
): CancelablePromise<PathwayEnrollmentPlus> {
|
|
529
650
|
return __request(OpenAPI, {
|
|
530
651
|
method: 'GET',
|
|
531
652
|
url: '/api/catalog/enrollment/pathways/',
|
|
653
|
+
query: {
|
|
654
|
+
'active': active,
|
|
655
|
+
'include_default_platform': includeDefaultPlatform,
|
|
656
|
+
'include_metadata': includeMetadata,
|
|
657
|
+
'org': org,
|
|
658
|
+
'pathway_id': pathwayId,
|
|
659
|
+
'pathway_key': pathwayKey,
|
|
660
|
+
'pathway_uuid': pathwayUuid,
|
|
661
|
+
'platform_key': platformKey,
|
|
662
|
+
'slug': slug,
|
|
663
|
+
'user_id': userId,
|
|
664
|
+
'username': username,
|
|
665
|
+
},
|
|
532
666
|
});
|
|
533
667
|
}
|
|
534
668
|
/**
|
|
535
669
|
* Log user enrollment with a pathway.
|
|
536
|
-
* @
|
|
670
|
+
* @param active Whether the enrollment should be active
|
|
671
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
672
|
+
* @param includeMetadata Include metadata in the response
|
|
673
|
+
* @param org Organization for the pathway
|
|
674
|
+
* @param pathwayId Pathway ID for enrollment
|
|
675
|
+
* @param pathwayKey Pathway key for enrollment
|
|
676
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
677
|
+
* @param platformKey Platform key for the pathway
|
|
678
|
+
* @param slug Pathway slug for enrollment
|
|
679
|
+
* @param userId User ID for enrollment
|
|
680
|
+
* @param username Username for enrollment
|
|
681
|
+
* @param requestBody
|
|
682
|
+
* @returns PathwayEnrollment
|
|
537
683
|
* @throws ApiError
|
|
538
684
|
*/
|
|
539
|
-
public static catalogEnrollmentPathwaysCreate(
|
|
685
|
+
public static catalogEnrollmentPathwaysCreate(
|
|
686
|
+
active: boolean = true,
|
|
687
|
+
includeDefaultPlatform?: boolean,
|
|
688
|
+
includeMetadata: boolean = true,
|
|
689
|
+
org?: string,
|
|
690
|
+
pathwayId?: string,
|
|
691
|
+
pathwayKey?: string,
|
|
692
|
+
pathwayUuid?: string,
|
|
693
|
+
platformKey?: string,
|
|
694
|
+
slug?: string,
|
|
695
|
+
userId?: string,
|
|
696
|
+
username?: string,
|
|
697
|
+
requestBody?: PathwayEnrollmentRequest,
|
|
698
|
+
): CancelablePromise<PathwayEnrollment> {
|
|
540
699
|
return __request(OpenAPI, {
|
|
541
700
|
method: 'POST',
|
|
542
701
|
url: '/api/catalog/enrollment/pathways/',
|
|
702
|
+
query: {
|
|
703
|
+
'active': active,
|
|
704
|
+
'include_default_platform': includeDefaultPlatform,
|
|
705
|
+
'include_metadata': includeMetadata,
|
|
706
|
+
'org': org,
|
|
707
|
+
'pathway_id': pathwayId,
|
|
708
|
+
'pathway_key': pathwayKey,
|
|
709
|
+
'pathway_uuid': pathwayUuid,
|
|
710
|
+
'platform_key': platformKey,
|
|
711
|
+
'slug': slug,
|
|
712
|
+
'user_id': userId,
|
|
713
|
+
'username': username,
|
|
714
|
+
},
|
|
715
|
+
body: requestBody,
|
|
716
|
+
mediaType: 'application/json',
|
|
543
717
|
});
|
|
544
718
|
}
|
|
545
719
|
/**
|
|
546
720
|
* Unenroll from a pathway. Deactivates enrollment.
|
|
547
|
-
* @
|
|
721
|
+
* @param active Whether the enrollment should be active
|
|
722
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
723
|
+
* @param includeMetadata Include metadata in the response
|
|
724
|
+
* @param org Organization for the pathway
|
|
725
|
+
* @param pathwayId Pathway ID for enrollment
|
|
726
|
+
* @param pathwayKey Pathway key for enrollment
|
|
727
|
+
* @param pathwayUuid Pathway UUID for enrollment
|
|
728
|
+
* @param platformKey Platform key for the pathway
|
|
729
|
+
* @param slug Pathway slug for enrollment
|
|
730
|
+
* @param userId User ID for enrollment
|
|
731
|
+
* @param username Username for enrollment
|
|
732
|
+
* @returns PathwayEnrollment
|
|
548
733
|
* @throws ApiError
|
|
549
734
|
*/
|
|
550
|
-
public static catalogEnrollmentPathwaysDestroy(
|
|
735
|
+
public static catalogEnrollmentPathwaysDestroy(
|
|
736
|
+
active: boolean = true,
|
|
737
|
+
includeDefaultPlatform?: boolean,
|
|
738
|
+
includeMetadata: boolean = true,
|
|
739
|
+
org?: string,
|
|
740
|
+
pathwayId?: string,
|
|
741
|
+
pathwayKey?: string,
|
|
742
|
+
pathwayUuid?: string,
|
|
743
|
+
platformKey?: string,
|
|
744
|
+
slug?: string,
|
|
745
|
+
userId?: string,
|
|
746
|
+
username?: string,
|
|
747
|
+
): CancelablePromise<PathwayEnrollment> {
|
|
551
748
|
return __request(OpenAPI, {
|
|
552
749
|
method: 'DELETE',
|
|
553
750
|
url: '/api/catalog/enrollment/pathways/',
|
|
751
|
+
query: {
|
|
752
|
+
'active': active,
|
|
753
|
+
'include_default_platform': includeDefaultPlatform,
|
|
754
|
+
'include_metadata': includeMetadata,
|
|
755
|
+
'org': org,
|
|
756
|
+
'pathway_id': pathwayId,
|
|
757
|
+
'pathway_key': pathwayKey,
|
|
758
|
+
'pathway_uuid': pathwayUuid,
|
|
759
|
+
'platform_key': platformKey,
|
|
760
|
+
'slug': slug,
|
|
761
|
+
'user_id': userId,
|
|
762
|
+
'username': username,
|
|
763
|
+
},
|
|
554
764
|
});
|
|
555
765
|
}
|
|
556
766
|
/**
|
|
557
767
|
* Search pathway enrollments based on user or pathway identifiers. Returns paginated enrollment results.
|
|
558
|
-
* @returns
|
|
768
|
+
* @returns PathwayEnrollmentPlus
|
|
559
769
|
* @throws ApiError
|
|
560
770
|
*/
|
|
561
|
-
public static catalogEnrollmentPathwaysSearchRetrieve(): CancelablePromise<
|
|
771
|
+
public static catalogEnrollmentPathwaysSearchRetrieve(): CancelablePromise<PathwayEnrollmentPlus> {
|
|
562
772
|
return __request(OpenAPI, {
|
|
563
773
|
method: 'GET',
|
|
564
774
|
url: '/api/catalog/enrollment/pathways/search/',
|
|
@@ -566,112 +776,433 @@ export class CatalogService {
|
|
|
566
776
|
}
|
|
567
777
|
/**
|
|
568
778
|
* Log user enrollment with a pathway.
|
|
569
|
-
* @
|
|
779
|
+
* @param active Whether the enrollment should be active
|
|
780
|
+
* @param org Organization for the pathway
|
|
781
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
782
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
783
|
+
* @param platformKey Platform key for the pathway
|
|
784
|
+
* @param slug Pathway slug for self-enrollment
|
|
785
|
+
* @param userId User ID for self-enrollment
|
|
786
|
+
* @param username Username for self-enrollment
|
|
787
|
+
* @param requestBody
|
|
788
|
+
* @returns PathwayEnrollment
|
|
570
789
|
* @throws ApiError
|
|
571
790
|
*/
|
|
572
|
-
public static catalogEnrollmentPathwaysSelfCreate(
|
|
791
|
+
public static catalogEnrollmentPathwaysSelfCreate(
|
|
792
|
+
active: boolean = true,
|
|
793
|
+
org?: string,
|
|
794
|
+
pathwayId?: string,
|
|
795
|
+
pathwayKey?: string,
|
|
796
|
+
platformKey?: string,
|
|
797
|
+
slug?: string,
|
|
798
|
+
userId?: string,
|
|
799
|
+
username?: string,
|
|
800
|
+
requestBody?: PathwaySelfEnrollmentRequest,
|
|
801
|
+
): CancelablePromise<PathwayEnrollment> {
|
|
573
802
|
return __request(OpenAPI, {
|
|
574
803
|
method: 'POST',
|
|
575
804
|
url: '/api/catalog/enrollment/pathways/self/',
|
|
805
|
+
query: {
|
|
806
|
+
'active': active,
|
|
807
|
+
'org': org,
|
|
808
|
+
'pathway_id': pathwayId,
|
|
809
|
+
'pathway_key': pathwayKey,
|
|
810
|
+
'platform_key': platformKey,
|
|
811
|
+
'slug': slug,
|
|
812
|
+
'user_id': userId,
|
|
813
|
+
'username': username,
|
|
814
|
+
},
|
|
815
|
+
body: requestBody,
|
|
816
|
+
mediaType: 'application/json',
|
|
576
817
|
});
|
|
577
818
|
}
|
|
578
819
|
/**
|
|
579
820
|
* Unenroll from a pathway. Deactivates enrollment.
|
|
580
|
-
* @
|
|
821
|
+
* @param active Whether the enrollment should be active
|
|
822
|
+
* @param org Organization for the pathway
|
|
823
|
+
* @param pathwayId Pathway ID for self-enrollment
|
|
824
|
+
* @param pathwayKey Pathway key for self-enrollment
|
|
825
|
+
* @param platformKey Platform key for the pathway
|
|
826
|
+
* @param slug Pathway slug for self-enrollment
|
|
827
|
+
* @param userId User ID for self-enrollment
|
|
828
|
+
* @param username Username for self-enrollment
|
|
829
|
+
* @returns PathwayEnrollment
|
|
581
830
|
* @throws ApiError
|
|
582
831
|
*/
|
|
583
|
-
public static catalogEnrollmentPathwaysSelfDestroy(
|
|
832
|
+
public static catalogEnrollmentPathwaysSelfDestroy(
|
|
833
|
+
active: boolean = true,
|
|
834
|
+
org?: string,
|
|
835
|
+
pathwayId?: string,
|
|
836
|
+
pathwayKey?: string,
|
|
837
|
+
platformKey?: string,
|
|
838
|
+
slug?: string,
|
|
839
|
+
userId?: string,
|
|
840
|
+
username?: string,
|
|
841
|
+
): CancelablePromise<PathwayEnrollment> {
|
|
584
842
|
return __request(OpenAPI, {
|
|
585
843
|
method: 'DELETE',
|
|
586
844
|
url: '/api/catalog/enrollment/pathways/self/',
|
|
845
|
+
query: {
|
|
846
|
+
'active': active,
|
|
847
|
+
'org': org,
|
|
848
|
+
'pathway_id': pathwayId,
|
|
849
|
+
'pathway_key': pathwayKey,
|
|
850
|
+
'platform_key': platformKey,
|
|
851
|
+
'slug': slug,
|
|
852
|
+
'user_id': userId,
|
|
853
|
+
'username': username,
|
|
854
|
+
},
|
|
587
855
|
});
|
|
588
856
|
}
|
|
589
857
|
/**
|
|
590
858
|
* Search program enrollments. Requires user_id or username and program_id or slug.
|
|
591
|
-
* @
|
|
859
|
+
* @param active Whether the enrollment should be active
|
|
860
|
+
* @param expired Date when enrollment expires
|
|
861
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
862
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
863
|
+
* @param includeMetadata Include metadata in the response
|
|
864
|
+
* @param org Organization for the program
|
|
865
|
+
* @param platformKey Platform key for the program
|
|
866
|
+
* @param programId Program ID for enrollment
|
|
867
|
+
* @param programKey Program key for enrollment
|
|
868
|
+
* @param programType Program type (standard, platform, custom)
|
|
869
|
+
* @param slug Program slug for enrollment
|
|
870
|
+
* @param started Date when enrollment started
|
|
871
|
+
* @param userId User ID for enrollment
|
|
872
|
+
* @param username Username for enrollment
|
|
873
|
+
* @returns ProgramEnrollmentPlus
|
|
592
874
|
* @throws ApiError
|
|
593
875
|
*/
|
|
594
|
-
public static catalogEnrollmentProgramsRetrieve(
|
|
876
|
+
public static catalogEnrollmentProgramsRetrieve(
|
|
877
|
+
active: boolean = true,
|
|
878
|
+
expired?: string,
|
|
879
|
+
ignoreExpiration: boolean = false,
|
|
880
|
+
includeDefaultPlatform?: boolean,
|
|
881
|
+
includeMetadata: boolean = true,
|
|
882
|
+
org?: string,
|
|
883
|
+
platformKey?: string,
|
|
884
|
+
programId?: string,
|
|
885
|
+
programKey?: string,
|
|
886
|
+
programType?: string,
|
|
887
|
+
slug?: string,
|
|
888
|
+
started?: string,
|
|
889
|
+
userId?: string,
|
|
890
|
+
username?: string,
|
|
891
|
+
): CancelablePromise<ProgramEnrollmentPlus> {
|
|
595
892
|
return __request(OpenAPI, {
|
|
596
893
|
method: 'GET',
|
|
597
894
|
url: '/api/catalog/enrollment/programs/',
|
|
895
|
+
query: {
|
|
896
|
+
'active': active,
|
|
897
|
+
'expired': expired,
|
|
898
|
+
'ignore_expiration': ignoreExpiration,
|
|
899
|
+
'include_default_platform': includeDefaultPlatform,
|
|
900
|
+
'include_metadata': includeMetadata,
|
|
901
|
+
'org': org,
|
|
902
|
+
'platform_key': platformKey,
|
|
903
|
+
'program_id': programId,
|
|
904
|
+
'program_key': programKey,
|
|
905
|
+
'program_type': programType,
|
|
906
|
+
'slug': slug,
|
|
907
|
+
'started': started,
|
|
908
|
+
'user_id': userId,
|
|
909
|
+
'username': username,
|
|
910
|
+
},
|
|
598
911
|
});
|
|
599
912
|
}
|
|
600
913
|
/**
|
|
601
914
|
* Log user enrollment with a program.
|
|
602
|
-
* @
|
|
915
|
+
* @param active Whether the enrollment should be active
|
|
916
|
+
* @param expired Date when enrollment expires
|
|
917
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
918
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
919
|
+
* @param includeMetadata Include metadata in the response
|
|
920
|
+
* @param org Organization for the program
|
|
921
|
+
* @param platformKey Platform key for the program
|
|
922
|
+
* @param programId Program ID for enrollment
|
|
923
|
+
* @param programKey Program key for enrollment
|
|
924
|
+
* @param programType Program type (standard, platform, custom)
|
|
925
|
+
* @param slug Program slug for enrollment
|
|
926
|
+
* @param started Date when enrollment started
|
|
927
|
+
* @param userId User ID for enrollment
|
|
928
|
+
* @param username Username for enrollment
|
|
929
|
+
* @param requestBody
|
|
930
|
+
* @returns ProgramEnrollment
|
|
603
931
|
* @throws ApiError
|
|
604
932
|
*/
|
|
605
|
-
public static catalogEnrollmentProgramsCreate(
|
|
933
|
+
public static catalogEnrollmentProgramsCreate(
|
|
934
|
+
active: boolean = true,
|
|
935
|
+
expired?: string,
|
|
936
|
+
ignoreExpiration: boolean = false,
|
|
937
|
+
includeDefaultPlatform?: boolean,
|
|
938
|
+
includeMetadata: boolean = true,
|
|
939
|
+
org?: string,
|
|
940
|
+
platformKey?: string,
|
|
941
|
+
programId?: string,
|
|
942
|
+
programKey?: string,
|
|
943
|
+
programType?: string,
|
|
944
|
+
slug?: string,
|
|
945
|
+
started?: string,
|
|
946
|
+
userId?: string,
|
|
947
|
+
username?: string,
|
|
948
|
+
requestBody?: ProgramEnrollmentPlus,
|
|
949
|
+
): CancelablePromise<ProgramEnrollment> {
|
|
606
950
|
return __request(OpenAPI, {
|
|
607
951
|
method: 'POST',
|
|
608
952
|
url: '/api/catalog/enrollment/programs/',
|
|
953
|
+
query: {
|
|
954
|
+
'active': active,
|
|
955
|
+
'expired': expired,
|
|
956
|
+
'ignore_expiration': ignoreExpiration,
|
|
957
|
+
'include_default_platform': includeDefaultPlatform,
|
|
958
|
+
'include_metadata': includeMetadata,
|
|
959
|
+
'org': org,
|
|
960
|
+
'platform_key': platformKey,
|
|
961
|
+
'program_id': programId,
|
|
962
|
+
'program_key': programKey,
|
|
963
|
+
'program_type': programType,
|
|
964
|
+
'slug': slug,
|
|
965
|
+
'started': started,
|
|
966
|
+
'user_id': userId,
|
|
967
|
+
'username': username,
|
|
968
|
+
},
|
|
969
|
+
body: requestBody,
|
|
970
|
+
mediaType: 'application/json',
|
|
609
971
|
});
|
|
610
972
|
}
|
|
611
973
|
/**
|
|
612
974
|
* Unenroll from a program. Deactivates enrollment.
|
|
613
|
-
* @
|
|
975
|
+
* @param active Whether the enrollment should be active
|
|
976
|
+
* @param expired Date when enrollment expires
|
|
977
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
978
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
979
|
+
* @param includeMetadata Include metadata in the response
|
|
980
|
+
* @param org Organization for the program
|
|
981
|
+
* @param platformKey Platform key for the program
|
|
982
|
+
* @param programId Program ID for enrollment
|
|
983
|
+
* @param programKey Program key for enrollment
|
|
984
|
+
* @param programType Program type (standard, platform, custom)
|
|
985
|
+
* @param slug Program slug for enrollment
|
|
986
|
+
* @param started Date when enrollment started
|
|
987
|
+
* @param userId User ID for enrollment
|
|
988
|
+
* @param username Username for enrollment
|
|
989
|
+
* @returns ProgramEnrollment
|
|
614
990
|
* @throws ApiError
|
|
615
991
|
*/
|
|
616
|
-
public static catalogEnrollmentProgramsDestroy(
|
|
992
|
+
public static catalogEnrollmentProgramsDestroy(
|
|
993
|
+
active: boolean = true,
|
|
994
|
+
expired?: string,
|
|
995
|
+
ignoreExpiration: boolean = false,
|
|
996
|
+
includeDefaultPlatform?: boolean,
|
|
997
|
+
includeMetadata: boolean = true,
|
|
998
|
+
org?: string,
|
|
999
|
+
platformKey?: string,
|
|
1000
|
+
programId?: string,
|
|
1001
|
+
programKey?: string,
|
|
1002
|
+
programType?: string,
|
|
1003
|
+
slug?: string,
|
|
1004
|
+
started?: string,
|
|
1005
|
+
userId?: string,
|
|
1006
|
+
username?: string,
|
|
1007
|
+
): CancelablePromise<ProgramEnrollment> {
|
|
617
1008
|
return __request(OpenAPI, {
|
|
618
1009
|
method: 'DELETE',
|
|
619
1010
|
url: '/api/catalog/enrollment/programs/',
|
|
1011
|
+
query: {
|
|
1012
|
+
'active': active,
|
|
1013
|
+
'expired': expired,
|
|
1014
|
+
'ignore_expiration': ignoreExpiration,
|
|
1015
|
+
'include_default_platform': includeDefaultPlatform,
|
|
1016
|
+
'include_metadata': includeMetadata,
|
|
1017
|
+
'org': org,
|
|
1018
|
+
'platform_key': platformKey,
|
|
1019
|
+
'program_id': programId,
|
|
1020
|
+
'program_key': programKey,
|
|
1021
|
+
'program_type': programType,
|
|
1022
|
+
'slug': slug,
|
|
1023
|
+
'started': started,
|
|
1024
|
+
'user_id': userId,
|
|
1025
|
+
'username': username,
|
|
1026
|
+
},
|
|
620
1027
|
});
|
|
621
1028
|
}
|
|
622
1029
|
/**
|
|
623
1030
|
* Search program enrollments based on user or program identifiers. Returns paginated enrollment results.
|
|
624
|
-
* @
|
|
1031
|
+
* @param includeDefaultPlatform Include enrollments from default platform
|
|
1032
|
+
* @param org Filter enrollments by organization
|
|
1033
|
+
* @param page Page number for pagination
|
|
1034
|
+
* @param pageSize Number of items per page
|
|
1035
|
+
* @param platformKey Filter enrollments by platform key
|
|
1036
|
+
* @param programId Filter enrollments by program ID
|
|
1037
|
+
* @param programType Filter by program type (standard, platform, custom)
|
|
1038
|
+
* @param slug Filter enrollments by program slug
|
|
1039
|
+
* @param sort Field to sort results by
|
|
1040
|
+
* @param userId Filter enrollments by user ID
|
|
1041
|
+
* @param username Filter enrollments by username
|
|
1042
|
+
* @returns ProgramEnrollmentPlus
|
|
625
1043
|
* @throws ApiError
|
|
626
1044
|
*/
|
|
627
|
-
public static catalogEnrollmentProgramsSearchRetrieve(
|
|
1045
|
+
public static catalogEnrollmentProgramsSearchRetrieve(
|
|
1046
|
+
includeDefaultPlatform?: boolean,
|
|
1047
|
+
org?: string,
|
|
1048
|
+
page?: number,
|
|
1049
|
+
pageSize?: number,
|
|
1050
|
+
platformKey?: string,
|
|
1051
|
+
programId?: string,
|
|
1052
|
+
programType?: string,
|
|
1053
|
+
slug?: string,
|
|
1054
|
+
sort: string = '-id',
|
|
1055
|
+
userId?: string,
|
|
1056
|
+
username?: string,
|
|
1057
|
+
): CancelablePromise<ProgramEnrollmentPlus> {
|
|
628
1058
|
return __request(OpenAPI, {
|
|
629
1059
|
method: 'GET',
|
|
630
1060
|
url: '/api/catalog/enrollment/programs/search/',
|
|
1061
|
+
query: {
|
|
1062
|
+
'include_default_platform': includeDefaultPlatform,
|
|
1063
|
+
'org': org,
|
|
1064
|
+
'page': page,
|
|
1065
|
+
'page_size': pageSize,
|
|
1066
|
+
'platform_key': platformKey,
|
|
1067
|
+
'program_id': programId,
|
|
1068
|
+
'program_type': programType,
|
|
1069
|
+
'slug': slug,
|
|
1070
|
+
'sort': sort,
|
|
1071
|
+
'user_id': userId,
|
|
1072
|
+
'username': username,
|
|
1073
|
+
},
|
|
631
1074
|
});
|
|
632
1075
|
}
|
|
633
1076
|
/**
|
|
634
1077
|
* Log user enrollment with a program.
|
|
635
|
-
* @
|
|
1078
|
+
* @param active Whether the enrollment should be active
|
|
1079
|
+
* @param expired Date when enrollment expires
|
|
1080
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
1081
|
+
* @param org Organization for the program
|
|
1082
|
+
* @param platformKey Platform key for the program
|
|
1083
|
+
* @param programId Program ID for self-enrollment
|
|
1084
|
+
* @param programKey Program key for self-enrollment
|
|
1085
|
+
* @param slug Program slug for self-enrollment
|
|
1086
|
+
* @param started Date when enrollment started
|
|
1087
|
+
* @param userId User ID for self-enrollment
|
|
1088
|
+
* @param username Username for self-enrollment
|
|
1089
|
+
* @param requestBody
|
|
1090
|
+
* @returns ProgramEnrollment
|
|
636
1091
|
* @throws ApiError
|
|
637
1092
|
*/
|
|
638
|
-
public static catalogEnrollmentProgramsSelfCreate(
|
|
1093
|
+
public static catalogEnrollmentProgramsSelfCreate(
|
|
1094
|
+
active: boolean = true,
|
|
1095
|
+
expired?: string,
|
|
1096
|
+
ignoreExpiration: boolean = false,
|
|
1097
|
+
org?: string,
|
|
1098
|
+
platformKey?: string,
|
|
1099
|
+
programId?: string,
|
|
1100
|
+
programKey?: string,
|
|
1101
|
+
slug?: string,
|
|
1102
|
+
started?: string,
|
|
1103
|
+
userId?: string,
|
|
1104
|
+
username?: string,
|
|
1105
|
+
requestBody?: ProgramEnrollment,
|
|
1106
|
+
): CancelablePromise<ProgramEnrollment> {
|
|
639
1107
|
return __request(OpenAPI, {
|
|
640
1108
|
method: 'POST',
|
|
641
1109
|
url: '/api/catalog/enrollment/programs/self/',
|
|
1110
|
+
query: {
|
|
1111
|
+
'active': active,
|
|
1112
|
+
'expired': expired,
|
|
1113
|
+
'ignore_expiration': ignoreExpiration,
|
|
1114
|
+
'org': org,
|
|
1115
|
+
'platform_key': platformKey,
|
|
1116
|
+
'program_id': programId,
|
|
1117
|
+
'program_key': programKey,
|
|
1118
|
+
'slug': slug,
|
|
1119
|
+
'started': started,
|
|
1120
|
+
'user_id': userId,
|
|
1121
|
+
'username': username,
|
|
1122
|
+
},
|
|
1123
|
+
body: requestBody,
|
|
1124
|
+
mediaType: 'application/json',
|
|
642
1125
|
});
|
|
643
1126
|
}
|
|
644
1127
|
/**
|
|
645
1128
|
* Unenroll from a program. Deactivates enrollment.
|
|
1129
|
+
* @param active Whether the enrollment should be active
|
|
1130
|
+
* @param expired Date when enrollment expires
|
|
1131
|
+
* @param ignoreExpiration Whether to ignore expiration during unenrollment
|
|
1132
|
+
* @param org Organization for the program
|
|
1133
|
+
* @param platformKey Platform key for the program
|
|
1134
|
+
* @param programId Program ID for self-enrollment
|
|
1135
|
+
* @param programKey Program key for self-enrollment
|
|
1136
|
+
* @param slug Program slug for self-enrollment
|
|
1137
|
+
* @param started Date when enrollment started
|
|
1138
|
+
* @param userId User ID for self-enrollment
|
|
1139
|
+
* @param username Username for self-enrollment
|
|
646
1140
|
* @returns void
|
|
647
1141
|
* @throws ApiError
|
|
648
1142
|
*/
|
|
649
|
-
public static catalogEnrollmentProgramsSelfDestroy(
|
|
1143
|
+
public static catalogEnrollmentProgramsSelfDestroy(
|
|
1144
|
+
active: boolean = true,
|
|
1145
|
+
expired?: string,
|
|
1146
|
+
ignoreExpiration: boolean = false,
|
|
1147
|
+
org?: string,
|
|
1148
|
+
platformKey?: string,
|
|
1149
|
+
programId?: string,
|
|
1150
|
+
programKey?: string,
|
|
1151
|
+
slug?: string,
|
|
1152
|
+
started?: string,
|
|
1153
|
+
userId?: string,
|
|
1154
|
+
username?: string,
|
|
1155
|
+
): CancelablePromise<void> {
|
|
650
1156
|
return __request(OpenAPI, {
|
|
651
1157
|
method: 'DELETE',
|
|
652
1158
|
url: '/api/catalog/enrollment/programs/self/',
|
|
1159
|
+
query: {
|
|
1160
|
+
'active': active,
|
|
1161
|
+
'expired': expired,
|
|
1162
|
+
'ignore_expiration': ignoreExpiration,
|
|
1163
|
+
'org': org,
|
|
1164
|
+
'platform_key': platformKey,
|
|
1165
|
+
'program_id': programId,
|
|
1166
|
+
'program_key': programKey,
|
|
1167
|
+
'slug': slug,
|
|
1168
|
+
'started': started,
|
|
1169
|
+
'user_id': userId,
|
|
1170
|
+
'username': username,
|
|
1171
|
+
},
|
|
653
1172
|
});
|
|
654
1173
|
}
|
|
655
1174
|
/**
|
|
656
1175
|
* Retrieve auto increment information for a specific platform.
|
|
657
|
-
* @returns
|
|
1176
|
+
* @returns CatalogAutoIncrementResponse
|
|
658
1177
|
* @throws ApiError
|
|
659
1178
|
*/
|
|
660
|
-
public static catalogIncrementRetrieve(): CancelablePromise<
|
|
1179
|
+
public static catalogIncrementRetrieve(): CancelablePromise<CatalogAutoIncrementResponse> {
|
|
661
1180
|
return __request(OpenAPI, {
|
|
662
1181
|
method: 'GET',
|
|
663
1182
|
url: '/api/catalog/increment/',
|
|
1183
|
+
errors: {
|
|
1184
|
+
404: `No response body`,
|
|
1185
|
+
},
|
|
664
1186
|
});
|
|
665
1187
|
}
|
|
666
1188
|
/**
|
|
667
1189
|
* Update auto increment information and retrieve a new ID for a specific platform.
|
|
668
|
-
* @
|
|
1190
|
+
* @param requestBody
|
|
1191
|
+
* @returns any
|
|
669
1192
|
* @throws ApiError
|
|
670
1193
|
*/
|
|
671
|
-
public static catalogIncrementCreate(
|
|
1194
|
+
public static catalogIncrementCreate(
|
|
1195
|
+
requestBody: CatalogAutoIncrementUpdateRequest,
|
|
1196
|
+
): CancelablePromise<Record<string, any>> {
|
|
672
1197
|
return __request(OpenAPI, {
|
|
673
1198
|
method: 'POST',
|
|
674
1199
|
url: '/api/catalog/increment/',
|
|
1200
|
+
body: requestBody,
|
|
1201
|
+
mediaType: 'application/json',
|
|
1202
|
+
errors: {
|
|
1203
|
+
400: `No response body`,
|
|
1204
|
+
500: `No response body`,
|
|
1205
|
+
},
|
|
675
1206
|
});
|
|
676
1207
|
}
|
|
677
1208
|
/**
|
|
@@ -4165,111 +4696,103 @@ export class CatalogService {
|
|
|
4165
4696
|
}
|
|
4166
4697
|
/**
|
|
4167
4698
|
* Query metadata choices based on field_key, scope, and org parameters.
|
|
4699
|
+
* @param fieldKey The key of the field for which choices are being queried
|
|
4700
|
+
* @param org The organization context for the metadata choices
|
|
4701
|
+
* @param scope The scope within which to query the metadata choices (course, program, pathway, resource)
|
|
4168
4702
|
* @returns any No response body
|
|
4169
4703
|
* @throws ApiError
|
|
4170
4704
|
*/
|
|
4171
|
-
public static catalogMetadataChoicesRetrieve(
|
|
4705
|
+
public static catalogMetadataChoicesRetrieve(
|
|
4706
|
+
fieldKey?: string,
|
|
4707
|
+
org?: string,
|
|
4708
|
+
scope?: string,
|
|
4709
|
+
): CancelablePromise<any> {
|
|
4172
4710
|
return __request(OpenAPI, {
|
|
4173
4711
|
method: 'GET',
|
|
4174
4712
|
url: '/api/catalog/metadata/choices/',
|
|
4713
|
+
query: {
|
|
4714
|
+
'field_key': fieldKey,
|
|
4715
|
+
'org': org,
|
|
4716
|
+
'scope': scope,
|
|
4717
|
+
},
|
|
4175
4718
|
});
|
|
4176
4719
|
}
|
|
4177
4720
|
/**
|
|
4178
|
-
*
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4181
|
-
* This method retrieves metadata for a specified course. The course_id must be provided
|
|
4182
|
-
* as a query parameter. If the course is not found, a 400 status code is returned.
|
|
4183
|
-
* If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
|
|
4184
|
-
* the metadata is returned with a 200 status code.
|
|
4185
|
-
*
|
|
4186
|
-
* Params:
|
|
4187
|
-
* course_id: The ID of the course for which metadata is being queried.
|
|
4721
|
+
* Retrieve metadata for a course.
|
|
4722
|
+
* @param courseId The course ID to get metadata for
|
|
4188
4723
|
* @returns any No response body
|
|
4189
4724
|
* @throws ApiError
|
|
4190
4725
|
*/
|
|
4191
|
-
public static catalogMetadataCourseRetrieve(
|
|
4726
|
+
public static catalogMetadataCourseRetrieve(
|
|
4727
|
+
courseId: string,
|
|
4728
|
+
): CancelablePromise<any> {
|
|
4192
4729
|
return __request(OpenAPI, {
|
|
4193
4730
|
method: 'GET',
|
|
4194
4731
|
url: '/api/catalog/metadata/course/',
|
|
4732
|
+
query: {
|
|
4733
|
+
'course_id': courseId,
|
|
4734
|
+
},
|
|
4735
|
+
errors: {
|
|
4736
|
+
400: `No response body`,
|
|
4737
|
+
404: `No response body`,
|
|
4738
|
+
},
|
|
4195
4739
|
});
|
|
4196
4740
|
}
|
|
4197
4741
|
/**
|
|
4198
|
-
*
|
|
4199
|
-
*
|
|
4200
|
-
*
|
|
4201
|
-
* This method updates the metadata for a specified course. The course_id and metadata
|
|
4202
|
-
* must be provided in the request data. An optional 'update' parameter can be provided
|
|
4203
|
-
* to specify whether to overwrite existing metadata. If the course is not found, a 400
|
|
4204
|
-
* status code is returned. If the field parameter is provided, a 404 status code is returned
|
|
4205
|
-
* as field updates are not supported. On successful update, the updated metadata is returned
|
|
4206
|
-
* with a 200 status code. If the update fails, a 400 status code is returned.
|
|
4207
|
-
*
|
|
4208
|
-
* Params:
|
|
4209
|
-
* course_id: The ID of the course for which metadata is being updated.
|
|
4210
|
-
* metadata: The new metadata to update the course with.
|
|
4211
|
-
* update (optional): A boolean indicating whether to overwrite existing metadata.
|
|
4742
|
+
* Update metadata for a course.
|
|
4743
|
+
* @param courseId The course ID to get metadata for
|
|
4744
|
+
* @param requestBody
|
|
4212
4745
|
* @returns any No response body
|
|
4213
4746
|
* @throws ApiError
|
|
4214
4747
|
*/
|
|
4215
|
-
public static catalogMetadataCourseCreate(
|
|
4748
|
+
public static catalogMetadataCourseCreate(
|
|
4749
|
+
courseId: string,
|
|
4750
|
+
requestBody: CourseMetadataUpdateRequest,
|
|
4751
|
+
): CancelablePromise<any> {
|
|
4216
4752
|
return __request(OpenAPI, {
|
|
4217
4753
|
method: 'POST',
|
|
4218
4754
|
url: '/api/catalog/metadata/course/',
|
|
4755
|
+
query: {
|
|
4756
|
+
'course_id': courseId,
|
|
4757
|
+
},
|
|
4758
|
+
body: requestBody,
|
|
4759
|
+
mediaType: 'application/json',
|
|
4760
|
+
errors: {
|
|
4761
|
+
400: `No response body`,
|
|
4762
|
+
404: `No response body`,
|
|
4763
|
+
},
|
|
4219
4764
|
});
|
|
4220
4765
|
}
|
|
4221
4766
|
/**
|
|
4222
|
-
*
|
|
4223
|
-
*
|
|
4224
|
-
*
|
|
4225
|
-
* This method retrieves and returns the public metadata for a specified course.
|
|
4226
|
-
* It requires a 'course_id' parameter to identify the course for which metadata is requested.
|
|
4227
|
-
*
|
|
4228
|
-
* CAUTION: Does not factor in course visibility.
|
|
4229
|
-
*
|
|
4230
|
-
* Params:
|
|
4231
|
-
* course_id: The unique identifier for the course whose metadata is being queried.
|
|
4232
|
-
*
|
|
4233
|
-
* Returns:
|
|
4234
|
-
* - 200: Successfully retrieved the course metadata.
|
|
4235
|
-
* - 400: The course ID provided does not correspond to any existing course.
|
|
4236
|
-
* - 404: Metadata retrieval failed for the specified course.
|
|
4237
|
-
*
|
|
4238
|
-
* Side Effects:
|
|
4239
|
-
* - Logs debug information if the course is not found or if metadata retrieval fails.
|
|
4767
|
+
* Retrieve public metadata for a course.
|
|
4768
|
+
* @param courseId The course ID to get metadata for
|
|
4240
4769
|
* @returns any No response body
|
|
4241
4770
|
* @throws ApiError
|
|
4242
4771
|
*/
|
|
4243
|
-
public static catalogMetadataCoursePublicRetrieve(
|
|
4772
|
+
public static catalogMetadataCoursePublicRetrieve(
|
|
4773
|
+
courseId: string,
|
|
4774
|
+
): CancelablePromise<any> {
|
|
4244
4775
|
return __request(OpenAPI, {
|
|
4245
4776
|
method: 'GET',
|
|
4246
4777
|
url: '/api/catalog/metadata/course-public/',
|
|
4778
|
+
query: {
|
|
4779
|
+
'course_id': courseId,
|
|
4780
|
+
},
|
|
4781
|
+
errors: {
|
|
4782
|
+
400: `No response body`,
|
|
4783
|
+
404: `No response body`,
|
|
4784
|
+
},
|
|
4247
4785
|
});
|
|
4248
4786
|
}
|
|
4249
4787
|
/**
|
|
4250
|
-
*
|
|
4251
|
-
*
|
|
4252
|
-
*
|
|
4253
|
-
* This method retrieves and returns the public metadata for a specified course.
|
|
4254
|
-
* It requires a 'course_id' parameter to identify the course for which metadata is requested.
|
|
4255
|
-
*
|
|
4256
|
-
* CAUTION: Does not factor in course visibility.
|
|
4257
|
-
*
|
|
4258
|
-
* Params:
|
|
4259
|
-
* course_id: The unique identifier for the course whose metadata is being queried.
|
|
4260
|
-
*
|
|
4261
|
-
* Returns:
|
|
4262
|
-
* - 200: Successfully retrieved the course metadata.
|
|
4263
|
-
* - 400: The course ID provided does not correspond to any existing course.
|
|
4264
|
-
* - 404: Metadata retrieval failed for the specified course.
|
|
4265
|
-
*
|
|
4266
|
-
* Side Effects:
|
|
4267
|
-
* - Logs debug information if the course is not found or if metadata retrieval fails.
|
|
4788
|
+
* Retrieve public metadata for a course.
|
|
4789
|
+
* @param courseId The course ID to get metadata for
|
|
4268
4790
|
* @param field
|
|
4269
4791
|
* @returns any No response body
|
|
4270
4792
|
* @throws ApiError
|
|
4271
4793
|
*/
|
|
4272
4794
|
public static catalogMetadataCoursePublicRetrieve2(
|
|
4795
|
+
courseId: string,
|
|
4273
4796
|
field: string,
|
|
4274
4797
|
): CancelablePromise<any> {
|
|
4275
4798
|
return __request(OpenAPI, {
|
|
@@ -4278,55 +4801,44 @@ export class CatalogService {
|
|
|
4278
4801
|
path: {
|
|
4279
4802
|
'field': field,
|
|
4280
4803
|
},
|
|
4804
|
+
query: {
|
|
4805
|
+
'course_id': courseId,
|
|
4806
|
+
},
|
|
4807
|
+
errors: {
|
|
4808
|
+
400: `No response body`,
|
|
4809
|
+
404: `No response body`,
|
|
4810
|
+
},
|
|
4281
4811
|
});
|
|
4282
4812
|
}
|
|
4283
4813
|
/**
|
|
4284
|
-
*
|
|
4285
|
-
*
|
|
4286
|
-
*
|
|
4287
|
-
* Return course info for courses matching course query
|
|
4288
|
-
*
|
|
4289
|
-
* Params:
|
|
4290
|
-
* <filters>
|
|
4291
|
-
*
|
|
4292
|
-
* This method accepts a set of filters in the request body to query the course metadata.
|
|
4293
|
-
* It returns a list of courses that match the provided filters.
|
|
4294
|
-
*
|
|
4295
|
-
* Error Conditions:
|
|
4296
|
-
* - Returns a 400 status code if the search filters are empty or invalid.
|
|
4297
|
-
* - Returns a 500 status code if an unexpected error occurs during the query process.
|
|
4298
|
-
*
|
|
4299
|
-
* Side Effects:
|
|
4300
|
-
* - Logs an error if the search filters are empty.
|
|
4301
|
-
* - Logs an exception if the filters are invalid or if an unexpected error occurs.
|
|
4302
|
-
*
|
|
4303
|
-
* Special Return Codes:
|
|
4304
|
-
* - A 200 status code indicates successful retrieval of course metadata.
|
|
4305
|
-
* @returns any No response body
|
|
4814
|
+
* Search for courses matching specified metadata filters.
|
|
4815
|
+
* @param requestBody
|
|
4816
|
+
* @returns any
|
|
4306
4817
|
* @throws ApiError
|
|
4307
4818
|
*/
|
|
4308
|
-
public static catalogMetadataCourseSearchCreate(
|
|
4819
|
+
public static catalogMetadataCourseSearchCreate(
|
|
4820
|
+
requestBody?: CourseMetadataSearchRequest,
|
|
4821
|
+
): CancelablePromise<Record<string, any>> {
|
|
4309
4822
|
return __request(OpenAPI, {
|
|
4310
4823
|
method: 'POST',
|
|
4311
4824
|
url: '/api/catalog/metadata/course-search/',
|
|
4825
|
+
body: requestBody,
|
|
4826
|
+
mediaType: 'application/json',
|
|
4827
|
+
errors: {
|
|
4828
|
+
400: `No response body`,
|
|
4829
|
+
500: `No response body`,
|
|
4830
|
+
},
|
|
4312
4831
|
});
|
|
4313
4832
|
}
|
|
4314
4833
|
/**
|
|
4315
|
-
*
|
|
4316
|
-
*
|
|
4317
|
-
*
|
|
4318
|
-
* This method retrieves metadata for a specified course. The course_id must be provided
|
|
4319
|
-
* as a query parameter. If the course is not found, a 400 status code is returned.
|
|
4320
|
-
* If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
|
|
4321
|
-
* the metadata is returned with a 200 status code.
|
|
4322
|
-
*
|
|
4323
|
-
* Params:
|
|
4324
|
-
* course_id: The ID of the course for which metadata is being queried.
|
|
4834
|
+
* Retrieve metadata for a course.
|
|
4835
|
+
* @param courseId The course ID to get metadata for
|
|
4325
4836
|
* @param field
|
|
4326
4837
|
* @returns any No response body
|
|
4327
4838
|
* @throws ApiError
|
|
4328
4839
|
*/
|
|
4329
4840
|
public static catalogMetadataCourseRetrieve2(
|
|
4841
|
+
courseId: string,
|
|
4330
4842
|
field: string,
|
|
4331
4843
|
): CancelablePromise<any> {
|
|
4332
4844
|
return __request(OpenAPI, {
|
|
@@ -4335,29 +4847,27 @@ export class CatalogService {
|
|
|
4335
4847
|
path: {
|
|
4336
4848
|
'field': field,
|
|
4337
4849
|
},
|
|
4850
|
+
query: {
|
|
4851
|
+
'course_id': courseId,
|
|
4852
|
+
},
|
|
4853
|
+
errors: {
|
|
4854
|
+
400: `No response body`,
|
|
4855
|
+
404: `No response body`,
|
|
4856
|
+
},
|
|
4338
4857
|
});
|
|
4339
4858
|
}
|
|
4340
4859
|
/**
|
|
4341
|
-
*
|
|
4342
|
-
*
|
|
4343
|
-
*
|
|
4344
|
-
* This method updates the metadata for a specified course. The course_id and metadata
|
|
4345
|
-
* must be provided in the request data. An optional 'update' parameter can be provided
|
|
4346
|
-
* to specify whether to overwrite existing metadata. If the course is not found, a 400
|
|
4347
|
-
* status code is returned. If the field parameter is provided, a 404 status code is returned
|
|
4348
|
-
* as field updates are not supported. On successful update, the updated metadata is returned
|
|
4349
|
-
* with a 200 status code. If the update fails, a 400 status code is returned.
|
|
4350
|
-
*
|
|
4351
|
-
* Params:
|
|
4352
|
-
* course_id: The ID of the course for which metadata is being updated.
|
|
4353
|
-
* metadata: The new metadata to update the course with.
|
|
4354
|
-
* update (optional): A boolean indicating whether to overwrite existing metadata.
|
|
4860
|
+
* Update metadata for a course.
|
|
4861
|
+
* @param courseId The course ID to get metadata for
|
|
4355
4862
|
* @param field
|
|
4863
|
+
* @param requestBody
|
|
4356
4864
|
* @returns any No response body
|
|
4357
4865
|
* @throws ApiError
|
|
4358
4866
|
*/
|
|
4359
4867
|
public static catalogMetadataCourseCreate2(
|
|
4868
|
+
courseId: string,
|
|
4360
4869
|
field: string,
|
|
4870
|
+
requestBody: CourseMetadataUpdateRequest,
|
|
4361
4871
|
): CancelablePromise<any> {
|
|
4362
4872
|
return __request(OpenAPI, {
|
|
4363
4873
|
method: 'POST',
|
|
@@ -4365,6 +4875,15 @@ export class CatalogService {
|
|
|
4365
4875
|
path: {
|
|
4366
4876
|
'field': field,
|
|
4367
4877
|
},
|
|
4878
|
+
query: {
|
|
4879
|
+
'course_id': courseId,
|
|
4880
|
+
},
|
|
4881
|
+
body: requestBody,
|
|
4882
|
+
mediaType: 'application/json',
|
|
4883
|
+
errors: {
|
|
4884
|
+
400: `No response body`,
|
|
4885
|
+
404: `No response body`,
|
|
4886
|
+
},
|
|
4368
4887
|
});
|
|
4369
4888
|
}
|
|
4370
4889
|
/**
|
|
@@ -4981,10 +5500,10 @@ export class CatalogService {
|
|
|
4981
5500
|
}
|
|
4982
5501
|
/**
|
|
4983
5502
|
* Retrieve pathways matching query. Limited parameters.
|
|
4984
|
-
* @returns
|
|
5503
|
+
* @returns Pathway
|
|
4985
5504
|
* @throws ApiError
|
|
4986
5505
|
*/
|
|
4987
|
-
public static
|
|
5506
|
+
public static catalogPathwaysList(): CancelablePromise<Array<Pathway>> {
|
|
4988
5507
|
return __request(OpenAPI, {
|
|
4989
5508
|
method: 'GET',
|
|
4990
5509
|
url: '/api/catalog/pathways/',
|
|
@@ -4992,32 +5511,43 @@ export class CatalogService {
|
|
|
4992
5511
|
}
|
|
4993
5512
|
/**
|
|
4994
5513
|
* Add or update a pathway.
|
|
4995
|
-
* @
|
|
5514
|
+
* @param requestBody
|
|
5515
|
+
* @returns Pathway
|
|
4996
5516
|
* @throws ApiError
|
|
4997
5517
|
*/
|
|
4998
|
-
public static catalogPathwaysCreate(
|
|
5518
|
+
public static catalogPathwaysCreate(
|
|
5519
|
+
requestBody: PathwayCreateUpdateRequest,
|
|
5520
|
+
): CancelablePromise<Pathway> {
|
|
4999
5521
|
return __request(OpenAPI, {
|
|
5000
5522
|
method: 'POST',
|
|
5001
5523
|
url: '/api/catalog/pathways/',
|
|
5524
|
+
body: requestBody,
|
|
5525
|
+
mediaType: 'application/json',
|
|
5526
|
+
errors: {
|
|
5527
|
+
400: `No response body`,
|
|
5528
|
+
},
|
|
5002
5529
|
});
|
|
5003
5530
|
}
|
|
5004
5531
|
/**
|
|
5005
5532
|
* Remove a pathway from the database.
|
|
5006
|
-
* @returns
|
|
5533
|
+
* @returns PathwayDeleteResponse
|
|
5007
5534
|
* @throws ApiError
|
|
5008
5535
|
*/
|
|
5009
|
-
public static catalogPathwaysDestroy(): CancelablePromise<
|
|
5536
|
+
public static catalogPathwaysDestroy(): CancelablePromise<PathwayDeleteResponse> {
|
|
5010
5537
|
return __request(OpenAPI, {
|
|
5011
5538
|
method: 'DELETE',
|
|
5012
5539
|
url: '/api/catalog/pathways/',
|
|
5540
|
+
errors: {
|
|
5541
|
+
400: `No response body`,
|
|
5542
|
+
},
|
|
5013
5543
|
});
|
|
5014
5544
|
}
|
|
5015
5545
|
/**
|
|
5016
5546
|
* Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.
|
|
5017
|
-
* @returns
|
|
5547
|
+
* @returns Program
|
|
5018
5548
|
* @throws ApiError
|
|
5019
5549
|
*/
|
|
5020
|
-
public static
|
|
5550
|
+
public static catalogProgramsList(): CancelablePromise<Array<Program>> {
|
|
5021
5551
|
return __request(OpenAPI, {
|
|
5022
5552
|
method: 'GET',
|
|
5023
5553
|
url: '/api/catalog/programs/',
|
|
@@ -5025,24 +5555,35 @@ export class CatalogService {
|
|
|
5025
5555
|
}
|
|
5026
5556
|
/**
|
|
5027
5557
|
* Add or update a program. Accepts a list of courses and updates or creates a program.
|
|
5028
|
-
* @
|
|
5558
|
+
* @param requestBody
|
|
5559
|
+
* @returns Program
|
|
5029
5560
|
* @throws ApiError
|
|
5030
5561
|
*/
|
|
5031
|
-
public static catalogProgramsCreate(
|
|
5562
|
+
public static catalogProgramsCreate(
|
|
5563
|
+
requestBody: ProgramCreateUpdateRequest,
|
|
5564
|
+
): CancelablePromise<Program> {
|
|
5032
5565
|
return __request(OpenAPI, {
|
|
5033
5566
|
method: 'POST',
|
|
5034
5567
|
url: '/api/catalog/programs/',
|
|
5568
|
+
body: requestBody,
|
|
5569
|
+
mediaType: 'application/json',
|
|
5570
|
+
errors: {
|
|
5571
|
+
400: `No response body`,
|
|
5572
|
+
},
|
|
5035
5573
|
});
|
|
5036
5574
|
}
|
|
5037
5575
|
/**
|
|
5038
5576
|
* Remove a program from the database. Requires program_id and org as parameters.
|
|
5039
|
-
* @returns
|
|
5577
|
+
* @returns ProgramDeleteResponse
|
|
5040
5578
|
* @throws ApiError
|
|
5041
5579
|
*/
|
|
5042
|
-
public static catalogProgramsDestroy(): CancelablePromise<
|
|
5580
|
+
public static catalogProgramsDestroy(): CancelablePromise<ProgramDeleteResponse> {
|
|
5043
5581
|
return __request(OpenAPI, {
|
|
5044
5582
|
method: 'DELETE',
|
|
5045
5583
|
url: '/api/catalog/programs/',
|
|
5584
|
+
errors: {
|
|
5585
|
+
400: `No response body`,
|
|
5586
|
+
},
|
|
5046
5587
|
});
|
|
5047
5588
|
}
|
|
5048
5589
|
/**
|
|
@@ -5065,91 +5606,162 @@ export class CatalogService {
|
|
|
5065
5606
|
*
|
|
5066
5607
|
* Side Effects:
|
|
5067
5608
|
* - None
|
|
5068
|
-
* @
|
|
5609
|
+
* @param courseId Current course ID
|
|
5610
|
+
* @param org Organization to filter recommendations
|
|
5611
|
+
* @param userId User ID for personalized recommendations
|
|
5612
|
+
* @returns Course
|
|
5069
5613
|
* @throws ApiError
|
|
5070
5614
|
*/
|
|
5071
|
-
public static catalogRecommendationCoursesRetrieve(
|
|
5615
|
+
public static catalogRecommendationCoursesRetrieve(
|
|
5616
|
+
courseId: string,
|
|
5617
|
+
org?: string,
|
|
5618
|
+
userId?: string,
|
|
5619
|
+
): CancelablePromise<Course> {
|
|
5072
5620
|
return __request(OpenAPI, {
|
|
5073
5621
|
method: 'GET',
|
|
5074
5622
|
url: '/api/catalog/recommendation/courses/',
|
|
5623
|
+
query: {
|
|
5624
|
+
'course_id': courseId,
|
|
5625
|
+
'org': org,
|
|
5626
|
+
'user_id': userId,
|
|
5627
|
+
},
|
|
5075
5628
|
});
|
|
5076
5629
|
}
|
|
5077
5630
|
/**
|
|
5078
|
-
* GET
|
|
5079
5631
|
* Retrieve resources matching query. Limited parameters.
|
|
5080
|
-
*
|
|
5081
|
-
*
|
|
5082
|
-
*
|
|
5083
|
-
*
|
|
5084
|
-
*
|
|
5085
|
-
*
|
|
5086
|
-
*
|
|
5087
|
-
*
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5090
|
-
*
|
|
5091
|
-
* This method retrieves resources based on the provided query parameters.
|
|
5092
|
-
* It filters the resources using the allowed parameters and returns a serialized list of resources.
|
|
5093
|
-
*
|
|
5094
|
-
* Error Conditions:
|
|
5095
|
-
* - If no resources match the query, an empty list is returned.
|
|
5096
|
-
*
|
|
5097
|
-
* Side Effects:
|
|
5098
|
-
* - None
|
|
5099
|
-
* @returns any No response body
|
|
5632
|
+
* @param id Resource ID
|
|
5633
|
+
* @param itemId Item ID associated with the resource
|
|
5634
|
+
* @param key Platform key
|
|
5635
|
+
* @param name Resource name
|
|
5636
|
+
* @param org Platform organization
|
|
5637
|
+
* @param platformKey Platform key (alternative to key)
|
|
5638
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
5639
|
+
* @param resourceType Type of resource
|
|
5640
|
+
* @param userId User ID who owns the resource
|
|
5641
|
+
* @param username Username who owns the resource
|
|
5642
|
+
* @returns Resource
|
|
5100
5643
|
* @throws ApiError
|
|
5101
5644
|
*/
|
|
5102
|
-
public static
|
|
5645
|
+
public static catalogResourcesList(
|
|
5646
|
+
id?: number,
|
|
5647
|
+
itemId?: string,
|
|
5648
|
+
key?: string,
|
|
5649
|
+
name?: string,
|
|
5650
|
+
org?: string,
|
|
5651
|
+
platformKey?: string,
|
|
5652
|
+
platformOrg?: string,
|
|
5653
|
+
resourceType?: string,
|
|
5654
|
+
userId?: number,
|
|
5655
|
+
username?: string,
|
|
5656
|
+
): CancelablePromise<Array<Resource>> {
|
|
5103
5657
|
return __request(OpenAPI, {
|
|
5104
5658
|
method: 'GET',
|
|
5105
5659
|
url: '/api/catalog/resources/',
|
|
5660
|
+
query: {
|
|
5661
|
+
'id': id,
|
|
5662
|
+
'item_id': itemId,
|
|
5663
|
+
'key': key,
|
|
5664
|
+
'name': name,
|
|
5665
|
+
'org': org,
|
|
5666
|
+
'platform_key': platformKey,
|
|
5667
|
+
'platform_org': platformOrg,
|
|
5668
|
+
'resource_type': resourceType,
|
|
5669
|
+
'user_id': userId,
|
|
5670
|
+
'username': username,
|
|
5671
|
+
},
|
|
5106
5672
|
});
|
|
5107
5673
|
}
|
|
5108
5674
|
/**
|
|
5109
5675
|
* Create or update a resource with optional image upload
|
|
5110
5676
|
* Create or update a resource. For updates, include the resource ID.
|
|
5111
5677
|
* @param formData
|
|
5678
|
+
* @param id Resource ID
|
|
5679
|
+
* @param itemId Item ID associated with the resource
|
|
5680
|
+
* @param key Platform key
|
|
5681
|
+
* @param name Resource name
|
|
5682
|
+
* @param org Platform organization
|
|
5683
|
+
* @param platformKey Platform key (alternative to key)
|
|
5684
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
5685
|
+
* @param resourceType Type of resource
|
|
5686
|
+
* @param userId User ID who owns the resource
|
|
5687
|
+
* @param username Username who owns the resource
|
|
5112
5688
|
* @returns Resource
|
|
5113
5689
|
* @throws ApiError
|
|
5114
5690
|
*/
|
|
5115
5691
|
public static catalogResourcesCreate(
|
|
5116
5692
|
formData: ResourceCreateUpdate,
|
|
5693
|
+
id?: number,
|
|
5694
|
+
itemId?: string,
|
|
5695
|
+
key?: string,
|
|
5696
|
+
name?: string,
|
|
5697
|
+
org?: string,
|
|
5698
|
+
platformKey?: string,
|
|
5699
|
+
platformOrg?: string,
|
|
5700
|
+
resourceType?: string,
|
|
5701
|
+
userId?: number,
|
|
5702
|
+
username?: string,
|
|
5117
5703
|
): CancelablePromise<Resource> {
|
|
5118
5704
|
return __request(OpenAPI, {
|
|
5119
5705
|
method: 'POST',
|
|
5120
5706
|
url: '/api/catalog/resources/',
|
|
5707
|
+
query: {
|
|
5708
|
+
'id': id,
|
|
5709
|
+
'item_id': itemId,
|
|
5710
|
+
'key': key,
|
|
5711
|
+
'name': name,
|
|
5712
|
+
'org': org,
|
|
5713
|
+
'platform_key': platformKey,
|
|
5714
|
+
'platform_org': platformOrg,
|
|
5715
|
+
'resource_type': resourceType,
|
|
5716
|
+
'user_id': userId,
|
|
5717
|
+
'username': username,
|
|
5718
|
+
},
|
|
5121
5719
|
formData: formData,
|
|
5122
5720
|
mediaType: 'multipart/form-data',
|
|
5123
5721
|
});
|
|
5124
5722
|
}
|
|
5125
5723
|
/**
|
|
5126
|
-
* DELETE
|
|
5127
5724
|
* Remove a resource from the database.
|
|
5128
|
-
*
|
|
5129
|
-
*
|
|
5130
|
-
*
|
|
5131
|
-
*
|
|
5132
|
-
*
|
|
5133
|
-
*
|
|
5134
|
-
*
|
|
5135
|
-
*
|
|
5136
|
-
*
|
|
5137
|
-
*
|
|
5138
|
-
*
|
|
5139
|
-
*
|
|
5140
|
-
* Error Conditions:
|
|
5141
|
-
* - If required parameters are missing, a 400 status is returned.
|
|
5142
|
-
* - If no resources match the query, the count will be zero.
|
|
5143
|
-
*
|
|
5144
|
-
* Side Effects:
|
|
5145
|
-
* - The specified resource is removed from the database.
|
|
5146
|
-
* @returns void
|
|
5725
|
+
* @param id Resource ID
|
|
5726
|
+
* @param itemId Item ID associated with the resource
|
|
5727
|
+
* @param key Platform key
|
|
5728
|
+
* @param name Resource name
|
|
5729
|
+
* @param org Platform organization
|
|
5730
|
+
* @param platformKey Platform key (alternative to key)
|
|
5731
|
+
* @param platformOrg Platform organization (alternative to org)
|
|
5732
|
+
* @param resourceType Type of resource
|
|
5733
|
+
* @param userId User ID who owns the resource
|
|
5734
|
+
* @param username Username who owns the resource
|
|
5735
|
+
* @returns ResourceDeleteResponse
|
|
5147
5736
|
* @throws ApiError
|
|
5148
5737
|
*/
|
|
5149
|
-
public static catalogResourcesDestroy(
|
|
5738
|
+
public static catalogResourcesDestroy(
|
|
5739
|
+
id?: number,
|
|
5740
|
+
itemId?: string,
|
|
5741
|
+
key?: string,
|
|
5742
|
+
name?: string,
|
|
5743
|
+
org?: string,
|
|
5744
|
+
platformKey?: string,
|
|
5745
|
+
platformOrg?: string,
|
|
5746
|
+
resourceType?: string,
|
|
5747
|
+
userId?: number,
|
|
5748
|
+
username?: string,
|
|
5749
|
+
): CancelablePromise<ResourceDeleteResponse> {
|
|
5150
5750
|
return __request(OpenAPI, {
|
|
5151
5751
|
method: 'DELETE',
|
|
5152
5752
|
url: '/api/catalog/resources/',
|
|
5753
|
+
query: {
|
|
5754
|
+
'id': id,
|
|
5755
|
+
'item_id': itemId,
|
|
5756
|
+
'key': key,
|
|
5757
|
+
'name': name,
|
|
5758
|
+
'org': org,
|
|
5759
|
+
'platform_key': platformKey,
|
|
5760
|
+
'platform_org': platformOrg,
|
|
5761
|
+
'resource_type': resourceType,
|
|
5762
|
+
'user_id': userId,
|
|
5763
|
+
'username': username,
|
|
5764
|
+
},
|
|
5153
5765
|
});
|
|
5154
5766
|
}
|
|
5155
5767
|
/**
|
|
@@ -5213,17 +5825,24 @@ export class CatalogService {
|
|
|
5213
5825
|
});
|
|
5214
5826
|
}
|
|
5215
5827
|
/**
|
|
5216
|
-
*
|
|
5217
|
-
*
|
|
5218
|
-
*
|
|
5219
|
-
* course_id
|
|
5220
|
-
* @returns any No response body
|
|
5828
|
+
* Retrieve aggregate review information for a course.
|
|
5829
|
+
* @param courseId The course ID to get review information for
|
|
5830
|
+
* @returns CourseReviewInfoResponse
|
|
5221
5831
|
* @throws ApiError
|
|
5222
5832
|
*/
|
|
5223
|
-
public static catalogReviewsCourseInfoRetrieve(
|
|
5833
|
+
public static catalogReviewsCourseInfoRetrieve(
|
|
5834
|
+
courseId: string,
|
|
5835
|
+
): CancelablePromise<CourseReviewInfoResponse> {
|
|
5224
5836
|
return __request(OpenAPI, {
|
|
5225
5837
|
method: 'GET',
|
|
5226
5838
|
url: '/api/catalog/reviews/course/info/',
|
|
5839
|
+
query: {
|
|
5840
|
+
'course_id': courseId,
|
|
5841
|
+
},
|
|
5842
|
+
errors: {
|
|
5843
|
+
400: `No response body`,
|
|
5844
|
+
404: `No response body`,
|
|
5845
|
+
},
|
|
5227
5846
|
});
|
|
5228
5847
|
}
|
|
5229
5848
|
/**
|
|
@@ -5401,17 +6020,24 @@ export class CatalogService {
|
|
|
5401
6020
|
});
|
|
5402
6021
|
}
|
|
5403
6022
|
/**
|
|
5404
|
-
*
|
|
5405
|
-
*
|
|
5406
|
-
*
|
|
5407
|
-
* program_key
|
|
5408
|
-
* @returns any No response body
|
|
6023
|
+
* Retrieve aggregate review information for a program.
|
|
6024
|
+
* @param programKey The program key to get review information for
|
|
6025
|
+
* @returns ProgramReviewInfoResponse
|
|
5409
6026
|
* @throws ApiError
|
|
5410
6027
|
*/
|
|
5411
|
-
public static catalogReviewsProgramInfoRetrieve(
|
|
6028
|
+
public static catalogReviewsProgramInfoRetrieve(
|
|
6029
|
+
programKey: string,
|
|
6030
|
+
): CancelablePromise<ProgramReviewInfoResponse> {
|
|
5412
6031
|
return __request(OpenAPI, {
|
|
5413
6032
|
method: 'GET',
|
|
5414
6033
|
url: '/api/catalog/reviews/program/info/',
|
|
6034
|
+
query: {
|
|
6035
|
+
'program_key': programKey,
|
|
6036
|
+
},
|
|
6037
|
+
errors: {
|
|
6038
|
+
400: `No response body`,
|
|
6039
|
+
404: `No response body`,
|
|
6040
|
+
},
|
|
5415
6041
|
});
|
|
5416
6042
|
}
|
|
5417
6043
|
/**
|
|
@@ -5530,158 +6156,201 @@ export class CatalogService {
|
|
|
5530
6156
|
}
|
|
5531
6157
|
/**
|
|
5532
6158
|
* Retrieve roles matching query parameters. Supports filtering by name, id, and slug.
|
|
5533
|
-
* @
|
|
6159
|
+
* @param id Role ID
|
|
6160
|
+
* @param name Role name
|
|
6161
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
6162
|
+
* @param page Page number for pagination
|
|
6163
|
+
* @param pageSize Number of items per page
|
|
6164
|
+
* @param platformKey Platform key
|
|
6165
|
+
* @param slug Role slug
|
|
6166
|
+
* @param sort Field to sort results by
|
|
6167
|
+
* @returns Role
|
|
5534
6168
|
* @throws ApiError
|
|
5535
6169
|
*/
|
|
5536
|
-
public static catalogRolesRetrieve(
|
|
6170
|
+
public static catalogRolesRetrieve(
|
|
6171
|
+
id?: number,
|
|
6172
|
+
name?: string,
|
|
6173
|
+
nameIexact?: string,
|
|
6174
|
+
page?: number,
|
|
6175
|
+
pageSize?: number,
|
|
6176
|
+
platformKey?: string,
|
|
6177
|
+
slug?: string,
|
|
6178
|
+
sort: string = 'id',
|
|
6179
|
+
): CancelablePromise<Role> {
|
|
5537
6180
|
return __request(OpenAPI, {
|
|
5538
6181
|
method: 'GET',
|
|
5539
6182
|
url: '/api/catalog/roles/',
|
|
6183
|
+
query: {
|
|
6184
|
+
'id': id,
|
|
6185
|
+
'name': name,
|
|
6186
|
+
'name__iexact': nameIexact,
|
|
6187
|
+
'page': page,
|
|
6188
|
+
'page_size': pageSize,
|
|
6189
|
+
'platform_key': platformKey,
|
|
6190
|
+
'slug': slug,
|
|
6191
|
+
'sort': sort,
|
|
6192
|
+
},
|
|
5540
6193
|
});
|
|
5541
6194
|
}
|
|
5542
6195
|
/**
|
|
5543
6196
|
* Add a new role or update an existing role based on provided data.
|
|
5544
|
-
* @
|
|
6197
|
+
* @param requestBody
|
|
6198
|
+
* @param id Role ID
|
|
6199
|
+
* @param name Role name
|
|
6200
|
+
* @param nameIexact Exact match for role name (case insensitive)
|
|
6201
|
+
* @param page Page number for pagination
|
|
6202
|
+
* @param pageSize Number of items per page
|
|
6203
|
+
* @param platformKey Platform key
|
|
6204
|
+
* @param slug Role slug
|
|
6205
|
+
* @param sort Field to sort results by
|
|
6206
|
+
* @returns Role
|
|
5545
6207
|
* @throws ApiError
|
|
5546
6208
|
*/
|
|
5547
|
-
public static catalogRolesCreate(
|
|
6209
|
+
public static catalogRolesCreate(
|
|
6210
|
+
requestBody: RoleCreateUpdateRequest,
|
|
6211
|
+
id?: number,
|
|
6212
|
+
name?: string,
|
|
6213
|
+
nameIexact?: string,
|
|
6214
|
+
page?: number,
|
|
6215
|
+
pageSize?: number,
|
|
6216
|
+
platformKey?: string,
|
|
6217
|
+
slug?: string,
|
|
6218
|
+
sort: string = 'id',
|
|
6219
|
+
): CancelablePromise<Role> {
|
|
5548
6220
|
return __request(OpenAPI, {
|
|
5549
6221
|
method: 'POST',
|
|
5550
6222
|
url: '/api/catalog/roles/',
|
|
6223
|
+
query: {
|
|
6224
|
+
'id': id,
|
|
6225
|
+
'name': name,
|
|
6226
|
+
'name__iexact': nameIexact,
|
|
6227
|
+
'page': page,
|
|
6228
|
+
'page_size': pageSize,
|
|
6229
|
+
'platform_key': platformKey,
|
|
6230
|
+
'slug': slug,
|
|
6231
|
+
'sort': sort,
|
|
6232
|
+
},
|
|
6233
|
+
body: requestBody,
|
|
6234
|
+
mediaType: 'application/json',
|
|
5551
6235
|
});
|
|
5552
6236
|
}
|
|
5553
6237
|
/**
|
|
5554
6238
|
* Retrieve desired roles for a user.
|
|
5555
|
-
*
|
|
5556
|
-
*
|
|
5557
|
-
*
|
|
5558
|
-
* If no roles are found, it returns a status of 400 indicating a bad request.
|
|
5559
|
-
*
|
|
5560
|
-
* Error Conditions:
|
|
5561
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5562
|
-
* - If no desired roles exist for the user, a 400 status is returned.
|
|
5563
|
-
*
|
|
5564
|
-
* Side Effects:
|
|
5565
|
-
* - None
|
|
5566
|
-
* @returns any No response body
|
|
6239
|
+
* @param userId User ID
|
|
6240
|
+
* @param username Username
|
|
6241
|
+
* @returns DesiredRole
|
|
5567
6242
|
* @throws ApiError
|
|
5568
6243
|
*/
|
|
5569
|
-
public static catalogRolesDesiredRetrieve(
|
|
6244
|
+
public static catalogRolesDesiredRetrieve(
|
|
6245
|
+
userId?: number,
|
|
6246
|
+
username?: string,
|
|
6247
|
+
): CancelablePromise<DesiredRole> {
|
|
5570
6248
|
return __request(OpenAPI, {
|
|
5571
6249
|
method: 'GET',
|
|
5572
6250
|
url: '/api/catalog/roles/desired/',
|
|
6251
|
+
query: {
|
|
6252
|
+
'user_id': userId,
|
|
6253
|
+
'username': username,
|
|
6254
|
+
},
|
|
6255
|
+
errors: {
|
|
6256
|
+
400: `No response body`,
|
|
6257
|
+
},
|
|
5573
6258
|
});
|
|
5574
6259
|
}
|
|
5575
6260
|
/**
|
|
5576
|
-
*
|
|
5577
|
-
*
|
|
5578
|
-
*
|
|
5579
|
-
*
|
|
5580
|
-
*
|
|
5581
|
-
* - skills: The skills associated with the desired role.
|
|
5582
|
-
* - data: Additional data related to the desired role.
|
|
5583
|
-
*
|
|
5584
|
-
* This method allows adding or updating a user's desired roles. It accepts user identification
|
|
5585
|
-
* and role data in the request body. If the role is successfully created, it returns the serialized
|
|
5586
|
-
* role data with a status of 201. If the role is updated, it returns the serialized role data with
|
|
5587
|
-
* a status of 200. If the operation fails, it returns a status of 400.
|
|
5588
|
-
*
|
|
5589
|
-
* Error Conditions:
|
|
5590
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5591
|
-
* - If the role cannot be created or updated, a 400 status is returned.
|
|
5592
|
-
*
|
|
5593
|
-
* Side Effects:
|
|
5594
|
-
* - Creates or updates the desired roles for the specified user.
|
|
5595
|
-
* @returns any No response body
|
|
6261
|
+
* Add or update desired roles for a user.
|
|
6262
|
+
* @param requestBody
|
|
6263
|
+
* @param userId User ID
|
|
6264
|
+
* @param username Username
|
|
6265
|
+
* @returns DesiredRole
|
|
5596
6266
|
* @throws ApiError
|
|
5597
6267
|
*/
|
|
5598
|
-
public static catalogRolesDesiredCreate(
|
|
6268
|
+
public static catalogRolesDesiredCreate(
|
|
6269
|
+
requestBody: DesiredRoleCreateUpdateRequest,
|
|
6270
|
+
userId?: number,
|
|
6271
|
+
username?: string,
|
|
6272
|
+
): CancelablePromise<DesiredRole> {
|
|
5599
6273
|
return __request(OpenAPI, {
|
|
5600
6274
|
method: 'POST',
|
|
5601
6275
|
url: '/api/catalog/roles/desired/',
|
|
6276
|
+
query: {
|
|
6277
|
+
'user_id': userId,
|
|
6278
|
+
'username': username,
|
|
6279
|
+
},
|
|
6280
|
+
body: requestBody,
|
|
6281
|
+
mediaType: 'application/json',
|
|
6282
|
+
errors: {
|
|
6283
|
+
400: `No response body`,
|
|
6284
|
+
},
|
|
5602
6285
|
});
|
|
5603
6286
|
}
|
|
5604
6287
|
/**
|
|
5605
|
-
* Add or update a role.
|
|
5606
|
-
*
|
|
5607
|
-
*
|
|
5608
|
-
* It checks if public role creation is allowed, and if not, returns a 404 status.
|
|
5609
|
-
* If the request is made by a user token, the user is logged.
|
|
5610
|
-
*
|
|
5611
|
-
* Params:
|
|
5612
|
-
* - id: Identifier for the role.
|
|
5613
|
-
* - name: Name of the role.
|
|
5614
|
-
* - slug: A short label for the role.
|
|
5615
|
-
* - data: Additional data for the role.
|
|
5616
|
-
*
|
|
5617
|
-
* Returns:
|
|
5618
|
-
* - 201 status code if a new role is created.
|
|
5619
|
-
* - 200 status code if an existing role is updated.
|
|
5620
|
-
* - 400 status code if the role creation or update fails.
|
|
5621
|
-
* - 404 status code if public role creation is not allowed.
|
|
5622
|
-
*
|
|
5623
|
-
* Side Effects:
|
|
5624
|
-
* - Logs the user if the request is made by a user token.
|
|
5625
|
-
* @returns any No response body
|
|
6288
|
+
* Add or update a role through the public API (when enabled).
|
|
6289
|
+
* @param requestBody
|
|
6290
|
+
* @returns Role
|
|
5626
6291
|
* @throws ApiError
|
|
5627
6292
|
*/
|
|
5628
|
-
public static catalogRolesPublicCreate(
|
|
6293
|
+
public static catalogRolesPublicCreate(
|
|
6294
|
+
requestBody: RoleCreateUpdateRequest,
|
|
6295
|
+
): CancelablePromise<Role> {
|
|
5629
6296
|
return __request(OpenAPI, {
|
|
5630
6297
|
method: 'POST',
|
|
5631
6298
|
url: '/api/catalog/roles/public/',
|
|
6299
|
+
body: requestBody,
|
|
6300
|
+
mediaType: 'application/json',
|
|
6301
|
+
errors: {
|
|
6302
|
+
404: `No response body`,
|
|
6303
|
+
},
|
|
5632
6304
|
});
|
|
5633
6305
|
}
|
|
5634
6306
|
/**
|
|
5635
|
-
*
|
|
5636
|
-
*
|
|
5637
|
-
*
|
|
5638
|
-
*
|
|
5639
|
-
* - name: The name of the role.
|
|
5640
|
-
* - id: The ID of the role.
|
|
5641
|
-
* - slug: The slug of the role.
|
|
5642
|
-
*
|
|
5643
|
-
* Returns:
|
|
5644
|
-
* - 200: If the role is found, returns the serialized role data.
|
|
5645
|
-
* - 400: If no role is found for the user.
|
|
5646
|
-
*
|
|
5647
|
-
* Error Conditions:
|
|
5648
|
-
* - If the user cannot be found using the provided user_id or username, a 400 status is returned.
|
|
5649
|
-
* @returns any No response body
|
|
6307
|
+
* Retrieve reported roles for a user.
|
|
6308
|
+
* @param userId User ID
|
|
6309
|
+
* @param username Username
|
|
6310
|
+
* @returns ReportedRole
|
|
5650
6311
|
* @throws ApiError
|
|
5651
6312
|
*/
|
|
5652
|
-
public static catalogRolesReportedRetrieve(
|
|
6313
|
+
public static catalogRolesReportedRetrieve(
|
|
6314
|
+
userId?: number,
|
|
6315
|
+
username?: string,
|
|
6316
|
+
): CancelablePromise<ReportedRole> {
|
|
5653
6317
|
return __request(OpenAPI, {
|
|
5654
6318
|
method: 'GET',
|
|
5655
6319
|
url: '/api/catalog/roles/reported/',
|
|
6320
|
+
query: {
|
|
6321
|
+
'user_id': userId,
|
|
6322
|
+
'username': username,
|
|
6323
|
+
},
|
|
6324
|
+
errors: {
|
|
6325
|
+
400: `No response body`,
|
|
6326
|
+
},
|
|
5656
6327
|
});
|
|
5657
6328
|
}
|
|
5658
6329
|
/**
|
|
5659
|
-
*
|
|
5660
|
-
*
|
|
5661
|
-
*
|
|
5662
|
-
*
|
|
5663
|
-
*
|
|
5664
|
-
* - skills: The skills associated with the role.
|
|
5665
|
-
* - data: Additional data related to the role.
|
|
5666
|
-
*
|
|
5667
|
-
* Returns:
|
|
5668
|
-
* - 201: If a new role is created, returns the serialized role data.
|
|
5669
|
-
* - 200: If an existing role is updated, returns the serialized role data.
|
|
5670
|
-
* - 400: If the role cannot be saved or updated.
|
|
5671
|
-
*
|
|
5672
|
-
* Error Conditions:
|
|
5673
|
-
* - If the user cannot be found using the provided user_id or username, a 400 status is returned.
|
|
5674
|
-
* - If the role cannot be saved or updated, a 400 status is returned.
|
|
5675
|
-
*
|
|
5676
|
-
* Side Effects:
|
|
5677
|
-
* - Creates a new role or updates an existing role for the user.
|
|
5678
|
-
* @returns any No response body
|
|
6330
|
+
* Add or update reported roles for a user.
|
|
6331
|
+
* @param requestBody
|
|
6332
|
+
* @param userId User ID
|
|
6333
|
+
* @param username Username
|
|
6334
|
+
* @returns ReportedRole
|
|
5679
6335
|
* @throws ApiError
|
|
5680
6336
|
*/
|
|
5681
|
-
public static catalogRolesReportedCreate(
|
|
6337
|
+
public static catalogRolesReportedCreate(
|
|
6338
|
+
requestBody: ReportedRoleCreateUpdateRequest,
|
|
6339
|
+
userId?: number,
|
|
6340
|
+
username?: string,
|
|
6341
|
+
): CancelablePromise<ReportedRole> {
|
|
5682
6342
|
return __request(OpenAPI, {
|
|
5683
6343
|
method: 'POST',
|
|
5684
6344
|
url: '/api/catalog/roles/reported/',
|
|
6345
|
+
query: {
|
|
6346
|
+
'user_id': userId,
|
|
6347
|
+
'username': username,
|
|
6348
|
+
},
|
|
6349
|
+
body: requestBody,
|
|
6350
|
+
mediaType: 'application/json',
|
|
6351
|
+
errors: {
|
|
6352
|
+
400: `No response body`,
|
|
6353
|
+
},
|
|
5685
6354
|
});
|
|
5686
6355
|
}
|
|
5687
6356
|
/**
|
|
@@ -5704,123 +6373,166 @@ export class CatalogService {
|
|
|
5704
6373
|
*
|
|
5705
6374
|
* Special Return Codes:
|
|
5706
6375
|
* - A 200 status code indicates successful retrieval of programs matching the query.
|
|
5707
|
-
* @
|
|
6376
|
+
* @param requestBody
|
|
6377
|
+
* @param org The organization to which the programs belong
|
|
6378
|
+
* @param query The search term used to filter programs
|
|
6379
|
+
* @returns ProgramSearch
|
|
5708
6380
|
* @throws ApiError
|
|
5709
6381
|
*/
|
|
5710
|
-
public static catalogSearchProgramsCreate(
|
|
6382
|
+
public static catalogSearchProgramsCreate(
|
|
6383
|
+
requestBody: ProgramSearch,
|
|
6384
|
+
org?: string,
|
|
6385
|
+
query: string = '',
|
|
6386
|
+
): CancelablePromise<ProgramSearch> {
|
|
5711
6387
|
return __request(OpenAPI, {
|
|
5712
6388
|
method: 'POST',
|
|
5713
6389
|
url: '/api/catalog/search/programs/',
|
|
6390
|
+
query: {
|
|
6391
|
+
'org': org,
|
|
6392
|
+
'query': query,
|
|
6393
|
+
},
|
|
6394
|
+
body: requestBody,
|
|
6395
|
+
mediaType: 'application/json',
|
|
5714
6396
|
});
|
|
5715
6397
|
}
|
|
5716
6398
|
/**
|
|
5717
6399
|
* Retrieve skills matching query. Limited parameters.
|
|
5718
|
-
* @
|
|
6400
|
+
* @param id Skill ID
|
|
6401
|
+
* @param name Skill name
|
|
6402
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
6403
|
+
* @param page Page number for pagination
|
|
6404
|
+
* @param pageSize Number of items per page
|
|
6405
|
+
* @param platformKey Platform key
|
|
6406
|
+
* @param slug Skill slug
|
|
6407
|
+
* @param sort Field to sort results by
|
|
6408
|
+
* @returns Skill
|
|
5719
6409
|
* @throws ApiError
|
|
5720
6410
|
*/
|
|
5721
|
-
public static catalogSkillsRetrieve(
|
|
6411
|
+
public static catalogSkillsRetrieve(
|
|
6412
|
+
id?: number,
|
|
6413
|
+
name?: string,
|
|
6414
|
+
nameIexact?: string,
|
|
6415
|
+
page?: number,
|
|
6416
|
+
pageSize?: number,
|
|
6417
|
+
platformKey?: string,
|
|
6418
|
+
slug?: string,
|
|
6419
|
+
sort: string = 'id',
|
|
6420
|
+
): CancelablePromise<Skill> {
|
|
5722
6421
|
return __request(OpenAPI, {
|
|
5723
6422
|
method: 'GET',
|
|
5724
6423
|
url: '/api/catalog/skills/',
|
|
6424
|
+
query: {
|
|
6425
|
+
'id': id,
|
|
6426
|
+
'name': name,
|
|
6427
|
+
'name__iexact': nameIexact,
|
|
6428
|
+
'page': page,
|
|
6429
|
+
'page_size': pageSize,
|
|
6430
|
+
'platform_key': platformKey,
|
|
6431
|
+
'slug': slug,
|
|
6432
|
+
'sort': sort,
|
|
6433
|
+
},
|
|
5725
6434
|
});
|
|
5726
6435
|
}
|
|
5727
6436
|
/**
|
|
5728
6437
|
* Add or update a skill.
|
|
5729
|
-
* @
|
|
6438
|
+
* @param id Skill ID
|
|
6439
|
+
* @param name Skill name
|
|
6440
|
+
* @param nameIexact Exact match for skill name (case insensitive)
|
|
6441
|
+
* @param page Page number for pagination
|
|
6442
|
+
* @param pageSize Number of items per page
|
|
6443
|
+
* @param platformKey Platform key
|
|
6444
|
+
* @param slug Skill slug
|
|
6445
|
+
* @param sort Field to sort results by
|
|
6446
|
+
* @param requestBody
|
|
6447
|
+
* @returns Skill
|
|
5730
6448
|
* @throws ApiError
|
|
5731
6449
|
*/
|
|
5732
|
-
public static catalogSkillsCreate(
|
|
6450
|
+
public static catalogSkillsCreate(
|
|
6451
|
+
id?: number,
|
|
6452
|
+
name?: string,
|
|
6453
|
+
nameIexact?: string,
|
|
6454
|
+
page?: number,
|
|
6455
|
+
pageSize?: number,
|
|
6456
|
+
platformKey?: string,
|
|
6457
|
+
slug?: string,
|
|
6458
|
+
sort: string = 'id',
|
|
6459
|
+
requestBody?: Skill,
|
|
6460
|
+
): CancelablePromise<Skill> {
|
|
5733
6461
|
return __request(OpenAPI, {
|
|
5734
6462
|
method: 'POST',
|
|
5735
6463
|
url: '/api/catalog/skills/',
|
|
6464
|
+
query: {
|
|
6465
|
+
'id': id,
|
|
6466
|
+
'name': name,
|
|
6467
|
+
'name__iexact': nameIexact,
|
|
6468
|
+
'page': page,
|
|
6469
|
+
'page_size': pageSize,
|
|
6470
|
+
'platform_key': platformKey,
|
|
6471
|
+
'slug': slug,
|
|
6472
|
+
'sort': sort,
|
|
6473
|
+
},
|
|
6474
|
+
body: requestBody,
|
|
6475
|
+
mediaType: 'application/json',
|
|
5736
6476
|
});
|
|
5737
6477
|
}
|
|
5738
6478
|
/**
|
|
5739
|
-
* GET
|
|
5740
6479
|
* Retrieve desired skills for a user.
|
|
5741
|
-
*
|
|
5742
|
-
*
|
|
5743
|
-
*
|
|
5744
|
-
*
|
|
5745
|
-
* Params:
|
|
5746
|
-
* - name: The name of the skill to retrieve.
|
|
5747
|
-
* - id: The unique identifier of the skill.
|
|
5748
|
-
* - slug: A slug representation of the skill.
|
|
5749
|
-
*
|
|
5750
|
-
* Returns:
|
|
5751
|
-
* - 200: A successful response containing the serialized desired skill data.
|
|
5752
|
-
* - 400: If the user is not found or no desired skills exist for the user.
|
|
5753
|
-
*
|
|
5754
|
-
* Error Conditions:
|
|
5755
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5756
|
-
* - If no desired skills are found for the identified user, a 400 status is returned.
|
|
5757
|
-
* @returns any No response body
|
|
6480
|
+
* @param userId User ID
|
|
6481
|
+
* @param username Username
|
|
6482
|
+
* @returns DesiredSkill
|
|
5758
6483
|
* @throws ApiError
|
|
5759
6484
|
*/
|
|
5760
|
-
public static catalogSkillsDesiredRetrieve(
|
|
6485
|
+
public static catalogSkillsDesiredRetrieve(
|
|
6486
|
+
userId?: number,
|
|
6487
|
+
username?: string,
|
|
6488
|
+
): CancelablePromise<DesiredSkill> {
|
|
5761
6489
|
return __request(OpenAPI, {
|
|
5762
6490
|
method: 'GET',
|
|
5763
6491
|
url: '/api/catalog/skills/desired/',
|
|
6492
|
+
query: {
|
|
6493
|
+
'user_id': userId,
|
|
6494
|
+
'username': username,
|
|
6495
|
+
},
|
|
5764
6496
|
});
|
|
5765
6497
|
}
|
|
5766
6498
|
/**
|
|
5767
|
-
*
|
|
5768
|
-
*
|
|
5769
|
-
*
|
|
5770
|
-
*
|
|
5771
|
-
*
|
|
5772
|
-
* to be added or updated.
|
|
5773
|
-
*
|
|
5774
|
-
* Params:
|
|
5775
|
-
* - user_id/username: Identifies the user for whom the skills are to be added or updated.
|
|
5776
|
-
* - skills: A list of skills to be added or updated.
|
|
5777
|
-
* - data: Additional data related to the skills.
|
|
5778
|
-
*
|
|
5779
|
-
* Returns:
|
|
5780
|
-
* - 201: If a new skill is successfully created.
|
|
5781
|
-
* - 200: If an existing skill is successfully updated.
|
|
5782
|
-
* - 400: If the user cannot be identified or the skill cannot be saved.
|
|
5783
|
-
*
|
|
5784
|
-
* Error Conditions:
|
|
5785
|
-
* - If the user cannot be identified from the provided parameters, a 400 status is returned.
|
|
5786
|
-
* - If the skill cannot be saved due to any reason, a 400 status is returned.
|
|
5787
|
-
*
|
|
5788
|
-
* Side Effects:
|
|
5789
|
-
* - This method may create a new skill entry or update an existing one in the database.
|
|
5790
|
-
* @returns any No response body
|
|
6499
|
+
* Add or update desired skills for a user.
|
|
6500
|
+
* @param requestBody
|
|
6501
|
+
* @param userId User ID
|
|
6502
|
+
* @param username Username
|
|
6503
|
+
* @returns DesiredSkill
|
|
5791
6504
|
* @throws ApiError
|
|
5792
6505
|
*/
|
|
5793
|
-
public static catalogSkillsDesiredCreate(
|
|
6506
|
+
public static catalogSkillsDesiredCreate(
|
|
6507
|
+
requestBody: DesiredSkillCreateUpdateRequest,
|
|
6508
|
+
userId?: number,
|
|
6509
|
+
username?: string,
|
|
6510
|
+
): CancelablePromise<DesiredSkill> {
|
|
5794
6511
|
return __request(OpenAPI, {
|
|
5795
6512
|
method: 'POST',
|
|
5796
6513
|
url: '/api/catalog/skills/desired/',
|
|
6514
|
+
query: {
|
|
6515
|
+
'user_id': userId,
|
|
6516
|
+
'username': username,
|
|
6517
|
+
},
|
|
6518
|
+
body: requestBody,
|
|
6519
|
+
mediaType: 'application/json',
|
|
5797
6520
|
});
|
|
5798
6521
|
}
|
|
5799
6522
|
/**
|
|
5800
|
-
* POST
|
|
5801
6523
|
* Add or update a skill.
|
|
5802
|
-
*
|
|
5803
|
-
*
|
|
5804
|
-
* - id: The unique identifier for the skill.
|
|
5805
|
-
* - name: The name of the skill.
|
|
5806
|
-
* - slug: A URL-friendly version of the skill name.
|
|
5807
|
-
* - data: Additional data related to the skill.
|
|
5808
|
-
*
|
|
5809
|
-
* 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.
|
|
5810
|
-
*
|
|
5811
|
-
* If the request is made by a user with a valid token, the user will be logged.
|
|
5812
|
-
*
|
|
5813
|
-
* Returns:
|
|
5814
|
-
* - 201 status code if a new skill is created successfully.
|
|
5815
|
-
* - 200 status code if an existing skill is updated successfully.
|
|
5816
|
-
* - 400 status code if the skill creation or update fails.
|
|
5817
|
-
* @returns any No response body
|
|
6524
|
+
* @param requestBody
|
|
6525
|
+
* @returns Skill
|
|
5818
6526
|
* @throws ApiError
|
|
5819
6527
|
*/
|
|
5820
|
-
public static catalogSkillsPublicCreate(
|
|
6528
|
+
public static catalogSkillsPublicCreate(
|
|
6529
|
+
requestBody: SkillCreateUpdateRequest,
|
|
6530
|
+
): CancelablePromise<Skill> {
|
|
5821
6531
|
return __request(OpenAPI, {
|
|
5822
6532
|
method: 'POST',
|
|
5823
6533
|
url: '/api/catalog/skills/public/',
|
|
6534
|
+
body: requestBody,
|
|
6535
|
+
mediaType: 'application/json',
|
|
5824
6536
|
});
|
|
5825
6537
|
}
|
|
5826
6538
|
/**
|
|
@@ -5840,13 +6552,22 @@ export class CatalogService {
|
|
|
5840
6552
|
* Error Conditions:
|
|
5841
6553
|
* - If the user cannot be identified, a 400 status code is returned.
|
|
5842
6554
|
* - If no reported skills exist for the user, a 400 status code is returned.
|
|
5843
|
-
* @
|
|
6555
|
+
* @param userId User ID
|
|
6556
|
+
* @param username Username
|
|
6557
|
+
* @returns ReportedSkill
|
|
5844
6558
|
* @throws ApiError
|
|
5845
6559
|
*/
|
|
5846
|
-
public static catalogSkillsReportedRetrieve(
|
|
6560
|
+
public static catalogSkillsReportedRetrieve(
|
|
6561
|
+
userId?: number,
|
|
6562
|
+
username?: string,
|
|
6563
|
+
): CancelablePromise<ReportedSkill> {
|
|
5847
6564
|
return __request(OpenAPI, {
|
|
5848
6565
|
method: 'GET',
|
|
5849
6566
|
url: '/api/catalog/skills/reported/',
|
|
6567
|
+
query: {
|
|
6568
|
+
'user_id': userId,
|
|
6569
|
+
'username': username,
|
|
6570
|
+
},
|
|
5850
6571
|
});
|
|
5851
6572
|
}
|
|
5852
6573
|
/**
|
|
@@ -5872,13 +6593,26 @@ export class CatalogService {
|
|
|
5872
6593
|
* Side Effects:
|
|
5873
6594
|
* - If a new skill is created, it will be persisted in the database.
|
|
5874
6595
|
* - If an existing skill is updated, the changes will be saved in the database.
|
|
5875
|
-
* @
|
|
6596
|
+
* @param requestBody
|
|
6597
|
+
* @param userId User ID
|
|
6598
|
+
* @param username Username
|
|
6599
|
+
* @returns ReportedSkill
|
|
5876
6600
|
* @throws ApiError
|
|
5877
6601
|
*/
|
|
5878
|
-
public static catalogSkillsReportedCreate(
|
|
6602
|
+
public static catalogSkillsReportedCreate(
|
|
6603
|
+
requestBody: ReportedSkill,
|
|
6604
|
+
userId?: number,
|
|
6605
|
+
username?: string,
|
|
6606
|
+
): CancelablePromise<ReportedSkill> {
|
|
5879
6607
|
return __request(OpenAPI, {
|
|
5880
6608
|
method: 'POST',
|
|
5881
6609
|
url: '/api/catalog/skills/reported/',
|
|
6610
|
+
query: {
|
|
6611
|
+
'user_id': userId,
|
|
6612
|
+
'username': username,
|
|
6613
|
+
},
|
|
6614
|
+
body: requestBody,
|
|
6615
|
+
mediaType: 'application/json',
|
|
5882
6616
|
});
|
|
5883
6617
|
}
|
|
5884
6618
|
/**
|