@iblai/iblai-api 3.58.0-core → 3.59.0-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 +28763 -11942
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +28751 -11924
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +28763 -11942
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +335 -28
- 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/CallConfiguration.d.ts +26 -0
- package/dist/types/models/CallConfigurationModeEnum.d.ts +8 -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/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/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/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/DocumentSettingsResponse.d.ts +3 -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/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/HeygenTemplateRequest.d.ts +5 -0
- package/dist/types/models/HeygenTemplateResponseSingle.d.ts +6 -0
- package/dist/types/models/HeygenVideoDetail.d.ts +8 -0
- package/dist/types/models/HeygenVideoRequest.d.ts +5 -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/LlmProviderEnum.d.ts +8 -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 +87 -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 +84 -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 +47 -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 +60 -0
- package/dist/types/models/MentorSettingsPublic.d.ts +46 -0
- package/dist/types/models/MentorSettingsRequest.d.ts +62 -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/Observation.d.ts +31 -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/PaginatedHeygenTemplateResponseSingleList.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/PaginatedObservationList.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/PaginatedRetrieverDocumentEmbeddingList.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/PaginatedTraceList.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/PatchedCallConfiguration.d.ts +26 -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 +84 -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/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/Prompt.d.ts +22 -0
- package/dist/types/models/PromptCategory.d.ts +7 -0
- package/dist/types/models/PromptFacet.d.ts +17 -0
- package/dist/types/models/PromptSearchResponse.d.ts +35 -0
- package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
- package/dist/types/models/Provider05cEnum.d.ts +14 -0
- package/dist/types/models/Provider637Enum.d.ts +10 -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/RecommendedCoursesResponse.d.ts +33 -0
- package/dist/types/models/RelatedText.d.ts +3 -0
- package/dist/types/models/RequestDataVariable.d.ts +14 -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 +27 -0
- package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +58 -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/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/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/StripeCheckoutSessionRequest.d.ts +2 -2
- package/dist/types/models/{ModeEnum.d.ts → StripeCheckoutSessionRequestModeEnum.d.ts} +1 -1
- package/dist/types/models/SttProviderEnum.d.ts +12 -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 +11 -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/Trace.d.ts +17 -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 +62 -0
- package/dist/types/models/TrainDocumentViewResponse.d.ts +15 -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/TtsProviderEnum.d.ts +10 -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/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/VideoCaption.d.ts +3 -0
- package/dist/types/models/Voice.d.ts +9 -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 +319 -0
- package/dist/types/services/AiAnalyticsService.d.ts +7034 -0
- package/dist/types/services/AiBotService.d.ts +642 -0
- package/dist/types/services/AiFinetuningService.d.ts +232 -0
- package/dist/types/services/AiIndexService.d.ts +408 -0
- package/dist/types/services/AiMarketingService.d.ts +38 -0
- package/dist/types/services/AiMediaService.d.ts +122 -0
- package/dist/types/services/AiMentorService.d.ts +4937 -0
- package/dist/types/services/AiPromptService.d.ts +1034 -0
- package/dist/types/services/{ServiceService.d.ts → CommerceService.d.ts} +187 -1
- package/dist/types/services/CoreService.d.ts +215 -0
- package/dist/types/services/{MediaResourcesService.d.ts → MediaService.d.ts} +1 -1
- package/dist/types/services/{NotificationService.d.ts → NotificationsService.d.ts} +70 -1
- package/dist/types/services/{OrgsService.d.ts → ScimService.d.ts} +1 -1
- package/dist/types/services/SearchService.d.ts +718 -0
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +335 -28
- 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/CallConfiguration.ts +31 -0
- package/src/models/CallConfigurationModeEnum.ts +12 -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/CourseCreationTask.ts +36 -0
- package/src/models/CourseCreationTaskFile.ts +12 -0
- package/src/models/CourseCreationTaskStatusEnum.ts +20 -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/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/DocumentSettingsResponse.ts +8 -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/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/HeygenTemplateRequest.ts +10 -0
- package/src/models/HeygenTemplateResponseSingle.ts +11 -0
- package/src/models/HeygenVideoDetail.ts +13 -0
- package/src/models/HeygenVideoRequest.ts +10 -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/LlmProviderEnum.ts +12 -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 +92 -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 +89 -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 +52 -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 +65 -0
- package/src/models/MentorSettingsPublic.ts +51 -0
- package/src/models/MentorSettingsRequest.ts +67 -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/{FloatOverTime.ts → MetricChange.ts} +2 -8
- 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/Observation.ts +36 -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/PaginatedHeygenTemplateResponseSingleList.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/PaginatedObservationList.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/PaginatedRetrieverDocumentEmbeddingList.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/PaginatedTraceList.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/PatchedCallConfiguration.ts +31 -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 +89 -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/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/Prompt.ts +27 -0
- package/src/models/PromptCategory.ts +12 -0
- package/src/models/PromptFacet.ts +22 -0
- package/src/models/PromptSearchResponse.ts +40 -0
- package/src/models/PromptVisibilityEnum.ts +14 -0
- package/src/models/Provider05cEnum.ts +18 -0
- package/src/models/Provider637Enum.ts +14 -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/RecommendedCoursesResponse.ts +38 -0
- package/src/models/RelatedText.ts +8 -0
- package/src/models/RequestDataVariable.ts +19 -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 +32 -0
- package/src/models/RetrieverDocumentEmbeddingRequest.ts +63 -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/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/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/StripeCheckoutSessionRequest.ts +2 -2
- package/src/models/{ModeEnum.ts → StripeCheckoutSessionRequestModeEnum.ts} +1 -1
- package/src/models/SttProviderEnum.ts +16 -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 +16 -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/Trace.ts +22 -0
- package/src/models/TrainChatSessionDocumentView.ts +11 -0
- package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
- package/src/models/TrainDocumentViewRequest.ts +67 -0
- package/src/models/TrainDocumentViewResponse.ts +20 -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/TtsProviderEnum.ts +14 -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/UserSentimentCountView.ts +9 -0
- package/src/models/UserTrendByPeriod.ts +10 -0
- package/src/models/VectorResult.ts +13 -0
- package/src/models/VideoCaption.ts +8 -0
- package/src/models/Voice.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 +505 -0
- package/src/services/AiAnalyticsService.ts +11651 -0
- package/src/services/AiBotService.ts +1330 -0
- package/src/services/AiFinetuningService.ts +472 -0
- package/src/services/AiIndexService.ts +719 -0
- package/src/services/AiMarketingService.ts +96 -0
- package/src/services/AiMediaService.ts +289 -0
- package/src/services/AiMentorService.ts +9108 -0
- package/src/services/AiPromptService.ts +1980 -0
- package/src/services/{ServiceService.ts → CommerceService.ts} +339 -1
- package/src/services/CoreService.ts +311 -0
- package/src/services/{MediaResourcesService.ts → MediaService.ts} +1 -1
- package/src/services/{NotificationService.ts → NotificationsService.ts} +139 -1
- package/src/services/{OrgsService.ts → ScimService.ts} +1 -1
- package/src/services/SearchService.ts +1428 -398
- package/dist/types/models/FloatOverTime.d.ts +0 -10
- package/dist/types/models/NetRevenueOverTime.d.ts +0 -8
- package/dist/types/models/Order.d.ts +0 -22
- package/dist/types/models/Product.d.ts +0 -22
- package/dist/types/models/ProductTable.d.ts +0 -26
- package/dist/types/models/RevenueByProduct.d.ts +0 -6
- package/dist/types/models/Summary.d.ts +0 -18
- package/dist/types/services/AnalyticsService.d.ts +0 -83
- package/dist/types/services/AudienceService.d.ts +0 -544
- package/dist/types/services/DepartmentsService.d.ts +0 -80
- package/dist/types/services/EngagementService.d.ts +0 -747
- package/dist/types/services/FinanceService.d.ts +0 -81
- package/dist/types/services/NotificationBuilderService.d.ts +0 -72
- package/dist/types/services/OverviewService.d.ts +0 -283
- package/dist/types/services/PerformanceService.d.ts +0 -259
- package/dist/types/services/PerlearnerService.d.ts +0 -715
- package/dist/types/services/PlatformService.d.ts +0 -496
- package/dist/types/services/ProviderAssociationService.d.ts +0 -17
- package/dist/types/services/ProvidersService.d.ts +0 -164
- package/dist/types/services/ProvisionService.d.ts +0 -15
- package/dist/types/services/RolesService.d.ts +0 -59
- package/dist/types/services/UserGroupsService.d.ts +0 -86
- package/src/models/NetRevenueOverTime.ts +0 -13
- package/src/models/Order.ts +0 -27
- package/src/models/Product.ts +0 -27
- package/src/models/ProductTable.ts +0 -31
- package/src/models/RevenueByProduct.ts +0 -11
- package/src/models/Summary.ts +0 -23
- package/src/services/AnalyticsService.ts +0 -132
- package/src/services/AudienceService.ts +0 -798
- package/src/services/DepartmentsService.ts +0 -122
- package/src/services/EngagementService.ts +0 -1199
- package/src/services/FinanceService.ts +0 -165
- package/src/services/NotificationBuilderService.ts +0 -147
- package/src/services/OverviewService.ts +0 -423
- package/src/services/PerformanceService.ts +0 -405
- package/src/services/PerlearnerService.ts +0 -1321
- package/src/services/PlatformService.ts +0 -884
- package/src/services/ProviderAssociationService.ts +0 -33
- package/src/services/ProvidersService.ts +0 -302
- package/src/services/ProvisionService.ts +0 -31
- package/src/services/RolesService.ts +0 -89
- package/src/services/UserGroupsService.ts +0 -128
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
-
/* istanbul ignore file */
|
|
3
|
-
/* tslint:disable */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
|
-
import { OpenAPI } from '../core/OpenAPI';
|
|
7
|
-
import { request as __request } from '../core/request';
|
|
8
|
-
export class ProviderAssociationService {
|
|
9
|
-
/**
|
|
10
|
-
* Handle callbacks from Stripe after successful checkout.
|
|
11
|
-
*
|
|
12
|
-
* Updates:
|
|
13
|
-
* - Platform launch state
|
|
14
|
-
* - Association configuration status
|
|
15
|
-
* @returns any
|
|
16
|
-
* @throws ApiError
|
|
17
|
-
*/
|
|
18
|
-
public static providerAssociationStripeCallbackRetrieve({
|
|
19
|
-
launchId,
|
|
20
|
-
}: {
|
|
21
|
-
launchId: string,
|
|
22
|
-
}): CancelablePromise<{
|
|
23
|
-
message?: string;
|
|
24
|
-
}> {
|
|
25
|
-
return __request(OpenAPI, {
|
|
26
|
-
method: 'GET',
|
|
27
|
-
url: '/api/provider-association/stripe/callback/{launch_id}/',
|
|
28
|
-
path: {
|
|
29
|
-
'launch_id': launchId,
|
|
30
|
-
},
|
|
31
|
-
});
|
|
32
|
-
}
|
|
33
|
-
}
|
|
@@ -1,302 +0,0 @@
|
|
|
1
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
-
/* istanbul ignore file */
|
|
3
|
-
/* tslint:disable */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
import type { AppleSubscriptionStatusRequest } from '../models/AppleSubscriptionStatusRequest';
|
|
6
|
-
import type { AppleSubscriptionStatusView } from '../models/AppleSubscriptionStatusView';
|
|
7
|
-
import type { AppleVerifyTransactionId } from '../models/AppleVerifyTransactionId';
|
|
8
|
-
import type { AssociateAccountResponse } from '../models/AssociateAccountResponse';
|
|
9
|
-
import type { AssociateAppleAccount } from '../models/AssociateAppleAccount';
|
|
10
|
-
import type { AWSTenantLaunchRequest } from '../models/AWSTenantLaunchRequest';
|
|
11
|
-
import type { BaseResponse } from '../models/BaseResponse';
|
|
12
|
-
import type { GCPTenantLaunchRequest } from '../models/GCPTenantLaunchRequest';
|
|
13
|
-
import type { GooglePayAccountResponse } from '../models/GooglePayAccountResponse';
|
|
14
|
-
import type { GooglePayVerifyToken } from '../models/GooglePayVerifyToken';
|
|
15
|
-
import type { StripeNewUserTenantLaunchRequest } from '../models/StripeNewUserTenantLaunchRequest';
|
|
16
|
-
import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
|
|
17
|
-
import type { VerifyGCPMarketPlaceRequest } from '../models/VerifyGCPMarketPlaceRequest';
|
|
18
|
-
import type { VerifyGCPMarketPlaceResponse } from '../models/VerifyGCPMarketPlaceResponse';
|
|
19
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
20
|
-
import { OpenAPI } from '../core/OpenAPI';
|
|
21
|
-
import { request as __request } from '../core/request';
|
|
22
|
-
export class ProvidersService {
|
|
23
|
-
/**
|
|
24
|
-
* Associate an Apple account with a user known user
|
|
25
|
-
* @returns AssociateAccountResponse
|
|
26
|
-
* @throws ApiError
|
|
27
|
-
*/
|
|
28
|
-
public static providersAppleAssociateAccountCreate({
|
|
29
|
-
requestBody,
|
|
30
|
-
}: {
|
|
31
|
-
requestBody: AssociateAppleAccount,
|
|
32
|
-
}): CancelablePromise<AssociateAccountResponse> {
|
|
33
|
-
return __request(OpenAPI, {
|
|
34
|
-
method: 'POST',
|
|
35
|
-
url: '/api/providers/apple/associate-account/',
|
|
36
|
-
body: requestBody,
|
|
37
|
-
mediaType: 'application/json',
|
|
38
|
-
});
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* View to handle apple webhooks
|
|
42
|
-
* @returns any No response body
|
|
43
|
-
* @throws ApiError
|
|
44
|
-
*/
|
|
45
|
-
public static providersAppleHookCreate(): CancelablePromise<any> {
|
|
46
|
-
return __request(OpenAPI, {
|
|
47
|
-
method: 'POST',
|
|
48
|
-
url: '/api/providers/apple/hook/',
|
|
49
|
-
});
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Returns information about a user subscription status
|
|
53
|
-
* @returns AppleSubscriptionStatusView
|
|
54
|
-
* @throws ApiError
|
|
55
|
-
*/
|
|
56
|
-
public static providersAppleSubscriptionStatusCreate({
|
|
57
|
-
requestBody,
|
|
58
|
-
}: {
|
|
59
|
-
requestBody?: AppleSubscriptionStatusRequest,
|
|
60
|
-
}): CancelablePromise<AppleSubscriptionStatusView> {
|
|
61
|
-
return __request(OpenAPI, {
|
|
62
|
-
method: 'POST',
|
|
63
|
-
url: '/api/providers/apple/subscription-status/',
|
|
64
|
-
body: requestBody,
|
|
65
|
-
mediaType: 'application/json',
|
|
66
|
-
});
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Checks if a provided transaction_id is valid
|
|
70
|
-
* @returns BaseResponse
|
|
71
|
-
* @throws ApiError
|
|
72
|
-
*/
|
|
73
|
-
public static providersAppleValidateTransactionIdCreate({
|
|
74
|
-
requestBody,
|
|
75
|
-
}: {
|
|
76
|
-
requestBody: AppleVerifyTransactionId,
|
|
77
|
-
}): CancelablePromise<BaseResponse> {
|
|
78
|
-
return __request(OpenAPI, {
|
|
79
|
-
method: 'POST',
|
|
80
|
-
url: '/api/providers/apple/validate-transaction-id/',
|
|
81
|
-
body: requestBody,
|
|
82
|
-
mediaType: 'application/json',
|
|
83
|
-
});
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Serves a view that redirects to the AWS marketplace create organization page
|
|
87
|
-
*
|
|
88
|
-
* Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the
|
|
89
|
-
* URL of the AWS marketplace create organization page
|
|
90
|
-
* @returns any No response body
|
|
91
|
-
* @throws ApiError
|
|
92
|
-
*/
|
|
93
|
-
public static providersAwsCreateOrganizationCreate(): CancelablePromise<any> {
|
|
94
|
-
return __request(OpenAPI, {
|
|
95
|
-
method: 'POST',
|
|
96
|
-
url: '/api/providers/aws/create-organization/',
|
|
97
|
-
});
|
|
98
|
-
}
|
|
99
|
-
/**
|
|
100
|
-
* API endpoint to get domain setup status
|
|
101
|
-
* @returns any No response body
|
|
102
|
-
* @throws ApiError
|
|
103
|
-
*/
|
|
104
|
-
public static providersAwsDomainStatusRetrieve(): CancelablePromise<any> {
|
|
105
|
-
return __request(OpenAPI, {
|
|
106
|
-
method: 'GET',
|
|
107
|
-
url: '/api/providers/aws/domain-status/',
|
|
108
|
-
});
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
* Proxy to the Platform launch API
|
|
112
|
-
*
|
|
113
|
-
* We cannot expose launching a tenant to an authorized user hence the need for the API
|
|
114
|
-
*
|
|
115
|
-
* The API validates the x_amzn_marketplace_token and then proxies the request to the Platform Launch API
|
|
116
|
-
* @returns TenantLaunchResponse
|
|
117
|
-
* @throws ApiError
|
|
118
|
-
*/
|
|
119
|
-
public static providersAwsLaunchTenantCreate({
|
|
120
|
-
requestBody,
|
|
121
|
-
}: {
|
|
122
|
-
requestBody: AWSTenantLaunchRequest,
|
|
123
|
-
}): CancelablePromise<TenantLaunchResponse> {
|
|
124
|
-
return __request(OpenAPI, {
|
|
125
|
-
method: 'POST',
|
|
126
|
-
url: '/api/providers/aws/launch-tenant/',
|
|
127
|
-
body: requestBody,
|
|
128
|
-
mediaType: 'application/json',
|
|
129
|
-
});
|
|
130
|
-
}
|
|
131
|
-
/**
|
|
132
|
-
* API endpoint to get/update CNAME records for domain setup
|
|
133
|
-
* @returns any No response body
|
|
134
|
-
* @throws ApiError
|
|
135
|
-
*/
|
|
136
|
-
public static providersAwsSyncDomainRecordsRetrieve(): CancelablePromise<any> {
|
|
137
|
-
return __request(OpenAPI, {
|
|
138
|
-
method: 'GET',
|
|
139
|
-
url: '/api/providers/aws/sync-domain-records/',
|
|
140
|
-
});
|
|
141
|
-
}
|
|
142
|
-
/**
|
|
143
|
-
* API endpoint to get/update CNAME records for domain setup
|
|
144
|
-
* @returns any No response body
|
|
145
|
-
* @throws ApiError
|
|
146
|
-
*/
|
|
147
|
-
public static providersAwsSyncDomainRecordsCreate(): CancelablePromise<any> {
|
|
148
|
-
return __request(OpenAPI, {
|
|
149
|
-
method: 'POST',
|
|
150
|
-
url: '/api/providers/aws/sync-domain-records/',
|
|
151
|
-
});
|
|
152
|
-
}
|
|
153
|
-
/**
|
|
154
|
-
* Serves a view that redirects to the GCP marketplace create organization page
|
|
155
|
-
*
|
|
156
|
-
* Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
|
|
157
|
-
* page
|
|
158
|
-
* @returns any No response body
|
|
159
|
-
* @throws ApiError
|
|
160
|
-
*/
|
|
161
|
-
public static providersGcpCreateOrganizationCreate(): CancelablePromise<any> {
|
|
162
|
-
return __request(OpenAPI, {
|
|
163
|
-
method: 'POST',
|
|
164
|
-
url: '/api/providers/gcp/create-organization/',
|
|
165
|
-
});
|
|
166
|
-
}
|
|
167
|
-
/**
|
|
168
|
-
* Serves a view that redirects to the GCP marketplace create organization page
|
|
169
|
-
*
|
|
170
|
-
* Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
|
|
171
|
-
* page
|
|
172
|
-
* @returns any No response body
|
|
173
|
-
* @throws ApiError
|
|
174
|
-
*/
|
|
175
|
-
public static providersGcpCreateOrganizationCreate2({
|
|
176
|
-
productId,
|
|
177
|
-
}: {
|
|
178
|
-
productId: string,
|
|
179
|
-
}): CancelablePromise<any> {
|
|
180
|
-
return __request(OpenAPI, {
|
|
181
|
-
method: 'POST',
|
|
182
|
-
url: '/api/providers/gcp/create-organization/{product_id}/',
|
|
183
|
-
path: {
|
|
184
|
-
'product_id': productId,
|
|
185
|
-
},
|
|
186
|
-
});
|
|
187
|
-
}
|
|
188
|
-
/**
|
|
189
|
-
* @returns any No response body
|
|
190
|
-
* @throws ApiError
|
|
191
|
-
*/
|
|
192
|
-
public static providersGcpHookCreate(): CancelablePromise<any> {
|
|
193
|
-
return __request(OpenAPI, {
|
|
194
|
-
method: 'POST',
|
|
195
|
-
url: '/api/providers/gcp/hook/',
|
|
196
|
-
});
|
|
197
|
-
}
|
|
198
|
-
/**
|
|
199
|
-
* Proxy to the Platform launch API
|
|
200
|
-
*
|
|
201
|
-
* We cannot expose launching a tenant to an authorized user hence the need for the API
|
|
202
|
-
*
|
|
203
|
-
* The API validates the x_gcp_marketplace_token and then proxies the request to the Platform Launc API
|
|
204
|
-
* @returns TenantLaunchResponse
|
|
205
|
-
* @throws ApiError
|
|
206
|
-
*/
|
|
207
|
-
public static providersGcpLaunchTenantCreate({
|
|
208
|
-
requestBody,
|
|
209
|
-
}: {
|
|
210
|
-
requestBody: GCPTenantLaunchRequest,
|
|
211
|
-
}): CancelablePromise<TenantLaunchResponse> {
|
|
212
|
-
return __request(OpenAPI, {
|
|
213
|
-
method: 'POST',
|
|
214
|
-
url: '/api/providers/gcp/launch-tenant/',
|
|
215
|
-
body: requestBody,
|
|
216
|
-
mediaType: 'application/json',
|
|
217
|
-
});
|
|
218
|
-
}
|
|
219
|
-
/**
|
|
220
|
-
* @returns VerifyGCPMarketPlaceResponse
|
|
221
|
-
* @throws ApiError
|
|
222
|
-
*/
|
|
223
|
-
public static providersGcpValidateSignupTokenCreate({
|
|
224
|
-
requestBody,
|
|
225
|
-
}: {
|
|
226
|
-
requestBody: VerifyGCPMarketPlaceRequest,
|
|
227
|
-
}): CancelablePromise<VerifyGCPMarketPlaceResponse> {
|
|
228
|
-
return __request(OpenAPI, {
|
|
229
|
-
method: 'POST',
|
|
230
|
-
url: '/api/providers/gcp/validate-signup-token/',
|
|
231
|
-
body: requestBody,
|
|
232
|
-
mediaType: 'application/json',
|
|
233
|
-
});
|
|
234
|
-
}
|
|
235
|
-
/**
|
|
236
|
-
* Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
|
|
237
|
-
* @returns GooglePayAccountResponse
|
|
238
|
-
* @throws ApiError
|
|
239
|
-
*/
|
|
240
|
-
public static providersGooglePayGetAccountRetrieve({
|
|
241
|
-
bundleId,
|
|
242
|
-
}: {
|
|
243
|
-
bundleId: string,
|
|
244
|
-
}): CancelablePromise<GooglePayAccountResponse> {
|
|
245
|
-
return __request(OpenAPI, {
|
|
246
|
-
method: 'GET',
|
|
247
|
-
url: '/api/providers/google-pay/get-account/{bundle_id}',
|
|
248
|
-
path: {
|
|
249
|
-
'bundle_id': bundleId,
|
|
250
|
-
},
|
|
251
|
-
});
|
|
252
|
-
}
|
|
253
|
-
/**
|
|
254
|
-
* View to handle Google Pay webhooks
|
|
255
|
-
* @returns any No response body
|
|
256
|
-
* @throws ApiError
|
|
257
|
-
*/
|
|
258
|
-
public static providersGooglePayHookCreate(): CancelablePromise<any> {
|
|
259
|
-
return __request(OpenAPI, {
|
|
260
|
-
method: 'POST',
|
|
261
|
-
url: '/api/providers/google-pay/hook/',
|
|
262
|
-
});
|
|
263
|
-
}
|
|
264
|
-
/**
|
|
265
|
-
* Associate a Google Pay account with a known user
|
|
266
|
-
* @returns BaseResponse
|
|
267
|
-
* @throws ApiError
|
|
268
|
-
*/
|
|
269
|
-
public static providersGooglePayValidateTransactionIdCreate({
|
|
270
|
-
requestBody,
|
|
271
|
-
}: {
|
|
272
|
-
requestBody: GooglePayVerifyToken,
|
|
273
|
-
}): CancelablePromise<BaseResponse> {
|
|
274
|
-
return __request(OpenAPI, {
|
|
275
|
-
method: 'POST',
|
|
276
|
-
url: '/api/providers/google-pay/validate-transaction-id/',
|
|
277
|
-
body: requestBody,
|
|
278
|
-
mediaType: 'application/json',
|
|
279
|
-
});
|
|
280
|
-
}
|
|
281
|
-
/**
|
|
282
|
-
* Proxy to the Platform launch API
|
|
283
|
-
*
|
|
284
|
-
* We cannot expose launching a tenant to an unauthorized user hence the need for the API
|
|
285
|
-
*
|
|
286
|
-
* The API validates the stripe_checkout_id and then proxies the request to the Platform Launch API
|
|
287
|
-
* @returns TenantLaunchResponse
|
|
288
|
-
* @throws ApiError
|
|
289
|
-
*/
|
|
290
|
-
public static providersStripeCreateOrganizationCreate({
|
|
291
|
-
requestBody,
|
|
292
|
-
}: {
|
|
293
|
-
requestBody: StripeNewUserTenantLaunchRequest,
|
|
294
|
-
}): CancelablePromise<TenantLaunchResponse> {
|
|
295
|
-
return __request(OpenAPI, {
|
|
296
|
-
method: 'POST',
|
|
297
|
-
url: '/api/providers/stripe/create-organization/',
|
|
298
|
-
body: requestBody,
|
|
299
|
-
mediaType: 'application/json',
|
|
300
|
-
});
|
|
301
|
-
}
|
|
302
|
-
}
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
-
/* istanbul ignore file */
|
|
3
|
-
/* tslint:disable */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
|
-
import { OpenAPI } from '../core/OpenAPI';
|
|
7
|
-
import { request as __request } from '../core/request';
|
|
8
|
-
export class ProvisionService {
|
|
9
|
-
/**
|
|
10
|
-
* POST
|
|
11
|
-
* Update platform provisioning config
|
|
12
|
-
*
|
|
13
|
-
* request body:
|
|
14
|
-
* {"config_name": "demo_config}
|
|
15
|
-
* @returns any No response body
|
|
16
|
-
* @throws ApiError
|
|
17
|
-
*/
|
|
18
|
-
public static provisionCreate({
|
|
19
|
-
configName,
|
|
20
|
-
}: {
|
|
21
|
-
configName: string,
|
|
22
|
-
}): CancelablePromise<any> {
|
|
23
|
-
return __request(OpenAPI, {
|
|
24
|
-
method: 'POST',
|
|
25
|
-
url: '/api/provision/{config_name}/',
|
|
26
|
-
path: {
|
|
27
|
-
'config_name': configName,
|
|
28
|
-
},
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
}
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
-
/* istanbul ignore file */
|
|
3
|
-
/* tslint:disable */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
import type { DesiredRole } from '../models/DesiredRole';
|
|
6
|
-
import type { ReportedRole } from '../models/ReportedRole';
|
|
7
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
|
-
import { OpenAPI } from '../core/OpenAPI';
|
|
9
|
-
import { request as __request } from '../core/request';
|
|
10
|
-
export class RolesService {
|
|
11
|
-
/**
|
|
12
|
-
* Retrieve a user's desired role information.
|
|
13
|
-
*
|
|
14
|
-
* This endpoint returns the role and skills that a user has indicated
|
|
15
|
-
* they want to develop or acquire. This represents the user's career
|
|
16
|
-
* goals and learning objectives.
|
|
17
|
-
*
|
|
18
|
-
* Path Parameters:
|
|
19
|
-
* org (str): The platform/organization identifier
|
|
20
|
-
* username (str): The username of the user to retrieve role information for
|
|
21
|
-
*
|
|
22
|
-
* Returns:
|
|
23
|
-
* The user's desired role information including:
|
|
24
|
-
* - Target role title
|
|
25
|
-
* - Skills needed for the role
|
|
26
|
-
* - Current progress toward skill acquisition
|
|
27
|
-
*
|
|
28
|
-
* Error Responses:
|
|
29
|
-
* 400 Bad Request: If the user doesn't exist in the platform or has no desired role
|
|
30
|
-
* 404 Not Found: If the specified platform doesn't exist
|
|
31
|
-
* @returns DesiredRole
|
|
32
|
-
* @throws ApiError
|
|
33
|
-
*/
|
|
34
|
-
public static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve({
|
|
35
|
-
org,
|
|
36
|
-
username,
|
|
37
|
-
}: {
|
|
38
|
-
org: string,
|
|
39
|
-
username: string,
|
|
40
|
-
}): CancelablePromise<DesiredRole> {
|
|
41
|
-
return __request(OpenAPI, {
|
|
42
|
-
method: 'GET',
|
|
43
|
-
url: '/api/roles/platform/orgs/{org}/roles/users/{username}/desired-roles/',
|
|
44
|
-
path: {
|
|
45
|
-
'org': org,
|
|
46
|
-
'username': username,
|
|
47
|
-
},
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Retrieve a user's reported role information.
|
|
52
|
-
*
|
|
53
|
-
* This endpoint returns the role and skills that a user has reported
|
|
54
|
-
* having in their profile. This represents the user's current skills
|
|
55
|
-
* and professional role.
|
|
56
|
-
*
|
|
57
|
-
* Path Parameters:
|
|
58
|
-
* org (str): The platform/organization identifier
|
|
59
|
-
* username (str): The username of the user to retrieve role information for
|
|
60
|
-
*
|
|
61
|
-
* Returns:
|
|
62
|
-
* The user's reported role information including:
|
|
63
|
-
* - Role title
|
|
64
|
-
* - Skills associated with the role
|
|
65
|
-
* - Experience level
|
|
66
|
-
*
|
|
67
|
-
* Error Responses:
|
|
68
|
-
* 400 Bad Request: If the user doesn't exist in the platform or has no reported role
|
|
69
|
-
* 404 Not Found: If the specified platform doesn't exist
|
|
70
|
-
* @returns ReportedRole
|
|
71
|
-
* @throws ApiError
|
|
72
|
-
*/
|
|
73
|
-
public static rolesPlatformOrgsRolesUsersReportedRolesRetrieve({
|
|
74
|
-
org,
|
|
75
|
-
username,
|
|
76
|
-
}: {
|
|
77
|
-
org: string,
|
|
78
|
-
username: string,
|
|
79
|
-
}): CancelablePromise<ReportedRole> {
|
|
80
|
-
return __request(OpenAPI, {
|
|
81
|
-
method: 'GET',
|
|
82
|
-
url: '/api/roles/platform/orgs/{org}/roles/users/{username}/reported-roles/',
|
|
83
|
-
path: {
|
|
84
|
-
'org': org,
|
|
85
|
-
'username': username,
|
|
86
|
-
},
|
|
87
|
-
});
|
|
88
|
-
}
|
|
89
|
-
}
|
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
-
/* istanbul ignore file */
|
|
3
|
-
/* tslint:disable */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
import type { GroupList } from '../models/GroupList';
|
|
6
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
7
|
-
import { OpenAPI } from '../core/OpenAPI';
|
|
8
|
-
import { request as __request } from '../core/request';
|
|
9
|
-
export class UserGroupsService {
|
|
10
|
-
/**
|
|
11
|
-
* Get a list of user groups with metrics and filtering options.
|
|
12
|
-
*
|
|
13
|
-
* This endpoint provides a paginated list of user groups with aggregated metrics
|
|
14
|
-
* about learner performance, course completions, and skill acquisition.
|
|
15
|
-
*
|
|
16
|
-
* This endpoint uses DM token authentication and respects department-based
|
|
17
|
-
* access controls.
|
|
18
|
-
*
|
|
19
|
-
* Query Parameters:
|
|
20
|
-
* page (int, optional): Page number for pagination
|
|
21
|
-
* length (int, optional): Number of items per page
|
|
22
|
-
* program (str, optional): Filter by program
|
|
23
|
-
* pathway (str, optional): Filter by pathway
|
|
24
|
-
* groups (list, optional): Filter by group names
|
|
25
|
-
* location (str, optional): Filter by location
|
|
26
|
-
* is_enrolled (bool, optional): Filter for groups with enrolled users
|
|
27
|
-
* start_date (date, optional): Filter by learner join date (start range)
|
|
28
|
-
* end_date (date, optional): Filter by learner join date (end range)
|
|
29
|
-
*
|
|
30
|
-
* Returns:
|
|
31
|
-
* A paginated list of user groups with comprehensive metrics.
|
|
32
|
-
*
|
|
33
|
-
* Access Control:
|
|
34
|
-
* - Platform admins can see all groups
|
|
35
|
-
* - Department admins can only see groups in their departments
|
|
36
|
-
* @returns GroupList
|
|
37
|
-
* @throws ApiError
|
|
38
|
-
*/
|
|
39
|
-
public static userGroupsOrgsRetrieve({
|
|
40
|
-
key,
|
|
41
|
-
departmentId,
|
|
42
|
-
endDate,
|
|
43
|
-
format = 'json',
|
|
44
|
-
groups,
|
|
45
|
-
includeMainPlatform = true,
|
|
46
|
-
isEnrolled,
|
|
47
|
-
length,
|
|
48
|
-
location,
|
|
49
|
-
page,
|
|
50
|
-
pathway,
|
|
51
|
-
program,
|
|
52
|
-
startDate,
|
|
53
|
-
}: {
|
|
54
|
-
key: string,
|
|
55
|
-
/**
|
|
56
|
-
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
57
|
-
*/
|
|
58
|
-
departmentId?: number,
|
|
59
|
-
/**
|
|
60
|
-
* Filter by learners date_joined. Start date. ISO 8601
|
|
61
|
-
*/
|
|
62
|
-
endDate?: string,
|
|
63
|
-
/**
|
|
64
|
-
* Format
|
|
65
|
-
*
|
|
66
|
-
* * `json` - json
|
|
67
|
-
*/
|
|
68
|
-
format?: 'json',
|
|
69
|
-
/**
|
|
70
|
-
* Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
|
|
71
|
-
*/
|
|
72
|
-
groups?: Array<string>,
|
|
73
|
-
/**
|
|
74
|
-
* Include main platform data
|
|
75
|
-
*/
|
|
76
|
-
includeMainPlatform?: boolean,
|
|
77
|
-
/**
|
|
78
|
-
* Filter for users who have at least an enrollment
|
|
79
|
-
*/
|
|
80
|
-
isEnrolled?: boolean | null,
|
|
81
|
-
/**
|
|
82
|
-
* Size of data to return
|
|
83
|
-
*/
|
|
84
|
-
length?: number,
|
|
85
|
-
/**
|
|
86
|
-
* Location search string
|
|
87
|
-
*/
|
|
88
|
-
location?: string,
|
|
89
|
-
/**
|
|
90
|
-
* Page offset
|
|
91
|
-
*/
|
|
92
|
-
page?: number,
|
|
93
|
-
/**
|
|
94
|
-
* Pathway string
|
|
95
|
-
*/
|
|
96
|
-
pathway?: string,
|
|
97
|
-
/**
|
|
98
|
-
* Program search string
|
|
99
|
-
*/
|
|
100
|
-
program?: string,
|
|
101
|
-
/**
|
|
102
|
-
* Filter by learners date_joined. Start date. ISO 8601
|
|
103
|
-
*/
|
|
104
|
-
startDate?: string,
|
|
105
|
-
}): CancelablePromise<GroupList> {
|
|
106
|
-
return __request(OpenAPI, {
|
|
107
|
-
method: 'GET',
|
|
108
|
-
url: '/api/user-groups/orgs/{key}/',
|
|
109
|
-
path: {
|
|
110
|
-
'key': key,
|
|
111
|
-
},
|
|
112
|
-
query: {
|
|
113
|
-
'department_id': departmentId,
|
|
114
|
-
'end_date': endDate,
|
|
115
|
-
'format': format,
|
|
116
|
-
'groups': groups,
|
|
117
|
-
'include_main_platform': includeMainPlatform,
|
|
118
|
-
'is_enrolled': isEnrolled,
|
|
119
|
-
'length': length,
|
|
120
|
-
'location': location,
|
|
121
|
-
'page': page,
|
|
122
|
-
'pathway': pathway,
|
|
123
|
-
'program': program,
|
|
124
|
-
'start_date': startDate,
|
|
125
|
-
},
|
|
126
|
-
});
|
|
127
|
-
}
|
|
128
|
-
}
|