diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index fa9293d..b98aa4a 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -4,6 +4,7 @@ .openapi-generator-ignore .travis.yml README.md +docs/AIGeneratedImage.md docs/APITokenCost.md docs/AcceptanceEnum.md docs/ActiveUsersData.md @@ -38,14 +39,17 @@ docs/BulkCreateAssertion.md docs/CareerApi.md docs/ChartsessionMentor.md docs/ChatHistory.md +docs/ChatHistoryFilterData.md docs/ChatHistoryItem.md docs/ChatHistorySessionId.md docs/ChatSessionRequest.md docs/ChatSessionResponse.md docs/ChatSessionWithMessage.md docs/CheckDocumentTrainingStatus.md +docs/Company.md docs/ConversationMessage.md docs/ConversationVolume.md +docs/Conversations.md docs/CoreApi.md docs/Count.md docs/CountData.md @@ -70,12 +74,14 @@ docs/DataSet.md docs/DataSetCreate.md docs/DataSetPlatformValue.md docs/DataSetStatusEnum.md +docs/DateRange.md docs/DesiredSkill.md docs/DetailedGradeSubsection.md docs/DetailedGradeView.md docs/DetailedGradeViewData.md docs/DiscordConfig.md docs/DiscordWebhook.md +docs/Education.md docs/EngagementApi.md docs/EngagementPerCourse.md docs/EngagementPerCourseData.md @@ -83,6 +89,7 @@ docs/Enrollments.md docs/EnrollmentsData.md docs/EnrollmentsPerUser.md docs/EnrollmentsPerUserData.md +docs/Experience.md docs/FinanceApi.md docs/FloatOverTime.md docs/FreeUsageCount.md @@ -93,10 +100,13 @@ docs/IBLAIPlatformMeta.md docs/IBLAIPlatformMetaRequest.md docs/IBLAIPlatformMetaUpdateRequest.md docs/ImageUpload.md +docs/Institution.md +docs/InstitutionTypeEnum.md docs/IntegrationCredential.md docs/Issuer.md docs/IssuerAuthority.md docs/JobRun.md +docs/LLMCredentialResponse.md docs/LLMModelForTenant.md docs/LLMResponse.md docs/LLMScoresView.md @@ -107,38 +117,53 @@ docs/LLMTracesListResponse.md docs/LanguagesView.md docs/LearnerInformationAPI.md docs/LearnerInformationAPIData.md +docs/LtiKey.md +docs/LtiLaunchGate.md +docs/LtiTool.md docs/MainCreds.md +docs/MemoryStatusRequestView.md +docs/MemoryStatusView.md docs/Mentor.md docs/MentorCategory.md docs/MentorData.md docs/MentorDetailAnalytics.md docs/MentorFromTemplateRequest.md docs/MentorFromTemplateWithSettingRequest.md +docs/MentorMetadata.md docs/MentorSettings.md docs/MentorSettingsMentorVisibility.md docs/MentorSettingsRequest.md docs/MentorTrace.md docs/MentorVisibilityEnum.md docs/MentorWizard.md +docs/MessageStatus.md docs/MessageView.md docs/MessageViewRequest.md docs/MessageViewUpdatResponse.md +docs/Metadata.md docs/ModelCost.md docs/ModelUsage.md -docs/MonitoringApi.md +docs/ModerationLog.md docs/NetRevenueOverTime.md +docs/Notification.md +docs/NotificationApi.md +docs/NotificationCount.md +docs/NotificationStatusEnum.md docs/NullEnum.md docs/Observation.md docs/Order.md docs/OverTime.md -docs/Overtime.md +docs/OverTimeWithTotal.md docs/OvertimeMeta.md docs/OvertimeWithChangeInfo.md docs/OverviewApi.md docs/PageContent.md +docs/PaginatedAIGeneratedImageList.md +docs/PaginatedConversationsList.md docs/PaginatedDataSetList.md docs/PaginatedJobRunList.md docs/PaginatedMentorList.md +docs/PaginatedModerationLogList.md docs/PaginatedPeriodicAgentList.md docs/PaginatedPeriodicAgentLogList.md docs/PaginatedPlayWrightScriptList.md @@ -151,6 +176,7 @@ docs/PatchedCredentialRequest.md docs/PatchedDataSet.md docs/PatchedDiscordConfig.md docs/PatchedMentor.md +docs/PatchedNotification.md docs/PatchedPeriodicAgentCreate.md docs/PatchedPlatformPublicMetadata.md docs/PatchedPlayWrightScript.md @@ -198,6 +224,8 @@ docs/PredictiveAnalyticsResponse.md docs/PreviousAgentStatusEnum.md docs/Product.md docs/ProductTable.md +docs/Program.md +docs/ProgramTypeEnum.md docs/Prompt.md docs/PromptCategory.md docs/PromptVisibilityEnum.md @@ -208,6 +236,8 @@ docs/RatingEnum.md docs/RecommendCourseResponse.md docs/RecommendationSearchAPI.md docs/RecommendationsApi.md +docs/RedirectTokenRequest.md +docs/RedirectTokenResponse.md docs/RelatedText.md docs/ReportCreate.md docs/ReportData.md @@ -218,20 +248,25 @@ docs/ReportedSkill.md docs/ReportsApi.md docs/RequestDataVariable.md docs/ResourcePoint.md +docs/ResourceScrappedData.md docs/ResponseDataVariable.md docs/RetreiverTrainViewRequest.md docs/RetreiverTrainViewResponse.md docs/RetrieveTask.md docs/RetrieverDocumentEmbedding.md docs/RetrieverDocumentEmbeddingRequest.md +docs/RetrieverDocumentEmbeddingTrainingStatus.md docs/RetrieverRequestSearch.md docs/RetrieverRequestSearchDocument.md docs/RetrieverResponseSearch.md docs/ReuestDataVariableList.md docs/RevenueByProduct.md +docs/ScanWebhookRequest.md +docs/ScanWebhookResponse.md docs/Score.md docs/ScoreSummary.md docs/SearchApi.md +docs/SeedMentorsView.md docs/SessionBrowserScreenshot.md docs/SessionDetail.md docs/ShellLogs.md @@ -249,7 +284,9 @@ docs/StylesView.md docs/SubTimeChild.md docs/Summary.md docs/TagsView.md +docs/TargetSystemEnum.md docs/TaskView.md +docs/TemplateMentor.md docs/TenantMentorTraces.md docs/ThemeEnum.md docs/TimeChildData.md @@ -287,6 +324,7 @@ docs/UserChatMemoryStatusRequestView.md docs/UserChatMemoryStatusView.md docs/UserChatMemoryUpdateView.md docs/UserEdxMemory.md +docs/UserInfo.md docs/UserMemoryContextRequest.md docs/UserMemoryContextResponse.md docs/UserSentimentCountView.md @@ -326,7 +364,7 @@ iblai/api/core_api.py iblai/api/credentials_api.py iblai/api/engagement_api.py iblai/api/finance_api.py -iblai/api/monitoring_api.py +iblai/api/notification_api.py iblai/api/overview_api.py iblai/api/performance_api.py iblai/api/perlearner_api.py @@ -348,6 +386,7 @@ iblai/models/active_users_per_course.py iblai/models/active_users_per_course_data.py iblai/models/activity_api.py iblai/models/activity_data.py +iblai/models/ai_generated_image.py iblai/models/align_mentor_bubble_enum.py iblai/models/api_token_cost.py iblai/models/assertion.py @@ -365,14 +404,17 @@ iblai/models/bot_create.py iblai/models/bulk_create_assertion.py iblai/models/chartsession_mentor.py iblai/models/chat_history.py +iblai/models/chat_history_filter_data.py iblai/models/chat_history_item.py iblai/models/chat_history_session_id.py iblai/models/chat_session_request.py iblai/models/chat_session_response.py iblai/models/chat_session_with_message.py iblai/models/check_document_training_status.py +iblai/models/company.py iblai/models/conversation_message.py iblai/models/conversation_volume.py +iblai/models/conversations.py iblai/models/count.py iblai/models/count_data.py iblai/models/course_completion_per_course.py @@ -395,18 +437,21 @@ iblai/models/data_set.py iblai/models/data_set_create.py iblai/models/data_set_platform_value.py iblai/models/data_set_status_enum.py +iblai/models/date_range.py iblai/models/desired_skill.py iblai/models/detailed_grade_subsection.py iblai/models/detailed_grade_view.py iblai/models/detailed_grade_view_data.py iblai/models/discord_config.py iblai/models/discord_webhook.py +iblai/models/education.py iblai/models/engagement_per_course.py iblai/models/engagement_per_course_data.py iblai/models/enrollments.py iblai/models/enrollments_data.py iblai/models/enrollments_per_user.py iblai/models/enrollments_per_user_data.py +iblai/models/experience.py iblai/models/float_over_time.py iblai/models/free_usage_count.py iblai/models/grading_per_user.py @@ -416,6 +461,8 @@ iblai/models/iblai_platform_meta.py iblai/models/iblai_platform_meta_request.py iblai/models/iblai_platform_meta_update_request.py iblai/models/image_upload.py +iblai/models/institution.py +iblai/models/institution_type_enum.py iblai/models/integration_credential.py iblai/models/issuer.py iblai/models/issuer_authority.py @@ -423,6 +470,7 @@ iblai/models/job_run.py iblai/models/languages_view.py iblai/models/learner_information_api.py iblai/models/learner_information_api_data.py +iblai/models/llm_credential_response.py iblai/models/llm_model_for_tenant.py iblai/models/llm_response.py iblai/models/llm_scores_view.py @@ -430,36 +478,51 @@ iblai/models/llm_scores_view_request.py iblai/models/llm_scores_view_response.py iblai/models/llm_trace_detail.py iblai/models/llm_traces_list_response.py +iblai/models/lti_key.py +iblai/models/lti_launch_gate.py +iblai/models/lti_tool.py iblai/models/main_creds.py +iblai/models/memory_status_request_view.py +iblai/models/memory_status_view.py iblai/models/mentor.py iblai/models/mentor_category.py iblai/models/mentor_data.py iblai/models/mentor_detail_analytics.py iblai/models/mentor_from_template_request.py iblai/models/mentor_from_template_with_setting_request.py +iblai/models/mentor_metadata.py iblai/models/mentor_settings.py iblai/models/mentor_settings_mentor_visibility.py iblai/models/mentor_settings_request.py iblai/models/mentor_trace.py iblai/models/mentor_visibility_enum.py iblai/models/mentor_wizard.py +iblai/models/message_status.py iblai/models/message_view.py iblai/models/message_view_request.py iblai/models/message_view_updat_response.py +iblai/models/metadata.py iblai/models/model_cost.py iblai/models/model_usage.py +iblai/models/moderation_log.py iblai/models/net_revenue_over_time.py +iblai/models/notification.py +iblai/models/notification_count.py +iblai/models/notification_status_enum.py iblai/models/null_enum.py iblai/models/observation.py iblai/models/order.py iblai/models/over_time.py -iblai/models/overtime.py +iblai/models/over_time_with_total.py iblai/models/overtime_meta.py iblai/models/overtime_with_change_info.py iblai/models/page_content.py +iblai/models/paginated_ai_generated_image_list.py +iblai/models/paginated_conversations_list.py iblai/models/paginated_data_set_list.py iblai/models/paginated_job_run_list.py iblai/models/paginated_mentor_list.py +iblai/models/paginated_moderation_log_list.py iblai/models/paginated_periodic_agent_list.py iblai/models/paginated_periodic_agent_log_list.py iblai/models/paginated_play_wright_script_list.py @@ -472,6 +535,7 @@ iblai/models/patched_credential_request.py iblai/models/patched_data_set.py iblai/models/patched_discord_config.py iblai/models/patched_mentor.py +iblai/models/patched_notification.py iblai/models/patched_periodic_agent_create.py iblai/models/patched_platform_public_metadata.py iblai/models/patched_play_wright_script.py @@ -516,6 +580,8 @@ iblai/models/predictive_analytics_response.py iblai/models/previous_agent_status_enum.py iblai/models/product.py iblai/models/product_table.py +iblai/models/program.py +iblai/models/program_type_enum.py iblai/models/prompt.py iblai/models/prompt_category.py iblai/models/prompt_visibility_enum.py @@ -525,6 +591,8 @@ iblai/models/query_endpoint.py iblai/models/rating_enum.py iblai/models/recommend_course_response.py iblai/models/recommendation_search_api.py +iblai/models/redirect_token_request.py +iblai/models/redirect_token_response.py iblai/models/related_text.py iblai/models/report_create.py iblai/models/report_data.py @@ -534,19 +602,24 @@ iblai/models/report_status.py iblai/models/reported_skill.py iblai/models/request_data_variable.py iblai/models/resource_point.py +iblai/models/resource_scrapped_data.py iblai/models/response_data_variable.py iblai/models/retreiver_train_view_request.py iblai/models/retreiver_train_view_response.py iblai/models/retrieve_task.py iblai/models/retriever_document_embedding.py iblai/models/retriever_document_embedding_request.py +iblai/models/retriever_document_embedding_training_status.py iblai/models/retriever_request_search.py iblai/models/retriever_request_search_document.py iblai/models/retriever_response_search.py iblai/models/reuest_data_variable_list.py iblai/models/revenue_by_product.py +iblai/models/scan_webhook_request.py +iblai/models/scan_webhook_response.py iblai/models/score.py iblai/models/score_summary.py +iblai/models/seed_mentors_view.py iblai/models/session_browser_screenshot.py iblai/models/session_detail.py iblai/models/shell_logs.py @@ -563,7 +636,9 @@ iblai/models/styles_view.py iblai/models/sub_time_child.py iblai/models/summary.py iblai/models/tags_view.py +iblai/models/target_system_enum.py iblai/models/task_view.py +iblai/models/template_mentor.py iblai/models/tenant_mentor_traces.py iblai/models/theme_enum.py iblai/models/time_child_data.py @@ -601,6 +676,7 @@ iblai/models/user_chat_memory_status_request_view.py iblai/models/user_chat_memory_status_view.py iblai/models/user_chat_memory_update_view.py iblai/models/user_edx_memory.py +iblai/models/user_info.py iblai/models/user_memory_context_request.py iblai/models/user_memory_context_response.py iblai/models/user_sentiment_count_view.py @@ -642,6 +718,7 @@ test/test_ai_account_api.py test/test_ai_analytics_api.py test/test_ai_bot_api.py test/test_ai_finetuning_api.py +test/test_ai_generated_image.py test/test_ai_index_api.py test/test_ai_mentor_api.py test/test_ai_prompt_api.py @@ -665,14 +742,17 @@ test/test_bulk_create_assertion.py test/test_career_api.py test/test_chartsession_mentor.py test/test_chat_history.py +test/test_chat_history_filter_data.py test/test_chat_history_item.py test/test_chat_history_session_id.py test/test_chat_session_request.py test/test_chat_session_response.py test/test_chat_session_with_message.py test/test_check_document_training_status.py +test/test_company.py test/test_conversation_message.py test/test_conversation_volume.py +test/test_conversations.py test/test_core_api.py test/test_count.py test/test_count_data.py @@ -697,12 +777,14 @@ test/test_data_set.py test/test_data_set_create.py test/test_data_set_platform_value.py test/test_data_set_status_enum.py +test/test_date_range.py test/test_desired_skill.py test/test_detailed_grade_subsection.py test/test_detailed_grade_view.py test/test_detailed_grade_view_data.py test/test_discord_config.py test/test_discord_webhook.py +test/test_education.py test/test_engagement_api.py test/test_engagement_per_course.py test/test_engagement_per_course_data.py @@ -710,6 +792,7 @@ test/test_enrollments.py test/test_enrollments_data.py test/test_enrollments_per_user.py test/test_enrollments_per_user_data.py +test/test_experience.py test/test_finance_api.py test/test_float_over_time.py test/test_free_usage_count.py @@ -720,6 +803,8 @@ test/test_iblai_platform_meta.py test/test_iblai_platform_meta_request.py test/test_iblai_platform_meta_update_request.py test/test_image_upload.py +test/test_institution.py +test/test_institution_type_enum.py test/test_integration_credential.py test/test_issuer.py test/test_issuer_authority.py @@ -727,6 +812,7 @@ test/test_job_run.py test/test_languages_view.py test/test_learner_information_api.py test/test_learner_information_api_data.py +test/test_llm_credential_response.py test/test_llm_model_for_tenant.py test/test_llm_response.py test/test_llm_scores_view.py @@ -734,38 +820,53 @@ test/test_llm_scores_view_request.py test/test_llm_scores_view_response.py test/test_llm_trace_detail.py test/test_llm_traces_list_response.py +test/test_lti_key.py +test/test_lti_launch_gate.py +test/test_lti_tool.py test/test_main_creds.py +test/test_memory_status_request_view.py +test/test_memory_status_view.py test/test_mentor.py test/test_mentor_category.py test/test_mentor_data.py test/test_mentor_detail_analytics.py test/test_mentor_from_template_request.py test/test_mentor_from_template_with_setting_request.py +test/test_mentor_metadata.py test/test_mentor_settings.py test/test_mentor_settings_mentor_visibility.py test/test_mentor_settings_request.py test/test_mentor_trace.py test/test_mentor_visibility_enum.py test/test_mentor_wizard.py +test/test_message_status.py test/test_message_view.py test/test_message_view_request.py test/test_message_view_updat_response.py +test/test_metadata.py test/test_model_cost.py test/test_model_usage.py -test/test_monitoring_api.py +test/test_moderation_log.py test/test_net_revenue_over_time.py +test/test_notification.py +test/test_notification_api.py +test/test_notification_count.py +test/test_notification_status_enum.py test/test_null_enum.py test/test_observation.py test/test_order.py test/test_over_time.py -test/test_overtime.py +test/test_over_time_with_total.py test/test_overtime_meta.py test/test_overtime_with_change_info.py test/test_overview_api.py test/test_page_content.py +test/test_paginated_ai_generated_image_list.py +test/test_paginated_conversations_list.py test/test_paginated_data_set_list.py test/test_paginated_job_run_list.py test/test_paginated_mentor_list.py +test/test_paginated_moderation_log_list.py test/test_paginated_periodic_agent_list.py test/test_paginated_periodic_agent_log_list.py test/test_paginated_play_wright_script_list.py @@ -778,6 +879,7 @@ test/test_patched_credential_request.py test/test_patched_data_set.py test/test_patched_discord_config.py test/test_patched_mentor.py +test/test_patched_notification.py test/test_patched_periodic_agent_create.py test/test_patched_platform_public_metadata.py test/test_patched_play_wright_script.py @@ -825,6 +927,8 @@ test/test_predictive_analytics_response.py test/test_previous_agent_status_enum.py test/test_product.py test/test_product_table.py +test/test_program.py +test/test_program_type_enum.py test/test_prompt.py test/test_prompt_category.py test/test_prompt_visibility_enum.py @@ -835,6 +939,8 @@ test/test_rating_enum.py test/test_recommend_course_response.py test/test_recommendation_search_api.py test/test_recommendations_api.py +test/test_redirect_token_request.py +test/test_redirect_token_response.py test/test_related_text.py test/test_report_create.py test/test_report_data.py @@ -845,20 +951,25 @@ test/test_reported_skill.py test/test_reports_api.py test/test_request_data_variable.py test/test_resource_point.py +test/test_resource_scrapped_data.py test/test_response_data_variable.py test/test_retreiver_train_view_request.py test/test_retreiver_train_view_response.py test/test_retrieve_task.py test/test_retriever_document_embedding.py test/test_retriever_document_embedding_request.py +test/test_retriever_document_embedding_training_status.py test/test_retriever_request_search.py test/test_retriever_request_search_document.py test/test_retriever_response_search.py test/test_reuest_data_variable_list.py test/test_revenue_by_product.py +test/test_scan_webhook_request.py +test/test_scan_webhook_response.py test/test_score.py test/test_score_summary.py test/test_search_api.py +test/test_seed_mentors_view.py test/test_session_browser_screenshot.py test/test_session_detail.py test/test_shell_logs.py @@ -876,7 +987,9 @@ test/test_styles_view.py test/test_sub_time_child.py test/test_summary.py test/test_tags_view.py +test/test_target_system_enum.py test/test_task_view.py +test/test_template_mentor.py test/test_tenant_mentor_traces.py test/test_theme_enum.py test/test_time_child_data.py @@ -914,6 +1027,7 @@ test/test_user_chat_memory_status_request_view.py test/test_user_chat_memory_status_view.py test/test_user_chat_memory_update_view.py test/test_user_edx_memory.py +test/test_user_info.py test/test_user_memory_context_request.py test/test_user_memory_context_response.py test/test_user_sentiment_count_view.py diff --git a/README.md b/README.md index 0d7e6d9..3cdde02 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -# iblai-python-sdk +# iblai +API for iblai This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 2.4.1-ai-plus -- Package version: 2.4.1+ai.plus +- API version: 3.6.0-ai-plus +- Package version: 3.6.0+ai.plus - Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen @@ -111,6 +112,9 @@ Class | Method | HTTP request | Description *AiAccountApi* | [**ai_account_orgs_use_free_trial_create**](docs/AiAccountApi.md#ai_account_orgs_use_free_trial_create) | **POST** /api/ai-account/orgs/{org}/use-free-trial/ | *AiAccountApi* | [**ai_account_orgs_users_default_llm_key_usage_retrieve**](docs/AiAccountApi.md#ai_account_orgs_users_default_llm_key_usage_retrieve) | **GET** /api/ai-account/orgs/{org}/users/{user_id}/default-llm-key-usage | *AiAccountApi* | [**ai_account_orgs_users_free_trial_list**](docs/AiAccountApi.md#ai_account_orgs_users_free_trial_list) | **GET** /api/ai-account/orgs/{org}/users/{user_id}/free-trial | +*AiAnalyticsApi* | [**ai_analytics_orgs_users_chat_history_filter_retrieve**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_filter_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history-filter/ | +*AiAnalyticsApi* | [**ai_analytics_orgs_users_chat_history_list**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_list) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/ | +*AiAnalyticsApi* | [**ai_analytics_orgs_users_chat_history_retrieve**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/ | *AiAnalyticsApi* | [**ai_analytics_orgs_users_conversation_retrieve**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_conversation_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/conversation/ | *AiAnalyticsApi* | [**ai_analytics_orgs_users_costs_model_retrieve**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_costs_model_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/costs/model/ | *AiAnalyticsApi* | [**ai_analytics_orgs_users_costs_model_usage_retrieve**](docs/AiAnalyticsApi.md#ai_analytics_orgs_users_costs_model_usage_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/costs/model-usage/ | @@ -176,6 +180,7 @@ Class | Method | HTTP request | Description *AiFinetuningApi* | [**ai_finetuning_v1_org_user_trainings_retrieve**](docs/AiFinetuningApi.md#ai_finetuning_v1_org_user_trainings_retrieve) | **GET** /api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/ | *AiFinetuningApi* | [**ai_finetuning_v1_org_user_trainings_update**](docs/AiFinetuningApi.md#ai_finetuning_v1_org_user_trainings_update) | **PUT** /api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/ | *AiIndexApi* | [**ai_index_orgs_users_documents_destroy**](docs/AiIndexApi.md#ai_index_orgs_users_documents_destroy) | **DELETE** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | +*AiIndexApi* | [**ai_index_orgs_users_documents_graph_train_create**](docs/AiIndexApi.md#ai_index_orgs_users_documents_graph_train_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/ | *AiIndexApi* | [**ai_index_orgs_users_documents_pathways_retrieve**](docs/AiIndexApi.md#ai_index_orgs_users_documents_pathways_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/ | *AiIndexApi* | [**ai_index_orgs_users_documents_retrieve**](docs/AiIndexApi.md#ai_index_orgs_users_documents_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | *AiIndexApi* | [**ai_index_orgs_users_documents_search_create**](docs/AiIndexApi.md#ai_index_orgs_users_documents_search_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/search/ | @@ -185,9 +190,16 @@ Class | Method | HTTP request | Description *AiIndexApi* | [**ai_index_orgs_users_documents_train_retriever_create**](docs/AiIndexApi.md#ai_index_orgs_users_documents_train_retriever_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/ | *AiIndexApi* | [**ai_index_orgs_users_documents_train_sessions_create**](docs/AiIndexApi.md#ai_index_orgs_users_documents_train_sessions_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/ | *AiIndexApi* | [**ai_index_orgs_users_documents_update**](docs/AiIndexApi.md#ai_index_orgs_users_documents_update) | **PUT** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | +*AiIndexApi* | [**ai_index_orgs_users_resource_data_scrapped_retrieve**](docs/AiIndexApi.md#ai_index_orgs_users_resource_data_scrapped_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/resource/data/scrapped/ | +*AiIndexApi* | [**ai_index_orgs_users_resource_data_scrapped_retrieve2**](docs/AiIndexApi.md#ai_index_orgs_users_resource_data_scrapped_retrieve2) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/resource/{resource_id}/data/scrapped/ | +*AiIndexApi* | [**ai_index_webhook_scan_create**](docs/AiIndexApi.md#ai_index_webhook_scan_create) | **POST** /api/ai-index/webhook/scan/ | *AiMentorApi* | [**ai_mentor_orgs_metadata_create**](docs/AiMentorApi.md#ai_mentor_orgs_metadata_create) | **POST** /api/ai-mentor/orgs/{org}/metadata/ | *AiMentorApi* | [**ai_mentor_orgs_sessions_create**](docs/AiMentorApi.md#ai_mentor_orgs_sessions_create) | **POST** /api/ai-mentor/orgs/{org}/sessions/ | +*AiMentorApi* | [**ai_mentor_orgs_users_ai_generated_images_destroy**](docs/AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/ | +*AiMentorApi* | [**ai_mentor_orgs_users_ai_generated_images_list**](docs/AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/ | +*AiMentorApi* | [**ai_mentor_orgs_users_ai_generated_images_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/ | *AiMentorApi* | [**ai_mentor_orgs_users_audio_to_text_create**](docs/AiMentorApi.md#ai_mentor_orgs_users_audio_to_text_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/audio-to-text/ | +*AiMentorApi* | [**ai_mentor_orgs_users_available_template_mentors_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_available_template_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/available-template-mentors/ | *AiMentorApi* | [**ai_mentor_orgs_users_clear_chathistory_destroy**](docs/AiMentorApi.md#ai_mentor_orgs_users_clear_chathistory_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/clear-chathistory | *AiMentorApi* | [**ai_mentor_orgs_users_create**](docs/AiMentorApi.md#ai_mentor_orgs_users_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/ | *AiMentorApi* | [**ai_mentor_orgs_users_create_mentor_wizard_create**](docs/AiMentorApi.md#ai_mentor_orgs_users_create_mentor_wizard_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/ | @@ -210,13 +222,22 @@ Class | Method | HTTP request | Description *AiMentorApi* | [**ai_mentor_orgs_users_mentor_feedback_update**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_feedback_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentor_from_template_create**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_from_template_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-from-template/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentor_llms_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_llms_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-llms/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentor_seed_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_seed_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor/seed/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentor_tools_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_tools_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-tools/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentor_with_settings_create**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentor_with_settings_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-with-settings/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentors_available_tools_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_available_tools_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/available-tools/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentors_memory_component_settings_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_memory_component_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentors_memory_component_settings_update**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_memory_component_settings_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentors_public_settings_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_public_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-settings/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentors_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentors_scenarios_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_scenarios_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/ | +*AiMentorApi* | [**ai_mentor_orgs_users_mentors_scenarios_update**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_scenarios_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentors_settings_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/ | *AiMentorApi* | [**ai_mentor_orgs_users_mentors_settings_update**](docs/AiMentorApi.md#ai_mentor_orgs_users_mentors_settings_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/ | *AiMentorApi* | [**ai_mentor_orgs_users_metadata_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_metadata_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/metadata | +*AiMentorApi* | [**ai_mentor_orgs_users_moderation_logs_destroy**](docs/AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/ | +*AiMentorApi* | [**ai_mentor_orgs_users_moderation_logs_list**](docs/AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/ | +*AiMentorApi* | [**ai_mentor_orgs_users_moderation_logs_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/ | *AiMentorApi* | [**ai_mentor_orgs_users_partial_update**](docs/AiMentorApi.md#ai_mentor_orgs_users_partial_update) | **PATCH** /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/ | *AiMentorApi* | [**ai_mentor_orgs_users_periodic_agent_logs_list**](docs/AiMentorApi.md#ai_mentor_orgs_users_periodic_agent_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/ | *AiMentorApi* | [**ai_mentor_orgs_users_periodic_agent_logs_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_periodic_agent_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/{id}/ | @@ -242,6 +263,9 @@ Class | Method | HTTP request | Description *AiMentorApi* | [**ai_mentor_orgs_users_recommend_courses_block_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_recommend_courses_block_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses-block/ | *AiMentorApi* | [**ai_mentor_orgs_users_recommend_courses_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_recommend_courses_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/ | *AiMentorApi* | [**ai_mentor_orgs_users_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/ | +*AiMentorApi* | [**ai_mentor_orgs_users_safety_logs_destroy**](docs/AiMentorApi.md#ai_mentor_orgs_users_safety_logs_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/ | +*AiMentorApi* | [**ai_mentor_orgs_users_safety_logs_list**](docs/AiMentorApi.md#ai_mentor_orgs_users_safety_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/ | +*AiMentorApi* | [**ai_mentor_orgs_users_safety_logs_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_safety_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/ | *AiMentorApi* | [**ai_mentor_orgs_users_session_detail_mentors_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_session_detail_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/session-detail/mentors/{mentor}/ | *AiMentorApi* | [**ai_mentor_orgs_users_sessionid_list**](docs/AiMentorApi.md#ai_mentor_orgs_users_sessionid_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/sessionid/ | *AiMentorApi* | [**ai_mentor_orgs_users_sessions_browser_screenshot_retrieve**](docs/AiMentorApi.md#ai_mentor_orgs_users_sessions_browser_screenshot_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/browser-screenshot/ | @@ -274,6 +298,13 @@ Class | Method | HTTP request | Description *AiPromptApi* | [**ai_prompt_orgs_users_languages_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_languages_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/languages/{language_id}/ | *AiPromptApi* | [**ai_prompt_orgs_users_memory_context_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_context_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/ | *AiPromptApi* | [**ai_prompt_orgs_users_memory_context_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_context_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_create**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_destroy**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_destroy2**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_destroy2) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_status_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_status_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_status_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_status_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/ | +*AiPromptApi* | [**ai_prompt_orgs_users_memory_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_memory_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/ | *AiPromptApi* | [**ai_prompt_orgs_users_metadata_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_metadata_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/metadata | *AiPromptApi* | [**ai_prompt_orgs_users_prompt_create**](docs/AiPromptApi.md#ai_prompt_orgs_users_prompt_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/ | *AiPromptApi* | [**ai_prompt_orgs_users_prompt_destroy**](docs/AiPromptApi.md#ai_prompt_orgs_users_prompt_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/ | @@ -297,11 +328,6 @@ Class | Method | HTTP request | Description *AiPromptApi* | [**ai_prompt_orgs_users_tones_destroy**](docs/AiPromptApi.md#ai_prompt_orgs_users_tones_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/ | *AiPromptApi* | [**ai_prompt_orgs_users_tones_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_tones_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/ | *AiPromptApi* | [**ai_prompt_orgs_users_tones_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_tones_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/ | -*AiPromptApi* | [**ai_prompt_orgs_users_user_catalog_item_memory_create**](docs/AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -*AiPromptApi* | [**ai_prompt_orgs_users_user_catalog_item_memory_destroy**](docs/AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -*AiPromptApi* | [**ai_prompt_orgs_users_user_catalog_item_memory_destroy2**](docs/AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_destroy2) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/ | -*AiPromptApi* | [**ai_prompt_orgs_users_user_catalog_item_memory_retrieve**](docs/AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -*AiPromptApi* | [**ai_prompt_orgs_users_user_catalog_item_memory_update**](docs/AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/ | *AnalyticsApi* | [**analytics_orgs_time_update_create**](docs/AnalyticsApi.md#analytics_orgs_time_update_create) | **POST** /api/analytics/orgs/{org}/time/update/ | *AudienceApi* | [**audience_orgs_active_users_over_time_retrieve**](docs/AudienceApi.md#audience_orgs_active_users_over_time_retrieve) | **GET** /api/audience/orgs/{org}/active-users/over-time | *AudienceApi* | [**audience_orgs_active_users_per_course_retrieve**](docs/AudienceApi.md#audience_orgs_active_users_per_course_retrieve) | **GET** /api/audience/orgs/{org}/active-users/per-course | @@ -313,8 +339,39 @@ Class | Method | HTTP request | Description *AudienceApi* | [**audience_orgs_registered_users_over_time_retrieve**](docs/AudienceApi.md#audience_orgs_registered_users_over_time_retrieve) | **GET** /api/audience/orgs/{org}/registered-users/over-time | *AudienceApi* | [**audience_orgs_registered_users_per_course_retrieve**](docs/AudienceApi.md#audience_orgs_registered_users_per_course_retrieve) | **GET** /api/audience/orgs/{org}/registered-users/per-course | *AudienceApi* | [**audience_orgs_registered_users_retrieve**](docs/AudienceApi.md#audience_orgs_registered_users_retrieve) | **GET** /api/audience/orgs/{org}/registered-users/ | -*CareerApi* | [**career_resume_orgs_users_create**](docs/CareerApi.md#career_resume_orgs_users_create) | **POST** /api/career/resume/orgs/{orgs}/users/{user_id}/ | -*CareerApi* | [**career_resume_orgs_users_retrieve**](docs/CareerApi.md#career_resume_orgs_users_retrieve) | **GET** /api/career/resume/orgs/{orgs}/users/{user_id}/ | +*CareerApi* | [**career_orgs_companies_users_create**](docs/CareerApi.md#career_orgs_companies_users_create) | **POST** /api/career/orgs/{org}/companies/users/{username}/ | +*CareerApi* | [**career_orgs_companies_users_destroy**](docs/CareerApi.md#career_orgs_companies_users_destroy) | **DELETE** /api/career/orgs/{org}/companies/users/{username}/ | +*CareerApi* | [**career_orgs_companies_users_retrieve**](docs/CareerApi.md#career_orgs_companies_users_retrieve) | **GET** /api/career/orgs/{org}/companies/users/{username}/ | +*CareerApi* | [**career_orgs_companies_users_update**](docs/CareerApi.md#career_orgs_companies_users_update) | **PUT** /api/career/orgs/{org}/companies/users/{username}/ | +*CareerApi* | [**career_orgs_education_users_create**](docs/CareerApi.md#career_orgs_education_users_create) | **POST** /api/career/orgs/{org}/education/users/{username}/ | +*CareerApi* | [**career_orgs_education_users_destroy**](docs/CareerApi.md#career_orgs_education_users_destroy) | **DELETE** /api/career/orgs/{org}/education/users/{username}/ | +*CareerApi* | [**career_orgs_education_users_retrieve**](docs/CareerApi.md#career_orgs_education_users_retrieve) | **GET** /api/career/orgs/{org}/education/users/{username}/ | +*CareerApi* | [**career_orgs_education_users_update**](docs/CareerApi.md#career_orgs_education_users_update) | **PUT** /api/career/orgs/{org}/education/users/{username}/ | +*CareerApi* | [**career_orgs_experience_users_create**](docs/CareerApi.md#career_orgs_experience_users_create) | **POST** /api/career/orgs/{org}/experience/users/{username}/ | +*CareerApi* | [**career_orgs_experience_users_destroy**](docs/CareerApi.md#career_orgs_experience_users_destroy) | **DELETE** /api/career/orgs/{org}/experience/users/{username}/ | +*CareerApi* | [**career_orgs_experience_users_retrieve**](docs/CareerApi.md#career_orgs_experience_users_retrieve) | **GET** /api/career/orgs/{org}/experience/users/{username}/ | +*CareerApi* | [**career_orgs_experience_users_update**](docs/CareerApi.md#career_orgs_experience_users_update) | **PUT** /api/career/orgs/{org}/experience/users/{username}/ | +*CareerApi* | [**career_orgs_institutions_users_create**](docs/CareerApi.md#career_orgs_institutions_users_create) | **POST** /api/career/orgs/{org}/institutions/users/{username}/ | +*CareerApi* | [**career_orgs_institutions_users_destroy**](docs/CareerApi.md#career_orgs_institutions_users_destroy) | **DELETE** /api/career/orgs/{org}/institutions/users/{username}/ | +*CareerApi* | [**career_orgs_institutions_users_retrieve**](docs/CareerApi.md#career_orgs_institutions_users_retrieve) | **GET** /api/career/orgs/{org}/institutions/users/{username}/ | +*CareerApi* | [**career_orgs_institutions_users_update**](docs/CareerApi.md#career_orgs_institutions_users_update) | **PUT** /api/career/orgs/{org}/institutions/users/{username}/ | +*CareerApi* | [**career_orgs_programs_users_create**](docs/CareerApi.md#career_orgs_programs_users_create) | **POST** /api/career/orgs/{org}/programs/users/{username}/ | +*CareerApi* | [**career_orgs_programs_users_destroy**](docs/CareerApi.md#career_orgs_programs_users_destroy) | **DELETE** /api/career/orgs/{org}/programs/users/{username}/ | +*CareerApi* | [**career_orgs_programs_users_retrieve**](docs/CareerApi.md#career_orgs_programs_users_retrieve) | **GET** /api/career/orgs/{org}/programs/users/{username}/ | +*CareerApi* | [**career_orgs_programs_users_update**](docs/CareerApi.md#career_orgs_programs_users_update) | **PUT** /api/career/orgs/{org}/programs/users/{username}/ | +*CareerApi* | [**career_resume_orgs_users_create**](docs/CareerApi.md#career_resume_orgs_users_create) | **POST** /api/career/resume/orgs/{org}/users/{username}/ | +*CareerApi* | [**career_resume_orgs_users_retrieve**](docs/CareerApi.md#career_resume_orgs_users_retrieve) | **GET** /api/career/resume/orgs/{org}/users/{username}/ | +*CareerApi* | [**career_resume_orgs_users_update**](docs/CareerApi.md#career_resume_orgs_users_update) | **PUT** /api/career/resume/orgs/{org}/users/{username}/ | +*CoreApi* | [**core_lti1p3_provider_lti_keys_create**](docs/CoreApi.md#core_lti1p3_provider_lti_keys_create) | **POST** /api/core/lti/1p3/provider/lti-keys/ | +*CoreApi* | [**core_lti1p3_provider_lti_keys_destroy**](docs/CoreApi.md#core_lti1p3_provider_lti_keys_destroy) | **DELETE** /api/core/lti/1p3/provider/lti-keys/{id}/ | +*CoreApi* | [**core_lti1p3_provider_lti_keys_list**](docs/CoreApi.md#core_lti1p3_provider_lti_keys_list) | **GET** /api/core/lti/1p3/provider/lti-keys/ | +*CoreApi* | [**core_lti1p3_provider_lti_keys_retrieve**](docs/CoreApi.md#core_lti1p3_provider_lti_keys_retrieve) | **GET** /api/core/lti/1p3/provider/lti-keys/{id}/ | +*CoreApi* | [**core_lti1p3_provider_lti_keys_update**](docs/CoreApi.md#core_lti1p3_provider_lti_keys_update) | **PUT** /api/core/lti/1p3/provider/lti-keys/{id}/ | +*CoreApi* | [**core_lti1p3_provider_lti_tools_create**](docs/CoreApi.md#core_lti1p3_provider_lti_tools_create) | **POST** /api/core/lti/1p3/provider/lti-tools/ | +*CoreApi* | [**core_lti1p3_provider_lti_tools_destroy**](docs/CoreApi.md#core_lti1p3_provider_lti_tools_destroy) | **DELETE** /api/core/lti/1p3/provider/lti-tools/{id}/ | +*CoreApi* | [**core_lti1p3_provider_lti_tools_list**](docs/CoreApi.md#core_lti1p3_provider_lti_tools_list) | **GET** /api/core/lti/1p3/provider/lti-tools/ | +*CoreApi* | [**core_lti1p3_provider_lti_tools_retrieve**](docs/CoreApi.md#core_lti1p3_provider_lti_tools_retrieve) | **GET** /api/core/lti/1p3/provider/lti-tools/{id}/ | +*CoreApi* | [**core_lti1p3_provider_lti_tools_update**](docs/CoreApi.md#core_lti1p3_provider_lti_tools_update) | **PUT** /api/core/lti/1p3/provider/lti-tools/{id}/ | *CoreApi* | [**core_orgs_dark_mode_logo_create_create**](docs/CoreApi.md#core_orgs_dark_mode_logo_create_create) | **POST** /api/core/orgs/{org}/dark-mode-logo/create/ | *CoreApi* | [**core_orgs_dark_mode_logo_retrieve**](docs/CoreApi.md#core_orgs_dark_mode_logo_retrieve) | **GET** /api/core/orgs/{org}/dark-mode-logo/ | *CoreApi* | [**core_orgs_favicon_create_create**](docs/CoreApi.md#core_orgs_favicon_create_create) | **POST** /api/core/orgs/{org}/favicon/create/ | @@ -324,6 +381,9 @@ Class | Method | HTTP request | Description *CoreApi* | [**core_orgs_metadata_partial_update**](docs/CoreApi.md#core_orgs_metadata_partial_update) | **PATCH** /api/core/orgs/{org}/metadata/ | *CoreApi* | [**core_orgs_metadata_retrieve**](docs/CoreApi.md#core_orgs_metadata_retrieve) | **GET** /api/core/orgs/{org}/metadata/ | *CoreApi* | [**core_orgs_metadata_update**](docs/CoreApi.md#core_orgs_metadata_update) | **PUT** /api/core/orgs/{org}/metadata/ | +*CoreApi* | [**core_orgs_redirect_tokens_create**](docs/CoreApi.md#core_orgs_redirect_tokens_create) | **POST** /api/core/orgs/{org}/redirect-tokens/ | +*CoreApi* | [**core_orgs_redirect_tokens_delete_destroy**](docs/CoreApi.md#core_orgs_redirect_tokens_delete_destroy) | **DELETE** /api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete | +*CoreApi* | [**core_orgs_redirect_tokens_retrieve**](docs/CoreApi.md#core_orgs_redirect_tokens_retrieve) | **GET** /api/core/orgs/{org}/redirect-tokens/{redirect_token}/ | *CoreApi* | [**core_orgs_thumbnail_create_create**](docs/CoreApi.md#core_orgs_thumbnail_create_create) | **POST** /api/core/orgs/{org}/thumbnail/create/ | *CoreApi* | [**core_orgs_thumbnail_retrieve**](docs/CoreApi.md#core_orgs_thumbnail_retrieve) | **GET** /api/core/orgs/{org}/thumbnail/ | *CredentialsApi* | [**credentials_orgs_users_assertions_bulk_create**](docs/CredentialsApi.md#credentials_orgs_users_assertions_bulk_create) | **POST** /api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/bulk/ | @@ -372,7 +432,14 @@ Class | Method | HTTP request | Description *FinanceApi* | [**finance_orgs_products_sales_over_time_retrieve**](docs/FinanceApi.md#finance_orgs_products_sales_over_time_retrieve) | **GET** /api/finance/orgs/{org}/products/{item_id}/sales-over-time | *FinanceApi* | [**finance_orgs_revenue_net_over_time_retrieve**](docs/FinanceApi.md#finance_orgs_revenue_net_over_time_retrieve) | **GET** /api/finance/orgs/{org}/revenue/net-over-time | *FinanceApi* | [**finance_orgs_revenue_products_retrieve**](docs/FinanceApi.md#finance_orgs_revenue_products_retrieve) | **GET** /api/finance/orgs/{org}/revenue/products | -*MonitoringApi* | [**monitoring_connectors_retrieve**](docs/MonitoringApi.md#monitoring_connectors_retrieve) | **GET** /monitoring/connectors/ | +*NotificationApi* | [**notification_v1_orgs_notifications_bulk_update_partial_update**](docs/NotificationApi.md#notification_v1_orgs_notifications_bulk_update_partial_update) | **PATCH** /api/notification/v1/orgs/{org}/notifications/bulk-update/ | +*NotificationApi* | [**notification_v1_orgs_notifications_retrieve**](docs/NotificationApi.md#notification_v1_orgs_notifications_retrieve) | **GET** /api/notification/v1/orgs/{org}/notifications/ | +*NotificationApi* | [**notification_v1_orgs_notifications_update**](docs/NotificationApi.md#notification_v1_orgs_notifications_update) | **PUT** /api/notification/v1/orgs/{org}/notifications/ | +*NotificationApi* | [**notification_v1_orgs_users_notifications_bulk_update_partial_update**](docs/NotificationApi.md#notification_v1_orgs_users_notifications_bulk_update_partial_update) | **PATCH** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/ | +*NotificationApi* | [**notification_v1_orgs_users_notifications_count_retrieve**](docs/NotificationApi.md#notification_v1_orgs_users_notifications_count_retrieve) | **GET** /api/notification/v1/orgs/{org}/users/{user_id}/notifications-count/ | +*NotificationApi* | [**notification_v1_orgs_users_notifications_destroy**](docs/NotificationApi.md#notification_v1_orgs_users_notifications_destroy) | **DELETE** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/{notification_id}/ | +*NotificationApi* | [**notification_v1_orgs_users_notifications_retrieve**](docs/NotificationApi.md#notification_v1_orgs_users_notifications_retrieve) | **GET** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/ | +*NotificationApi* | [**notification_v1_orgs_users_notifications_update**](docs/NotificationApi.md#notification_v1_orgs_users_notifications_update) | **PUT** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/ | *OverviewApi* | [**overview_orgs_active_users_retrieve**](docs/OverviewApi.md#overview_orgs_active_users_retrieve) | **GET** /api/overview/orgs/{org}/active-users | *OverviewApi* | [**overview_orgs_average_grade_retrieve**](docs/OverviewApi.md#overview_orgs_average_grade_retrieve) | **GET** /api/overview/orgs/{org}/average-grade | *OverviewApi* | [**overview_orgs_courses_completions_retrieve**](docs/OverviewApi.md#overview_orgs_courses_completions_retrieve) | **GET** /api/overview/orgs/{org}/courses/completions | @@ -416,9 +483,12 @@ Class | Method | HTTP request | Description *ReportsApi* | [**reports_orgs_new_create**](docs/ReportsApi.md#reports_orgs_new_create) | **POST** /api/reports/orgs/{org}/new | *SearchApi* | [**search_ai_search_detail_retrieve**](docs/SearchApi.md#search_ai_search_detail_retrieve) | **GET** /api/search/ai-search/detail/ | *SearchApi* | [**search_ai_search_retrieve**](docs/SearchApi.md#search_ai_search_retrieve) | **GET** /api/search/ai-search/ | +*SearchApi* | [**search_catalog_retrieve**](docs/SearchApi.md#search_catalog_retrieve) | **GET** /api/search/catalog/ | *SearchApi* | [**search_documentsearch_retrieve**](docs/SearchApi.md#search_documentsearch_retrieve) | **GET** /api/search/documentsearch/ | *SearchApi* | [**search_es_health_retrieve**](docs/SearchApi.md#search_es_health_retrieve) | **GET** /api/search/es-health/ | +*SearchApi* | [**search_personalized_catalog_retrieve**](docs/SearchApi.md#search_personalized_catalog_retrieve) | **GET** /api/search/personalized-catalog/{username}/ | *SearchApi* | [**search_search_retrieve**](docs/SearchApi.md#search_search_retrieve) | **GET** /api/search/search/ | +*SearchApi* | [**search_users_orgs_users_retrieve**](docs/SearchApi.md#search_users_orgs_users_retrieve) | **GET** /api/search/users/orgs/{org}/users/{username}/ | *SkillsApi* | [**skills_orgs_skills_list**](docs/SkillsApi.md#skills_orgs_skills_list) | **GET** /api/skills/orgs/{org}/skills | *SkillsApi* | [**skills_orgs_skills_percentile_list**](docs/SkillsApi.md#skills_orgs_skills_percentile_list) | **GET** /api/skills/orgs/{org}/skills/percentile/ | *SkillsApi* | [**skills_orgs_skills_percentile_retrieve**](docs/SkillsApi.md#skills_orgs_skills_percentile_retrieve) | **GET** /api/skills/orgs/{org}/skills/{skill_id}/percentile/ | @@ -435,6 +505,7 @@ Class | Method | HTTP request | Description ## Documentation For Models + - [AIGeneratedImage](docs/AIGeneratedImage.md) - [APITokenCost](docs/APITokenCost.md) - [AcceptanceEnum](docs/AcceptanceEnum.md) - [ActiveUsersData](docs/ActiveUsersData.md) @@ -459,14 +530,17 @@ Class | Method | HTTP request | Description - [BulkCreateAssertion](docs/BulkCreateAssertion.md) - [ChartsessionMentor](docs/ChartsessionMentor.md) - [ChatHistory](docs/ChatHistory.md) + - [ChatHistoryFilterData](docs/ChatHistoryFilterData.md) - [ChatHistoryItem](docs/ChatHistoryItem.md) - [ChatHistorySessionId](docs/ChatHistorySessionId.md) - [ChatSessionRequest](docs/ChatSessionRequest.md) - [ChatSessionResponse](docs/ChatSessionResponse.md) - [ChatSessionWithMessage](docs/ChatSessionWithMessage.md) - [CheckDocumentTrainingStatus](docs/CheckDocumentTrainingStatus.md) + - [Company](docs/Company.md) - [ConversationMessage](docs/ConversationMessage.md) - [ConversationVolume](docs/ConversationVolume.md) + - [Conversations](docs/Conversations.md) - [Count](docs/Count.md) - [CountData](docs/CountData.md) - [CourseCompletionPerCourse](docs/CourseCompletionPerCourse.md) @@ -489,18 +563,21 @@ Class | Method | HTTP request | Description - [DataSetCreate](docs/DataSetCreate.md) - [DataSetPlatformValue](docs/DataSetPlatformValue.md) - [DataSetStatusEnum](docs/DataSetStatusEnum.md) + - [DateRange](docs/DateRange.md) - [DesiredSkill](docs/DesiredSkill.md) - [DetailedGradeSubsection](docs/DetailedGradeSubsection.md) - [DetailedGradeView](docs/DetailedGradeView.md) - [DetailedGradeViewData](docs/DetailedGradeViewData.md) - [DiscordConfig](docs/DiscordConfig.md) - [DiscordWebhook](docs/DiscordWebhook.md) + - [Education](docs/Education.md) - [EngagementPerCourse](docs/EngagementPerCourse.md) - [EngagementPerCourseData](docs/EngagementPerCourseData.md) - [Enrollments](docs/Enrollments.md) - [EnrollmentsData](docs/EnrollmentsData.md) - [EnrollmentsPerUser](docs/EnrollmentsPerUser.md) - [EnrollmentsPerUserData](docs/EnrollmentsPerUserData.md) + - [Experience](docs/Experience.md) - [FloatOverTime](docs/FloatOverTime.md) - [FreeUsageCount](docs/FreeUsageCount.md) - [GradingPerUser](docs/GradingPerUser.md) @@ -510,10 +587,13 @@ Class | Method | HTTP request | Description - [IBLAIPlatformMetaRequest](docs/IBLAIPlatformMetaRequest.md) - [IBLAIPlatformMetaUpdateRequest](docs/IBLAIPlatformMetaUpdateRequest.md) - [ImageUpload](docs/ImageUpload.md) + - [Institution](docs/Institution.md) + - [InstitutionTypeEnum](docs/InstitutionTypeEnum.md) - [IntegrationCredential](docs/IntegrationCredential.md) - [Issuer](docs/Issuer.md) - [IssuerAuthority](docs/IssuerAuthority.md) - [JobRun](docs/JobRun.md) + - [LLMCredentialResponse](docs/LLMCredentialResponse.md) - [LLMModelForTenant](docs/LLMModelForTenant.md) - [LLMResponse](docs/LLMResponse.md) - [LLMScoresView](docs/LLMScoresView.md) @@ -524,36 +604,51 @@ Class | Method | HTTP request | Description - [LanguagesView](docs/LanguagesView.md) - [LearnerInformationAPI](docs/LearnerInformationAPI.md) - [LearnerInformationAPIData](docs/LearnerInformationAPIData.md) + - [LtiKey](docs/LtiKey.md) + - [LtiLaunchGate](docs/LtiLaunchGate.md) + - [LtiTool](docs/LtiTool.md) - [MainCreds](docs/MainCreds.md) + - [MemoryStatusRequestView](docs/MemoryStatusRequestView.md) + - [MemoryStatusView](docs/MemoryStatusView.md) - [Mentor](docs/Mentor.md) - [MentorCategory](docs/MentorCategory.md) - [MentorData](docs/MentorData.md) - [MentorDetailAnalytics](docs/MentorDetailAnalytics.md) - [MentorFromTemplateRequest](docs/MentorFromTemplateRequest.md) - [MentorFromTemplateWithSettingRequest](docs/MentorFromTemplateWithSettingRequest.md) + - [MentorMetadata](docs/MentorMetadata.md) - [MentorSettings](docs/MentorSettings.md) - [MentorSettingsMentorVisibility](docs/MentorSettingsMentorVisibility.md) - [MentorSettingsRequest](docs/MentorSettingsRequest.md) - [MentorTrace](docs/MentorTrace.md) - [MentorVisibilityEnum](docs/MentorVisibilityEnum.md) - [MentorWizard](docs/MentorWizard.md) + - [MessageStatus](docs/MessageStatus.md) - [MessageView](docs/MessageView.md) - [MessageViewRequest](docs/MessageViewRequest.md) - [MessageViewUpdatResponse](docs/MessageViewUpdatResponse.md) + - [Metadata](docs/Metadata.md) - [ModelCost](docs/ModelCost.md) - [ModelUsage](docs/ModelUsage.md) + - [ModerationLog](docs/ModerationLog.md) - [NetRevenueOverTime](docs/NetRevenueOverTime.md) + - [Notification](docs/Notification.md) + - [NotificationCount](docs/NotificationCount.md) + - [NotificationStatusEnum](docs/NotificationStatusEnum.md) - [NullEnum](docs/NullEnum.md) - [Observation](docs/Observation.md) - [Order](docs/Order.md) - [OverTime](docs/OverTime.md) - - [Overtime](docs/Overtime.md) + - [OverTimeWithTotal](docs/OverTimeWithTotal.md) - [OvertimeMeta](docs/OvertimeMeta.md) - [OvertimeWithChangeInfo](docs/OvertimeWithChangeInfo.md) - [PageContent](docs/PageContent.md) + - [PaginatedAIGeneratedImageList](docs/PaginatedAIGeneratedImageList.md) + - [PaginatedConversationsList](docs/PaginatedConversationsList.md) - [PaginatedDataSetList](docs/PaginatedDataSetList.md) - [PaginatedJobRunList](docs/PaginatedJobRunList.md) - [PaginatedMentorList](docs/PaginatedMentorList.md) + - [PaginatedModerationLogList](docs/PaginatedModerationLogList.md) - [PaginatedPeriodicAgentList](docs/PaginatedPeriodicAgentList.md) - [PaginatedPeriodicAgentLogList](docs/PaginatedPeriodicAgentLogList.md) - [PaginatedPlayWrightScriptList](docs/PaginatedPlayWrightScriptList.md) @@ -566,6 +661,7 @@ Class | Method | HTTP request | Description - [PatchedDataSet](docs/PatchedDataSet.md) - [PatchedDiscordConfig](docs/PatchedDiscordConfig.md) - [PatchedMentor](docs/PatchedMentor.md) + - [PatchedNotification](docs/PatchedNotification.md) - [PatchedPeriodicAgentCreate](docs/PatchedPeriodicAgentCreate.md) - [PatchedPlatformPublicMetadata](docs/PatchedPlatformPublicMetadata.md) - [PatchedPlayWrightScript](docs/PatchedPlayWrightScript.md) @@ -610,6 +706,8 @@ Class | Method | HTTP request | Description - [PreviousAgentStatusEnum](docs/PreviousAgentStatusEnum.md) - [Product](docs/Product.md) - [ProductTable](docs/ProductTable.md) + - [Program](docs/Program.md) + - [ProgramTypeEnum](docs/ProgramTypeEnum.md) - [Prompt](docs/Prompt.md) - [PromptCategory](docs/PromptCategory.md) - [PromptVisibilityEnum](docs/PromptVisibilityEnum.md) @@ -619,6 +717,8 @@ Class | Method | HTTP request | Description - [RatingEnum](docs/RatingEnum.md) - [RecommendCourseResponse](docs/RecommendCourseResponse.md) - [RecommendationSearchAPI](docs/RecommendationSearchAPI.md) + - [RedirectTokenRequest](docs/RedirectTokenRequest.md) + - [RedirectTokenResponse](docs/RedirectTokenResponse.md) - [RelatedText](docs/RelatedText.md) - [ReportCreate](docs/ReportCreate.md) - [ReportData](docs/ReportData.md) @@ -628,19 +728,24 @@ Class | Method | HTTP request | Description - [ReportedSkill](docs/ReportedSkill.md) - [RequestDataVariable](docs/RequestDataVariable.md) - [ResourcePoint](docs/ResourcePoint.md) + - [ResourceScrappedData](docs/ResourceScrappedData.md) - [ResponseDataVariable](docs/ResponseDataVariable.md) - [RetreiverTrainViewRequest](docs/RetreiverTrainViewRequest.md) - [RetreiverTrainViewResponse](docs/RetreiverTrainViewResponse.md) - [RetrieveTask](docs/RetrieveTask.md) - [RetrieverDocumentEmbedding](docs/RetrieverDocumentEmbedding.md) - [RetrieverDocumentEmbeddingRequest](docs/RetrieverDocumentEmbeddingRequest.md) + - [RetrieverDocumentEmbeddingTrainingStatus](docs/RetrieverDocumentEmbeddingTrainingStatus.md) - [RetrieverRequestSearch](docs/RetrieverRequestSearch.md) - [RetrieverRequestSearchDocument](docs/RetrieverRequestSearchDocument.md) - [RetrieverResponseSearch](docs/RetrieverResponseSearch.md) - [ReuestDataVariableList](docs/ReuestDataVariableList.md) - [RevenueByProduct](docs/RevenueByProduct.md) + - [ScanWebhookRequest](docs/ScanWebhookRequest.md) + - [ScanWebhookResponse](docs/ScanWebhookResponse.md) - [Score](docs/Score.md) - [ScoreSummary](docs/ScoreSummary.md) + - [SeedMentorsView](docs/SeedMentorsView.md) - [SessionBrowserScreenshot](docs/SessionBrowserScreenshot.md) - [SessionDetail](docs/SessionDetail.md) - [ShellLogs](docs/ShellLogs.md) @@ -657,7 +762,9 @@ Class | Method | HTTP request | Description - [SubTimeChild](docs/SubTimeChild.md) - [Summary](docs/Summary.md) - [TagsView](docs/TagsView.md) + - [TargetSystemEnum](docs/TargetSystemEnum.md) - [TaskView](docs/TaskView.md) + - [TemplateMentor](docs/TemplateMentor.md) - [TenantMentorTraces](docs/TenantMentorTraces.md) - [ThemeEnum](docs/ThemeEnum.md) - [TimeChildData](docs/TimeChildData.md) @@ -695,6 +802,7 @@ Class | Method | HTTP request | Description - [UserChatMemoryStatusView](docs/UserChatMemoryStatusView.md) - [UserChatMemoryUpdateView](docs/UserChatMemoryUpdateView.md) - [UserEdxMemory](docs/UserEdxMemory.md) + - [UserInfo](docs/UserInfo.md) - [UserMemoryContextRequest](docs/UserMemoryContextRequest.md) - [UserMemoryContextResponse](docs/UserMemoryContextResponse.md) - [UserSentimentCountView](docs/UserSentimentCountView.md) diff --git a/docs/AIGeneratedImage.md b/docs/AIGeneratedImage.md new file mode 100644 index 0000000..8ad3753 --- /dev/null +++ b/docs/AIGeneratedImage.md @@ -0,0 +1,36 @@ +# AIGeneratedImage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**user** | **int** | edX user ID | +**image** | **str** | | +**platform** | **int** | | +**prompt** | **str** | | [optional] +**model** | **str** | | [optional] +**provider** | **str** | | [optional] +**date_created** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.ai_generated_image import AIGeneratedImage + +# TODO update the JSON string below +json = "{}" +# create an instance of AIGeneratedImage from a JSON string +ai_generated_image_instance = AIGeneratedImage.from_json(json) +# print the JSON string representation of the object +print(AIGeneratedImage.to_json()) + +# convert the object into a dict +ai_generated_image_dict = ai_generated_image_instance.to_dict() +# create an instance of AIGeneratedImage from a dict +ai_generated_image_from_dict = AIGeneratedImage.from_dict(ai_generated_image_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AiAccountApi.md b/docs/AiAccountApi.md index 1e9524f..6880114 100644 --- a/docs/AiAccountApi.md +++ b/docs/AiAccountApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description # **ai_account_orgs_credential_create** -> Credential ai_account_orgs_credential_create(org, credential_request) +> LLMCredentialResponse ai_account_orgs_credential_create(org, credential_request) @@ -33,8 +33,8 @@ This is for creating llm credentials for a tenant. Accessible to tenant admins ```python import iblai -from iblai.models.credential import Credential from iblai.models.credential_request import CredentialRequest +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.rest import ApiException from pprint import pprint @@ -75,7 +75,7 @@ Name | Type | Description | Notes ### Return type -[**Credential**](Credential.md) +[**LLMCredentialResponse**](LLMCredentialResponse.md) ### Authorization @@ -95,7 +95,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_account_orgs_credential_partial_update** -> Credential ai_account_orgs_credential_partial_update(org, patched_credential_request=patched_credential_request) +> LLMCredentialResponse ai_account_orgs_credential_partial_update(org, patched_credential_request=patched_credential_request) @@ -107,7 +107,7 @@ This is for updating llm credentials for a tenant. Accessible to tenant admins ```python import iblai -from iblai.models.credential import Credential +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.models.patched_credential_request import PatchedCredentialRequest from iblai.rest import ApiException from pprint import pprint @@ -149,7 +149,7 @@ Name | Type | Description | Notes ### Return type -[**Credential**](Credential.md) +[**LLMCredentialResponse**](LLMCredentialResponse.md) ### Authorization @@ -169,7 +169,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_account_orgs_credential_retrieve** -> Credential ai_account_orgs_credential_retrieve(org, name=name) +> LLMCredentialResponse ai_account_orgs_credential_retrieve(org, name=name) @@ -181,7 +181,7 @@ This is for getting list of llm credentials for a tenant. You can also filter t ```python import iblai -from iblai.models.credential import Credential +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.rest import ApiException from pprint import pprint @@ -222,7 +222,7 @@ Name | Type | Description | Notes ### Return type -[**Credential**](Credential.md) +[**LLMCredentialResponse**](LLMCredentialResponse.md) ### Authorization @@ -976,7 +976,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_account_orgs_users_free_trial_list** -> List[Credential] ai_account_orgs_users_free_trial_list(org, user_id) +> List[LLMCredentialResponse] ai_account_orgs_users_free_trial_list(org, user_id) @@ -988,7 +988,7 @@ This is for getting list of free trial status for a tenant. Accessible to tenan ```python import iblai -from iblai.models.credential import Credential +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.rest import ApiException from pprint import pprint @@ -1029,7 +1029,7 @@ Name | Type | Description | Notes ### Return type -[**List[Credential]**](Credential.md) +[**List[LLMCredentialResponse]**](LLMCredentialResponse.md) ### Authorization diff --git a/docs/AiAnalyticsApi.md b/docs/AiAnalyticsApi.md index 52d62ac..4b1eb0c 100644 --- a/docs/AiAnalyticsApi.md +++ b/docs/AiAnalyticsApi.md @@ -4,6 +4,9 @@ All URIs are relative to *https://base.manager.iblai.app* Method | HTTP request | Description ------------- | ------------- | ------------- +[**ai_analytics_orgs_users_chat_history_filter_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_filter_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history-filter/ | +[**ai_analytics_orgs_users_chat_history_list**](AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_list) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/ | +[**ai_analytics_orgs_users_chat_history_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_chat_history_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/ | [**ai_analytics_orgs_users_conversation_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_conversation_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/conversation/ | [**ai_analytics_orgs_users_costs_model_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_costs_model_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/costs/model/ | [**ai_analytics_orgs_users_costs_model_usage_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_costs_model_usage_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/costs/model-usage/ | @@ -22,8 +25,257 @@ Method | HTTP request | Description [**ai_analytics_orgs_users_user_feedback_retrieve**](AiAnalyticsApi.md#ai_analytics_orgs_users_user_feedback_retrieve) | **GET** /api/ai-analytics/orgs/{org}/users/{user_id}/user-feedback/ | +# **ai_analytics_orgs_users_chat_history_filter_retrieve** +> ChatHistoryFilterData ai_analytics_orgs_users_chat_history_filter_retrieve(org, user_id) + + + +Retrieve the chat history for a tenant Filter parameters for period are start_date and end date Accessible to tenant Admins only. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.chat_history_filter_data import ChatHistoryFilterData +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiAnalyticsApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_analytics_orgs_users_chat_history_filter_retrieve(org, user_id) + print("The response of AiAnalyticsApi->ai_analytics_orgs_users_chat_history_filter_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiAnalyticsApi->ai_analytics_orgs_users_chat_history_filter_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**ChatHistoryFilterData**](ChatHistoryFilterData.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_analytics_orgs_users_chat_history_list** +> PaginatedConversationsList ai_analytics_orgs_users_chat_history_list(org, user_id, end_date=end_date, mentor=mentor, page=page, page_size=page_size, sentiment=sentiment, start_date=start_date, topics=topics, user_id2=user_id2) + + + +Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.paginated_conversations_list import PaginatedConversationsList +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiAnalyticsApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +end_date = '2013-10-20' # date | (optional) +mentor = 'mentor_example' # str | (optional) +page = 56 # int | A page number within the paginated result set. (optional) +page_size = 56 # int | Number of results to return per page. (optional) +sentiment = 'sentiment_example' # str | (optional) +start_date = '2013-10-20' # date | (optional) +topics = 'topics_example' # str | (optional) +user_id2 = 'user_id_example' # str | (optional) + +try: + api_response = api_instance.ai_analytics_orgs_users_chat_history_list(org, user_id, end_date=end_date, mentor=mentor, page=page, page_size=page_size, sentiment=sentiment, start_date=start_date, topics=topics, user_id2=user_id2) + print("The response of AiAnalyticsApi->ai_analytics_orgs_users_chat_history_list:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiAnalyticsApi->ai_analytics_orgs_users_chat_history_list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **end_date** | **date**| | [optional] + **mentor** | **str**| | [optional] + **page** | **int**| A page number within the paginated result set. | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **sentiment** | **str**| | [optional] + **start_date** | **date**| | [optional] + **topics** | **str**| | [optional] + **user_id2** | **str**| | [optional] + +### Return type + +[**PaginatedConversationsList**](PaginatedConversationsList.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_analytics_orgs_users_chat_history_retrieve** +> Conversations ai_analytics_orgs_users_chat_history_retrieve(id, org, user_id, end_date=end_date, mentor=mentor, sentiment=sentiment, start_date=start_date, topics=topics, user_id2=user_id2) + + + +Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.conversations import Conversations +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiAnalyticsApi(api_client) +id = 'id_example' # str | A UUID string identifying this session. +org = 'org_example' # str | +user_id = 'user_id_example' # str | +end_date = '2013-10-20' # date | (optional) +mentor = 'mentor_example' # str | (optional) +sentiment = 'sentiment_example' # str | (optional) +start_date = '2013-10-20' # date | (optional) +topics = 'topics_example' # str | (optional) +user_id2 = 'user_id_example' # str | (optional) + +try: + api_response = api_instance.ai_analytics_orgs_users_chat_history_retrieve(id, org, user_id, end_date=end_date, mentor=mentor, sentiment=sentiment, start_date=start_date, topics=topics, user_id2=user_id2) + print("The response of AiAnalyticsApi->ai_analytics_orgs_users_chat_history_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiAnalyticsApi->ai_analytics_orgs_users_chat_history_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| A UUID string identifying this session. | + **org** | **str**| | + **user_id** | **str**| | + **end_date** | **date**| | [optional] + **mentor** | **str**| | [optional] + **sentiment** | **str**| | [optional] + **start_date** | **date**| | [optional] + **topics** | **str**| | [optional] + **user_id2** | **str**| | [optional] + +### Return type + +[**Conversations**](Conversations.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ai_analytics_orgs_users_conversation_retrieve** -> ConversationVolume ai_analytics_orgs_users_conversation_retrieve(org, user_id, period=period) +> ConversationVolume ai_analytics_orgs_users_conversation_retrieve(org, user_id, end_date=end_date, start_date=start_date) @@ -55,10 +307,11 @@ client = get_platform_api_client( api_instance = iblai.AiAnalyticsApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -period = '7d' # str | (optional) (default to '7d') +end_date = '2013-10-20' # date | (optional) +start_date = '2013-10-20' # date | (optional) try: - api_response = api_instance.ai_analytics_orgs_users_conversation_retrieve(org, user_id, period=period) + api_response = api_instance.ai_analytics_orgs_users_conversation_retrieve(org, user_id, end_date=end_date, start_date=start_date) print("The response of AiAnalyticsApi->ai_analytics_orgs_users_conversation_retrieve:\n") pprint(api_response) except Exception as e: @@ -74,7 +327,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **period** | **str**| | [optional] [default to '7d'] + **end_date** | **date**| | [optional] + **start_date** | **date**| | [optional] ### Return type @@ -1122,9 +1376,9 @@ client = get_platform_api_client( api_instance = iblai.AiAnalyticsApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -end_date = '2013-10-20T19:20:30+01:00' # datetime | (optional) +end_date = '2013-10-20' # date | (optional) mentor = 'mentor_example' # str | (optional) -start_date = '2013-10-20T19:20:30+01:00' # datetime | (optional) +start_date = '2013-10-20' # date | (optional) topics = 'topics_example' # str | (optional) try: @@ -1144,9 +1398,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **end_date** | **datetime**| | [optional] + **end_date** | **date**| | [optional] **mentor** | **str**| | [optional] - **start_date** | **datetime**| | [optional] + **start_date** | **date**| | [optional] **topics** | **str**| | [optional] ### Return type diff --git a/docs/AiIndexApi.md b/docs/AiIndexApi.md index 8583a70..30864cf 100644 --- a/docs/AiIndexApi.md +++ b/docs/AiIndexApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://base.manager.iblai.app* Method | HTTP request | Description ------------- | ------------- | ------------- [**ai_index_orgs_users_documents_destroy**](AiIndexApi.md#ai_index_orgs_users_documents_destroy) | **DELETE** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | +[**ai_index_orgs_users_documents_graph_train_create**](AiIndexApi.md#ai_index_orgs_users_documents_graph_train_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/ | [**ai_index_orgs_users_documents_pathways_retrieve**](AiIndexApi.md#ai_index_orgs_users_documents_pathways_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/ | [**ai_index_orgs_users_documents_retrieve**](AiIndexApi.md#ai_index_orgs_users_documents_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | [**ai_index_orgs_users_documents_search_create**](AiIndexApi.md#ai_index_orgs_users_documents_search_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/search/ | @@ -14,6 +15,9 @@ Method | HTTP request | Description [**ai_index_orgs_users_documents_train_retriever_create**](AiIndexApi.md#ai_index_orgs_users_documents_train_retriever_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/ | [**ai_index_orgs_users_documents_train_sessions_create**](AiIndexApi.md#ai_index_orgs_users_documents_train_sessions_create) | **POST** /api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/ | [**ai_index_orgs_users_documents_update**](AiIndexApi.md#ai_index_orgs_users_documents_update) | **PUT** /api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/ | +[**ai_index_orgs_users_resource_data_scrapped_retrieve**](AiIndexApi.md#ai_index_orgs_users_resource_data_scrapped_retrieve) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/resource/data/scrapped/ | +[**ai_index_orgs_users_resource_data_scrapped_retrieve2**](AiIndexApi.md#ai_index_orgs_users_resource_data_scrapped_retrieve2) | **GET** /api/ai-index/orgs/{org}/users/{user_id}/resource/{resource_id}/data/scrapped/ | +[**ai_index_webhook_scan_create**](AiIndexApi.md#ai_index_webhook_scan_create) | **POST** /api/ai-index/webhook/scan/ | # **ai_index_orgs_users_documents_destroy** @@ -88,6 +92,82 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ai_index_orgs_users_documents_graph_train_create** +> TrainDocumentViewResponse ai_index_orgs_users_documents_graph_train_create(org, user_id, train_document_view_request) + + + +This is for training graph - based documents through the worker. Accessible to tenant admins only. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.train_document_view_request import TrainDocumentViewRequest +from iblai.models.train_document_view_response import TrainDocumentViewResponse +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiIndexApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +train_document_view_request = iblai.TrainDocumentViewRequest() # TrainDocumentViewRequest | + +try: + api_response = api_instance.ai_index_orgs_users_documents_graph_train_create(org, user_id, train_document_view_request) + print("The response of AiIndexApi->ai_index_orgs_users_documents_graph_train_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiIndexApi->ai_index_orgs_users_documents_graph_train_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **train_document_view_request** | [**TrainDocumentViewRequest**](TrainDocumentViewRequest.md)| | + +### Return type + +[**TrainDocumentViewResponse**](TrainDocumentViewResponse.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ai_index_orgs_users_documents_pathways_retrieve** > RetrieverDocumentEmbedding ai_index_orgs_users_documents_pathways_retrieve(org, pathway, user_id) @@ -773,3 +853,219 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ai_index_orgs_users_resource_data_scrapped_retrieve** +> ResourceScrappedData ai_index_orgs_users_resource_data_scrapped_retrieve(org, user_id, is_archive=is_archive, is_like=is_like, is_video=is_video, search_key=search_key) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.resource_scrapped_data import ResourceScrappedData +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiIndexApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +is_archive = True # bool | (optional) +is_like = True # bool | (optional) +is_video = True # bool | (optional) +search_key = 'search_key_example' # str | (optional) + +try: + api_response = api_instance.ai_index_orgs_users_resource_data_scrapped_retrieve(org, user_id, is_archive=is_archive, is_like=is_like, is_video=is_video, search_key=search_key) + print("The response of AiIndexApi->ai_index_orgs_users_resource_data_scrapped_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiIndexApi->ai_index_orgs_users_resource_data_scrapped_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **is_archive** | **bool**| | [optional] + **is_like** | **bool**| | [optional] + **is_video** | **bool**| | [optional] + **search_key** | **str**| | [optional] + +### Return type + +[**ResourceScrappedData**](ResourceScrappedData.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_index_orgs_users_resource_data_scrapped_retrieve2** +> ResourceScrappedData ai_index_orgs_users_resource_data_scrapped_retrieve2(org, resource_id, user_id) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.resource_scrapped_data import ResourceScrappedData +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiIndexApi(api_client) +org = 'org_example' # str | +resource_id = 'resource_id_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_index_orgs_users_resource_data_scrapped_retrieve2(org, resource_id, user_id) + print("The response of AiIndexApi->ai_index_orgs_users_resource_data_scrapped_retrieve2:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiIndexApi->ai_index_orgs_users_resource_data_scrapped_retrieve2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **resource_id** | **str**| | + **user_id** | **str**| | + +### Return type + +[**ResourceScrappedData**](ResourceScrappedData.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_index_webhook_scan_create** +> ScanWebhookResponse ai_index_webhook_scan_create(scan_webhook_request) + + + +Webhook endpoint to receive file scan status. + +### Example + + +```python +import iblai +from iblai.models.scan_webhook_request import ScanWebhookRequest +from iblai.models.scan_webhook_response import ScanWebhookResponse +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.AiIndexApi(api_client) +scan_webhook_request = iblai.ScanWebhookRequest() # ScanWebhookRequest | + +try: + api_response = api_instance.ai_index_webhook_scan_create(scan_webhook_request) + print("The response of AiIndexApi->ai_index_webhook_scan_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiIndexApi->ai_index_webhook_scan_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scan_webhook_request** | [**ScanWebhookRequest**](ScanWebhookRequest.md)| | + +### Return type + +[**ScanWebhookResponse**](ScanWebhookResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AiMentorApi.md b/docs/AiMentorApi.md index 6ab0a30..3c82e0c 100644 --- a/docs/AiMentorApi.md +++ b/docs/AiMentorApi.md @@ -6,7 +6,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**ai_mentor_orgs_metadata_create**](AiMentorApi.md#ai_mentor_orgs_metadata_create) | **POST** /api/ai-mentor/orgs/{org}/metadata/ | [**ai_mentor_orgs_sessions_create**](AiMentorApi.md#ai_mentor_orgs_sessions_create) | **POST** /api/ai-mentor/orgs/{org}/sessions/ | +[**ai_mentor_orgs_users_ai_generated_images_destroy**](AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/ | +[**ai_mentor_orgs_users_ai_generated_images_list**](AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/ | +[**ai_mentor_orgs_users_ai_generated_images_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_ai_generated_images_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/ | [**ai_mentor_orgs_users_audio_to_text_create**](AiMentorApi.md#ai_mentor_orgs_users_audio_to_text_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/audio-to-text/ | +[**ai_mentor_orgs_users_available_template_mentors_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_available_template_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/available-template-mentors/ | [**ai_mentor_orgs_users_clear_chathistory_destroy**](AiMentorApi.md#ai_mentor_orgs_users_clear_chathistory_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/clear-chathistory | [**ai_mentor_orgs_users_create**](AiMentorApi.md#ai_mentor_orgs_users_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/ | [**ai_mentor_orgs_users_create_mentor_wizard_create**](AiMentorApi.md#ai_mentor_orgs_users_create_mentor_wizard_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/ | @@ -29,13 +33,22 @@ Method | HTTP request | Description [**ai_mentor_orgs_users_mentor_feedback_update**](AiMentorApi.md#ai_mentor_orgs_users_mentor_feedback_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/ | [**ai_mentor_orgs_users_mentor_from_template_create**](AiMentorApi.md#ai_mentor_orgs_users_mentor_from_template_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-from-template/ | [**ai_mentor_orgs_users_mentor_llms_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentor_llms_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-llms/ | +[**ai_mentor_orgs_users_mentor_seed_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentor_seed_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor/seed/ | [**ai_mentor_orgs_users_mentor_tools_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentor_tools_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-tools/ | [**ai_mentor_orgs_users_mentor_with_settings_create**](AiMentorApi.md#ai_mentor_orgs_users_mentor_with_settings_create) | **POST** /api/ai-mentor/orgs/{org}/users/{user_id}/mentor-with-settings/ | +[**ai_mentor_orgs_users_mentors_available_tools_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_available_tools_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/available-tools/ | +[**ai_mentor_orgs_users_mentors_memory_component_settings_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_memory_component_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/ | +[**ai_mentor_orgs_users_mentors_memory_component_settings_update**](AiMentorApi.md#ai_mentor_orgs_users_mentors_memory_component_settings_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/ | [**ai_mentor_orgs_users_mentors_public_settings_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_public_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-settings/ | [**ai_mentor_orgs_users_mentors_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/ | +[**ai_mentor_orgs_users_mentors_scenarios_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_scenarios_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/ | +[**ai_mentor_orgs_users_mentors_scenarios_update**](AiMentorApi.md#ai_mentor_orgs_users_mentors_scenarios_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/ | [**ai_mentor_orgs_users_mentors_settings_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_mentors_settings_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/ | [**ai_mentor_orgs_users_mentors_settings_update**](AiMentorApi.md#ai_mentor_orgs_users_mentors_settings_update) | **PUT** /api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/ | [**ai_mentor_orgs_users_metadata_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_metadata_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/metadata | +[**ai_mentor_orgs_users_moderation_logs_destroy**](AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/ | +[**ai_mentor_orgs_users_moderation_logs_list**](AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/ | +[**ai_mentor_orgs_users_moderation_logs_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_moderation_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/ | [**ai_mentor_orgs_users_partial_update**](AiMentorApi.md#ai_mentor_orgs_users_partial_update) | **PATCH** /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/ | [**ai_mentor_orgs_users_periodic_agent_logs_list**](AiMentorApi.md#ai_mentor_orgs_users_periodic_agent_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/ | [**ai_mentor_orgs_users_periodic_agent_logs_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_periodic_agent_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/{id}/ | @@ -61,6 +74,9 @@ Method | HTTP request | Description [**ai_mentor_orgs_users_recommend_courses_block_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_recommend_courses_block_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses-block/ | [**ai_mentor_orgs_users_recommend_courses_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_recommend_courses_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/ | [**ai_mentor_orgs_users_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/{name}/ | +[**ai_mentor_orgs_users_safety_logs_destroy**](AiMentorApi.md#ai_mentor_orgs_users_safety_logs_destroy) | **DELETE** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/ | +[**ai_mentor_orgs_users_safety_logs_list**](AiMentorApi.md#ai_mentor_orgs_users_safety_logs_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/ | +[**ai_mentor_orgs_users_safety_logs_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_safety_logs_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/ | [**ai_mentor_orgs_users_session_detail_mentors_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_session_detail_mentors_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/session-detail/mentors/{mentor}/ | [**ai_mentor_orgs_users_sessionid_list**](AiMentorApi.md#ai_mentor_orgs_users_sessionid_list) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/sessionid/ | [**ai_mentor_orgs_users_sessions_browser_screenshot_retrieve**](AiMentorApi.md#ai_mentor_orgs_users_sessions_browser_screenshot_retrieve) | **GET** /api/ai-mentor/orgs/{org}/users/{user_id}/sessions/{session_id}/browser-screenshot/ | @@ -81,11 +97,11 @@ Method | HTTP request | Description # **ai_mentor_orgs_metadata_create** -> ai_mentor_orgs_metadata_create(org) +> MentorMetadata ai_mentor_orgs_metadata_create(org, mentor_metadata) -Endpoint for adding mentor metadata. Accessible to tenant admins and students. Returns: 201: Metadata Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Request: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } +Endpoint for adding mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Request: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\", \"mentor_id: 1 } Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\", \"mentor_id: 1 } ### Example @@ -93,6 +109,7 @@ Endpoint for adding mentor metadata. Accessible to tenant admins and students. ```python import iblai +from iblai.models.mentor_metadata import MentorMetadata from iblai.rest import ApiException from pprint import pprint @@ -111,9 +128,12 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | +mentor_metadata = iblai.MentorMetadata() # MentorMetadata | try: - api_instance.ai_mentor_orgs_metadata_create(org) + api_response = api_instance.ai_mentor_orgs_metadata_create(org, mentor_metadata) + print("The response of AiMentorApi->ai_mentor_orgs_metadata_create:\n") + pprint(api_response) except Exception as e: print("Exception when calling AiMentorApi->ai_mentor_orgs_metadata_create: %s\n" % e) ``` @@ -126,10 +146,11 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **mentor_metadata** | [**MentorMetadata**](MentorMetadata.md)| | ### Return type -void (empty response body) +[**MentorMetadata**](MentorMetadata.md) ### Authorization @@ -137,14 +158,14 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -210,12 +231,12 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_audio_to_text_create** -> AudioToTextResponse ai_mentor_orgs_users_audio_to_text_create(org, user_id, audio_to_text_request) +# **ai_mentor_orgs_users_ai_generated_images_destroy** +> ai_mentor_orgs_users_ai_generated_images_destroy(id, org, user_id) -Endpoint to convert audio to text. Accessible to tenant admins and students. Returns: 200: audio text object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/audio-to-text/ Request: { \"file\": binary } Response: { \"text\": \"Programming\", } +Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. ### Example @@ -223,8 +244,6 @@ Endpoint to convert audio to text. Accessible to tenant admins and students. R ```python import iblai -from iblai.models.audio_to_text_request import AudioToTextRequest -from iblai.models.audio_to_text_response import AudioToTextResponse from iblai.rest import ApiException from pprint import pprint @@ -242,16 +261,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this ai generated image. org = 'org_example' # str | user_id = 'user_id_example' # str | -audio_to_text_request = iblai.AudioToTextRequest() # AudioToTextRequest | try: - api_response = api_instance.ai_mentor_orgs_users_audio_to_text_create(org, user_id, audio_to_text_request) - print("The response of AiMentorApi->ai_mentor_orgs_users_audio_to_text_create:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_ai_generated_images_destroy(id, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_audio_to_text_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_ai_generated_images_destroy: %s\n" % e) ``` @@ -261,13 +278,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this ai generated image. | **org** | **str**| | **user_id** | **str**| | - **audio_to_text_request** | [**AudioToTextRequest**](AudioToTextRequest.md)| | ### Return type -[**AudioToTextResponse**](AudioToTextResponse.md) +void (empty response body) ### Authorization @@ -275,23 +292,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_clear_chathistory_destroy** -> ai_mentor_orgs_users_clear_chathistory_destroy(org, user_id) +# **ai_mentor_orgs_users_ai_generated_images_list** +> PaginatedAIGeneratedImageList ai_mentor_orgs_users_ai_generated_images_list(org, user_id, model=model, ordering=ordering, page=page, page_size=page_size, provider=provider, search=search, username=username) -Endpoint to clear user's chat history Returns: 200: No responde data +Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. ### Example @@ -299,6 +316,7 @@ Endpoint to clear user's chat history Returns: 200: No responde data ```python import iblai +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList from iblai.rest import ApiException from pprint import pprint @@ -318,11 +336,20 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +model = 'model_example' # str | (optional) +ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional) +page = 56 # int | A page number within the paginated result set. (optional) +page_size = 56 # int | Number of results to return per page. (optional) +provider = 'provider_example' # str | (optional) +search = 'search_example' # str | A search term. (optional) +username = 'username_example' # str | (optional) try: - api_instance.ai_mentor_orgs_users_clear_chathistory_destroy(org, user_id) + api_response = api_instance.ai_mentor_orgs_users_ai_generated_images_list(org, user_id, model=model, ordering=ordering, page=page, page_size=page_size, provider=provider, search=search, username=username) + print("The response of AiMentorApi->ai_mentor_orgs_users_ai_generated_images_list:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_clear_chathistory_destroy: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_ai_generated_images_list: %s\n" % e) ``` @@ -334,10 +361,17 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **model** | **str**| | [optional] + **ordering** | **str**| Which field to use when ordering the results. | [optional] + **page** | **int**| A page number within the paginated result set. | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **provider** | **str**| | [optional] + **search** | **str**| A search term. | [optional] + **username** | **str**| | [optional] ### Return type -void (empty response body) +[**PaginatedAIGeneratedImageList**](PaginatedAIGeneratedImageList.md) ### Authorization @@ -346,22 +380,22 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_create** -> Mentor ai_mentor_orgs_users_create(org, user_id, mentor, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) +# **ai_mentor_orgs_users_ai_generated_images_retrieve** +> AIGeneratedImage ai_mentor_orgs_users_ai_generated_images_retrieve(id, org, user_id) -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent +Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. ### Example @@ -369,7 +403,7 @@ Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ```python import iblai -from iblai.models.mentor import Mentor +from iblai.models.ai_generated_image import AIGeneratedImage from iblai.rest import ApiException from pprint import pprint @@ -387,21 +421,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this ai generated image. org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor = iblai.Mentor() # Mentor | -filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) -metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) -metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) -return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) -visibility = 'visibility_example' # str | visibility type to be queried with (optional) try: - api_response = api_instance.ai_mentor_orgs_users_create(org, user_id, mentor, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) - print("The response of AiMentorApi->ai_mentor_orgs_users_create:\n") + api_response = api_instance.ai_mentor_orgs_users_ai_generated_images_retrieve(id, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_ai_generated_images_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_ai_generated_images_retrieve: %s\n" % e) ``` @@ -411,18 +440,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this ai generated image. | **org** | **str**| | **user_id** | **str**| | - **mentor** | [**Mentor**](Mentor.md)| | - **filter_by** | **str**| Filter options include, date, name, default is date | [optional] - **metadata_key** | **str**| Metadata key to be queried with | [optional] - **metadata_value** | **str**| Metadata value to be filter for | [optional] - **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] - **visibility** | **str**| visibility type to be queried with | [optional] ### Return type -[**Mentor**](Mentor.md) +[**AIGeneratedImage**](AIGeneratedImage.md) ### Authorization @@ -430,23 +454,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_create_mentor_wizard_create** -> Mentor ai_mentor_orgs_users_create_mentor_wizard_create(org, user_id, mentor_wizard) +# **ai_mentor_orgs_users_audio_to_text_create** +> AudioToTextResponse ai_mentor_orgs_users_audio_to_text_create(org, user_id, audio_to_text_request) - Endpoint to automatically create a mentor given a name and a description of the mentor. All other parameters for the mentor will be automatically populated using an llm. This includes but not limitted to marketing conversations, system prompt, proactive prompt, profile icon and more. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 201: a Mentor instance 400: An error occurred when validating inputs or creating mentor. Example: **Create a mentor** POST: /api/ai-mentor/orgs/main/users/johndoe/create-mentor-wizard/ Request: { \"name\": \"Fashion Expert\", \"description\": \"An expert at Fashion Design } Response: { \"name\": \"Fashion Agent\", \"unique_id\": \"ef425893-877c-4538-9e79-54eb1eebd165\", \"platform\": \"main\", \"slug\": \"df57c4b3-32c5-4a3a-81a4-97e9e2ac8d25\", \"description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"allow_anonymous\": false, \"pathways\": [], \"session_information\": { \"user_count\": 0, \"session_count\": 0, \"users\": {} }, \"suggested_prompts\": [], \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"system_prompt\": \"You are an expert in fashion. Your role is to educate users on the latest fashion trends, styles, and tips in dressing, clothes, shoes, and makeup. Explain concepts clearly and provide practical examples.\", \"metadata\": { \"category\": \"Fashion\" }, \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. Any prompt that is immoral or contains abusive words, insults, query that involve damaging content, and law breaking acts, etc should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"moderation_response\": \"Please keep the conversation within the bounds of what the agent is tasked to do and per your platform's rules.\", \"enable_moderation\": false, \"is_proactive\": false, \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\", \"created_at\": \"2024-07-16T13:53:48.583825+00:00\", \"updated_at\": \"2024-07-16T13:53:48.612369+00:00\", \"seo_tags\": [ { \"name\": \"viewport\", \"content\": \"width=device-width, initial-scale=1.0\" }, { \"name\": \"description\", \"content\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\" }, { \"name\": \"keywords\", \"content\": \"Fashion, Dressing, Clothes, Shoes, Makeup, Trends\" } ], \"marketing_conversations\": [ { \"type\": \"ai\", \"content\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. What would you like to learn about today?\" }, { \"type\": \"human\", \"content\": \"Can you suggest some trendy outfits for this season?\" }, { \"type\": \"ai\", \"content\": \"Absolutely! This season, oversized blazers, high-waisted trousers, and statement boots are trending. Pair these with minimalist accessories for a chic look. Would you like to know more about any specific item?\" }, { \"type\": \"human\", \"content\": \"What makeup trends are popular right now?\" }, { \"type\": \"ai\", \"content\": \"Current makeup trends include bold eyeliner, glitter accents, and natural, glowing skin. Bright lip colors are also making a comeback. Which of these trends would you like to explore more?\" } ], \"tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"created_by\": null, \"settings\": { \"id\": 98, \"display_name\": \"Fashion Agent\", \"profile_image\": \"http://localhost:8000/media/public/mentor/profile/2fc32125-2404-4ca9-8261-bcb66f48f4bb.png\", \"initial_message\": null, \"suggested_message\": null, \"theme\": \"light\", \"user_message_color\": \"#2467EB\", \"mentor_bubble_color\": \"#000000\", \"align_mentor_bubble\": \"left\", \"mentor\": \"Fashion Agent\", \"metadata\": { \"category\": \"Fashion\" }, \"mentor_visibility\": \"viewable_by_anyone\", \"enable_image_generation\": true, \"enable_web_browsing\": false, \"enable_code_interpreter\": false, \"custom_css\": null, \"allow_anonymous\": false, \"mentor_description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"suggested_prompts\": [], \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"mentor_tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\" } } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } +Endpoint to convert audio to text. Accessible to tenant admins and students. Returns: 200: audio text object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/audio-to-text/ Request: { \"file\": binary } Response: { \"text\": \"Programming\", } ### Example @@ -454,8 +478,8 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.mentor import Mentor -from iblai.models.mentor_wizard import MentorWizard +from iblai.models.audio_to_text_request import AudioToTextRequest +from iblai.models.audio_to_text_response import AudioToTextResponse from iblai.rest import ApiException from pprint import pprint @@ -475,14 +499,14 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor_wizard = iblai.MentorWizard() # MentorWizard | +audio_to_text_request = iblai.AudioToTextRequest() # AudioToTextRequest | try: - api_response = api_instance.ai_mentor_orgs_users_create_mentor_wizard_create(org, user_id, mentor_wizard) - print("The response of AiMentorApi->ai_mentor_orgs_users_create_mentor_wizard_create:\n") + api_response = api_instance.ai_mentor_orgs_users_audio_to_text_create(org, user_id, audio_to_text_request) + print("The response of AiMentorApi->ai_mentor_orgs_users_audio_to_text_create:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_create_mentor_wizard_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_audio_to_text_create: %s\n" % e) ``` @@ -494,11 +518,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **mentor_wizard** | [**MentorWizard**](MentorWizard.md)| | + **audio_to_text_request** | [**AudioToTextRequest**](AudioToTextRequest.md)| | ### Return type -[**Mentor**](Mentor.md) +[**AudioToTextResponse**](AudioToTextResponse.md) ### Authorization @@ -513,16 +537,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_custom_instruction_create** -> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_create(org, user_id, custom_instruction_response=custom_instruction_response) +# **ai_mentor_orgs_users_available_template_mentors_retrieve** +> TemplateMentor ai_mentor_orgs_users_available_template_mentors_retrieve(org, user_id) -Endpoint for Adding user's custom instructions Accessible to tenant admins and students. Returns: 201: Custom Instruction Object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Request: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } +This endpoint list available template mentors for a tenant Returns: 200 : List of Tool objects Example : GET : api/ai-mentor/orgs/main/users/johndoe/available-template-mentors/ Response: [ { \"id\": 1, \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"unique_id\": \"8485a252-eecf-436b-ba25-3f4ea3e7cda9\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", } ] ### Example @@ -530,7 +554,7 @@ Endpoint for Adding user's custom instructions Accessible to tenant admins and ```python import iblai -from iblai.models.custom_instruction_response import CustomInstructionResponse +from iblai.models.template_mentor import TemplateMentor from iblai.rest import ApiException from pprint import pprint @@ -550,14 +574,13 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -custom_instruction_response = iblai.CustomInstructionResponse() # CustomInstructionResponse | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_custom_instruction_create(org, user_id, custom_instruction_response=custom_instruction_response) - print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_create:\n") + api_response = api_instance.ai_mentor_orgs_users_available_template_mentors_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_available_template_mentors_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_available_template_mentors_retrieve: %s\n" % e) ``` @@ -569,11 +592,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **custom_instruction_response** | [**CustomInstructionResponse**](CustomInstructionResponse.md)| | [optional] ### Return type -[**CustomInstructionResponse**](CustomInstructionResponse.md) +[**TemplateMentor**](TemplateMentor.md) ### Authorization @@ -581,23 +603,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_custom_instruction_retrieve** -> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_retrieve(org, user_id) +# **ai_mentor_orgs_users_clear_chathistory_destroy** +> ai_mentor_orgs_users_clear_chathistory_destroy(org, user_id) -Endpoint for getting user's custom prompts Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } +Endpoint to clear user's chat history Returns: 204: No responde data ### Example @@ -605,7 +627,6 @@ Endpoint for getting user's custom prompts Accessible to tenant admins and stud ```python import iblai -from iblai.models.custom_instruction_response import CustomInstructionResponse from iblai.rest import ApiException from pprint import pprint @@ -627,11 +648,9 @@ org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_custom_instruction_retrieve(org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_clear_chathistory_destroy(org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_clear_chathistory_destroy: %s\n" % e) ``` @@ -646,7 +665,7 @@ Name | Type | Description | Notes ### Return type -[**CustomInstructionResponse**](CustomInstructionResponse.md) +void (empty response body) ### Authorization @@ -655,22 +674,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_custom_instruction_update** -> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_update(org, user_id, custom_instruction_response=custom_instruction_response) +# **ai_mentor_orgs_users_create** +> Mentor ai_mentor_orgs_users_create(org, user_id, mentor, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) -Endpoint for updating user's custom instructions. Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ REquest: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -678,7 +697,7 @@ Endpoint for updating user's custom instructions. Accessible to tenant admins a ```python import iblai -from iblai.models.custom_instruction_response import CustomInstructionResponse +from iblai.models.mentor import Mentor from iblai.rest import ApiException from pprint import pprint @@ -698,14 +717,19 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -custom_instruction_response = iblai.CustomInstructionResponse() # CustomInstructionResponse | (optional) +mentor = iblai.Mentor() # Mentor | +filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) +metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) +metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) +return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) +visibility = 'visibility_example' # str | visibility type to be queried with (optional) try: - api_response = api_instance.ai_mentor_orgs_users_custom_instruction_update(org, user_id, custom_instruction_response=custom_instruction_response) - print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_update:\n") + api_response = api_instance.ai_mentor_orgs_users_create(org, user_id, mentor, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) + print("The response of AiMentorApi->ai_mentor_orgs_users_create:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_update: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_create: %s\n" % e) ``` @@ -717,11 +741,16 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **custom_instruction_response** | [**CustomInstructionResponse**](CustomInstructionResponse.md)| | [optional] + **mentor** | [**Mentor**](Mentor.md)| | + **filter_by** | **str**| Filter options include, date, name, default is date | [optional] + **metadata_key** | **str**| Metadata key to be queried with | [optional] + **metadata_value** | **str**| Metadata value to be filter for | [optional] + **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] + **visibility** | **str**| visibility type to be queried with | [optional] ### Return type -[**CustomInstructionResponse**](CustomInstructionResponse.md) +[**Mentor**](Mentor.md) ### Authorization @@ -736,16 +765,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_destroy** -> ai_mentor_orgs_users_destroy(name, org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) +# **ai_mentor_orgs_users_create_mentor_wizard_create** +> Mentor ai_mentor_orgs_users_create_mentor_wizard_create(org, user_id, mentor_wizard) -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + Endpoint to automatically create a mentor given a name and a description of the mentor. All other parameters for the mentor will be automatically populated using an llm. This includes but not limitted to marketing conversations, system prompt, proactive prompt, profile icon and more. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 201: a Mentor instance 400: An error occurred when validating inputs or creating mentor. Example: **Create a mentor** POST: /api/ai-mentor/orgs/main/users/johndoe/create-mentor-wizard/ Request: { \"name\": \"Fashion Expert\", \"description\": \"An expert at Fashion Design } Response: { \"name\": \"Fashion Agent\", \"unique_id\": \"ef425893-877c-4538-9e79-54eb1eebd165\", \"platform\": \"main\", \"slug\": \"df57c4b3-32c5-4a3a-81a4-97e9e2ac8d25\", \"description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"allow_anonymous\": false, \"pathways\": [], \"session_information\": { \"user_count\": 0, \"session_count\": 0, \"users\": {} }, \"suggested_prompts\": [], \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"system_prompt\": \"You are an expert in fashion. Your role is to educate users on the latest fashion trends, styles, and tips in dressing, clothes, shoes, and makeup. Explain concepts clearly and provide practical examples.\", \"metadata\": { \"category\": \"Fashion\" }, \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. Any prompt that is immoral or contains abusive words, insults, query that involve damaging content, and law breaking acts, etc should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"moderation_response\": \"Please keep the conversation within the bounds of what the agent is tasked to do and per your platform's rules.\", \"enable_moderation\": false, \"safety_system_prompt\": \"You are a moderator tasked with identifying whether a message from an ai model to a user is is appropriate or inappropriate. If the message is immoral or contains abusive words, insults, damaging content, and law breaking acts, etc it should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"safety_response\": \"Sorry, the AI model generated an inappropriate response. Kindly refine your prompt or try again with a different prompt.\", \"enable_safety_system\": false, \"is_proactive\": false, \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\", \"created_at\": \"2024-07-16T13:53:48.583825+00:00\", \"updated_at\": \"2024-07-16T13:53:48.612369+00:00\", \"seo_tags\": [ { \"name\": \"viewport\", \"content\": \"width=device-width, initial-scale=1.0\" }, { \"name\": \"description\", \"content\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\" }, { \"name\": \"keywords\", \"content\": \"Fashion, Dressing, Clothes, Shoes, Makeup, Trends\" } ], \"marketing_conversations\": [ { \"type\": \"ai\", \"content\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. What would you like to learn about today?\" }, { \"type\": \"human\", \"content\": \"Can you suggest some trendy outfits for this season?\" }, { \"type\": \"ai\", \"content\": \"Absolutely! This season, oversized blazers, high-waisted trousers, and statement boots are trending. Pair these with minimalist accessories for a chic look. Would you like to know more about any specific item?\" }, { \"type\": \"human\", \"content\": \"What makeup trends are popular right now?\" }, { \"type\": \"ai\", \"content\": \"Current makeup trends include bold eyeliner, glitter accents, and natural, glowing skin. Bright lip colors are also making a comeback. Which of these trends would you like to explore more?\" } ], \"tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"created_by\": null, \"settings\": { \"id\": 98, \"display_name\": \"Fashion Agent\", \"profile_image\": \"http://localhost:8000/media/public/mentor/profile/2fc32125-2404-4ca9-8261-bcb66f48f4bb.png\", \"initial_message\": null, \"suggested_message\": null, \"theme\": \"light\", \"user_message_color\": \"#2467EB\", \"mentor_bubble_color\": \"#000000\", \"align_mentor_bubble\": \"left\", \"mentor\": \"Fashion Agent\", \"metadata\": { \"category\": \"Fashion\" }, \"mentor_visibility\": \"viewable_by_anyone\", \"enable_image_generation\": true, \"enable_web_browsing\": false, \"enable_code_interpreter\": false, \"custom_css\": null, \"allow_anonymous\": false, \"mentor_description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"suggested_prompts\": [], \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"mentor_tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\" } } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } ### Example @@ -753,6 +782,8 @@ Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ```python import iblai +from iblai.models.mentor import Mentor +from iblai.models.mentor_wizard import MentorWizard from iblai.rest import ApiException from pprint import pprint @@ -770,19 +801,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -name = 'name_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) -metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) -metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) -return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) -visibility = 'visibility_example' # str | visibility type to be queried with (optional) +mentor_wizard = iblai.MentorWizard() # MentorWizard | try: - api_instance.ai_mentor_orgs_users_destroy(name, org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) + api_response = api_instance.ai_mentor_orgs_users_create_mentor_wizard_create(org, user_id, mentor_wizard) + print("The response of AiMentorApi->ai_mentor_orgs_users_create_mentor_wizard_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_destroy: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_create_mentor_wizard_create: %s\n" % e) ``` @@ -792,18 +820,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **name** | **str**| | **org** | **str**| | **user_id** | **str**| | - **filter_by** | **str**| Filter options include, date, name, default is date | [optional] - **metadata_key** | **str**| Metadata key to be queried with | [optional] - **metadata_value** | **str**| Metadata value to be filter for | [optional] - **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] - **visibility** | **str**| visibility type to be queried with | [optional] + **mentor_wizard** | [**MentorWizard**](MentorWizard.md)| | ### Return type -void (empty response body) +[**Mentor**](Mentor.md) ### Authorization @@ -811,23 +834,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_downloads_tasks_retrieve** -> ChatHistoryItem ai_mentor_orgs_users_downloads_tasks_retrieve(org, task_id, user_id, to_csv=to_csv) +# **ai_mentor_orgs_users_custom_instruction_create** +> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_create(org, user_id, custom_instruction_response=custom_instruction_response) -Endpoint to download user chathistory. Accessible to tenant admins and students. Returns: 200: When task is not ready. 200: chat history object 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/lydiah/downloads/tasks/307be194-2351-44ff-8d7b-24660fd9ec34 Response: { \"state\": \"task_not_ready\" } +Endpoint for Adding user's custom instructions Accessible to tenant admins and students. Returns: 201: Custom Instruction Object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Request: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } ### Example @@ -835,7 +858,7 @@ Endpoint to download user chathistory. Accessible to tenant admins and students ```python import iblai -from iblai.models.chat_history_item import ChatHistoryItem +from iblai.models.custom_instruction_response import CustomInstructionResponse from iblai.rest import ApiException from pprint import pprint @@ -854,16 +877,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | -task_id = 'task_id_example' # str | user_id = 'user_id_example' # str | -to_csv = False # bool | Choose download in csv or not (optional) (default to False) +custom_instruction_response = iblai.CustomInstructionResponse() # CustomInstructionResponse | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_downloads_tasks_retrieve(org, task_id, user_id, to_csv=to_csv) - print("The response of AiMentorApi->ai_mentor_orgs_users_downloads_tasks_retrieve:\n") + api_response = api_instance.ai_mentor_orgs_users_custom_instruction_create(org, user_id, custom_instruction_response=custom_instruction_response) + print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_create:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_downloads_tasks_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_create: %s\n" % e) ``` @@ -874,13 +896,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **task_id** | **str**| | **user_id** | **str**| | - **to_csv** | **bool**| Choose download in csv or not | [optional] [default to False] + **custom_instruction_response** | [**CustomInstructionResponse**](CustomInstructionResponse.md)| | [optional] ### Return type -[**ChatHistoryItem**](ChatHistoryItem.md) +[**CustomInstructionResponse**](CustomInstructionResponse.md) ### Authorization @@ -888,23 +909,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_edx_memory_destroy** -> ai_mentor_orgs_users_edx_memory_destroy(id, org, user_id) +# **ai_mentor_orgs_users_custom_instruction_retrieve** +> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_retrieve(org, user_id) -Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } +Endpoint for getting user's custom prompts Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } ### Example @@ -912,6 +933,7 @@ Endpoints to fetch and delete Edx stored Memory information stored for a user an ```python import iblai +from iblai.models.custom_instruction_response import CustomInstructionResponse from iblai.rest import ApiException from pprint import pprint @@ -929,14 +951,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -id = 56 # int | A unique integer value identifying this user edx memory. org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_instance.ai_mentor_orgs_users_edx_memory_destroy(id, org, user_id) + api_response = api_instance.ai_mentor_orgs_users_custom_instruction_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_retrieve:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_destroy: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_retrieve: %s\n" % e) ``` @@ -946,13 +969,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this user edx memory. | **org** | **str**| | **user_id** | **str**| | ### Return type -void (empty response body) +[**CustomInstructionResponse**](CustomInstructionResponse.md) ### Authorization @@ -961,22 +983,22 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_edx_memory_list** -> PaginatedUserEdxMemoryList ai_mentor_orgs_users_edx_memory_list(org, user_id, course_id=course_id, ordering=ordering, page=page, page_size=page_size, student=student, username=username) +# **ai_mentor_orgs_users_custom_instruction_update** +> CustomInstructionResponse ai_mentor_orgs_users_custom_instruction_update(org, user_id, custom_instruction_response=custom_instruction_response) -Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } +Endpoint for updating user's custom instructions. Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ REquest: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } ### Example @@ -984,7 +1006,7 @@ Endpoints to fetch and delete Edx stored Memory information stored for a user an ```python import iblai -from iblai.models.paginated_user_edx_memory_list import PaginatedUserEdxMemoryList +from iblai.models.custom_instruction_response import CustomInstructionResponse from iblai.rest import ApiException from pprint import pprint @@ -1004,19 +1026,14 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -course_id = 'course_id_example' # str | (optional) -ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional) -page = 56 # int | A page number within the paginated result set. (optional) -page_size = 56 # int | Number of results to return per page. (optional) -student = 56 # int | edX user ID (optional) -username = 'username_example' # str | (optional) +custom_instruction_response = iblai.CustomInstructionResponse() # CustomInstructionResponse | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_edx_memory_list(org, user_id, course_id=course_id, ordering=ordering, page=page, page_size=page_size, student=student, username=username) - print("The response of AiMentorApi->ai_mentor_orgs_users_edx_memory_list:\n") + api_response = api_instance.ai_mentor_orgs_users_custom_instruction_update(org, user_id, custom_instruction_response=custom_instruction_response) + print("The response of AiMentorApi->ai_mentor_orgs_users_custom_instruction_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_list: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_custom_instruction_update: %s\n" % e) ``` @@ -1028,16 +1045,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **course_id** | **str**| | [optional] - **ordering** | **str**| Which field to use when ordering the results. | [optional] - **page** | **int**| A page number within the paginated result set. | [optional] - **page_size** | **int**| Number of results to return per page. | [optional] - **student** | **int**| edX user ID | [optional] - **username** | **str**| | [optional] + **custom_instruction_response** | [**CustomInstructionResponse**](CustomInstructionResponse.md)| | [optional] ### Return type -[**PaginatedUserEdxMemoryList**](PaginatedUserEdxMemoryList.md) +[**CustomInstructionResponse**](CustomInstructionResponse.md) ### Authorization @@ -1045,7 +1057,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1056,12 +1068,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_edx_memory_retrieve** -> UserEdxMemory ai_mentor_orgs_users_edx_memory_retrieve(id, org, user_id) +# **ai_mentor_orgs_users_destroy** +> ai_mentor_orgs_users_destroy(name, org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) -Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -1069,7 +1081,6 @@ Endpoints to fetch and delete Edx stored Memory information stored for a user an ```python import iblai -from iblai.models.user_edx_memory import UserEdxMemory from iblai.rest import ApiException from pprint import pprint @@ -1087,16 +1098,19 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -id = 56 # int | A unique integer value identifying this user edx memory. +name = 'name_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | +filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) +metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) +metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) +return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) +visibility = 'visibility_example' # str | visibility type to be queried with (optional) try: - api_response = api_instance.ai_mentor_orgs_users_edx_memory_retrieve(id, org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_edx_memory_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_destroy(name, org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, return_session_information=return_session_information, visibility=visibility) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_destroy: %s\n" % e) ``` @@ -1106,13 +1120,18 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this user edx memory. | + **name** | **str**| | **org** | **str**| | **user_id** | **str**| | + **filter_by** | **str**| Filter options include, date, name, default is date | [optional] + **metadata_key** | **str**| Metadata key to be queried with | [optional] + **metadata_value** | **str**| Metadata value to be filter for | [optional] + **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] + **visibility** | **str**| visibility type to be queried with | [optional] ### Return type -[**UserEdxMemory**](UserEdxMemory.md) +void (empty response body) ### Authorization @@ -1121,22 +1140,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_export_chathistory_create** -> TaskView ai_mentor_orgs_users_export_chathistory_create(org, user_id, task_view) +# **ai_mentor_orgs_users_downloads_tasks_retrieve** +> ChatHistoryItem ai_mentor_orgs_users_downloads_tasks_retrieve(org, task_id, user_id, to_csv=to_csv) -Endpoint for worker exporting user chathistory. Accessible to both tenant admins and students. Returns: 200: task id. Example: POST: /api/ai-mentor/orgs/main/users/lydiah/export-chathistory/ Requests: No request data. Response: { \"task_id\": \"307be194-2351-44ff-8d7b-24660fd9ec34\" } +Endpoint to download user chathistory. Accessible to tenant admins and students. Returns: 200: When task is not ready. 200: chat history object 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/lydiah/downloads/tasks/307be194-2351-44ff-8d7b-24660fd9ec34 Response: { \"state\": \"task_not_ready\" } ### Example @@ -1144,7 +1163,7 @@ Endpoint for worker exporting user chathistory. Accessible to both tenant admin ```python import iblai -from iblai.models.task_view import TaskView +from iblai.models.chat_history_item import ChatHistoryItem from iblai.rest import ApiException from pprint import pprint @@ -1163,15 +1182,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | +task_id = 'task_id_example' # str | user_id = 'user_id_example' # str | -task_view = iblai.TaskView() # TaskView | +to_csv = False # bool | Choose download in csv or not (optional) (default to False) try: - api_response = api_instance.ai_mentor_orgs_users_export_chathistory_create(org, user_id, task_view) - print("The response of AiMentorApi->ai_mentor_orgs_users_export_chathistory_create:\n") + api_response = api_instance.ai_mentor_orgs_users_downloads_tasks_retrieve(org, task_id, user_id, to_csv=to_csv) + print("The response of AiMentorApi->ai_mentor_orgs_users_downloads_tasks_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_export_chathistory_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_downloads_tasks_retrieve: %s\n" % e) ``` @@ -1182,12 +1202,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **task_id** | **str**| | **user_id** | **str**| | - **task_view** | [**TaskView**](TaskView.md)| | + **to_csv** | **bool**| Choose download in csv or not | [optional] [default to False] ### Return type -[**TaskView**](TaskView.md) +[**ChatHistoryItem**](ChatHistoryItem.md) ### Authorization @@ -1195,7 +1216,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1206,12 +1227,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_free_usage_count_retrieve** -> FreeUsageCount ai_mentor_orgs_users_free_usage_count_retrieve(org, user_id) +# **ai_mentor_orgs_users_edx_memory_destroy** +> ai_mentor_orgs_users_edx_memory_destroy(id, org, user_id) -Endpoint to get free usage count. Retrieve the number of questions left for a tenant Accessible to tenant admins and students. Returns: 200: free usage count. 404: When tenant not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/free-usage-count/ Response: { \"count\": 3 } +Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } ### Example @@ -1219,7 +1240,6 @@ Endpoint to get free usage count. Retrieve the number of questions left for a t ```python import iblai -from iblai.models.free_usage_count import FreeUsageCount from iblai.rest import ApiException from pprint import pprint @@ -1237,15 +1257,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this user edx memory. org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_free_usage_count_retrieve(org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_free_usage_count_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_edx_memory_destroy(id, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_free_usage_count_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_destroy: %s\n" % e) ``` @@ -1255,12 +1274,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this user edx memory. | **org** | **str**| | **user_id** | **str**| | ### Return type -[**FreeUsageCount**](FreeUsageCount.md) +void (empty response body) ### Authorization @@ -1269,22 +1289,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_list** -> PaginatedMentorList ai_mentor_orgs_users_list(org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, page=page, page_size=page_size, return_session_information=return_session_information, visibility=visibility) +# **ai_mentor_orgs_users_edx_memory_list** +> PaginatedUserEdxMemoryList ai_mentor_orgs_users_edx_memory_list(org, user_id, course_id=course_id, ordering=ordering, page=page, page_size=page_size, student=student, username=username) -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent +Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } ### Example @@ -1292,7 +1312,7 @@ Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ```python import iblai -from iblai.models.paginated_mentor_list import PaginatedMentorList +from iblai.models.paginated_user_edx_memory_list import PaginatedUserEdxMemoryList from iblai.rest import ApiException from pprint import pprint @@ -1312,20 +1332,19 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) -metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) -metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) +course_id = 'course_id_example' # str | (optional) +ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional) page = 56 # int | A page number within the paginated result set. (optional) page_size = 56 # int | Number of results to return per page. (optional) -return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) -visibility = 'visibility_example' # str | visibility type to be queried with (optional) +student = 56 # int | edX user ID (optional) +username = 'username_example' # str | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_list(org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, page=page, page_size=page_size, return_session_information=return_session_information, visibility=visibility) - print("The response of AiMentorApi->ai_mentor_orgs_users_list:\n") + api_response = api_instance.ai_mentor_orgs_users_edx_memory_list(org, user_id, course_id=course_id, ordering=ordering, page=page, page_size=page_size, student=student, username=username) + print("The response of AiMentorApi->ai_mentor_orgs_users_edx_memory_list:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_list: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_list: %s\n" % e) ``` @@ -1337,17 +1356,16 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **filter_by** | **str**| Filter options include, date, name, default is date | [optional] - **metadata_key** | **str**| Metadata key to be queried with | [optional] - **metadata_value** | **str**| Metadata value to be filter for | [optional] + **course_id** | **str**| | [optional] + **ordering** | **str**| Which field to use when ordering the results. | [optional] **page** | **int**| A page number within the paginated result set. | [optional] **page_size** | **int**| Number of results to return per page. | [optional] - **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] - **visibility** | **str**| visibility type to be queried with | [optional] + **student** | **int**| edX user ID | [optional] + **username** | **str**| | [optional] ### Return type -[**PaginatedMentorList**](PaginatedMentorList.md) +[**PaginatedUserEdxMemoryList**](PaginatedUserEdxMemoryList.md) ### Authorization @@ -1366,12 +1384,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_categories_create** -> MentorCategory ai_mentor_orgs_users_mentor_categories_create(org, user_id, mentor_category) +# **ai_mentor_orgs_users_edx_memory_retrieve** +> UserEdxMemory ai_mentor_orgs_users_edx_memory_retrieve(id, org, user_id) -This is for adding mentor categories Accessible to tenant admins only. Returns: 200 : Mentor category detail. Example : POST : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } +Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } ### Example @@ -1379,7 +1397,7 @@ This is for adding mentor categories Accessible to tenant admins only. Returns ```python import iblai -from iblai.models.mentor_category import MentorCategory +from iblai.models.user_edx_memory import UserEdxMemory from iblai.rest import ApiException from pprint import pprint @@ -1397,16 +1415,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this user edx memory. org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor_category = iblai.MentorCategory() # MentorCategory | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_categories_create(org, user_id, mentor_category) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_categories_create:\n") + api_response = api_instance.ai_mentor_orgs_users_edx_memory_retrieve(id, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_edx_memory_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_edx_memory_retrieve: %s\n" % e) ``` @@ -1416,13 +1434,88 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this user edx memory. | **org** | **str**| | **user_id** | **str**| | - **mentor_category** | [**MentorCategory**](MentorCategory.md)| | ### Return type -[**MentorCategory**](MentorCategory.md) +[**UserEdxMemory**](UserEdxMemory.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_export_chathistory_create** +> TaskView ai_mentor_orgs_users_export_chathistory_create(org, user_id, task_view) + + + +Endpoint for worker exporting user chathistory. Accessible to both tenant admins and students. Returns: 200: task id. Example: POST: /api/ai-mentor/orgs/main/users/lydiah/export-chathistory/ Requests: No request data. Response: { \"task_id\": \"307be194-2351-44ff-8d7b-24660fd9ec34\" } + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.task_view import TaskView +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +task_view = iblai.TaskView() # TaskView | + +try: + api_response = api_instance.ai_mentor_orgs_users_export_chathistory_create(org, user_id, task_view) + print("The response of AiMentorApi->ai_mentor_orgs_users_export_chathistory_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_export_chathistory_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **task_view** | [**TaskView**](TaskView.md)| | + +### Return type + +[**TaskView**](TaskView.md) ### Authorization @@ -1441,12 +1534,876 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_categories_destroy** -> ai_mentor_orgs_users_mentor_categories_destroy(org, user_id) +# **ai_mentor_orgs_users_free_usage_count_retrieve** +> FreeUsageCount ai_mentor_orgs_users_free_usage_count_retrieve(org, user_id) -This is for deleting mentor category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"category\": \"Education\" } Response: No response body. +Endpoint to get free usage count. Retrieve the number of questions left for a tenant Accessible to tenant admins and students. Returns: 200: free usage count. 404: When tenant is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/free-usage-count/ Response: { \"count\": 3 } + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.free_usage_count import FreeUsageCount +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_free_usage_count_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_free_usage_count_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_free_usage_count_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**FreeUsageCount**](FreeUsageCount.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_list** +> PaginatedMentorList ai_mentor_orgs_users_list(org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, page=page, page_size=page_size, return_session_information=return_session_information, visibility=visibility) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.paginated_mentor_list import PaginatedMentorList +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) +metadata_key = 'metadata_key_example' # str | Metadata key to be queried with (optional) +metadata_value = 'metadata_value_example' # str | Metadata value to be filter for (optional) +page = 56 # int | A page number within the paginated result set. (optional) +page_size = 56 # int | Number of results to return per page. (optional) +return_session_information = True # bool | Declares if session information should be included in the mentor data (optional) +visibility = 'visibility_example' # str | visibility type to be queried with (optional) + +try: + api_response = api_instance.ai_mentor_orgs_users_list(org, user_id, filter_by=filter_by, metadata_key=metadata_key, metadata_value=metadata_value, page=page, page_size=page_size, return_session_information=return_session_information, visibility=visibility) + print("The response of AiMentorApi->ai_mentor_orgs_users_list:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **filter_by** | **str**| Filter options include, date, name, default is date | [optional] + **metadata_key** | **str**| Metadata key to be queried with | [optional] + **metadata_value** | **str**| Metadata value to be filter for | [optional] + **page** | **int**| A page number within the paginated result set. | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **return_session_information** | **bool**| Declares if session information should be included in the mentor data | [optional] + **visibility** | **str**| visibility type to be queried with | [optional] + +### Return type + +[**PaginatedMentorList**](PaginatedMentorList.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_categories_create** +> MentorCategory ai_mentor_orgs_users_mentor_categories_create(org, user_id, mentor_category) + + + +This is for adding mentor categories Accessible to tenant admins only. Returns: 200 : Mentor category detail. Example : POST : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.mentor_category import MentorCategory +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +mentor_category = iblai.MentorCategory() # MentorCategory | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_categories_create(org, user_id, mentor_category) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_categories_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **mentor_category** | [**MentorCategory**](MentorCategory.md)| | + +### Return type + +[**MentorCategory**](MentorCategory.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_categories_destroy** +> ai_mentor_orgs_users_mentor_categories_destroy(org, user_id) + + + +This is for deleting mentor category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"category\": \"Education\" } Response: No response body. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_instance.ai_mentor_orgs_users_mentor_categories_destroy(org, user_id) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_categories_retrieve** +> MentorCategory ai_mentor_orgs_users_mentor_categories_retrieve(org, user_id) + + + +This is for getting mentor categories Accessible to tenant admins and students. Returns: 200 : List of mentor categories. Example : GET : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.mentor_category import MentorCategory +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_categories_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_categories_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**MentorCategory**](MentorCategory.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_feedback_create_create** +> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_create_create(org, user_id, user_chat_feedback) + + + +Endpoint to add chat feedback. Accessible to tenant admins and students. Returns: 201: chat feedback object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + +### Example + + +```python +import iblai +from iblai.models.user_chat_feedback import UserChatFeedback +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +user_chat_feedback = iblai.UserChatFeedback() # UserChatFeedback | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_create_create(org, user_id, user_chat_feedback) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_create_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_create_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **user_chat_feedback** | [**UserChatFeedback**](UserChatFeedback.md)| | + +### Return type + +[**UserChatFeedback**](UserChatFeedback.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_feedback_retrieve** +> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_retrieve(feedback_id, org, user_id) + + + +Endpoint to get feedback detail. Accessible to tenant admins and students. Returns: 200: feed back detail. 404: When feedback id is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Response: { \"id\": 1, \"username\": \"lydiah\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + +### Example + + +```python +import iblai +from iblai.models.user_chat_feedback import UserChatFeedback +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +feedback_id = 56 # int | +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_retrieve(feedback_id, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feedback_id** | **int**| | + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**UserChatFeedback**](UserChatFeedback.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_feedback_update** +> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_update(feedback_id, org, user_id, user_chat_feedback) + + + +Endpoint to update chat feedback. Accessible to tenant admins and students. Returns: 200: chat feed back object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + +### Example + + +```python +import iblai +from iblai.models.user_chat_feedback import UserChatFeedback +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +feedback_id = 56 # int | +org = 'org_example' # str | +user_id = 'user_id_example' # str | +user_chat_feedback = iblai.UserChatFeedback() # UserChatFeedback | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_update(feedback_id, org, user_id, user_chat_feedback) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feedback_id** | **int**| | + **org** | **str**| | + **user_id** | **str**| | + **user_chat_feedback** | [**UserChatFeedback**](UserChatFeedback.md)| | + +### Return type + +[**UserChatFeedback**](UserChatFeedback.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_from_template_create** +> Mentor ai_mentor_orgs_users_mentor_from_template_create(org, user_id, mentor_from_template_request) + + + +View to create a mentor from a template Accessible to only tenant admins. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.mentor import Mentor +from iblai.models.mentor_from_template_request import MentorFromTemplateRequest +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +mentor_from_template_request = iblai.MentorFromTemplateRequest() # MentorFromTemplateRequest | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_from_template_create(org, user_id, mentor_from_template_request) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_from_template_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_from_template_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **mentor_from_template_request** | [**MentorFromTemplateRequest**](MentorFromTemplateRequest.md)| | + +### Return type + +[**Mentor**](Mentor.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_llms_retrieve** +> LLMResponse ai_mentor_orgs_users_mentor_llms_retrieve(org, user_id) + + + +Endpoint to get mentor llms. Accessible to both students and tenant admins. Returns: 200: list of llms. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-llms/ Response: [ { \"id\": 2, \"name\": \"google\", \"description\": \"Google LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://ai.google.dev/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview </h4> <p> Gemini 1.5 delivers dramatically enhanced performance with a more efficient architecture. The first model we’ve released for early testing, Gemini 1.5 Pro, introduces a breakthrough experimental feature in long-context understanding.</p> <p>The chat-bison model is a large language model that excels at language understanding, language generation and conversations. This chat model is fine-tuned to conduct natural multi-turn conversations. The PaLM 2 Chat Bison is ideal for text tasks that require back-and-forth interactions. For text tasks that can be completed with one API response (without the need for continuous conversation), use the PaLM 2 Text Bison.</p>\", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" }, { \"id\": 1, \"name\": \"openai\", \"description\": \"Openai LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://openai.com/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview. </h4> <p> OpenAI has been at the forefront of developing advanced language models, including the Generative Pre-trained Transformer (GPT) series. </p> <p> With 128k context, fresher knowledge and the broadest set of capabilities, GPT-4 Turbo is more powerful than GPT-4 and offered at a lower price. <a href='https://platform.openai.com/docs/models/gpt-4'> Learn about GPT-4 Turbo <a> </p> <p>With broad general knowledge and domain expertise, GPT-4 can follow complex instructions in natural language and solve difficult problems with accuracy.<a href='https://openai.com/gpt-4'> Learn about GPT-4 <a> </p> <p>GPT-3.5 Turbo models are capable and cost-effective. gpt-3.5-turbo-0125 is the flagship model of this family, supports a 16K context window and is optimized for dialog. gpt-3.5-turbo-instruct is an Instruct model and only supports a 4K context window.<a href='https://platform.openai.com/docs/guides/chat'> Learn about GPT-3.5 Turbo <a></p> <p><a href=''> <a></p> \", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" } ] + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.llm_response import LLMResponse +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_llms_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_llms_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_llms_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**LLMResponse**](LLMResponse.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_seed_retrieve** +> SeedMentorsView ai_mentor_orgs_users_mentor_seed_retrieve(org, user_id) + + + +Endpoint for seed mentors and prompts for a tenant. Accessible to tenant admins only. Returns: 200: status of seeding. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/seed-mentors/ Response: { \"detail\": \"Mentors seeded\" } + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.seed_mentors_view import SeedMentorsView +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_seed_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_seed_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_seed_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**SeedMentorsView**](SeedMentorsView.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_tools_retrieve** +> ToolResponse ai_mentor_orgs_users_mentor_tools_retrieve(org, user_id) + + + +Endpoint to get mentor tools. Accessible to tenant admins only. Returns: 200: list of tools. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.tool_response import ToolResponse +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_mentor_tools_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_tools_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_tools_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**ToolResponse**](ToolResponse.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_mentor_with_settings_create** +> Mentor ai_mentor_orgs_users_mentor_with_settings_create(org, user_id, mentor_from_template_with_setting_request) + + + +View to create a mentor from a template with settings. Accessible to tenant admins only. ### Example @@ -1454,6 +2411,8 @@ This is for deleting mentor category Accessible to tenant admins only. Returns ```python import iblai +from iblai.models.mentor import Mentor +from iblai.models.mentor_from_template_with_setting_request import MentorFromTemplateWithSettingRequest from iblai.rest import ApiException from pprint import pprint @@ -1473,11 +2432,14 @@ client = get_platform_api_client( api_instance = iblai.AiMentorApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +mentor_from_template_with_setting_request = iblai.MentorFromTemplateWithSettingRequest() # MentorFromTemplateWithSettingRequest | try: - api_instance.ai_mentor_orgs_users_mentor_categories_destroy(org, user_id) + api_response = api_instance.ai_mentor_orgs_users_mentor_with_settings_create(org, user_id, mentor_from_template_with_setting_request) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_with_settings_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_destroy: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_with_settings_create: %s\n" % e) ``` @@ -1489,10 +2451,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **mentor_from_template_with_setting_request** | [**MentorFromTemplateWithSettingRequest**](MentorFromTemplateWithSettingRequest.md)| | ### Return type -void (empty response body) +[**Mentor**](Mentor.md) ### Authorization @@ -1500,23 +2463,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_categories_retrieve** -> MentorCategory ai_mentor_orgs_users_mentor_categories_retrieve(org, user_id) +# **ai_mentor_orgs_users_mentors_available_tools_retrieve** +> ToolResponse ai_mentor_orgs_users_mentors_available_tools_retrieve(mentor, org, user_id) -This is for getting mentor categories Accessible to tenant admins and students. Returns: 200 : List of mentor categories. Example : GET : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] +This endpoint list tools allowed for a particular mentor. Accessible to tenant admins and students. Returns: 200 : List of Tool objects Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/available-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] ### Example @@ -1524,7 +2487,7 @@ This is for getting mentor categories Accessible to tenant admins and students. ```python import iblai -from iblai.models.mentor_category import MentorCategory +from iblai.models.tool_response import ToolResponse from iblai.rest import ApiException from pprint import pprint @@ -1542,15 +2505,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_categories_retrieve(org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_categories_retrieve:\n") + api_response = api_instance.ai_mentor_orgs_users_mentors_available_tools_retrieve(mentor, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_available_tools_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_categories_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_available_tools_retrieve: %s\n" % e) ``` @@ -1560,12 +2524,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | ### Return type -[**MentorCategory**](MentorCategory.md) +[**ToolResponse**](ToolResponse.md) ### Authorization @@ -1584,12 +2549,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_feedback_create_create** -> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_create_create(org, user_id, user_chat_feedback) +# **ai_mentor_orgs_users_mentors_memory_component_settings_retrieve** +> ai_mentor_orgs_users_mentors_memory_component_settings_retrieve(mentor, org, user_id) -Endpoint to add chat feedback. Accessible to tenant admins and students. Returns: 201: chat feedback object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } +Endpoint for toggling the memory component. Accessible to tenant admins and students. Returns: 200: Learner memory status for given mentor and student. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/student0/mentors/main/memory-component-settings/ Request: { \"enabled\": true } Response: { \"detail\": \"Request was successful.\", \"enabled\": true } ### Example @@ -1597,7 +2562,6 @@ Endpoint to add chat feedback. Accessible to tenant admins and students. Retur ```python import iblai -from iblai.models.user_chat_feedback import UserChatFeedback from iblai.rest import ApiException from pprint import pprint @@ -1615,16 +2579,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -user_chat_feedback = iblai.UserChatFeedback() # UserChatFeedback | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_create_create(org, user_id, user_chat_feedback) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_create_create:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_mentors_memory_component_settings_retrieve(mentor, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_create_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_memory_component_settings_retrieve: %s\n" % e) ``` @@ -1634,13 +2596,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | - **user_chat_feedback** | [**UserChatFeedback**](UserChatFeedback.md)| | ### Return type -[**UserChatFeedback**](UserChatFeedback.md) +void (empty response body) ### Authorization @@ -1648,23 +2610,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**200** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_feedback_retrieve** -> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_retrieve(feedback_id, org, user_id) +# **ai_mentor_orgs_users_mentors_memory_component_settings_update** +> ai_mentor_orgs_users_mentors_memory_component_settings_update(mentor, org, user_id) -Endpoint to get feedback detail. Accessible to tenant admins and students. Returns: 200: feed back detail. 404: When feedback id is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Response: { \"id\": 1, \"username\": \"lydiah\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } +Endpoint for toggling the memory component. Accessible to tenant admins and students. Returns: 200: Learner memory status for given mentor and student. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/student0/mentors/main/memory-component-settings/ Request: { \"enabled\": true } Response: { \"detail\": \"Request was successful.\", \"enabled\": true } ### Example @@ -1672,7 +2634,6 @@ Endpoint to get feedback detail. Accessible to tenant admins and students. Ret ```python import iblai -from iblai.models.user_chat_feedback import UserChatFeedback from iblai.rest import ApiException from pprint import pprint @@ -1690,16 +2651,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -feedback_id = 56 # int | +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_retrieve(feedback_id, org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_mentors_memory_component_settings_update(mentor, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_memory_component_settings_update: %s\n" % e) ``` @@ -1709,13 +2668,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **feedback_id** | **int**| | + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | ### Return type -[**UserChatFeedback**](UserChatFeedback.md) +void (empty response body) ### Authorization @@ -1724,58 +2683,45 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**200** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_feedback_update** -> UserChatFeedback ai_mentor_orgs_users_mentor_feedback_update(feedback_id, org, user_id, user_chat_feedback) +# **ai_mentor_orgs_users_mentors_public_settings_retrieve** +> MentorSettings ai_mentor_orgs_users_mentors_public_settings_retrieve(mentor, org, user_id) -Endpoint to update chat feedback. Accessible to tenant admins and students. Returns: 200: chat feed back object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } +Endpoint to get mentor public settings. Accessible to any user. ### Example -* Api Key Authentication (PlatformApiKeyAuthentication): ```python import iblai -from iblai.models.user_chat_feedback import UserChatFeedback +from iblai.models.mentor_settings import MentorSettings from iblai.rest import ApiException from pprint import pprint -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` -# You can generate an authenticated client using the following helper method -client = get_platform_api_client( - host="https://base.manager.iblai.app", - key=os.environ["API_KEY"] -) # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -feedback_id = 56 # int | +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -user_chat_feedback = iblai.UserChatFeedback() # UserChatFeedback | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_feedback_update(feedback_id, org, user_id, user_chat_feedback) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_feedback_update:\n") + api_response = api_instance.ai_mentor_orgs_users_mentors_public_settings_retrieve(mentor, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_public_settings_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_feedback_update: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_public_settings_retrieve: %s\n" % e) ``` @@ -1785,22 +2731,21 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **feedback_id** | **int**| | + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | - **user_chat_feedback** | [**UserChatFeedback**](UserChatFeedback.md)| | ### Return type -[**UserChatFeedback**](UserChatFeedback.md) +[**MentorSettings**](MentorSettings.md) ### Authorization -[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) +No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1811,12 +2756,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_from_template_create** -> Mentor ai_mentor_orgs_users_mentor_from_template_create(org, user_id, mentor_from_template_request) +# **ai_mentor_orgs_users_mentors_retrieve** +> Mentor ai_mentor_orgs_users_mentors_retrieve(mentor, org, user_id) -View to create a mentor from a template Accessible to only tenant admins. +This endpoint get mentor detail data. Accessible to tenant admins and students. Returns: 200 : Mentor object. Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/ Response: { \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"allow_anonymous\": false, \"pathways\": [], \"suggested_prompts\": [ \"\" ], \"llm_provider\": \"IBLChatOpenAI\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", \"metadata\": { \"admin\": true, \"student\": true, \"featured\": true, \"allow_to_use_as_template\": true }, \"proactive_message\": \"\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. \", \"enable_moderation\": false, \"safety_system_prompt\": \"You are a moderator tasked with identifying whether a message from an ai model to a user is is appropriate or inappropriate. If the message is immoral or contains abusive words, insults, damaging content, and law breaking acts, etc it should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"safety_response\": \"Sorry, the AI model generated an inappropriate response. Kindly refine your prompt or try again with a different prompt.\", \"enable_safety_system\": false, \"created_by\": \"system\" } ### Example @@ -1825,7 +2770,6 @@ View to create a mentor from a template Accessible to only tenant admins. ```python import iblai from iblai.models.mentor import Mentor -from iblai.models.mentor_from_template_request import MentorFromTemplateRequest from iblai.rest import ApiException from pprint import pprint @@ -1843,16 +2787,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor_from_template_request = iblai.MentorFromTemplateRequest() # MentorFromTemplateRequest | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_from_template_create(org, user_id, mentor_from_template_request) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_from_template_create:\n") + api_response = api_instance.ai_mentor_orgs_users_mentors_retrieve(mentor, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_from_template_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_retrieve: %s\n" % e) ``` @@ -1862,9 +2806,9 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | - **mentor_from_template_request** | [**MentorFromTemplateRequest**](MentorFromTemplateRequest.md)| | ### Return type @@ -1876,7 +2820,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1887,12 +2831,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_llms_retrieve** -> LLMResponse ai_mentor_orgs_users_mentor_llms_retrieve(org, user_id) +# **ai_mentor_orgs_users_mentors_scenarios_retrieve** +> ai_mentor_orgs_users_mentors_scenarios_retrieve(mentor, org, user_id) -Endpoint to get mentor llms. Accessible to both students and tenant admins. Returns: 200: list of llms. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-llms/ Response: [ { \"id\": 2, \"name\": \"google\", \"description\": \"Google LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://ai.google.dev/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview </h4> <p> Gemini 1.5 delivers dramatically enhanced performance with a more efficient architecture. The first model we’ve released for early testing, Gemini 1.5 Pro, introduces a breakthrough experimental feature in long-context understanding.</p> <p>The chat-bison model is a large language model that excels at language understanding, language generation and conversations. This chat model is fine-tuned to conduct natural multi-turn conversations. The PaLM 2 Chat Bison is ideal for text tasks that require back-and-forth interactions. For text tasks that can be completed with one API response (without the need for continuous conversation), use the PaLM 2 Text Bison.</p>\", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" }, { \"id\": 1, \"name\": \"openai\", \"description\": \"Openai LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://openai.com/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview. </h4> <p> OpenAI has been at the forefront of developing advanced language models, including the Generative Pre-trained Transformer (GPT) series. </p> <p> With 128k context, fresher knowledge and the broadest set of capabilities, GPT-4 Turbo is more powerful than GPT-4 and offered at a lower price. <a href='https://platform.openai.com/docs/models/gpt-4'> Learn about GPT-4 Turbo <a> </p> <p>With broad general knowledge and domain expertise, GPT-4 can follow complex instructions in natural language and solve difficult problems with accuracy.<a href='https://openai.com/gpt-4'> Learn about GPT-4 <a> </p> <p>GPT-3.5 Turbo models are capable and cost-effective. gpt-3.5-turbo-0125 is the flagship model of this family, supports a 16K context window and is optimized for dialog. gpt-3.5-turbo-instruct is an Instruct model and only supports a 4K context window.<a href='https://platform.openai.com/docs/guides/chat'> Learn about GPT-3.5 Turbo <a></p> <p><a href=''> <a></p> \", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" } ] +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -1900,7 +2844,6 @@ Endpoint to get mentor llms. Accessible to both students and tenant admins. Re ```python import iblai -from iblai.models.llm_response import LLMResponse from iblai.rest import ApiException from pprint import pprint @@ -1918,15 +2861,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_llms_retrieve(org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_llms_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_mentors_scenarios_retrieve(mentor, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_llms_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_scenarios_retrieve: %s\n" % e) ``` @@ -1936,12 +2878,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | ### Return type -[**LLMResponse**](LLMResponse.md) +void (empty response body) ### Authorization @@ -1950,22 +2893,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**200** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_tools_retrieve** -> ToolResponse ai_mentor_orgs_users_mentor_tools_retrieve(org, user_id) +# **ai_mentor_orgs_users_mentors_scenarios_update** +> ai_mentor_orgs_users_mentors_scenarios_update(mentor, org, user_id) -Endpoint to get mentor tools. Accessible to tenant admins only. Returns: 200: list of tools. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -1973,7 +2916,6 @@ Endpoint to get mentor tools. Accessible to tenant admins only. Returns: ```python import iblai -from iblai.models.tool_response import ToolResponse from iblai.rest import ApiException from pprint import pprint @@ -1991,15 +2933,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_tools_retrieve(org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_tools_retrieve:\n") - pprint(api_response) + api_instance.ai_mentor_orgs_users_mentors_scenarios_update(mentor, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_tools_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_scenarios_update: %s\n" % e) ``` @@ -2009,12 +2950,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | ### Return type -[**ToolResponse**](ToolResponse.md) +void (empty response body) ### Authorization @@ -2023,22 +2965,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**200** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentor_with_settings_create** -> Mentor ai_mentor_orgs_users_mentor_with_settings_create(org, user_id, mentor_from_template_with_setting_request) +# **ai_mentor_orgs_users_mentors_settings_retrieve** +> MentorSettings ai_mentor_orgs_users_mentors_settings_retrieve(mentor, org, user_id) -View to create a mentor from a template with settings. Accessible to tenant admins only. +Endpoint to get mentor settings. Accessible to tenant admins only. ### Example @@ -2046,8 +2988,7 @@ View to create a mentor from a template with settings. Accessible to tenant adm ```python import iblai -from iblai.models.mentor import Mentor -from iblai.models.mentor_from_template_with_setting_request import MentorFromTemplateWithSettingRequest +from iblai.models.mentor_settings import MentorSettings from iblai.rest import ApiException from pprint import pprint @@ -2065,16 +3006,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor_from_template_with_setting_request = iblai.MentorFromTemplateWithSettingRequest() # MentorFromTemplateWithSettingRequest | try: - api_response = api_instance.ai_mentor_orgs_users_mentor_with_settings_create(org, user_id, mentor_from_template_with_setting_request) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentor_with_settings_create:\n") + api_response = api_instance.ai_mentor_orgs_users_mentors_settings_retrieve(mentor, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_settings_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentor_with_settings_create: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_settings_retrieve: %s\n" % e) ``` @@ -2084,13 +3025,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | - **mentor_from_template_with_setting_request** | [**MentorFromTemplateWithSettingRequest**](MentorFromTemplateWithSettingRequest.md)| | ### Return type -[**Mentor**](Mentor.md) +[**MentorSettings**](MentorSettings.md) ### Authorization @@ -2098,7 +3039,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -2109,35 +3050,49 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentors_public_settings_retrieve** -> MentorSettings ai_mentor_orgs_users_mentors_public_settings_retrieve(mentor, org, user_id) +# **ai_mentor_orgs_users_mentors_settings_update** +> MentorSettings ai_mentor_orgs_users_mentors_settings_update(mentor, org, user_id, mentor_settings_request=mentor_settings_request) -Endpoint to get mentor public settings. Accessible to any user. +Endpoint to update mentor settings. Accessible to tenant admins only. ### Example +* Api Key Authentication (PlatformApiKeyAuthentication): ```python import iblai from iblai.models.mentor_settings import MentorSettings +from iblai.models.mentor_settings_request import MentorSettingsRequest from iblai.rest import ApiException from pprint import pprint +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | +mentor_settings_request = iblai.MentorSettingsRequest() # MentorSettingsRequest | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_mentors_public_settings_retrieve(mentor, org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_public_settings_retrieve:\n") + api_response = api_instance.ai_mentor_orgs_users_mentors_settings_update(mentor, org, user_id, mentor_settings_request=mentor_settings_request) + print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_settings_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_public_settings_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_settings_update: %s\n" % e) ``` @@ -2150,6 +3105,7 @@ Name | Type | Description | Notes **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | + **mentor_settings_request** | [**MentorSettingsRequest**](MentorSettingsRequest.md)| | [optional] ### Return type @@ -2157,11 +3113,11 @@ Name | Type | Description | Notes ### Authorization -No authorization required +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -2172,12 +3128,12 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentors_retrieve** -> Mentor ai_mentor_orgs_users_mentors_retrieve(mentor, org, user_id) +# **ai_mentor_orgs_users_metadata_retrieve** +> MentorMetadata ai_mentor_orgs_users_metadata_retrieve(org, user_id) -This endpoint get mentor detail data. Accessible to tenant admins and students. Returns: 200 : Mentor object. Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/ Response: { \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"allow_anonymous\": false, \"pathways\": [], \"suggested_prompts\": [ \"\" ], \"llm_provider\": \"IBLChatOpenAI\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", \"metadata\": { \"admin\": true, \"student\": true, \"featured\": true, \"allow_to_use_as_template\": true }, \"proactive_message\": \"\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. \", \"enable_moderation\": false, \"created_by\": \"system\" } +Endpoint for getting mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } ### Example @@ -2185,7 +3141,7 @@ This endpoint get mentor detail data. Accessible to tenant admins and students. ```python import iblai -from iblai.models.mentor import Mentor +from iblai.models.mentor_metadata import MentorMetadata from iblai.rest import ApiException from pprint import pprint @@ -2203,16 +3159,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_mentor_orgs_users_mentors_retrieve(mentor, org, user_id) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_retrieve:\n") + api_response = api_instance.ai_mentor_orgs_users_metadata_retrieve(org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_metadata_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_metadata_retrieve: %s\n" % e) ``` @@ -2222,13 +3177,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | ### Return type -[**Mentor**](Mentor.md) +[**MentorMetadata**](MentorMetadata.md) ### Authorization @@ -2247,12 +3201,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentors_settings_retrieve** -> ai_mentor_orgs_users_mentors_settings_retrieve(mentor, org, user_id) +# **ai_mentor_orgs_users_moderation_logs_destroy** +> ai_mentor_orgs_users_moderation_logs_destroy(id, org, user_id) -Endpoint to get mentor settings. Accessible to tenant admins only. +Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. ### Example @@ -2277,14 +3231,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -mentor = 'mentor_example' # str | +id = 56 # int | A unique integer value identifying this moderation log. org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_instance.ai_mentor_orgs_users_mentors_settings_retrieve(mentor, org, user_id) + api_instance.ai_mentor_orgs_users_moderation_logs_destroy(id, org, user_id) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_settings_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_moderation_logs_destroy: %s\n" % e) ``` @@ -2294,7 +3248,7 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **mentor** | **str**| | + **id** | **int**| A unique integer value identifying this moderation log. | **org** | **str**| | **user_id** | **str**| | @@ -2315,16 +3269,16 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | No response body | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_mentors_settings_update** -> MentorSettings ai_mentor_orgs_users_mentors_settings_update(mentor, org, user_id, mentor_settings_request=mentor_settings_request) +# **ai_mentor_orgs_users_moderation_logs_list** +> PaginatedModerationLogList ai_mentor_orgs_users_moderation_logs_list(org, user_id, mentor=mentor, ordering=ordering, page=page, page_size=page_size, platform_key=platform_key, search=search, target_system=target_system, username=username) -Endpoint to update mentor settings. Accessible to tenant admins only. +Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. ### Example @@ -2332,8 +3286,7 @@ Endpoint to update mentor settings. Accessible to tenant admins only. ```python import iblai -from iblai.models.mentor_settings import MentorSettings -from iblai.models.mentor_settings_request import MentorSettingsRequest +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList from iblai.rest import ApiException from pprint import pprint @@ -2351,17 +3304,23 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) -mentor = 'mentor_example' # str | org = 'org_example' # str | user_id = 'user_id_example' # str | -mentor_settings_request = iblai.MentorSettingsRequest() # MentorSettingsRequest | (optional) +mentor = 56 # int | (optional) +ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional) +page = 56 # int | A page number within the paginated result set. (optional) +page_size = 56 # int | Number of results to return per page. (optional) +platform_key = 'platform_key_example' # str | (optional) +search = 'search_example' # str | A search term. (optional) +target_system = 'target_system_example' # str | * `Safety System` - Safety System * `Moderation System` - Moderation System (optional) +username = 'username_example' # str | (optional) try: - api_response = api_instance.ai_mentor_orgs_users_mentors_settings_update(mentor, org, user_id, mentor_settings_request=mentor_settings_request) - print("The response of AiMentorApi->ai_mentor_orgs_users_mentors_settings_update:\n") + api_response = api_instance.ai_mentor_orgs_users_moderation_logs_list(org, user_id, mentor=mentor, ordering=ordering, page=page, page_size=page_size, platform_key=platform_key, search=search, target_system=target_system, username=username) + print("The response of AiMentorApi->ai_mentor_orgs_users_moderation_logs_list:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_mentors_settings_update: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_moderation_logs_list: %s\n" % e) ``` @@ -2371,14 +3330,20 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **mentor** | **str**| | **org** | **str**| | **user_id** | **str**| | - **mentor_settings_request** | [**MentorSettingsRequest**](MentorSettingsRequest.md)| | [optional] + **mentor** | **int**| | [optional] + **ordering** | **str**| Which field to use when ordering the results. | [optional] + **page** | **int**| A page number within the paginated result set. | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **platform_key** | **str**| | [optional] + **search** | **str**| A search term. | [optional] + **target_system** | **str**| * `Safety System` - Safety System * `Moderation System` - Moderation System | [optional] + **username** | **str**| | [optional] ### Return type -[**MentorSettings**](MentorSettings.md) +[**PaginatedModerationLogList**](PaginatedModerationLogList.md) ### Authorization @@ -2386,7 +3351,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -2397,12 +3362,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_mentor_orgs_users_metadata_retrieve** -> ai_mentor_orgs_users_metadata_retrieve(org, user_id) +# **ai_mentor_orgs_users_moderation_logs_retrieve** +> ModerationLog ai_mentor_orgs_users_moderation_logs_retrieve(id, org, user_id) -Endpoint for getting mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } +Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. ### Example @@ -2410,6 +3375,7 @@ Endpoint for getting mentor metadata. Accessible to tenant admins and students. ```python import iblai +from iblai.models.moderation_log import ModerationLog from iblai.rest import ApiException from pprint import pprint @@ -2427,13 +3393,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this moderation log. org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_instance.ai_mentor_orgs_users_metadata_retrieve(org, user_id) + api_response = api_instance.ai_mentor_orgs_users_moderation_logs_retrieve(id, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_moderation_logs_retrieve:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiMentorApi->ai_mentor_orgs_users_metadata_retrieve: %s\n" % e) + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_moderation_logs_retrieve: %s\n" % e) ``` @@ -2443,12 +3412,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this moderation log. | **org** | **str**| | **user_id** | **str**| | ### Return type -void (empty response body) +[**ModerationLog**](ModerationLog.md) ### Authorization @@ -2457,13 +3427,13 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -2726,7 +3696,7 @@ Name | Type | Description | Notes -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -2801,7 +3771,7 @@ Name | Type | Description | Notes -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -2873,7 +3843,7 @@ void (empty response body) -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -2970,7 +3940,7 @@ Name | Type | Description | Notes -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -3048,7 +4018,7 @@ Name | Type | Description | Notes -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -3123,7 +4093,7 @@ Name | Type | Description | Notes -Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. +Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` ### Example @@ -4041,7 +5011,7 @@ Name | Type | Description | Notes -This is for getting predictive analytics. Accessible to tenant admins only. Returns: 200 : Object of List of predicted data. 400 : When ai response can not be loaded to json. 404: When openai key for tenant is not set. 429: When openai request have exceeded the rate limit. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/ Requests: { \"prompt\": { \"data_variables\": [ { \"variable_name\": \"registered_users\", \"data_set\": { \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, \"2023-10-09\": 5, \"2023-10-10\": 4 }, \"number_of_data_points\": 5 }, { \"variable_name\": \"courses_enrolled\", \"data_set\": { \"2023-08-09\": 0, \"2023-08-10\": 0, \"2023-08-11\": 0, \"2023-08-12\": 0, \"2023-08-13\": 0 }, \"number_of_data_points\": 6 }, { \"variable_name\": \"completed_courses\", \"data_set\": { \"2023-10-04\": 0, \"2023-10-05\": 4, \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, }, \"number_of_data_points\": 5 } ] } } Response: { \"predictions\": [ { \"variable_name\": \"registered_users\", \"predicted_data\": { \"2023-10-11\": 2, \"2023-10-12\": 2, \"2023-10-13\": 1, \"2023-10-14\": 1, \"2023-10-15\": 1 }, \"narrative\": \"The number of registered users has been relatively stable with some fluctuations. There is a slight increase in the number of registered users over time.\" }, { \"variable_name\": \"courses_enrolled\", \"predicted_data\": { \"2023-10-09\": 0, \"2023-10-10\": 0, \"2023-10-11\": 0, \"2023-10-12\": 0, \"2023-10-13\": 0 }, \"narrative\": \"No courses have been enrolled recently, indicating a decline in enrollment. It is expected that the number of courses enrolled will remain at 0 for the next 31 data points.\" }, { \"variable_name\": \"completed_courses\", \"predicted_data\": { \"2023-10-10\": 4, \"2023-10-11\": 4, \"2023-10-12\": 4, \"2023-10-13\": 4, \"2023-10-14\": 4 }, \"narrative\": \"The number of completed courses has remained constant at 4. There is no indication of any change in the near future.\" } ] } +This is for getting predictive analytics. Accessible to tenant admins only. Returns: 200 : Object of List of predicted data. 400 : When ai response can not be loaded to json. 404: When OpenAI key for tenant is not set. 429: When OpenAI request have exceeded the rate limit. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/ Requests: { \"prompt\": { \"data_variables\": [ { \"variable_name\": \"registered_users\", \"data_set\": { \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, \"2023-10-09\": 5, \"2023-10-10\": 4 }, \"number_of_data_points\": 5 }, { \"variable_name\": \"courses_enrolled\", \"data_set\": { \"2023-08-09\": 0, \"2023-08-10\": 0, \"2023-08-11\": 0, \"2023-08-12\": 0, \"2023-08-13\": 0 }, \"number_of_data_points\": 6 }, { \"variable_name\": \"completed_courses\", \"data_set\": { \"2023-10-04\": 0, \"2023-10-05\": 4, \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, }, \"number_of_data_points\": 5 } ] } } Response: { \"predictions\": [ { \"variable_name\": \"registered_users\", \"predicted_data\": { \"2023-10-11\": 2, \"2023-10-12\": 2, \"2023-10-13\": 1, \"2023-10-14\": 1, \"2023-10-15\": 1 }, \"narrative\": \"The number of registered users has been relatively stable with some fluctuations. There is a slight increase in the number of registered users over time.\" }, { \"variable_name\": \"courses_enrolled\", \"predicted_data\": { \"2023-10-09\": 0, \"2023-10-10\": 0, \"2023-10-11\": 0, \"2023-10-12\": 0, \"2023-10-13\": 0 }, \"narrative\": \"No courses have been enrolled recently, indicating a decline in enrollment. It is expected that the number of courses enrolled will remain at 0 for the next 31 data points.\" }, { \"variable_name\": \"completed_courses\", \"predicted_data\": { \"2023-10-10\": 4, \"2023-10-11\": 4, \"2023-10-12\": 4, \"2023-10-13\": 4, \"2023-10-14\": 4 }, \"narrative\": \"The number of completed courses has remained constant at 4. There is no indication of any change in the near future.\" } ] } ### Example @@ -4442,6 +5412,242 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ai_mentor_orgs_users_safety_logs_destroy** +> ai_mentor_orgs_users_safety_logs_destroy(id, org, user_id) + + + +Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this moderation log. +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_instance.ai_mentor_orgs_users_safety_logs_destroy(id, org, user_id) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_safety_logs_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this moderation log. | + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_safety_logs_list** +> PaginatedModerationLogList ai_mentor_orgs_users_safety_logs_list(org, user_id, mentor=mentor, ordering=ordering, page=page, page_size=page_size, platform_key=platform_key, search=search, target_system=target_system, username=username) + + + +Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +mentor = 56 # int | (optional) +ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional) +page = 56 # int | A page number within the paginated result set. (optional) +page_size = 56 # int | Number of results to return per page. (optional) +platform_key = 'platform_key_example' # str | (optional) +search = 'search_example' # str | A search term. (optional) +target_system = 'target_system_example' # str | * `Safety System` - Safety System * `Moderation System` - Moderation System (optional) +username = 'username_example' # str | (optional) + +try: + api_response = api_instance.ai_mentor_orgs_users_safety_logs_list(org, user_id, mentor=mentor, ordering=ordering, page=page, page_size=page_size, platform_key=platform_key, search=search, target_system=target_system, username=username) + print("The response of AiMentorApi->ai_mentor_orgs_users_safety_logs_list:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_safety_logs_list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **mentor** | **int**| | [optional] + **ordering** | **str**| Which field to use when ordering the results. | [optional] + **page** | **int**| A page number within the paginated result set. | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **platform_key** | **str**| | [optional] + **search** | **str**| A search term. | [optional] + **target_system** | **str**| * `Safety System` - Safety System * `Moderation System` - Moderation System | [optional] + **username** | **str**| | [optional] + +### Return type + +[**PaginatedModerationLogList**](PaginatedModerationLogList.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_mentor_orgs_users_safety_logs_retrieve** +> ModerationLog ai_mentor_orgs_users_safety_logs_retrieve(id, org, user_id) + + + +Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.moderation_log import ModerationLog +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiMentorApi(api_client) +id = 56 # int | A unique integer value identifying this moderation log. +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_response = api_instance.ai_mentor_orgs_users_safety_logs_retrieve(id, org, user_id) + print("The response of AiMentorApi->ai_mentor_orgs_users_safety_logs_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiMentorApi->ai_mentor_orgs_users_safety_logs_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this moderation log. | + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +[**ModerationLog**](ModerationLog.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ai_mentor_orgs_users_session_detail_mentors_retrieve** > SessionDetail ai_mentor_orgs_users_session_detail_mentors_retrieve(mentor, org, user_id) @@ -4738,28 +5944,14 @@ No authorization required -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - ### Example -* Api Key Authentication (PlatformApiKeyAuthentication): ```python import iblai from iblai.rest import ApiException from pprint import pprint -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` -# You can generate an authenticated client using the following helper method -client = get_platform_api_client( - host="https://base.manager.iblai.app", - key=os.environ["API_KEY"] -) # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) @@ -4790,7 +5982,7 @@ void (empty response body) ### Authorization -[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) +No authorization required ### HTTP request headers @@ -4889,7 +6081,6 @@ Name | Type | Description | Notes ### Example -* Api Key Authentication (PlatformApiKeyAuthentication): ```python import iblai @@ -4897,17 +6088,6 @@ from iblai.models.message_view import MessageView from iblai.rest import ApiException from pprint import pprint -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` -# You can generate an authenticated client using the following helper method -client = get_platform_api_client( - host="https://base.manager.iblai.app", - key=os.environ["API_KEY"] -) # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) @@ -4942,7 +6122,7 @@ Name | Type | Description | Notes ### Authorization -[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) +No authorization required ### HTTP request headers @@ -5197,7 +6377,6 @@ Name | Type | Description | Notes ### Example -* Api Key Authentication (PlatformApiKeyAuthentication): ```python import iblai @@ -5206,17 +6385,6 @@ from iblai.models.message_view_updat_response import MessageViewUpdatResponse from iblai.rest import ApiException from pprint import pprint -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` -# You can generate an authenticated client using the following helper method -client = get_platform_api_client( - host="https://base.manager.iblai.app", - key=os.environ["API_KEY"] -) # Create an instance of the API class api_instance = iblai.AiMentorApi(api_client) @@ -5251,7 +6419,7 @@ Name | Type | Description | Notes ### Authorization -[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) +No authorization required ### HTTP request headers diff --git a/docs/AiPromptApi.md b/docs/AiPromptApi.md index 647d7e1..65f4175 100644 --- a/docs/AiPromptApi.md +++ b/docs/AiPromptApi.md @@ -19,6 +19,13 @@ Method | HTTP request | Description [**ai_prompt_orgs_users_languages_update**](AiPromptApi.md#ai_prompt_orgs_users_languages_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/languages/{language_id}/ | [**ai_prompt_orgs_users_memory_context_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_memory_context_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/ | [**ai_prompt_orgs_users_memory_context_update**](AiPromptApi.md#ai_prompt_orgs_users_memory_context_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-context/ | +[**ai_prompt_orgs_users_memory_create**](AiPromptApi.md#ai_prompt_orgs_users_memory_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +[**ai_prompt_orgs_users_memory_destroy**](AiPromptApi.md#ai_prompt_orgs_users_memory_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +[**ai_prompt_orgs_users_memory_destroy2**](AiPromptApi.md#ai_prompt_orgs_users_memory_destroy2) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/ | +[**ai_prompt_orgs_users_memory_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_memory_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/ | +[**ai_prompt_orgs_users_memory_status_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_memory_status_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/ | +[**ai_prompt_orgs_users_memory_status_update**](AiPromptApi.md#ai_prompt_orgs_users_memory_status_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/ | +[**ai_prompt_orgs_users_memory_update**](AiPromptApi.md#ai_prompt_orgs_users_memory_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/ | [**ai_prompt_orgs_users_metadata_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_metadata_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/metadata | [**ai_prompt_orgs_users_prompt_create**](AiPromptApi.md#ai_prompt_orgs_users_prompt_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/ | [**ai_prompt_orgs_users_prompt_destroy**](AiPromptApi.md#ai_prompt_orgs_users_prompt_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/ | @@ -42,15 +49,10 @@ Method | HTTP request | Description [**ai_prompt_orgs_users_tones_destroy**](AiPromptApi.md#ai_prompt_orgs_users_tones_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/ | [**ai_prompt_orgs_users_tones_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_tones_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/ | [**ai_prompt_orgs_users_tones_update**](AiPromptApi.md#ai_prompt_orgs_users_tones_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/ | -[**ai_prompt_orgs_users_user_catalog_item_memory_create**](AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_create) | **POST** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -[**ai_prompt_orgs_users_user_catalog_item_memory_destroy**](AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_destroy) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -[**ai_prompt_orgs_users_user_catalog_item_memory_destroy2**](AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_destroy2) | **DELETE** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/ | -[**ai_prompt_orgs_users_user_catalog_item_memory_retrieve**](AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_retrieve) | **GET** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/ | -[**ai_prompt_orgs_users_user_catalog_item_memory_update**](AiPromptApi.md#ai_prompt_orgs_users_user_catalog_item_memory_update) | **PUT** /api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/ | # **ai_prompt_orgs_metadata_create** -> ai_prompt_orgs_metadata_create(org) +> Metadata ai_prompt_orgs_metadata_create(org, metadata) @@ -62,6 +64,7 @@ Endpoint for adding prompt metadata. Accessible to tenant admins and students. ```python import iblai +from iblai.models.metadata import Metadata from iblai.rest import ApiException from pprint import pprint @@ -80,9 +83,12 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +metadata = iblai.Metadata() # Metadata | try: - api_instance.ai_prompt_orgs_metadata_create(org) + api_response = api_instance.ai_prompt_orgs_metadata_create(org, metadata) + print("The response of AiPromptApi->ai_prompt_orgs_metadata_create:\n") + pprint(api_response) except Exception as e: print("Exception when calling AiPromptApi->ai_prompt_orgs_metadata_create: %s\n" % e) ``` @@ -95,10 +101,11 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **metadata** | [**Metadata**](Metadata.md)| | ### Return type -void (empty response body) +[**Metadata**](Metadata.md) ### Authorization @@ -106,14 +113,14 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -408,7 +415,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_prompt_orgs_users_all_chats_memory_update** -> UserChatMemoryUpdateView ai_prompt_orgs_users_all_chats_memory_update(org, user_id) +> UserChatMemoryUpdateView ai_prompt_orgs_users_all_chats_memory_update(org, user_id, user_all_chat_memory_view) @@ -420,6 +427,7 @@ Endpoint for updating all user chat memories from previous chat histories. Acce ```python import iblai +from iblai.models.user_all_chat_memory_view import UserAllChatMemoryView from iblai.models.user_chat_memory_update_view import UserChatMemoryUpdateView from iblai.rest import ApiException from pprint import pprint @@ -440,9 +448,10 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +user_all_chat_memory_view = iblai.UserAllChatMemoryView() # UserAllChatMemoryView | try: - api_response = api_instance.ai_prompt_orgs_users_all_chats_memory_update(org, user_id) + api_response = api_instance.ai_prompt_orgs_users_all_chats_memory_update(org, user_id, user_all_chat_memory_view) print("The response of AiPromptApi->ai_prompt_orgs_users_all_chats_memory_update:\n") pprint(api_response) except Exception as e: @@ -458,6 +467,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **user_all_chat_memory_view** | [**UserAllChatMemoryView**](UserAllChatMemoryView.md)| | ### Return type @@ -469,7 +479,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1152,12 +1162,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_metadata_retrieve** -> ai_prompt_orgs_users_metadata_retrieve(org, user_id) +# **ai_prompt_orgs_users_memory_create** +> UserCatalogItemMemoryView ai_prompt_orgs_users_memory_create(org, user_id, user_catalog_item_memory_view) -Endpoint for getting prompt metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"prompt\": \"testing\" } + Endpoint for Adding user catalog item memory. Accessible to tenant admins and students. Returns: 201: user catalog item memory Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } ### Example @@ -1165,6 +1175,7 @@ Endpoint for getting prompt metadata. Accessible to tenant admins and students. ```python import iblai +from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView from iblai.rest import ApiException from pprint import pprint @@ -1184,11 +1195,14 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +user_catalog_item_memory_view = iblai.UserCatalogItemMemoryView() # UserCatalogItemMemoryView | try: - api_instance.ai_prompt_orgs_users_metadata_retrieve(org, user_id) + api_response = api_instance.ai_prompt_orgs_users_memory_create(org, user_id, user_catalog_item_memory_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_memory_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_metadata_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_create: %s\n" % e) ``` @@ -1200,10 +1214,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **user_catalog_item_memory_view** | [**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md)| | ### Return type -void (empty response body) +[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) ### Authorization @@ -1211,23 +1226,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_create** -> Prompt ai_prompt_orgs_users_prompt_create(org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) +# **ai_prompt_orgs_users_memory_destroy** +> ai_prompt_orgs_users_memory_destroy(org, user_id) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for clearing user catalog item memories. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/ Response: No response Data ### Example @@ -1235,7 +1250,6 @@ View to create/retrieve/update a prompt. Accessible to both tenant admins and s ```python import iblai -from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -1255,20 +1269,11 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -prompt = iblai.Prompt() # Prompt | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_response = api_instance.ai_prompt_orgs_users_prompt_create(org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_create:\n") - pprint(api_response) + api_instance.ai_prompt_orgs_users_memory_destroy(org, user_id) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_destroy: %s\n" % e) ``` @@ -1280,17 +1285,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **prompt** | [**Prompt**](Prompt.md)| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -[**Prompt**](Prompt.md) +void (empty response body) ### Authorization @@ -1298,23 +1296,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_destroy** -> ai_prompt_orgs_users_prompt_destroy(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) +# **ai_prompt_orgs_users_memory_destroy2** +> ai_prompt_orgs_users_memory_destroy2(memory_id, org, user_id) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for deleting user catalog item memory Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/1/ Response: No response Data ### Example @@ -1339,20 +1337,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -id = 56 # int | A unique integer value identifying this prompt. +memory_id = 56 # int | org = 'org_example' # str | user_id = 'user_id_example' # str | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_instance.ai_prompt_orgs_users_prompt_destroy(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) + api_instance.ai_prompt_orgs_users_memory_destroy2(memory_id, org, user_id) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_destroy2: %s\n" % e) ``` @@ -1362,15 +1354,9 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this prompt. | + **memory_id** | **int**| | **org** | **str**| | **user_id** | **str**| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type @@ -1393,12 +1379,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_list** -> List[Prompt] ai_prompt_orgs_users_prompt_list(org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) +# **ai_prompt_orgs_users_memory_retrieve** +> UserCatalogItemMemoryView ai_prompt_orgs_users_memory_retrieve(org, user_id) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for getting user catalog item memories. Accessible to tenant admins and students. Returns: 200: List of user catalog item memories. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/memory/ Response: [ { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" }, } ] ### Example @@ -1406,7 +1392,7 @@ View to create/retrieve/update a prompt. Accessible to both tenant admins and s ```python import iblai -from iblai.models.prompt import Prompt +from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView from iblai.rest import ApiException from pprint import pprint @@ -1426,19 +1412,13 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_response = api_instance.ai_prompt_orgs_users_prompt_list(org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_list:\n") + api_response = api_instance.ai_prompt_orgs_users_memory_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_memory_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_list: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_retrieve: %s\n" % e) ``` @@ -1450,16 +1430,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -[**List[Prompt]**](Prompt.md) +[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) ### Authorization @@ -1478,12 +1452,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_partial_update** -> Prompt ai_prompt_orgs_users_prompt_partial_update(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility, patched_prompt=patched_prompt) +# **ai_prompt_orgs_users_memory_status_retrieve** +> MemoryStatusView ai_prompt_orgs_users_memory_status_retrieve(org, user_id) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for getting memory status. Accessible to tenant admins and students. Returns: 200: Obbject of memory status. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/memory-status/ Response: { \"id\": 1, \"username\": \"johndoes\", \"platform_key\": \"main\", \"enabled\": false } ### Example @@ -1491,8 +1465,7 @@ View to create/retrieve/update a prompt. Accessible to both tenant admins and s ```python import iblai -from iblai.models.patched_prompt import PatchedPrompt -from iblai.models.prompt import Prompt +from iblai.models.memory_status_view import MemoryStatusView from iblai.rest import ApiException from pprint import pprint @@ -1510,23 +1483,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | user_id = 'user_id_example' # str | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) -patched_prompt = iblai.PatchedPrompt() # PatchedPrompt | (optional) try: - api_response = api_instance.ai_prompt_orgs_users_prompt_partial_update(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility, patched_prompt=patched_prompt) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_partial_update:\n") + api_response = api_instance.ai_prompt_orgs_users_memory_status_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_memory_status_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_partial_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_status_retrieve: %s\n" % e) ``` @@ -1536,20 +1501,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | **user_id** | **str**| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] - **patched_prompt** | [**PatchedPrompt**](PatchedPrompt.md)| | [optional] ### Return type -[**Prompt**](Prompt.md) +[**MemoryStatusView**](MemoryStatusView.md) ### Authorization @@ -1557,7 +1514,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1568,12 +1525,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_retrieve** -> Prompt ai_prompt_orgs_users_prompt_retrieve(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) +# **ai_prompt_orgs_users_memory_status_update** +> MemoryStatusView ai_prompt_orgs_users_memory_status_update(org, user_id, memory_status_request_view) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for updating user memory status. Accessible to tenant admins and students. Returns: 200: user chat memory status Object. 400: When data is not valid. Example: PUT: /api/ai-prompt/orgs/main/users/johndoe/memory-status/ Request: { \"enabled\": false } Response: { \"id\": 1, \"username\": \"johndoes\", \"platform_key\": \"main\", \"enabled\": false } ### Example @@ -1581,7 +1538,8 @@ View to create/retrieve/update a prompt. Accessible to both tenant admins and s ```python import iblai -from iblai.models.prompt import Prompt +from iblai.models.memory_status_request_view import MemoryStatusRequestView +from iblai.models.memory_status_view import MemoryStatusView from iblai.rest import ApiException from pprint import pprint @@ -1599,22 +1557,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | user_id = 'user_id_example' # str | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) +memory_status_request_view = iblai.MemoryStatusRequestView() # MemoryStatusRequestView | try: - api_response = api_instance.ai_prompt_orgs_users_prompt_retrieve(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_retrieve:\n") + api_response = api_instance.ai_prompt_orgs_users_memory_status_update(org, user_id, memory_status_request_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_memory_status_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_status_update: %s\n" % e) ``` @@ -1624,19 +1576,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | **user_id** | **str**| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] + **memory_status_request_view** | [**MemoryStatusRequestView**](MemoryStatusRequestView.md)| | ### Return type -[**Prompt**](Prompt.md) +[**MemoryStatusView**](MemoryStatusView.md) ### Authorization @@ -1644,7 +1590,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1655,12 +1601,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompt_update** -> Prompt ai_prompt_orgs_users_prompt_update(id, org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) +# **ai_prompt_orgs_users_memory_update** +> UserCatalogItemMemoryView ai_prompt_orgs_users_memory_update(memory_id, org, user_id, user_catalog_item_memory_view) -View to create/retrieve/update a prompt. Accessible to both tenant admins and students. +Endpoint for updating user catalog item memory. Accessible to tenant admins and students. Returns: 200: user catalog item memory object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/1/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": \"i learnt about x and y\", \"next_steps\": \"learning about z\" } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } ### Example @@ -1668,7 +1614,7 @@ View to create/retrieve/update a prompt. Accessible to both tenant admins and s ```python import iblai -from iblai.models.prompt import Prompt +from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView from iblai.rest import ApiException from pprint import pprint @@ -1686,23 +1632,17 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -id = 56 # int | A unique integer value identifying this prompt. +memory_id = 56 # int | org = 'org_example' # str | user_id = 'user_id_example' # str | -prompt = iblai.Prompt() # Prompt | -category = 56 # int | Category of the prompt (optional) -created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) -filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) -mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) -tag = 56 # int | Tag of the prompt (optional) -visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) +user_catalog_item_memory_view = iblai.UserCatalogItemMemoryView() # UserCatalogItemMemoryView | try: - api_response = api_instance.ai_prompt_orgs_users_prompt_update(id, org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_update:\n") + api_response = api_instance.ai_prompt_orgs_users_memory_update(memory_id, org, user_id, user_catalog_item_memory_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_memory_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_memory_update: %s\n" % e) ``` @@ -1712,20 +1652,14 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **int**| A unique integer value identifying this prompt. | + **memory_id** | **int**| | **org** | **str**| | **user_id** | **str**| | - **prompt** | [**Prompt**](Prompt.md)| | - **category** | **int**| Category of the prompt | [optional] - **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] - **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] - **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] - **tag** | **int**| Tag of the prompt | [optional] - **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] + **user_catalog_item_memory_view** | [**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md)| | ### Return type -[**Prompt**](Prompt.md) +[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) ### Authorization @@ -1744,12 +1678,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompts_category_create** -> PromptCategory ai_prompt_orgs_users_prompts_category_create(org, user_id, prompt_category) +# **ai_prompt_orgs_users_metadata_retrieve** +> Metadata ai_prompt_orgs_users_metadata_retrieve(org, user_id) -This is for adding prompt categories Accessible to tenant admins only. Returns: 200 : Prompt category detail. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } +Endpoint for getting prompt metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"prompt\": \"testing\" } ### Example @@ -1757,7 +1691,7 @@ This is for adding prompt categories Accessible to tenant admins only. Returns ```python import iblai -from iblai.models.prompt_category import PromptCategory +from iblai.models.metadata import Metadata from iblai.rest import ApiException from pprint import pprint @@ -1777,14 +1711,13 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | -prompt_category = iblai.PromptCategory() # PromptCategory | try: - api_response = api_instance.ai_prompt_orgs_users_prompts_category_create(org, user_id, prompt_category) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompts_category_create:\n") + api_response = api_instance.ai_prompt_orgs_users_metadata_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_metadata_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_metadata_retrieve: %s\n" % e) ``` @@ -1796,11 +1729,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | - **prompt_category** | [**PromptCategory**](PromptCategory.md)| | ### Return type -[**PromptCategory**](PromptCategory.md) +[**Metadata**](Metadata.md) ### Authorization @@ -1808,7 +1740,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1819,12 +1751,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompts_category_destroy** -> ai_prompt_orgs_users_prompts_category_destroy(org, user_id) +# **ai_prompt_orgs_users_prompt_create** +> Prompt ai_prompt_orgs_users_prompt_create(org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) -This is for deleting prompt category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"category\": \"Education\" } Response: No response body. +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -1832,6 +1764,7 @@ This is for deleting prompt category Accessible to tenant admins only. Returns ```python import iblai +from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -1851,11 +1784,20 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +prompt = iblai.Prompt() # Prompt | +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_instance.ai_prompt_orgs_users_prompts_category_destroy(org, user_id) + api_response = api_instance.ai_prompt_orgs_users_prompt_create(org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_create: %s\n" % e) ``` @@ -1867,10 +1809,17 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **prompt** | [**Prompt**](Prompt.md)| | + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -void (empty response body) +[**Prompt**](Prompt.md) ### Authorization @@ -1878,23 +1827,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_prompts_category_retrieve** -> PromptCategory ai_prompt_orgs_users_prompts_category_retrieve(org, user_id, filter_by=filter_by) +# **ai_prompt_orgs_users_prompt_destroy** +> ai_prompt_orgs_users_prompt_destroy(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) -This is for getting prompt categories Accessible to tenant admins and students. Returns: 200 : List of prompt categories. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -1902,7 +1851,6 @@ This is for getting prompt categories Accessible to tenant admins and students. ```python import iblai -from iblai.models.prompt_category import PromptCategory from iblai.rest import ApiException from pprint import pprint @@ -1920,16 +1868,20 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) +id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | user_id = 'user_id_example' # str | -filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_response = api_instance.ai_prompt_orgs_users_prompts_category_retrieve(org, user_id, filter_by=filter_by) - print("The response of AiPromptApi->ai_prompt_orgs_users_prompts_category_retrieve:\n") - pprint(api_response) + api_instance.ai_prompt_orgs_users_prompt_destroy(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_destroy: %s\n" % e) ``` @@ -1939,13 +1891,19 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | **user_id** | **str**| | - **filter_by** | **str**| Filter options include, date, name, default is date | [optional] - -### Return type - -[**PromptCategory**](PromptCategory.md) + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] + +### Return type + +void (empty response body) ### Authorization @@ -1954,22 +1912,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_sessions_guided_prompts_retrieve** -> GuidedPromptsResponse ai_prompt_orgs_users_sessions_guided_prompts_retrieve(org, session_id, user_id) +# **ai_prompt_orgs_users_prompt_list** +> List[Prompt] ai_prompt_orgs_users_prompt_list(org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) -This is for getting guided prompts for a chat session session. Accessible to tenant admins and students. Returns: 200 : Object of list of guided prompts. 500 : When ai response can not be loaded to json. 404: When openai key for tenant is not set. 429: When openai request have exceeded the rate limit. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/sessions/4194d20c-37d5-4148-882f-f7d2d91f7769/guided-prompts/ Response: { \"ai_prompts\": [ \"What are the benefits of regular exercise?\", \"How can I create a healthy meal plan?\", \"What are some effective stress management techniques?\" ] } +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -1977,7 +1935,7 @@ This is for getting guided prompts for a chat session session. Accessible to te ```python import iblai -from iblai.models.guided_prompts_response import GuidedPromptsResponse +from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -1996,15 +1954,20 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -session_id = 'session_id_example' # str | user_id = 'user_id_example' # str | +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_response = api_instance.ai_prompt_orgs_users_sessions_guided_prompts_retrieve(org, session_id, user_id) - print("The response of AiPromptApi->ai_prompt_orgs_users_sessions_guided_prompts_retrieve:\n") + api_response = api_instance.ai_prompt_orgs_users_prompt_list(org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_list:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_sessions_guided_prompts_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_list: %s\n" % e) ``` @@ -2015,12 +1978,17 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **session_id** | **str**| | **user_id** | **str**| | + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -[**GuidedPromptsResponse**](GuidedPromptsResponse.md) +[**List[Prompt]**](Prompt.md) ### Authorization @@ -2039,12 +2007,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_styles_create** -> StylesView ai_prompt_orgs_users_styles_create(org, user_id, styles_view) +# **ai_prompt_orgs_users_prompt_partial_update** +> Prompt ai_prompt_orgs_users_prompt_partial_update(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility, patched_prompt=patched_prompt) -Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 201: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -2052,7 +2020,8 @@ Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: ```python import iblai -from iblai.models.styles_view import StylesView +from iblai.models.patched_prompt import PatchedPrompt +from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -2070,16 +2039,23 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) +id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | user_id = 'user_id_example' # str | -styles_view = iblai.StylesView() # StylesView | +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) +patched_prompt = iblai.PatchedPrompt() # PatchedPrompt | (optional) try: - api_response = api_instance.ai_prompt_orgs_users_styles_create(org, user_id, styles_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_styles_create:\n") + api_response = api_instance.ai_prompt_orgs_users_prompt_partial_update(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility, patched_prompt=patched_prompt) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_partial_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_partial_update: %s\n" % e) ``` @@ -2089,13 +2065,20 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | **user_id** | **str**| | - **styles_view** | [**StylesView**](StylesView.md)| | + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] + **patched_prompt** | [**PatchedPrompt**](PatchedPrompt.md)| | [optional] ### Return type -[**StylesView**](StylesView.md) +[**Prompt**](Prompt.md) ### Authorization @@ -2110,16 +2093,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_styles_destroy** -> ai_prompt_orgs_users_styles_destroy(org, style_id, user_id) +# **ai_prompt_orgs_users_prompt_retrieve** +> Prompt ai_prompt_orgs_users_prompt_retrieve(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) -Endpoint for deleting prompt style. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Response: No response Data +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -2127,6 +2110,7 @@ Endpoint for deleting prompt style. Accessible to tenant admins and students. ```python import iblai +from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -2144,14 +2128,22 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) +id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | -style_id = 56 # int | user_id = 'user_id_example' # str | +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_instance.ai_prompt_orgs_users_styles_destroy(org, style_id, user_id) + api_response = api_instance.ai_prompt_orgs_users_prompt_retrieve(id, org, user_id, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_retrieve:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_retrieve: %s\n" % e) ``` @@ -2161,13 +2153,19 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | - **style_id** | **int**| | **user_id** | **str**| | + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -void (empty response body) +[**Prompt**](Prompt.md) ### Authorization @@ -2176,22 +2174,22 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_styles_retrieve** -> StylesView ai_prompt_orgs_users_styles_retrieve(org, user_id) +# **ai_prompt_orgs_users_prompt_update** +> Prompt ai_prompt_orgs_users_prompt_update(id, org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) -Endpoint for getting prompt styles. Accessible to tenant admins and students. Returns: 200: List of styles. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/styles/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] +View to create/retrieve/update a prompt. Accessible to both tenant admins and students. ### Example @@ -2199,7 +2197,7 @@ Endpoint for getting prompt styles. Accessible to tenant admins and students. ```python import iblai -from iblai.models.styles_view import StylesView +from iblai.models.prompt import Prompt from iblai.rest import ApiException from pprint import pprint @@ -2217,15 +2215,23 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) +id = 56 # int | A unique integer value identifying this prompt. org = 'org_example' # str | user_id = 'user_id_example' # str | +prompt = iblai.Prompt() # Prompt | +category = 56 # int | Category of the prompt (optional) +created_by = 'created_by_example' # str | Option to filter by username of the prompt creators. (optional) +filter_by = 'filter_by_example' # str | Filter options include, date, prompt, default is date (optional) +mentor_unique_id = 'mentor_unique_id_example' # str | Mentor unique id of the prompt (optional) +tag = 56 # int | Tag of the prompt (optional) +visibility = 'visibility_example' # str | Visibility trype the mentor of the prompt (optional) try: - api_response = api_instance.ai_prompt_orgs_users_styles_retrieve(org, user_id) - print("The response of AiPromptApi->ai_prompt_orgs_users_styles_retrieve:\n") + api_response = api_instance.ai_prompt_orgs_users_prompt_update(id, org, user_id, prompt, category=category, created_by=created_by, filter_by=filter_by, mentor_unique_id=mentor_unique_id, tag=tag, visibility=visibility) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompt_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompt_update: %s\n" % e) ``` @@ -2235,12 +2241,20 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this prompt. | **org** | **str**| | **user_id** | **str**| | + **prompt** | [**Prompt**](Prompt.md)| | + **category** | **int**| Category of the prompt | [optional] + **created_by** | **str**| Option to filter by username of the prompt creators. | [optional] + **filter_by** | **str**| Filter options include, date, prompt, default is date | [optional] + **mentor_unique_id** | **str**| Mentor unique id of the prompt | [optional] + **tag** | **int**| Tag of the prompt | [optional] + **visibility** | **str**| Visibility trype the mentor of the prompt | [optional] ### Return type -[**StylesView**](StylesView.md) +[**Prompt**](Prompt.md) ### Authorization @@ -2248,7 +2262,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -2259,12 +2273,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_styles_update** -> StylesView ai_prompt_orgs_users_styles_update(org, style_id, user_id, styles_view) +# **ai_prompt_orgs_users_prompts_category_create** +> PromptCategory ai_prompt_orgs_users_prompts_category_create(org, user_id, prompt_category) -Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 200: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } +This is for adding prompt categories Accessible to tenant admins only. Returns: 200 : Prompt category detail. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ### Example @@ -2272,7 +2286,7 @@ Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: ```python import iblai -from iblai.models.styles_view import StylesView +from iblai.models.prompt_category import PromptCategory from iblai.rest import ApiException from pprint import pprint @@ -2291,16 +2305,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -style_id = 56 # int | user_id = 'user_id_example' # str | -styles_view = iblai.StylesView() # StylesView | +prompt_category = iblai.PromptCategory() # PromptCategory | try: - api_response = api_instance.ai_prompt_orgs_users_styles_update(org, style_id, user_id, styles_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_styles_update:\n") + api_response = api_instance.ai_prompt_orgs_users_prompts_category_create(org, user_id, prompt_category) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompts_category_create:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_create: %s\n" % e) ``` @@ -2311,13 +2324,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **style_id** | **int**| | **user_id** | **str**| | - **styles_view** | [**StylesView**](StylesView.md)| | + **prompt_category** | [**PromptCategory**](PromptCategory.md)| | ### Return type -[**StylesView**](StylesView.md) +[**PromptCategory**](PromptCategory.md) ### Authorization @@ -2336,12 +2348,157 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tags_create** -> TagsView ai_prompt_orgs_users_tags_create(org, user_id, tags_view) +# **ai_prompt_orgs_users_prompts_category_destroy** +> ai_prompt_orgs_users_prompts_category_destroy(org, user_id) + + + +This is for deleting prompt category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"category\": \"Education\" } Response: No response body. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiPromptApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_instance.ai_prompt_orgs_users_prompts_category_destroy(org, user_id) +except Exception as e: + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_prompt_orgs_users_prompts_category_retrieve** +> PromptCategory ai_prompt_orgs_users_prompts_category_retrieve(org, user_id, filter_by=filter_by) + + + +This is for getting prompt categories Accessible to tenant admins and students. Returns: 200 : List of prompt categories. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.prompt_category import PromptCategory +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.AiPromptApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +filter_by = 'filter_by_example' # str | Filter options include, date, name, default is date (optional) + +try: + api_response = api_instance.ai_prompt_orgs_users_prompts_category_retrieve(org, user_id, filter_by=filter_by) + print("The response of AiPromptApi->ai_prompt_orgs_users_prompts_category_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_prompts_category_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **filter_by** | **str**| Filter options include, date, name, default is date | [optional] + +### Return type + +[**PromptCategory**](PromptCategory.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ai_prompt_orgs_users_sessions_guided_prompts_retrieve** +> GuidedPromptsResponse ai_prompt_orgs_users_sessions_guided_prompts_retrieve(org, session_id, user_id) -Endpoint for Adding prompt tag. Accessible to tenant admins and students. Returns: 201: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ Request: Response: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } +This is for getting guided prompts for a chat session session. Accessible to tenant admins and students. Returns: 200 : Object of list of guided prompts. 500 : When ai response can not be loaded to json. 404: When OpenAI key for tenant is not set. 429: When OpenAI requests have exceeded the rate limit. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/sessions/4194d20c-37d5-4148-882f-f7d2d91f7769/guided-prompts/ Response: { \"ai_prompts\": [ \"What are the benefits of regular exercise?\", \"How can I create a healthy meal plan?\", \"What are some effective stress management techniques?\" ] } ### Example @@ -2349,7 +2506,7 @@ Endpoint for Adding prompt tag. Accessible to tenant admins and students. Retu ```python import iblai -from iblai.models.tags_view import TagsView +from iblai.models.guided_prompts_response import GuidedPromptsResponse from iblai.rest import ApiException from pprint import pprint @@ -2368,15 +2525,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +session_id = 'session_id_example' # str | user_id = 'user_id_example' # str | -tags_view = iblai.TagsView() # TagsView | try: - api_response = api_instance.ai_prompt_orgs_users_tags_create(org, user_id, tags_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_tags_create:\n") + api_response = api_instance.ai_prompt_orgs_users_sessions_guided_prompts_retrieve(org, session_id, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_sessions_guided_prompts_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_sessions_guided_prompts_retrieve: %s\n" % e) ``` @@ -2387,12 +2544,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **session_id** | **str**| | **user_id** | **str**| | - **tags_view** | [**TagsView**](TagsView.md)| | ### Return type -[**TagsView**](TagsView.md) +[**GuidedPromptsResponse**](GuidedPromptsResponse.md) ### Authorization @@ -2400,23 +2557,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tags_destroy** -> ai_prompt_orgs_users_tags_destroy(org, tag_id, user_id) +# **ai_prompt_orgs_users_styles_create** +> StylesView ai_prompt_orgs_users_styles_create(org, user_id, styles_view) -Endpoint for deleting prompt tag. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Response: No response Data +Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 201: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } ### Example @@ -2424,6 +2581,7 @@ Endpoint for deleting prompt tag. Accessible to tenant admins and students. Re ```python import iblai +from iblai.models.styles_view import StylesView from iblai.rest import ApiException from pprint import pprint @@ -2442,13 +2600,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -tag_id = 56 # int | user_id = 'user_id_example' # str | +styles_view = iblai.StylesView() # StylesView | try: - api_instance.ai_prompt_orgs_users_tags_destroy(org, tag_id, user_id) + api_response = api_instance.ai_prompt_orgs_users_styles_create(org, user_id, styles_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_styles_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_create: %s\n" % e) ``` @@ -2459,12 +2619,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **tag_id** | **int**| | **user_id** | **str**| | + **styles_view** | [**StylesView**](StylesView.md)| | ### Return type -void (empty response body) +[**StylesView**](StylesView.md) ### Authorization @@ -2472,23 +2632,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tags_retrieve** -> TagsView ai_prompt_orgs_users_tags_retrieve(org, user_id) +# **ai_prompt_orgs_users_styles_destroy** +> ai_prompt_orgs_users_styles_destroy(org, style_id, user_id) -Endpoint for getting prompt tags. Accessible to tenant admins and students. Returns: 200: List of tags. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tags/ Response: [ { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ] +Endpoint for deleting prompt style. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Response: No response Data ### Example @@ -2496,7 +2656,6 @@ Endpoint for getting prompt tags. Accessible to tenant admins and students. Re ```python import iblai -from iblai.models.tags_view import TagsView from iblai.rest import ApiException from pprint import pprint @@ -2515,14 +2674,13 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +style_id = 56 # int | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_prompt_orgs_users_tags_retrieve(org, user_id) - print("The response of AiPromptApi->ai_prompt_orgs_users_tags_retrieve:\n") - pprint(api_response) + api_instance.ai_prompt_orgs_users_styles_destroy(org, style_id, user_id) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_destroy: %s\n" % e) ``` @@ -2533,11 +2691,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **style_id** | **int**| | **user_id** | **str**| | ### Return type -[**TagsView**](TagsView.md) +void (empty response body) ### Authorization @@ -2546,22 +2705,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tags_update** -> TagsView ai_prompt_orgs_users_tags_update(org, tag_id, user_id, tags_view) +# **ai_prompt_orgs_users_styles_retrieve** +> StylesView ai_prompt_orgs_users_styles_retrieve(org, user_id) -Endpoint for updating prompt tag. Accessible to tenant admins and students. Returns: 200: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Request: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } +Endpoint for getting prompt styles. Accessible to tenant admins and students. Returns: 200: List of styles. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/styles/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] ### Example @@ -2569,7 +2728,7 @@ Endpoint for updating prompt tag. Accessible to tenant admins and students. Re ```python import iblai -from iblai.models.tags_view import TagsView +from iblai.models.styles_view import StylesView from iblai.rest import ApiException from pprint import pprint @@ -2588,16 +2747,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -tag_id = 56 # int | user_id = 'user_id_example' # str | -tags_view = iblai.TagsView() # TagsView | try: - api_response = api_instance.ai_prompt_orgs_users_tags_update(org, tag_id, user_id, tags_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_tags_update:\n") + api_response = api_instance.ai_prompt_orgs_users_styles_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_styles_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_retrieve: %s\n" % e) ``` @@ -2608,13 +2765,11 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **tag_id** | **int**| | **user_id** | **str**| | - **tags_view** | [**TagsView**](TagsView.md)| | ### Return type -[**TagsView**](TagsView.md) +[**StylesView**](StylesView.md) ### Authorization @@ -2622,7 +2777,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -2633,12 +2788,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tones_create** -> TonesView ai_prompt_orgs_users_tones_create(org, user_id, tones_view=tones_view) +# **ai_prompt_orgs_users_styles_update** +> StylesView ai_prompt_orgs_users_styles_update(org, style_id, user_id, styles_view) -Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: 201: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } +Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 200: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } ### Example @@ -2646,7 +2801,7 @@ Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: ```python import iblai -from iblai.models.tones_view import TonesView +from iblai.models.styles_view import StylesView from iblai.rest import ApiException from pprint import pprint @@ -2665,15 +2820,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +style_id = 56 # int | user_id = 'user_id_example' # str | -tones_view = iblai.TonesView() # TonesView | (optional) +styles_view = iblai.StylesView() # StylesView | try: - api_response = api_instance.ai_prompt_orgs_users_tones_create(org, user_id, tones_view=tones_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_tones_create:\n") + api_response = api_instance.ai_prompt_orgs_users_styles_update(org, style_id, user_id, styles_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_styles_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_styles_update: %s\n" % e) ``` @@ -2684,12 +2840,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **style_id** | **int**| | **user_id** | **str**| | - **tones_view** | [**TonesView**](TonesView.md)| | [optional] + **styles_view** | [**StylesView**](StylesView.md)| | ### Return type -[**TonesView**](TonesView.md) +[**StylesView**](StylesView.md) ### Authorization @@ -2704,16 +2861,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tones_destroy** -> ai_prompt_orgs_users_tones_destroy(org, tone_id, user_id) +# **ai_prompt_orgs_users_tags_create** +> TagsView ai_prompt_orgs_users_tags_create(org, user_id, tags_view) -Endpoint for deleting prompt tone. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tone/1/ Response: No response Data +Endpoint for Adding prompt tag. Accessible to tenant admins and students. Returns: 201: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ Request: Response: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ### Example @@ -2721,6 +2878,7 @@ Endpoint for deleting prompt tone. Accessible to tenant admins and students. R ```python import iblai +from iblai.models.tags_view import TagsView from iblai.rest import ApiException from pprint import pprint @@ -2739,13 +2897,15 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -tone_id = 56 # int | user_id = 'user_id_example' # str | +tags_view = iblai.TagsView() # TagsView | try: - api_instance.ai_prompt_orgs_users_tones_destroy(org, tone_id, user_id) + api_response = api_instance.ai_prompt_orgs_users_tags_create(org, user_id, tags_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_tags_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_create: %s\n" % e) ``` @@ -2756,12 +2916,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **tone_id** | **int**| | **user_id** | **str**| | + **tags_view** | [**TagsView**](TagsView.md)| | ### Return type -void (empty response body) +[**TagsView**](TagsView.md) ### Authorization @@ -2769,23 +2929,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tones_retrieve** -> TonesView ai_prompt_orgs_users_tones_retrieve(org, user_id) +# **ai_prompt_orgs_users_tags_destroy** +> ai_prompt_orgs_users_tags_destroy(org, tag_id, user_id) -Endpoint for getting prompt tones. Accessible to tenant admins and students. Returns: 200: List of tones. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tones/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] +Endpoint for deleting prompt tag. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Response: No response Data ### Example @@ -2793,7 +2953,6 @@ Endpoint for getting prompt tones. Accessible to tenant admins and students. R ```python import iblai -from iblai.models.tones_view import TonesView from iblai.rest import ApiException from pprint import pprint @@ -2812,14 +2971,13 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +tag_id = 56 # int | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_prompt_orgs_users_tones_retrieve(org, user_id) - print("The response of AiPromptApi->ai_prompt_orgs_users_tones_retrieve:\n") - pprint(api_response) + api_instance.ai_prompt_orgs_users_tags_destroy(org, tag_id, user_id) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_destroy: %s\n" % e) ``` @@ -2830,11 +2988,12 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **tag_id** | **int**| | **user_id** | **str**| | ### Return type -[**TonesView**](TonesView.md) +void (empty response body) ### Authorization @@ -2843,22 +3002,22 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | | - | +**204** | No response body | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_tones_update** -> TonesView ai_prompt_orgs_users_tones_update(org, tone_id, user_id, tones_view=tones_view) +# **ai_prompt_orgs_users_tags_retrieve** +> TagsView ai_prompt_orgs_users_tags_retrieve(org, user_id) -Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: 200: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } +Endpoint for getting prompt tags. Accessible to tenant admins and students. Returns: 200: List of tags. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tags/ Response: [ { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ] ### Example @@ -2866,7 +3025,7 @@ Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: ```python import iblai -from iblai.models.tones_view import TonesView +from iblai.models.tags_view import TagsView from iblai.rest import ApiException from pprint import pprint @@ -2885,16 +3044,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | -tone_id = 56 # int | user_id = 'user_id_example' # str | -tones_view = iblai.TonesView() # TonesView | (optional) try: - api_response = api_instance.ai_prompt_orgs_users_tones_update(org, tone_id, user_id, tones_view=tones_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_tones_update:\n") + api_response = api_instance.ai_prompt_orgs_users_tags_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_tags_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_retrieve: %s\n" % e) ``` @@ -2905,13 +3062,11 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | - **tone_id** | **int**| | **user_id** | **str**| | - **tones_view** | [**TonesView**](TonesView.md)| | [optional] ### Return type -[**TonesView**](TonesView.md) +[**TagsView**](TagsView.md) ### Authorization @@ -2919,7 +3074,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -2930,12 +3085,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_user_catalog_item_memory_create** -> UserCatalogItemMemoryView ai_prompt_orgs_users_user_catalog_item_memory_create(org, user_id, user_catalog_item_memory_view) +# **ai_prompt_orgs_users_tags_update** +> TagsView ai_prompt_orgs_users_tags_update(org, tag_id, user_id, tags_view) - Endpoint for Adding user catalog item memory. Accessible to tenant admins and students. Returns: 201: user catalog item memory Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } +Endpoint for updating prompt tag. Accessible to tenant admins and students. Returns: 200: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Request: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ### Example @@ -2943,7 +3098,7 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView +from iblai.models.tags_view import TagsView from iblai.rest import ApiException from pprint import pprint @@ -2962,15 +3117,16 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | +tag_id = 56 # int | user_id = 'user_id_example' # str | -user_catalog_item_memory_view = iblai.UserCatalogItemMemoryView() # UserCatalogItemMemoryView | +tags_view = iblai.TagsView() # TagsView | try: - api_response = api_instance.ai_prompt_orgs_users_user_catalog_item_memory_create(org, user_id, user_catalog_item_memory_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_create:\n") + api_response = api_instance.ai_prompt_orgs_users_tags_update(org, tag_id, user_id, tags_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_tags_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_create: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tags_update: %s\n" % e) ``` @@ -2981,12 +3137,13 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | + **tag_id** | **int**| | **user_id** | **str**| | - **user_catalog_item_memory_view** | [**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md)| | + **tags_view** | [**TagsView**](TagsView.md)| | ### Return type -[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) +[**TagsView**](TagsView.md) ### Authorization @@ -3001,16 +3158,16 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | | - | +**200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_user_catalog_item_memory_destroy** -> ai_prompt_orgs_users_user_catalog_item_memory_destroy(org, user_id) +# **ai_prompt_orgs_users_tones_create** +> TonesView ai_prompt_orgs_users_tones_create(org, user_id, tones_view=tones_view) -Endpoint for clearing user catalog item memories. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Response: No response Data +Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: 201: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } ### Example @@ -3018,6 +3175,7 @@ Endpoint for clearing user catalog item memories. Accessible to tenant admins a ```python import iblai +from iblai.models.tones_view import TonesView from iblai.rest import ApiException from pprint import pprint @@ -3037,11 +3195,14 @@ client = get_platform_api_client( api_instance = iblai.AiPromptApi(api_client) org = 'org_example' # str | user_id = 'user_id_example' # str | +tones_view = iblai.TonesView() # TonesView | (optional) try: - api_instance.ai_prompt_orgs_users_user_catalog_item_memory_destroy(org, user_id) + api_response = api_instance.ai_prompt_orgs_users_tones_create(org, user_id, tones_view=tones_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_tones_create:\n") + pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_destroy: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_create: %s\n" % e) ``` @@ -3053,10 +3214,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **str**| | **user_id** | **str**| | + **tones_view** | [**TonesView**](TonesView.md)| | [optional] ### Return type -void (empty response body) +[**TonesView**](TonesView.md) ### Authorization @@ -3064,23 +3226,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No response body | - | +**201** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_user_catalog_item_memory_destroy2** -> ai_prompt_orgs_users_user_catalog_item_memory_destroy2(memory_id, org, user_id) +# **ai_prompt_orgs_users_tones_destroy** +> ai_prompt_orgs_users_tones_destroy(org, tone_id, user_id) -Endpoint for deleting user catalog item memory Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/1/ Response: No response Data +Endpoint for deleting prompt tone. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tone/1/ Response: No response Data ### Example @@ -3105,14 +3267,14 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -memory_id = 56 # int | org = 'org_example' # str | +tone_id = 56 # int | user_id = 'user_id_example' # str | try: - api_instance.ai_prompt_orgs_users_user_catalog_item_memory_destroy2(memory_id, org, user_id) + api_instance.ai_prompt_orgs_users_tones_destroy(org, tone_id, user_id) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_destroy2: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_destroy: %s\n" % e) ``` @@ -3122,8 +3284,8 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **memory_id** | **int**| | **org** | **str**| | + **tone_id** | **int**| | **user_id** | **str**| | ### Return type @@ -3147,12 +3309,12 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_user_catalog_item_memory_retrieve** -> UserCatalogItemMemoryView ai_prompt_orgs_users_user_catalog_item_memory_retrieve(org, user_id) +# **ai_prompt_orgs_users_tones_retrieve** +> TonesView ai_prompt_orgs_users_tones_retrieve(org, user_id) -Endpoint for getting user catalog item memories. Accessible to tenant admins and students. Returns: 200: List of user catalog item memories. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Response: [ { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" }, } ] +Endpoint for getting prompt tones. Accessible to tenant admins and students. Returns: 200: List of tones. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tones/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] ### Example @@ -3160,7 +3322,7 @@ Endpoint for getting user catalog item memories. Accessible to tenant admins an ```python import iblai -from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView +from iblai.models.tones_view import TonesView from iblai.rest import ApiException from pprint import pprint @@ -3182,11 +3344,11 @@ org = 'org_example' # str | user_id = 'user_id_example' # str | try: - api_response = api_instance.ai_prompt_orgs_users_user_catalog_item_memory_retrieve(org, user_id) - print("The response of AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_retrieve:\n") + api_response = api_instance.ai_prompt_orgs_users_tones_retrieve(org, user_id) + print("The response of AiPromptApi->ai_prompt_orgs_users_tones_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_retrieve: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_retrieve: %s\n" % e) ``` @@ -3201,7 +3363,7 @@ Name | Type | Description | Notes ### Return type -[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) +[**TonesView**](TonesView.md) ### Authorization @@ -3220,12 +3382,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **ai_prompt_orgs_users_user_catalog_item_memory_update** -> UserCatalogItemMemoryView ai_prompt_orgs_users_user_catalog_item_memory_update(memory_id, org, user_id, user_catalog_item_memory_view) +# **ai_prompt_orgs_users_tones_update** +> TonesView ai_prompt_orgs_users_tones_update(org, tone_id, user_id, tones_view=tones_view) -Endpoint for updating user catalog item memory. Accessible to tenant admins and students. Returns: 200: user catalog item memory object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/1/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": \"i learnt about x and y\", \"next_steps\": \"learning about z\" } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } +Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: 200: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } ### Example @@ -3233,7 +3395,7 @@ Endpoint for updating user catalog item memory. Accessible to tenant admins and ```python import iblai -from iblai.models.user_catalog_item_memory_view import UserCatalogItemMemoryView +from iblai.models.tones_view import TonesView from iblai.rest import ApiException from pprint import pprint @@ -3251,17 +3413,17 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.AiPromptApi(api_client) -memory_id = 56 # int | org = 'org_example' # str | +tone_id = 56 # int | user_id = 'user_id_example' # str | -user_catalog_item_memory_view = iblai.UserCatalogItemMemoryView() # UserCatalogItemMemoryView | +tones_view = iblai.TonesView() # TonesView | (optional) try: - api_response = api_instance.ai_prompt_orgs_users_user_catalog_item_memory_update(memory_id, org, user_id, user_catalog_item_memory_view) - print("The response of AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_update:\n") + api_response = api_instance.ai_prompt_orgs_users_tones_update(org, tone_id, user_id, tones_view=tones_view) + print("The response of AiPromptApi->ai_prompt_orgs_users_tones_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling AiPromptApi->ai_prompt_orgs_users_user_catalog_item_memory_update: %s\n" % e) + print("Exception when calling AiPromptApi->ai_prompt_orgs_users_tones_update: %s\n" % e) ``` @@ -3271,14 +3433,14 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **memory_id** | **int**| | **org** | **str**| | + **tone_id** | **int**| | **user_id** | **str**| | - **user_catalog_item_memory_view** | [**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md)| | + **tones_view** | [**TonesView**](TonesView.md)| | [optional] ### Return type -[**UserCatalogItemMemoryView**](UserCatalogItemMemoryView.md) +[**TonesView**](TonesView.md) ### Authorization diff --git a/docs/CareerApi.md b/docs/CareerApi.md index 486a381..94a2040 100644 --- a/docs/CareerApi.md +++ b/docs/CareerApi.md @@ -4,16 +4,1460 @@ All URIs are relative to *https://base.manager.iblai.app* Method | HTTP request | Description ------------- | ------------- | ------------- -[**career_resume_orgs_users_create**](CareerApi.md#career_resume_orgs_users_create) | **POST** /api/career/resume/orgs/{orgs}/users/{user_id}/ | -[**career_resume_orgs_users_retrieve**](CareerApi.md#career_resume_orgs_users_retrieve) | **GET** /api/career/resume/orgs/{orgs}/users/{user_id}/ | +[**career_orgs_companies_users_create**](CareerApi.md#career_orgs_companies_users_create) | **POST** /api/career/orgs/{org}/companies/users/{username}/ | +[**career_orgs_companies_users_destroy**](CareerApi.md#career_orgs_companies_users_destroy) | **DELETE** /api/career/orgs/{org}/companies/users/{username}/ | +[**career_orgs_companies_users_retrieve**](CareerApi.md#career_orgs_companies_users_retrieve) | **GET** /api/career/orgs/{org}/companies/users/{username}/ | +[**career_orgs_companies_users_update**](CareerApi.md#career_orgs_companies_users_update) | **PUT** /api/career/orgs/{org}/companies/users/{username}/ | +[**career_orgs_education_users_create**](CareerApi.md#career_orgs_education_users_create) | **POST** /api/career/orgs/{org}/education/users/{username}/ | +[**career_orgs_education_users_destroy**](CareerApi.md#career_orgs_education_users_destroy) | **DELETE** /api/career/orgs/{org}/education/users/{username}/ | +[**career_orgs_education_users_retrieve**](CareerApi.md#career_orgs_education_users_retrieve) | **GET** /api/career/orgs/{org}/education/users/{username}/ | +[**career_orgs_education_users_update**](CareerApi.md#career_orgs_education_users_update) | **PUT** /api/career/orgs/{org}/education/users/{username}/ | +[**career_orgs_experience_users_create**](CareerApi.md#career_orgs_experience_users_create) | **POST** /api/career/orgs/{org}/experience/users/{username}/ | +[**career_orgs_experience_users_destroy**](CareerApi.md#career_orgs_experience_users_destroy) | **DELETE** /api/career/orgs/{org}/experience/users/{username}/ | +[**career_orgs_experience_users_retrieve**](CareerApi.md#career_orgs_experience_users_retrieve) | **GET** /api/career/orgs/{org}/experience/users/{username}/ | +[**career_orgs_experience_users_update**](CareerApi.md#career_orgs_experience_users_update) | **PUT** /api/career/orgs/{org}/experience/users/{username}/ | +[**career_orgs_institutions_users_create**](CareerApi.md#career_orgs_institutions_users_create) | **POST** /api/career/orgs/{org}/institutions/users/{username}/ | +[**career_orgs_institutions_users_destroy**](CareerApi.md#career_orgs_institutions_users_destroy) | **DELETE** /api/career/orgs/{org}/institutions/users/{username}/ | +[**career_orgs_institutions_users_retrieve**](CareerApi.md#career_orgs_institutions_users_retrieve) | **GET** /api/career/orgs/{org}/institutions/users/{username}/ | +[**career_orgs_institutions_users_update**](CareerApi.md#career_orgs_institutions_users_update) | **PUT** /api/career/orgs/{org}/institutions/users/{username}/ | +[**career_orgs_programs_users_create**](CareerApi.md#career_orgs_programs_users_create) | **POST** /api/career/orgs/{org}/programs/users/{username}/ | +[**career_orgs_programs_users_destroy**](CareerApi.md#career_orgs_programs_users_destroy) | **DELETE** /api/career/orgs/{org}/programs/users/{username}/ | +[**career_orgs_programs_users_retrieve**](CareerApi.md#career_orgs_programs_users_retrieve) | **GET** /api/career/orgs/{org}/programs/users/{username}/ | +[**career_orgs_programs_users_update**](CareerApi.md#career_orgs_programs_users_update) | **PUT** /api/career/orgs/{org}/programs/users/{username}/ | +[**career_resume_orgs_users_create**](CareerApi.md#career_resume_orgs_users_create) | **POST** /api/career/resume/orgs/{org}/users/{username}/ | +[**career_resume_orgs_users_retrieve**](CareerApi.md#career_resume_orgs_users_retrieve) | **GET** /api/career/resume/orgs/{org}/users/{username}/ | +[**career_resume_orgs_users_update**](CareerApi.md#career_resume_orgs_users_update) | **PUT** /api/career/resume/orgs/{org}/users/{username}/ | -# **career_resume_orgs_users_create** -> career_resume_orgs_users_create(orgs, user_id) +# **career_orgs_companies_users_create** +> Company career_orgs_companies_users_create(org, username, company) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.company import Company +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +company = iblai.Company() # Company | + +try: + api_response = api_instance.career_orgs_companies_users_create(org, username, company) + print("The response of CareerApi->career_orgs_companies_users_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_companies_users_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **company** | [**Company**](Company.md)| | + +### Return type + +[**Company**](Company.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_companies_users_destroy** +> career_orgs_companies_users_destroy(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_orgs_companies_users_destroy(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_companies_users_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_companies_users_retrieve** +> Company career_orgs_companies_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.company import Company +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_response = api_instance.career_orgs_companies_users_retrieve(org, username) + print("The response of CareerApi->career_orgs_companies_users_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_companies_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +[**Company**](Company.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_companies_users_update** +> Company career_orgs_companies_users_update(org, username, company) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.company import Company +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +company = iblai.Company() # Company | + +try: + api_response = api_instance.career_orgs_companies_users_update(org, username, company) + print("The response of CareerApi->career_orgs_companies_users_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_companies_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **company** | [**Company**](Company.md)| | + +### Return type + +[**Company**](Company.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_education_users_create** +> Education career_orgs_education_users_create(org, username, education) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.education import Education +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +education = iblai.Education() # Education | + +try: + api_response = api_instance.career_orgs_education_users_create(org, username, education) + print("The response of CareerApi->career_orgs_education_users_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_education_users_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **education** | [**Education**](Education.md)| | + +### Return type + +[**Education**](Education.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_education_users_destroy** +> career_orgs_education_users_destroy(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_orgs_education_users_destroy(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_education_users_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_education_users_retrieve** +> Education career_orgs_education_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.education import Education +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_response = api_instance.career_orgs_education_users_retrieve(org, username) + print("The response of CareerApi->career_orgs_education_users_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_education_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +[**Education**](Education.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_education_users_update** +> Education career_orgs_education_users_update(org, username, education) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.education import Education +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +education = iblai.Education() # Education | + +try: + api_response = api_instance.career_orgs_education_users_update(org, username, education) + print("The response of CareerApi->career_orgs_education_users_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_education_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **education** | [**Education**](Education.md)| | + +### Return type + +[**Education**](Education.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_experience_users_create** +> Experience career_orgs_experience_users_create(org, username, experience) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.experience import Experience +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +experience = iblai.Experience() # Experience | + +try: + api_response = api_instance.career_orgs_experience_users_create(org, username, experience) + print("The response of CareerApi->career_orgs_experience_users_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_experience_users_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **experience** | [**Experience**](Experience.md)| | + +### Return type + +[**Experience**](Experience.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_experience_users_destroy** +> career_orgs_experience_users_destroy(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_orgs_experience_users_destroy(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_experience_users_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_experience_users_retrieve** +> Experience career_orgs_experience_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.experience import Experience +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_response = api_instance.career_orgs_experience_users_retrieve(org, username) + print("The response of CareerApi->career_orgs_experience_users_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_experience_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +[**Experience**](Experience.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_experience_users_update** +> Experience career_orgs_experience_users_update(org, username, experience) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.experience import Experience +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +experience = iblai.Experience() # Experience | + +try: + api_response = api_instance.career_orgs_experience_users_update(org, username, experience) + print("The response of CareerApi->career_orgs_experience_users_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_experience_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **experience** | [**Experience**](Experience.md)| | + +### Return type + +[**Experience**](Experience.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_institutions_users_create** +> Institution career_orgs_institutions_users_create(org, username, institution) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.institution import Institution +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +institution = iblai.Institution() # Institution | + +try: + api_response = api_instance.career_orgs_institutions_users_create(org, username, institution) + print("The response of CareerApi->career_orgs_institutions_users_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_institutions_users_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **institution** | [**Institution**](Institution.md)| | + +### Return type + +[**Institution**](Institution.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_institutions_users_destroy** +> career_orgs_institutions_users_destroy(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_orgs_institutions_users_destroy(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_institutions_users_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_institutions_users_retrieve** +> Institution career_orgs_institutions_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.institution import Institution +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_response = api_instance.career_orgs_institutions_users_retrieve(org, username) + print("The response of CareerApi->career_orgs_institutions_users_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_institutions_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +[**Institution**](Institution.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_institutions_users_update** +> Institution career_orgs_institutions_users_update(org, username, institution) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.institution import Institution +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +institution = iblai.Institution() # Institution | + +try: + api_response = api_instance.career_orgs_institutions_users_update(org, username, institution) + print("The response of CareerApi->career_orgs_institutions_users_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_institutions_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **institution** | [**Institution**](Institution.md)| | + +### Return type + +[**Institution**](Institution.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_programs_users_create** +> Program career_orgs_programs_users_create(org, username, program) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.program import Program +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +program = iblai.Program() # Program | + +try: + api_response = api_instance.career_orgs_programs_users_create(org, username, program) + print("The response of CareerApi->career_orgs_programs_users_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_programs_users_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **program** | [**Program**](Program.md)| | + +### Return type + +[**Program**](Program.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_programs_users_destroy** +> career_orgs_programs_users_destroy(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_orgs_programs_users_destroy(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_programs_users_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_programs_users_retrieve** +> Program career_orgs_programs_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.program import Program +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_response = api_instance.career_orgs_programs_users_retrieve(org, username) + print("The response of CareerApi->career_orgs_programs_users_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_programs_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +[**Program**](Program.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_orgs_programs_users_update** +> Program career_orgs_programs_users_update(org, username, program) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.program import Program +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | +program = iblai.Program() # Program | + +try: + api_response = api_instance.career_orgs_programs_users_update(org, username, program) + print("The response of CareerApi->career_orgs_programs_users_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CareerApi->career_orgs_programs_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + **program** | [**Program**](Program.md)| | + +### Return type + +[**Program**](Program.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_resume_orgs_users_create** +> career_resume_orgs_users_create(org, username) -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -38,11 +1482,11 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.CareerApi(api_client) -orgs = 'orgs_example' # str | -user_id = 'user_id_example' # str | +org = 'org_example' # str | +username = 'username_example' # str | try: - api_instance.career_resume_orgs_users_create(orgs, user_id) + api_instance.career_resume_orgs_users_create(org, username) except Exception as e: print("Exception when calling CareerApi->career_resume_orgs_users_create: %s\n" % e) ``` @@ -54,8 +1498,8 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orgs** | **str**| | - **user_id** | **str**| | + **org** | **str**| | + **username** | **str**| | ### Return type @@ -79,11 +1523,9 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **career_resume_orgs_users_retrieve** -> career_resume_orgs_users_retrieve(orgs, user_id) - +> career_resume_orgs_users_retrieve(org, username) -Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent ### Example @@ -108,11 +1550,11 @@ client = get_platform_api_client( # Create an instance of the API class api_instance = iblai.CareerApi(api_client) -orgs = 'orgs_example' # str | -user_id = 'user_id_example' # str | +org = 'org_example' # str | +username = 'username_example' # str | try: - api_instance.career_resume_orgs_users_retrieve(orgs, user_id) + api_instance.career_resume_orgs_users_retrieve(org, username) except Exception as e: print("Exception when calling CareerApi->career_resume_orgs_users_retrieve: %s\n" % e) ``` @@ -124,8 +1566,76 @@ except Exception as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orgs** | **str**| | - **user_id** | **str**| | + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **career_resume_orgs_users_update** +> career_resume_orgs_users_update(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CareerApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.career_resume_orgs_users_update(org, username) +except Exception as e: + print("Exception when calling CareerApi->career_resume_orgs_users_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | ### Return type diff --git a/docs/ChatHistory.md b/docs/ChatHistory.md index 08b3d90..99e0f32 100644 --- a/docs/ChatHistory.md +++ b/docs/ChatHistory.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **message** | **object** | | [optional] **inserted_at** | **datetime** | | [readonly] **title** | **str** | | [optional] -**feedback** | **str** | | [readonly] +**feedback** | **object** | | [readonly] **document_sources** | **object** | | [optional] ## Example diff --git a/docs/ChatHistoryFilterData.md b/docs/ChatHistoryFilterData.md new file mode 100644 index 0000000..8e7db20 --- /dev/null +++ b/docs/ChatHistoryFilterData.md @@ -0,0 +1,31 @@ +# ChatHistoryFilterData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**topics** | [**List[TopicModel]**](TopicModel.md) | | +**date_ranges** | [**List[DateRange]**](DateRange.md) | | [optional] +**sentiment** | **List[str]** | | [optional] + +## Example + +```python +from iblai.models.chat_history_filter_data import ChatHistoryFilterData + +# TODO update the JSON string below +json = "{}" +# create an instance of ChatHistoryFilterData from a JSON string +chat_history_filter_data_instance = ChatHistoryFilterData.from_json(json) +# print the JSON string representation of the object +print(ChatHistoryFilterData.to_json()) + +# convert the object into a dict +chat_history_filter_data_dict = chat_history_filter_data_instance.to_dict() +# create an instance of ChatHistoryFilterData from a dict +chat_history_filter_data_from_dict = ChatHistoryFilterData.from_dict(chat_history_filter_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Company.md b/docs/Company.md new file mode 100644 index 0000000..9f4bd2e --- /dev/null +++ b/docs/Company.md @@ -0,0 +1,39 @@ +# Company + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**user** | **int** | edX user ID | [readonly] +**user_info** | [**UserInfo**](UserInfo.md) | | [readonly] +**name** | **str** | | +**industry** | **str** | | [optional] +**website** | **str** | | [optional] +**logo_url** | **str** | | [optional] +**data** | **object** | Metadata | [optional] +**metadata** | **object** | Metadata | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.company import Company + +# TODO update the JSON string below +json = "{}" +# create an instance of Company from a JSON string +company_instance = Company.from_json(json) +# print the JSON string representation of the object +print(Company.to_json()) + +# convert the object into a dict +company_dict = company_instance.to_dict() +# create an instance of Company from a dict +company_from_dict = Company.from_dict(company_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ConversationMessage.md b/docs/ConversationMessage.md index 1738b7b..a090584 100644 --- a/docs/ConversationMessage.md +++ b/docs/ConversationMessage.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **topics** | [**List[TopicModel]**](TopicModel.md) | | **id** | **str** | | **user_id** | **str** | | -**message_count** | **str** | | [readonly] +**message_count** | **int** | | [readonly] **model** | **str** | | **inserted_at** | **datetime** | | **user_sentiment** | **str** | | [readonly] diff --git a/docs/Conversations.md b/docs/Conversations.md new file mode 100644 index 0000000..e4f793e --- /dev/null +++ b/docs/Conversations.md @@ -0,0 +1,43 @@ +# Conversations + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**messages** | **str** | | [readonly] +**topics** | [**List[TopicModel]**](TopicModel.md) | | +**sentiment** | **str** | | [readonly] +**mentor** | **str** | | +**student** | **str** | | [readonly] +**model** | **str** | | +**rating** | **str** | | [readonly] +**inserted_at** | **datetime** | | [readonly] +**has_document** | **bool** | | [optional] +**memory_tracked** | **bool** | | [optional] +**llm_name** | **str** | | [optional] +**llm_provider** | **str** | | [optional] +**metadata** | **object** | | [optional] +**platform** | **int** | | [optional] + +## Example + +```python +from iblai.models.conversations import Conversations + +# TODO update the JSON string below +json = "{}" +# create an instance of Conversations from a JSON string +conversations_instance = Conversations.from_json(json) +# print the JSON string representation of the object +print(Conversations.to_json()) + +# convert the object into a dict +conversations_dict = conversations_instance.to_dict() +# create an instance of Conversations from a dict +conversations_from_dict = Conversations.from_dict(conversations_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CoreApi.md b/docs/CoreApi.md index 1019c81..2719639 100644 --- a/docs/CoreApi.md +++ b/docs/CoreApi.md @@ -4,6 +4,16 @@ All URIs are relative to *https://base.manager.iblai.app* Method | HTTP request | Description ------------- | ------------- | ------------- +[**core_lti1p3_provider_lti_keys_create**](CoreApi.md#core_lti1p3_provider_lti_keys_create) | **POST** /api/core/lti/1p3/provider/lti-keys/ | +[**core_lti1p3_provider_lti_keys_destroy**](CoreApi.md#core_lti1p3_provider_lti_keys_destroy) | **DELETE** /api/core/lti/1p3/provider/lti-keys/{id}/ | +[**core_lti1p3_provider_lti_keys_list**](CoreApi.md#core_lti1p3_provider_lti_keys_list) | **GET** /api/core/lti/1p3/provider/lti-keys/ | +[**core_lti1p3_provider_lti_keys_retrieve**](CoreApi.md#core_lti1p3_provider_lti_keys_retrieve) | **GET** /api/core/lti/1p3/provider/lti-keys/{id}/ | +[**core_lti1p3_provider_lti_keys_update**](CoreApi.md#core_lti1p3_provider_lti_keys_update) | **PUT** /api/core/lti/1p3/provider/lti-keys/{id}/ | +[**core_lti1p3_provider_lti_tools_create**](CoreApi.md#core_lti1p3_provider_lti_tools_create) | **POST** /api/core/lti/1p3/provider/lti-tools/ | +[**core_lti1p3_provider_lti_tools_destroy**](CoreApi.md#core_lti1p3_provider_lti_tools_destroy) | **DELETE** /api/core/lti/1p3/provider/lti-tools/{id}/ | +[**core_lti1p3_provider_lti_tools_list**](CoreApi.md#core_lti1p3_provider_lti_tools_list) | **GET** /api/core/lti/1p3/provider/lti-tools/ | +[**core_lti1p3_provider_lti_tools_retrieve**](CoreApi.md#core_lti1p3_provider_lti_tools_retrieve) | **GET** /api/core/lti/1p3/provider/lti-tools/{id}/ | +[**core_lti1p3_provider_lti_tools_update**](CoreApi.md#core_lti1p3_provider_lti_tools_update) | **PUT** /api/core/lti/1p3/provider/lti-tools/{id}/ | [**core_orgs_dark_mode_logo_create_create**](CoreApi.md#core_orgs_dark_mode_logo_create_create) | **POST** /api/core/orgs/{org}/dark-mode-logo/create/ | [**core_orgs_dark_mode_logo_retrieve**](CoreApi.md#core_orgs_dark_mode_logo_retrieve) | **GET** /api/core/orgs/{org}/dark-mode-logo/ | [**core_orgs_favicon_create_create**](CoreApi.md#core_orgs_favicon_create_create) | **POST** /api/core/orgs/{org}/favicon/create/ | @@ -13,10 +23,729 @@ Method | HTTP request | Description [**core_orgs_metadata_partial_update**](CoreApi.md#core_orgs_metadata_partial_update) | **PATCH** /api/core/orgs/{org}/metadata/ | [**core_orgs_metadata_retrieve**](CoreApi.md#core_orgs_metadata_retrieve) | **GET** /api/core/orgs/{org}/metadata/ | [**core_orgs_metadata_update**](CoreApi.md#core_orgs_metadata_update) | **PUT** /api/core/orgs/{org}/metadata/ | +[**core_orgs_redirect_tokens_create**](CoreApi.md#core_orgs_redirect_tokens_create) | **POST** /api/core/orgs/{org}/redirect-tokens/ | +[**core_orgs_redirect_tokens_delete_destroy**](CoreApi.md#core_orgs_redirect_tokens_delete_destroy) | **DELETE** /api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete | +[**core_orgs_redirect_tokens_retrieve**](CoreApi.md#core_orgs_redirect_tokens_retrieve) | **GET** /api/core/orgs/{org}/redirect-tokens/{redirect_token}/ | [**core_orgs_thumbnail_create_create**](CoreApi.md#core_orgs_thumbnail_create_create) | **POST** /api/core/orgs/{org}/thumbnail/create/ | [**core_orgs_thumbnail_retrieve**](CoreApi.md#core_orgs_thumbnail_retrieve) | **GET** /api/core/orgs/{org}/thumbnail/ | +# **core_lti1p3_provider_lti_keys_create** +> LtiKey core_lti1p3_provider_lti_keys_create(lti_key) + + + +Create a new LTI Provider Key + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_key import LtiKey +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +lti_key = iblai.LtiKey() # LtiKey | + +try: + api_response = api_instance.core_lti1p3_provider_lti_keys_create(lti_key) + print("The response of CoreApi->core_lti1p3_provider_lti_keys_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_keys_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lti_key** | [**LtiKey**](LtiKey.md)| | + +### Return type + +[**LtiKey**](LtiKey.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_keys_destroy** +> core_lti1p3_provider_lti_keys_destroy(id, platform_key) + + + +Delete an LTI Provider Key **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one. + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_instance.core_lti1p3_provider_lti_keys_destroy(id, platform_key) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_keys_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **platform_key** | **str**| Platform Key | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_keys_list** +> List[LtiKey] core_lti1p3_provider_lti_keys_list(platform_key) + + + +List your LTI Provider Key's + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_key import LtiKey +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_response = api_instance.core_lti1p3_provider_lti_keys_list(platform_key) + print("The response of CoreApi->core_lti1p3_provider_lti_keys_list:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_keys_list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **platform_key** | **str**| Platform Key | + +### Return type + +[**List[LtiKey]**](LtiKey.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_keys_retrieve** +> LtiKey core_lti1p3_provider_lti_keys_retrieve(id, platform_key) + + + +Get details about a specific LTI Provider Key + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_key import LtiKey +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_response = api_instance.core_lti1p3_provider_lti_keys_retrieve(id, platform_key) + print("The response of CoreApi->core_lti1p3_provider_lti_keys_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_keys_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **platform_key** | **str**| Platform Key | + +### Return type + +[**LtiKey**](LtiKey.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_keys_update** +> LtiKey core_lti1p3_provider_lti_keys_update(id, lti_key) + + + +Update an LTI Provider Key + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_key import LtiKey +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +lti_key = iblai.LtiKey() # LtiKey | + +try: + api_response = api_instance.core_lti1p3_provider_lti_keys_update(id, lti_key) + print("The response of CoreApi->core_lti1p3_provider_lti_keys_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_keys_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **lti_key** | [**LtiKey**](LtiKey.md)| | + +### Return type + +[**LtiKey**](LtiKey.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_tools_create** +> LtiTool core_lti1p3_provider_lti_tools_create(lti_tool) + + + +Create a new LTI Tool + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_tool import LtiTool +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +lti_tool = iblai.LtiTool() # LtiTool | + +try: + api_response = api_instance.core_lti1p3_provider_lti_tools_create(lti_tool) + print("The response of CoreApi->core_lti1p3_provider_lti_tools_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_tools_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lti_tool** | [**LtiTool**](LtiTool.md)| | + +### Return type + +[**LtiTool**](LtiTool.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_tools_destroy** +> core_lti1p3_provider_lti_tools_destroy(id, platform_key) + + + +Delete an LTI Tool + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_instance.core_lti1p3_provider_lti_tools_destroy(id, platform_key) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_tools_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **platform_key** | **str**| Platform Key | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_tools_list** +> List[LtiTool] core_lti1p3_provider_lti_tools_list(platform_key) + + + +List your LTI Tool's + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_tool import LtiTool +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_response = api_instance.core_lti1p3_provider_lti_tools_list(platform_key) + print("The response of CoreApi->core_lti1p3_provider_lti_tools_list:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_tools_list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **platform_key** | **str**| Platform Key | + +### Return type + +[**List[LtiTool]**](LtiTool.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_tools_retrieve** +> LtiTool core_lti1p3_provider_lti_tools_retrieve(id, platform_key) + + + +Get details about a specific LTI Tool + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_tool import LtiTool +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +platform_key = 'platform_key_example' # str | Platform Key + +try: + api_response = api_instance.core_lti1p3_provider_lti_tools_retrieve(id, platform_key) + print("The response of CoreApi->core_lti1p3_provider_lti_tools_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_tools_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **platform_key** | **str**| Platform Key | + +### Return type + +[**LtiTool**](LtiTool.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_lti1p3_provider_lti_tools_update** +> LtiTool core_lti1p3_provider_lti_tools_update(id, lti_tool) + + + +Update an LTI Tool + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.lti_tool import LtiTool +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +id = 'id_example' # str | +lti_tool = iblai.LtiTool() # LtiTool | + +try: + api_response = api_instance.core_lti1p3_provider_lti_tools_update(id, lti_tool) + print("The response of CoreApi->core_lti1p3_provider_lti_tools_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_lti1p3_provider_lti_tools_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **lti_tool** | [**LtiTool**](LtiTool.md)| | + +### Return type + +[**LtiTool**](LtiTool.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **core_orgs_dark_mode_logo_create_create** > ImageUpload core_orgs_dark_mode_logo_create_create(org, image_upload) @@ -622,6 +1351,223 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **core_orgs_redirect_tokens_create** +> RedirectTokenResponse core_orgs_redirect_tokens_create(org, redirect_token_request) + + + +Creates redirect tokens for a URL specified by for a platform + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.redirect_token_request import RedirectTokenRequest +from iblai.models.redirect_token_response import RedirectTokenResponse +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +org = 'org_example' # str | +redirect_token_request = iblai.RedirectTokenRequest() # RedirectTokenRequest | + +try: + api_response = api_instance.core_orgs_redirect_tokens_create(org, redirect_token_request) + print("The response of CoreApi->core_orgs_redirect_tokens_create:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_orgs_redirect_tokens_create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **redirect_token_request** | [**RedirectTokenRequest**](RedirectTokenRequest.md)| | + +### Return type + +[**RedirectTokenResponse**](RedirectTokenResponse.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_orgs_redirect_tokens_delete_destroy** +> core_orgs_redirect_tokens_delete_destroy(org, redirect_token) + + + +Delete specific token + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +org = 'org_example' # str | +redirect_token = 'redirect_token_example' # str | + +try: + api_instance.core_orgs_redirect_tokens_delete_destroy(org, redirect_token) +except Exception as e: + print("Exception when calling CoreApi->core_orgs_redirect_tokens_delete_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **redirect_token** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **core_orgs_redirect_tokens_retrieve** +> RedirectTokenResponse core_orgs_redirect_tokens_retrieve(org, redirect_token) + + + +Returns Redirect URL for the token specified. ``` Requires user to be a member of the platform with the token passed ``` + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.redirect_token_response import RedirectTokenResponse +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.CoreApi(api_client) +org = 'org_example' # str | +redirect_token = 'redirect_token_example' # str | + +try: + api_response = api_instance.core_orgs_redirect_tokens_retrieve(org, redirect_token) + print("The response of CoreApi->core_orgs_redirect_tokens_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling CoreApi->core_orgs_redirect_tokens_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **redirect_token** | **str**| | + +### Return type + +[**RedirectTokenResponse**](RedirectTokenResponse.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **core_orgs_thumbnail_create_create** > ImageUpload core_orgs_thumbnail_create_create(org, image_upload) diff --git a/docs/Credential.md b/docs/Credential.md index bf4639f..7f44784 100644 --- a/docs/Credential.md +++ b/docs/Credential.md @@ -5,9 +5,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**entity_id** | **str** | | **name** | **str** | | -**value** | **object** | | [optional] -**platform** | **str** | The platform key | +**name_override** | **str** | | [optional] +**description** | **str** | | [optional] +**criteria_url** | **str** | | +**criteria_narrative** | **str** | | +**created_at** | **datetime** | | +**icon_image** | **str** | | +**background_image** | **str** | | +**thumbnail_image** | **str** | | +**catalog_items** | **List[str]** | | [readonly] +**courses** | **List[Dict[str, str]]** | | [readonly] +**programs** | **List[Dict[str, str]]** | | [readonly] +**issuer_details** | **Dict[str, str]** | | [readonly] +**html_template** | **str** | | [optional] +**css_template** | **str** | | [optional] +**metadata** | **object** | | [optional] +**credential_type** | **str** | | +**expires** | **Dict[str, int]** | | [readonly] +**tags** | **object** | | [optional] +**signatories** | **List[Dict[str, str]]** | | [readonly] ## Example diff --git a/docs/DateRange.md b/docs/DateRange.md new file mode 100644 index 0000000..c8abf1f --- /dev/null +++ b/docs/DateRange.md @@ -0,0 +1,30 @@ +# DateRange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **date** | | +**end_date** | **date** | | + +## Example + +```python +from iblai.models.date_range import DateRange + +# TODO update the JSON string below +json = "{}" +# create an instance of DateRange from a JSON string +date_range_instance = DateRange.from_json(json) +# print the JSON string representation of the object +print(DateRange.to_json()) + +# convert the object into a dict +date_range_dict = date_range_instance.to_dict() +# create an instance of DateRange from a dict +date_range_from_dict = DateRange.from_dict(date_range_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Education.md b/docs/Education.md new file mode 100644 index 0000000..1812f57 --- /dev/null +++ b/docs/Education.md @@ -0,0 +1,45 @@ +# Education + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**user** | **int** | edX user ID | [readonly] +**user_info** | [**UserInfo**](UserInfo.md) | | [readonly] +**institution** | [**Institution**](Institution.md) | | [readonly] +**institution_id** | **int** | | +**degree** | **str** | | [optional] +**field_of_study** | **str** | | [optional] +**start_date** | **date** | | +**end_date** | **date** | | [optional] +**grade** | **decimal.Decimal** | | [optional] +**activities** | **str** | | [optional] +**description** | **str** | | [optional] +**data** | **object** | Metadata | [optional] +**metadata** | **object** | Metadata | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [readonly] +**is_current** | **bool** | | [optional] + +## Example + +```python +from iblai.models.education import Education + +# TODO update the JSON string below +json = "{}" +# create an instance of Education from a JSON string +education_instance = Education.from_json(json) +# print the JSON string representation of the object +print(Education.to_json()) + +# convert the object into a dict +education_dict = education_instance.to_dict() +# create an instance of Education from a dict +education_from_dict = Education.from_dict(education_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EngagementApi.md b/docs/EngagementApi.md index dabf098..3682681 100644 --- a/docs/EngagementApi.md +++ b/docs/EngagementApi.md @@ -421,7 +421,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **engagement_orgs_courses_time_over_time_retrieve** -> Overtime engagement_orgs_courses_time_over_time_retrieve(course_id, org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal engagement_orgs_courses_time_over_time_retrieve(course_id, org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -433,7 +433,7 @@ Time spent per course in secs on a per-day basis Query Params 1. start_date e.g ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -482,7 +482,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -585,7 +585,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **engagement_orgs_courses_time_users_over_time_retrieve** -> Overtime engagement_orgs_courses_time_users_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal engagement_orgs_courses_time_users_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -597,7 +597,7 @@ Time spent in secs on a per-day basis Query Params 1. course_id e.g ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -648,7 +648,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -753,7 +753,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **engagement_orgs_courses_videos_over_time_retrieve** -> Overtime engagement_orgs_courses_videos_over_time_retrieve(course_id, org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal engagement_orgs_courses_videos_over_time_retrieve(course_id, org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -765,7 +765,7 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -814,7 +814,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -1385,7 +1385,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **engagement_orgs_videos_over_time_retrieve** -> Overtime engagement_orgs_videos_over_time_retrieve(org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal engagement_orgs_videos_over_time_retrieve(org, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -1397,7 +1397,7 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -1444,7 +1444,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization diff --git a/docs/Experience.md b/docs/Experience.md new file mode 100644 index 0000000..f5961c3 --- /dev/null +++ b/docs/Experience.md @@ -0,0 +1,44 @@ +# Experience + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**user** | **int** | edX user ID | [readonly] +**user_info** | [**UserInfo**](UserInfo.md) | | [readonly] +**company** | [**Company**](Company.md) | | [readonly] +**company_id** | **int** | | +**title** | **str** | | +**employment_type** | **str** | | [optional] +**location** | **str** | | [optional] +**start_date** | **date** | | +**end_date** | **date** | | [optional] +**is_current** | **bool** | | [optional] +**description** | **str** | | [optional] +**data** | **object** | Metadata | [optional] +**metadata** | **object** | Metadata | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.experience import Experience + +# TODO update the JSON string below +json = "{}" +# create an instance of Experience from a JSON string +experience_instance = Experience.from_json(json) +# print the JSON string representation of the object +print(Experience.to_json()) + +# convert the object into a dict +experience_dict = experience_instance.to_dict() +# create an instance of Experience from a dict +experience_from_dict = Experience.from_dict(experience_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Institution.md b/docs/Institution.md new file mode 100644 index 0000000..edd3900 --- /dev/null +++ b/docs/Institution.md @@ -0,0 +1,39 @@ +# Institution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**name** | **str** | | +**institution_type** | [**InstitutionTypeEnum**](InstitutionTypeEnum.md) | | [optional] +**location** | **str** | | [optional] +**website** | **str** | | [optional] +**accreditation** | **str** | | [optional] +**established_year** | **int** | | [optional] +**data** | **object** | Metadata | [optional] +**metadata** | **object** | Metadata | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.institution import Institution + +# TODO update the JSON string below +json = "{}" +# create an instance of Institution from a JSON string +institution_instance = Institution.from_json(json) +# print the JSON string representation of the object +print(Institution.to_json()) + +# convert the object into a dict +institution_dict = institution_instance.to_dict() +# create an instance of Institution from a dict +institution_from_dict = Institution.from_dict(institution_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InstitutionTypeEnum.md b/docs/InstitutionTypeEnum.md new file mode 100644 index 0000000..745238a --- /dev/null +++ b/docs/InstitutionTypeEnum.md @@ -0,0 +1,19 @@ +# InstitutionTypeEnum + +* `university` - University * `college` - College * `institute` - Institute * `academy` - Academy * `other` - Other + +## Enum + +* `UNIVERSITY` (value: `'university'`) + +* `COLLEGE` (value: `'college'`) + +* `INSTITUTE` (value: `'institute'`) + +* `ACADEMY` (value: `'academy'`) + +* `OTHER` (value: `'other'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LLMCredentialResponse.md b/docs/LLMCredentialResponse.md new file mode 100644 index 0000000..b3a4a96 --- /dev/null +++ b/docs/LLMCredentialResponse.md @@ -0,0 +1,31 @@ +# LLMCredentialResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**value** | **object** | | [optional] +**platform** | **str** | The platform key | + +## Example + +```python +from iblai.models.llm_credential_response import LLMCredentialResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of LLMCredentialResponse from a JSON string +llm_credential_response_instance = LLMCredentialResponse.from_json(json) +# print the JSON string representation of the object +print(LLMCredentialResponse.to_json()) + +# convert the object into a dict +llm_credential_response_dict = llm_credential_response_instance.to_dict() +# create an instance of LLMCredentialResponse from a dict +llm_credential_response_from_dict = LLMCredentialResponse.from_dict(llm_credential_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LtiKey.md b/docs/LtiKey.md new file mode 100644 index 0000000..55da16c --- /dev/null +++ b/docs/LtiKey.md @@ -0,0 +1,33 @@ +# LtiKey + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**name** | **str** | Name of the RSA Key | +**public_key** | **str** | Public Key in PEM format | [readonly] +**public_jwk** | **object** | Public key in JWK format | [readonly] +**platform_key** | **str** | Platform Key | + +## Example + +```python +from iblai.models.lti_key import LtiKey + +# TODO update the JSON string below +json = "{}" +# create an instance of LtiKey from a JSON string +lti_key_instance = LtiKey.from_json(json) +# print the JSON string representation of the object +print(LtiKey.to_json()) + +# convert the object into a dict +lti_key_dict = lti_key_instance.to_dict() +# create an instance of LtiKey from a dict +lti_key_from_dict = LtiKey.from_dict(lti_key_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LtiLaunchGate.md b/docs/LtiLaunchGate.md new file mode 100644 index 0000000..11a49e3 --- /dev/null +++ b/docs/LtiLaunchGate.md @@ -0,0 +1,31 @@ +# LtiLaunchGate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowed_keys** | **List[str]** | | [optional] +**allowed_courses** | **List[str]** | | [optional] +**allow_all_within_org** | **bool** | If True, a target_link_uri will work with any content within this org | [optional] [default to False] + +## Example + +```python +from iblai.models.lti_launch_gate import LtiLaunchGate + +# TODO update the JSON string below +json = "{}" +# create an instance of LtiLaunchGate from a JSON string +lti_launch_gate_instance = LtiLaunchGate.from_json(json) +# print the JSON string representation of the object +print(LtiLaunchGate.to_json()) + +# convert the object into a dict +lti_launch_gate_dict = lti_launch_gate_instance.to_dict() +# create an instance of LtiLaunchGate from a dict +lti_launch_gate_from_dict = LtiLaunchGate.from_dict(lti_launch_gate_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LtiTool.md b/docs/LtiTool.md new file mode 100644 index 0000000..4009aaa --- /dev/null +++ b/docs/LtiTool.md @@ -0,0 +1,41 @@ +# LtiTool + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**title** | **str** | The title of the tool | +**issuer** | **str** | This value will look someting like https://example.com. Value provided by Lti 1.3 Platform. | +**client_id** | **str** | The client id provided by Lti 1.3 Platform | +**auth_login_url** | **str** | The Platforms OIDC Login endpoint. Value provided by LTI 1.3 Platform. | +**auth_token_url** | **str** | The Platforms OIDC Token endpoint. Value provided by LTI 1.3 Platform. | +**auth_audience** | **str** | The platforms Oauth2 Audience (aud). Usually can be skipped. | [optional] +**key_set_url** | **str** | The platforms JWKS endpoint. Value provided by LTI 1.3 Platform. | [optional] +**key_set** | **object** | In case Platform's JWKS endpoint is not available, you can provide the JWKS here. Value provided by LTI 1.3 Platform. | [optional] +**tool_key** | **int** | Reference to Lti Tool | +**deployment_ids** | **List[str]** | List of deployment ids. Example: [\"1\", \"deployment-2\"]. Value(s) provided by LTI 1.3 Platform. | +**platform_key** | **str** | | +**launch_gate** | [**LtiLaunchGate**](LtiLaunchGate.md) | | + +## Example + +```python +from iblai.models.lti_tool import LtiTool + +# TODO update the JSON string below +json = "{}" +# create an instance of LtiTool from a JSON string +lti_tool_instance = LtiTool.from_json(json) +# print the JSON string representation of the object +print(LtiTool.to_json()) + +# convert the object into a dict +lti_tool_dict = lti_tool_instance.to_dict() +# create an instance of LtiTool from a dict +lti_tool_from_dict = LtiTool.from_dict(lti_tool_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MemoryStatusRequestView.md b/docs/MemoryStatusRequestView.md new file mode 100644 index 0000000..649589e --- /dev/null +++ b/docs/MemoryStatusRequestView.md @@ -0,0 +1,29 @@ +# MemoryStatusRequestView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enable or disable memory use | + +## Example + +```python +from iblai.models.memory_status_request_view import MemoryStatusRequestView + +# TODO update the JSON string below +json = "{}" +# create an instance of MemoryStatusRequestView from a JSON string +memory_status_request_view_instance = MemoryStatusRequestView.from_json(json) +# print the JSON string representation of the object +print(MemoryStatusRequestView.to_json()) + +# convert the object into a dict +memory_status_request_view_dict = memory_status_request_view_instance.to_dict() +# create an instance of MemoryStatusRequestView from a dict +memory_status_request_view_from_dict = MemoryStatusRequestView.from_dict(memory_status_request_view_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MemoryStatusView.md b/docs/MemoryStatusView.md new file mode 100644 index 0000000..fbfab8a --- /dev/null +++ b/docs/MemoryStatusView.md @@ -0,0 +1,32 @@ +# MemoryStatusView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**username** | **str** | | +**platform_key** | **str** | | +**enabled** | **bool** | | [optional] + +## Example + +```python +from iblai.models.memory_status_view import MemoryStatusView + +# TODO update the JSON string below +json = "{}" +# create an instance of MemoryStatusView from a JSON string +memory_status_view_instance = MemoryStatusView.from_json(json) +# print the JSON string representation of the object +print(MemoryStatusView.to_json()) + +# convert the object into a dict +memory_status_view_dict = memory_status_view_instance.to_dict() +# create an instance of MemoryStatusView from a dict +memory_status_view_from_dict = MemoryStatusView.from_dict(memory_status_view_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Mentor.md b/docs/Mentor.md index 635dee7..c0db5d1 100644 --- a/docs/Mentor.md +++ b/docs/Mentor.md @@ -17,6 +17,9 @@ Name | Type | Description | Notes **proactive_prompt** | **str** | Prompt to start a conversation with a user. This prompt will be fed to the mentor as soon as the user enters the chatroom. This is used if is_proactive is true. | [optional] **moderation_system_prompt** | **str** | The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries. | [optional] **moderation_response** | **str** | Desired feedback to return to the user when their prompt is deemed inappropriate. | [optional] +**safety_system_prompt** | **str** | Prompt to check whether the models response is appropriate or not. | [optional] +**safety_response** | **str** | Feedback given to the user when a model generates an inappropriate response | [optional] +**enable_safety_system** | **bool** | | [optional] **proactive_message** | **str** | Prompt to start a conversation with a user. | [optional] **created_by** | **str** | | [optional] **created_at** | **datetime** | | [readonly] diff --git a/docs/MentorFromTemplateWithSettingRequest.md b/docs/MentorFromTemplateWithSettingRequest.md index cf8a414..15cf935 100644 --- a/docs/MentorFromTemplateWithSettingRequest.md +++ b/docs/MentorFromTemplateWithSettingRequest.md @@ -32,6 +32,9 @@ Name | Type | Description | Notes **seo_tags** | **object** | | [optional] **marketing_conversations** | **object** | | [optional] **proactive_prompt** | **str** | | [optional] +**moderation_system_prompt** | **str** | | [optional] +**moderation_response** | **str** | | [optional] +**enable_moderation** | **bool** | | [optional] [default to False] ## Example diff --git a/docs/MentorMetadata.md b/docs/MentorMetadata.md new file mode 100644 index 0000000..18e0017 --- /dev/null +++ b/docs/MentorMetadata.md @@ -0,0 +1,31 @@ +# MentorMetadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | **object** | | +**mentor** | **str** | | [optional] +**mentor_id** | **int** | | [optional] + +## Example + +```python +from iblai.models.mentor_metadata import MentorMetadata + +# TODO update the JSON string below +json = "{}" +# create an instance of MentorMetadata from a JSON string +mentor_metadata_instance = MentorMetadata.from_json(json) +# print the JSON string representation of the object +print(MentorMetadata.to_json()) + +# convert the object into a dict +mentor_metadata_dict = mentor_metadata_instance.to_dict() +# create an instance of MentorMetadata from a dict +mentor_metadata_from_dict = MentorMetadata.from_dict(mentor_metadata_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MentorSettings.md b/docs/MentorSettings.md index 69538a0..30a0173 100644 --- a/docs/MentorSettings.md +++ b/docs/MentorSettings.md @@ -17,19 +17,19 @@ Name | Type | Description | Notes **mentor** | **str** | | [readonly] **mentor_slug** | **str** | | [readonly] **mentor_unique_id** | **str** | | [readonly] -**metadata** | **str** | | [readonly] +**metadata** | **object** | | [readonly] **mentor_visibility** | [**MentorSettingsMentorVisibility**](MentorSettingsMentorVisibility.md) | | [optional] **enable_image_generation** | **bool** | | [optional] **enable_web_browsing** | **bool** | | [optional] **enable_code_interpreter** | **bool** | | [optional] **custom_css** | **str** | | [optional] -**allow_anonymous** | **str** | | [readonly] +**allow_anonymous** | **bool** | | [readonly] **mentor_description** | **str** | | [readonly] -**suggested_prompts** | **str** | | [readonly] +**suggested_prompts** | **object** | | [readonly] **proactive_message** | **str** | | [readonly] -**mentor_tools** | **str** | | [readonly] -**can_use_tools** | **str** | | [readonly] -**llm_temperature** | **str** | | [readonly] +**mentor_tools** | **object** | | [readonly] +**can_use_tools** | **bool** | | [readonly] +**llm_temperature** | **float** | | [readonly] **llm_provider** | **str** | | [readonly] **llm_name** | **str** | | [readonly] **proactive_prompt** | **str** | | [readonly] diff --git a/docs/MentorSettingsRequest.md b/docs/MentorSettingsRequest.md index 6335300..3945a35 100644 --- a/docs/MentorSettingsRequest.md +++ b/docs/MentorSettingsRequest.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**mentor_name** | **str** | | [optional] **display_name** | **str** | | [optional] **profile_image** | **str** | | [optional] **initial_message** | **str** | | [optional] @@ -16,19 +17,27 @@ Name | Type | Description | Notes **system_prompt** | **str** | | [optional] **llm_provider** | **str** | | [optional] **llm_name** | **str** | | [optional] -**featured** | **str** | | [optional] +**featured** | **bool** | | [optional] **metadata** | **object** | | [optional] **custom_css** | **str** | | [optional] **mentor_visibility** | **str** | | [optional] -**enable_image_generation** | **str** | | [optional] -**enable_web_browsing** | **str** | | [optional] -**enable_code_interpreter** | **str** | | [optional] -**allow_anonymous** | **str** | | [optional] +**enable_image_generation** | **bool** | | [optional] +**enable_web_browsing** | **bool** | | [optional] +**enable_code_interpreter** | **bool** | | [optional] +**allow_anonymous** | **bool** | | [optional] **mentor_description** | **str** | | [optional] **uploaded_profile_image** | **str** | | [optional] **proactive_message** | **str** | | [optional] +**can_use_tools** | **bool** | | [optional] **tool_slugs** | **List[str]** | | [optional] **llm_temperature** | **float** | | [optional] +**proactive_prompt** | **str** | | [optional] +**moderation_system_prompt** | **str** | | [optional] +**moderation_response** | **str** | | [optional] +**enable_moderation** | **bool** | | [optional] [default to False] +**safety_system_prompt** | **str** | | [optional] +**safety_response** | **str** | | [optional] +**enable_safety_system** | **bool** | | [optional] [default to False] ## Example diff --git a/docs/MessageStatus.md b/docs/MessageStatus.md new file mode 100644 index 0000000..3da67c7 --- /dev/null +++ b/docs/MessageStatus.md @@ -0,0 +1,28 @@ +# MessageStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```python +from iblai.models.message_status import MessageStatus + +# TODO update the JSON string below +json = "{}" +# create an instance of MessageStatus from a JSON string +message_status_instance = MessageStatus.from_json(json) +# print the JSON string representation of the object +print(MessageStatus.to_json()) + +# convert the object into a dict +message_status_dict = message_status_instance.to_dict() +# create an instance of MessageStatus from a dict +message_status_from_dict = MessageStatus.from_dict(message_status_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Metadata.md b/docs/Metadata.md new file mode 100644 index 0000000..fcf5440 --- /dev/null +++ b/docs/Metadata.md @@ -0,0 +1,31 @@ +# Metadata + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | **object** | | +**prompt** | **str** | | [optional] +**prompt_id** | **int** | | [optional] + +## Example + +```python +from iblai.models.metadata import Metadata + +# TODO update the JSON string below +json = "{}" +# create an instance of Metadata from a JSON string +metadata_instance = Metadata.from_json(json) +# print the JSON string representation of the object +print(Metadata.to_json()) + +# convert the object into a dict +metadata_dict = metadata_instance.to_dict() +# create an instance of Metadata from a dict +metadata_from_dict = Metadata.from_dict(metadata_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ModerationLog.md b/docs/ModerationLog.md new file mode 100644 index 0000000..95544d4 --- /dev/null +++ b/docs/ModerationLog.md @@ -0,0 +1,36 @@ +# ModerationLog + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**username** | **str** | | [optional] +**platform_key** | **str** | | +**mentor** | **int** | | +**prompt** | **str** | | +**reason** | **str** | | +**target_system** | [**TargetSystemEnum**](TargetSystemEnum.md) | | [optional] +**date_created** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.moderation_log import ModerationLog + +# TODO update the JSON string below +json = "{}" +# create an instance of ModerationLog from a JSON string +moderation_log_instance = ModerationLog.from_json(json) +# print the JSON string representation of the object +print(ModerationLog.to_json()) + +# convert the object into a dict +moderation_log_dict = moderation_log_instance.to_dict() +# create an instance of ModerationLog from a dict +moderation_log_from_dict = ModerationLog.from_dict(moderation_log_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitoringApi.md b/docs/MonitoringApi.md deleted file mode 100644 index a752a93..0000000 --- a/docs/MonitoringApi.md +++ /dev/null @@ -1,59 +0,0 @@ -# iblai.MonitoringApi - -All URIs are relative to *https://base.manager.iblai.app* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**monitoring_connectors_retrieve**](MonitoringApi.md#monitoring_connectors_retrieve) | **GET** /monitoring/connectors/ | - - -# **monitoring_connectors_retrieve** -> monitoring_connectors_retrieve() - - - -### Example - - -```python -import iblai -from iblai.rest import ApiException -from pprint import pprint - - -# Create an instance of the API class -api_instance = iblai.MonitoringApi(api_client) - -try: - api_instance.monitoring_connectors_retrieve() -except Exception as e: - print("Exception when calling MonitoringApi->monitoring_connectors_retrieve: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | No response body | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Notification.md b/docs/Notification.md new file mode 100644 index 0000000..59c1f3e --- /dev/null +++ b/docs/Notification.md @@ -0,0 +1,37 @@ +# Notification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**username** | **str** | | +**title** | **str** | | [readonly] +**body** | **str** | | [readonly] +**status** | [**MessageStatus**](MessageStatus.md) | | [optional] +**channel** | **int** | | [optional] +**context** | **object** | | [optional] +**short_message** | **str** | | [readonly] +**created_at** | **datetime** | | [optional] + +## Example + +```python +from iblai.models.notification import Notification + +# TODO update the JSON string below +json = "{}" +# create an instance of Notification from a JSON string +notification_instance = Notification.from_json(json) +# print the JSON string representation of the object +print(Notification.to_json()) + +# convert the object into a dict +notification_dict = notification_instance.to_dict() +# create an instance of Notification from a dict +notification_from_dict = Notification.from_dict(notification_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NotificationApi.md b/docs/NotificationApi.md new file mode 100644 index 0000000..6348bb8 --- /dev/null +++ b/docs/NotificationApi.md @@ -0,0 +1,627 @@ +# iblai.NotificationApi + +All URIs are relative to *https://base.manager.iblai.app* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**notification_v1_orgs_notifications_bulk_update_partial_update**](NotificationApi.md#notification_v1_orgs_notifications_bulk_update_partial_update) | **PATCH** /api/notification/v1/orgs/{org}/notifications/bulk-update/ | +[**notification_v1_orgs_notifications_retrieve**](NotificationApi.md#notification_v1_orgs_notifications_retrieve) | **GET** /api/notification/v1/orgs/{org}/notifications/ | +[**notification_v1_orgs_notifications_update**](NotificationApi.md#notification_v1_orgs_notifications_update) | **PUT** /api/notification/v1/orgs/{org}/notifications/ | +[**notification_v1_orgs_users_notifications_bulk_update_partial_update**](NotificationApi.md#notification_v1_orgs_users_notifications_bulk_update_partial_update) | **PATCH** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/ | +[**notification_v1_orgs_users_notifications_count_retrieve**](NotificationApi.md#notification_v1_orgs_users_notifications_count_retrieve) | **GET** /api/notification/v1/orgs/{org}/users/{user_id}/notifications-count/ | +[**notification_v1_orgs_users_notifications_destroy**](NotificationApi.md#notification_v1_orgs_users_notifications_destroy) | **DELETE** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/{notification_id}/ | +[**notification_v1_orgs_users_notifications_retrieve**](NotificationApi.md#notification_v1_orgs_users_notifications_retrieve) | **GET** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/ | +[**notification_v1_orgs_users_notifications_update**](NotificationApi.md#notification_v1_orgs_users_notifications_update) | **PUT** /api/notification/v1/orgs/{org}/users/{user_id}/notifications/ | + + +# **notification_v1_orgs_notifications_bulk_update_partial_update** +> Notification notification_v1_orgs_notifications_bulk_update_partial_update(org, patched_notification=patched_notification) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.models.patched_notification import PatchedNotification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +patched_notification = iblai.PatchedNotification() # PatchedNotification | (optional) + +try: + api_response = api_instance.notification_v1_orgs_notifications_bulk_update_partial_update(org, patched_notification=patched_notification) + print("The response of NotificationApi->notification_v1_orgs_notifications_bulk_update_partial_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_notifications_bulk_update_partial_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **patched_notification** | [**PatchedNotification**](PatchedNotification.md)| | [optional] + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_notifications_retrieve** +> Notification notification_v1_orgs_notifications_retrieve(org, channel=channel, end_date=end_date, exclude_channel=exclude_channel, start_date=start_date, status=status) + + + +Get notifications for a user + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +channel = 'channel_example' # str | (optional) +end_date = 'end_date_example' # str | (optional) +exclude_channel = 'exclude_channel_example' # str | (optional) +start_date = 'start_date_example' # str | (optional) +status = 'status_example' # str | (optional) + +try: + api_response = api_instance.notification_v1_orgs_notifications_retrieve(org, channel=channel, end_date=end_date, exclude_channel=exclude_channel, start_date=start_date, status=status) + print("The response of NotificationApi->notification_v1_orgs_notifications_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_notifications_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **channel** | **str**| | [optional] + **end_date** | **str**| | [optional] + **exclude_channel** | **str**| | [optional] + **start_date** | **str**| | [optional] + **status** | **str**| | [optional] + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_notifications_update** +> Notification notification_v1_orgs_notifications_update(org, notification) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +notification = iblai.Notification() # Notification | + +try: + api_response = api_instance.notification_v1_orgs_notifications_update(org, notification) + print("The response of NotificationApi->notification_v1_orgs_notifications_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_notifications_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **notification** | [**Notification**](Notification.md)| | + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_users_notifications_bulk_update_partial_update** +> Notification notification_v1_orgs_users_notifications_bulk_update_partial_update(org, user_id, patched_notification=patched_notification) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.models.patched_notification import PatchedNotification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +patched_notification = iblai.PatchedNotification() # PatchedNotification | (optional) + +try: + api_response = api_instance.notification_v1_orgs_users_notifications_bulk_update_partial_update(org, user_id, patched_notification=patched_notification) + print("The response of NotificationApi->notification_v1_orgs_users_notifications_bulk_update_partial_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_users_notifications_bulk_update_partial_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **patched_notification** | [**PatchedNotification**](PatchedNotification.md)| | [optional] + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_users_notifications_count_retrieve** +> NotificationCount notification_v1_orgs_users_notifications_count_retrieve(org, user_id, channel=channel, status=status) + + + +Get notifications count for a user + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification_count import NotificationCount +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +channel = 'channel_example' # str | (optional) +status = 'status_example' # str | (optional) + +try: + api_response = api_instance.notification_v1_orgs_users_notifications_count_retrieve(org, user_id, channel=channel, status=status) + print("The response of NotificationApi->notification_v1_orgs_users_notifications_count_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_users_notifications_count_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **channel** | **str**| | [optional] + **status** | **str**| | [optional] + +### Return type + +[**NotificationCount**](NotificationCount.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_users_notifications_destroy** +> notification_v1_orgs_users_notifications_destroy(notification_id, org, user_id) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +notification_id = 'notification_id_example' # str | +org = 'org_example' # str | +user_id = 'user_id_example' # str | + +try: + api_instance.notification_v1_orgs_users_notifications_destroy(notification_id, org, user_id) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_users_notifications_destroy: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notification_id** | **str**| | + **org** | **str**| | + **user_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_users_notifications_retrieve** +> Notification notification_v1_orgs_users_notifications_retrieve(org, user_id, channel=channel, end_date=end_date, exclude_channel=exclude_channel, start_date=start_date, status=status) + + + +Get notifications for a user + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +channel = 'channel_example' # str | (optional) +end_date = 'end_date_example' # str | (optional) +exclude_channel = 'exclude_channel_example' # str | (optional) +start_date = 'start_date_example' # str | (optional) +status = 'status_example' # str | (optional) + +try: + api_response = api_instance.notification_v1_orgs_users_notifications_retrieve(org, user_id, channel=channel, end_date=end_date, exclude_channel=exclude_channel, start_date=start_date, status=status) + print("The response of NotificationApi->notification_v1_orgs_users_notifications_retrieve:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_users_notifications_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **channel** | **str**| | [optional] + **end_date** | **str**| | [optional] + **exclude_channel** | **str**| | [optional] + **start_date** | **str**| | [optional] + **status** | **str**| | [optional] + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notification_v1_orgs_users_notifications_update** +> Notification notification_v1_orgs_users_notifications_update(org, user_id, notification) + + + +Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.models.notification import Notification +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.NotificationApi(api_client) +org = 'org_example' # str | +user_id = 'user_id_example' # str | +notification = iblai.Notification() # Notification | + +try: + api_response = api_instance.notification_v1_orgs_users_notifications_update(org, user_id, notification) + print("The response of NotificationApi->notification_v1_orgs_users_notifications_update:\n") + pprint(api_response) +except Exception as e: + print("Exception when calling NotificationApi->notification_v1_orgs_users_notifications_update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **user_id** | **str**| | + **notification** | [**Notification**](Notification.md)| | + +### Return type + +[**Notification**](Notification.md) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/NotificationCount.md b/docs/NotificationCount.md new file mode 100644 index 0000000..b4d8103 --- /dev/null +++ b/docs/NotificationCount.md @@ -0,0 +1,30 @@ +# NotificationCount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | | [optional] +**channel** | **str** | | [optional] + +## Example + +```python +from iblai.models.notification_count import NotificationCount + +# TODO update the JSON string below +json = "{}" +# create an instance of NotificationCount from a JSON string +notification_count_instance = NotificationCount.from_json(json) +# print the JSON string representation of the object +print(NotificationCount.to_json()) + +# convert the object into a dict +notification_count_dict = notification_count_instance.to_dict() +# create an instance of NotificationCount from a dict +notification_count_from_dict = NotificationCount.from_dict(notification_count_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NotificationStatusEnum.md b/docs/NotificationStatusEnum.md new file mode 100644 index 0000000..d5c17f6 --- /dev/null +++ b/docs/NotificationStatusEnum.md @@ -0,0 +1,15 @@ +# NotificationStatusEnum + +* `READ` - Read * `UNREAD` - Unread * `CANCELLED` - Cancelled + +## Enum + +* `READ` (value: `'READ'`) + +* `UNREAD` (value: `'UNREAD'`) + +* `CANCELLED` (value: `'CANCELLED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OverTime.md b/docs/OverTime.md index 2f8cceb..de80cee 100644 --- a/docs/OverTime.md +++ b/docs/OverTime.md @@ -1,30 +1,28 @@ -# Overtime +# OverTime -Returns { \"data\": { \"2022-04-26\": 0, \"2022-04-27\": 0, ... \"2023-01-01\": 0 }, \"total\": 0 } ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | **Dict[str, object]** | Dates are keys and values are the value for the date in the key. e,g `{\"2020-01-01\": 30. ...}` | [optional] -**total** | **int** | Total | [optional] +**data** | **Dict[str, object]** | | ## Example ```python -from iblai.models.overtime import Overtime +from iblai.models.over_time import OverTime # TODO update the JSON string below json = "{}" -# create an instance of Overtime from a JSON string -overtime_instance = Overtime.from_json(json) +# create an instance of OverTime from a JSON string +over_time_instance = OverTime.from_json(json) # print the JSON string representation of the object -print(Overtime.to_json()) +print(OverTime.to_json()) # convert the object into a dict -overtime_dict = overtime_instance.to_dict() -# create an instance of Overtime from a dict -overtime_from_dict = Overtime.from_dict(overtime_dict) +over_time_dict = over_time_instance.to_dict() +# create an instance of OverTime from a dict +over_time_from_dict = OverTime.from_dict(over_time_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/OverTimeWithTotal.md b/docs/OverTimeWithTotal.md new file mode 100644 index 0000000..7336bfa --- /dev/null +++ b/docs/OverTimeWithTotal.md @@ -0,0 +1,31 @@ +# OverTimeWithTotal + +Returns { \"data\": { \"2022-04-26\": 0, \"2022-04-27\": 0, ... \"2023-01-01\": 0 }, \"total\": 0 } + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **Dict[str, object]** | Dates are keys and values are the value for the date in the key. e,g `{\"2020-01-01\": 30. ...}` | [optional] +**total** | **int** | Total | [optional] + +## Example + +```python +from iblai.models.over_time_with_total import OverTimeWithTotal + +# TODO update the JSON string below +json = "{}" +# create an instance of OverTimeWithTotal from a JSON string +over_time_with_total_instance = OverTimeWithTotal.from_json(json) +# print the JSON string representation of the object +print(OverTimeWithTotal.to_json()) + +# convert the object into a dict +over_time_with_total_dict = over_time_with_total_instance.to_dict() +# create an instance of OverTimeWithTotal from a dict +over_time_with_total_from_dict = OverTimeWithTotal.from_dict(over_time_with_total_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaginatedAIGeneratedImageList.md b/docs/PaginatedAIGeneratedImageList.md new file mode 100644 index 0000000..d421a82 --- /dev/null +++ b/docs/PaginatedAIGeneratedImageList.md @@ -0,0 +1,32 @@ +# PaginatedAIGeneratedImageList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | | [optional] +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**List[AIGeneratedImage]**](AIGeneratedImage.md) | | [optional] + +## Example + +```python +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList + +# TODO update the JSON string below +json = "{}" +# create an instance of PaginatedAIGeneratedImageList from a JSON string +paginated_ai_generated_image_list_instance = PaginatedAIGeneratedImageList.from_json(json) +# print the JSON string representation of the object +print(PaginatedAIGeneratedImageList.to_json()) + +# convert the object into a dict +paginated_ai_generated_image_list_dict = paginated_ai_generated_image_list_instance.to_dict() +# create an instance of PaginatedAIGeneratedImageList from a dict +paginated_ai_generated_image_list_from_dict = PaginatedAIGeneratedImageList.from_dict(paginated_ai_generated_image_list_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaginatedConversationsList.md b/docs/PaginatedConversationsList.md new file mode 100644 index 0000000..4cea1b9 --- /dev/null +++ b/docs/PaginatedConversationsList.md @@ -0,0 +1,32 @@ +# PaginatedConversationsList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | | [optional] +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**List[Conversations]**](Conversations.md) | | [optional] + +## Example + +```python +from iblai.models.paginated_conversations_list import PaginatedConversationsList + +# TODO update the JSON string below +json = "{}" +# create an instance of PaginatedConversationsList from a JSON string +paginated_conversations_list_instance = PaginatedConversationsList.from_json(json) +# print the JSON string representation of the object +print(PaginatedConversationsList.to_json()) + +# convert the object into a dict +paginated_conversations_list_dict = paginated_conversations_list_instance.to_dict() +# create an instance of PaginatedConversationsList from a dict +paginated_conversations_list_from_dict = PaginatedConversationsList.from_dict(paginated_conversations_list_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaginatedModerationLogList.md b/docs/PaginatedModerationLogList.md new file mode 100644 index 0000000..dd72740 --- /dev/null +++ b/docs/PaginatedModerationLogList.md @@ -0,0 +1,32 @@ +# PaginatedModerationLogList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | | [optional] +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**List[ModerationLog]**](ModerationLog.md) | | [optional] + +## Example + +```python +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList + +# TODO update the JSON string below +json = "{}" +# create an instance of PaginatedModerationLogList from a JSON string +paginated_moderation_log_list_instance = PaginatedModerationLogList.from_json(json) +# print the JSON string representation of the object +print(PaginatedModerationLogList.to_json()) + +# convert the object into a dict +paginated_moderation_log_list_dict = paginated_moderation_log_list_instance.to_dict() +# create an instance of PaginatedModerationLogList from a dict +paginated_moderation_log_list_from_dict = PaginatedModerationLogList.from_dict(paginated_moderation_log_list_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PatchedMentor.md b/docs/PatchedMentor.md index 21deac6..116d69a 100644 --- a/docs/PatchedMentor.md +++ b/docs/PatchedMentor.md @@ -17,6 +17,9 @@ Name | Type | Description | Notes **proactive_prompt** | **str** | Prompt to start a conversation with a user. This prompt will be fed to the mentor as soon as the user enters the chatroom. This is used if is_proactive is true. | [optional] **moderation_system_prompt** | **str** | The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries. | [optional] **moderation_response** | **str** | Desired feedback to return to the user when their prompt is deemed inappropriate. | [optional] +**safety_system_prompt** | **str** | Prompt to check whether the models response is appropriate or not. | [optional] +**safety_response** | **str** | Feedback given to the user when a model generates an inappropriate response | [optional] +**enable_safety_system** | **bool** | | [optional] **proactive_message** | **str** | Prompt to start a conversation with a user. | [optional] **created_by** | **str** | | [optional] **created_at** | **datetime** | | [optional] [readonly] diff --git a/docs/PatchedNotification.md b/docs/PatchedNotification.md new file mode 100644 index 0000000..bf53d75 --- /dev/null +++ b/docs/PatchedNotification.md @@ -0,0 +1,37 @@ +# PatchedNotification + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**username** | **str** | | [optional] +**title** | **str** | | [optional] [readonly] +**body** | **str** | | [optional] [readonly] +**status** | [**MessageStatus**](MessageStatus.md) | | [optional] +**channel** | **int** | | [optional] +**context** | **object** | | [optional] +**short_message** | **str** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] + +## Example + +```python +from iblai.models.patched_notification import PatchedNotification + +# TODO update the JSON string below +json = "{}" +# create an instance of PatchedNotification from a JSON string +patched_notification_instance = PatchedNotification.from_json(json) +# print the JSON string representation of the object +print(PatchedNotification.to_json()) + +# convert the object into a dict +patched_notification_dict = patched_notification_instance.to_dict() +# create an instance of PatchedNotification from a dict +patched_notification_from_dict = PatchedNotification.from_dict(patched_notification_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PatchedPeriodicAgentCreate.md b/docs/PatchedPeriodicAgentCreate.md index 92a1204..46d5d93 100644 --- a/docs/PatchedPeriodicAgentCreate.md +++ b/docs/PatchedPeriodicAgentCreate.md @@ -18,6 +18,8 @@ Name | Type | Description | Notes **one_off** | **str** | | [optional] [readonly] **platform_key** | **str** | | [optional] [readonly] **pathway** | **str** | | [optional] +**callback_url** | **str** | | [optional] +**callback_secret** | **str** | | [optional] **parent_session_id** | **str** | | [optional] **parent_mentor_id** | **int** | | [optional] **previous_agent** | **int** | Agent that needs to run before the current agent runs. | [optional] diff --git a/docs/PatchedPlatformPublicMetadata.md b/docs/PatchedPlatformPublicMetadata.md index 6ef12a0..4bbb003 100644 --- a/docs/PatchedPlatformPublicMetadata.md +++ b/docs/PatchedPlatformPublicMetadata.md @@ -8,8 +8,6 @@ Name | Type | Description | Notes **platform_key** | **str** | | [optional] [readonly] **platform_name** | **str** | | [optional] [readonly] **metadata** | **object** | The public metadata | [optional] -**created_on** | **datetime** | | [optional] [readonly] -**last_updated** | **datetime** | | [optional] [readonly] ## Example diff --git a/docs/PeriodicAgent.md b/docs/PeriodicAgent.md index 93dbb14..cb35535 100644 --- a/docs/PeriodicAgent.md +++ b/docs/PeriodicAgent.md @@ -18,6 +18,8 @@ Name | Type | Description | Notes **one_off** | **str** | | [readonly] **platform_key** | **str** | | [readonly] **pathway** | **str** | | [optional] +**callback_url** | **str** | | [optional] +**callback_secret** | **str** | | [optional] **parent_session_id** | **str** | | [optional] **parent_mentor_id** | **int** | | [optional] **previous_agent** | **int** | Agent that needs to run before the current agent runs. | [optional] diff --git a/docs/PeriodicAgentCreate.md b/docs/PeriodicAgentCreate.md index 5d381aa..d007b4c 100644 --- a/docs/PeriodicAgentCreate.md +++ b/docs/PeriodicAgentCreate.md @@ -18,6 +18,8 @@ Name | Type | Description | Notes **one_off** | **str** | | [readonly] **platform_key** | **str** | | [readonly] **pathway** | **str** | | [optional] +**callback_url** | **str** | | [optional] +**callback_secret** | **str** | | [optional] **parent_session_id** | **str** | | [optional] **parent_mentor_id** | **int** | | [optional] **previous_agent** | **int** | Agent that needs to run before the current agent runs. | [optional] diff --git a/docs/PerlearnerApi.md b/docs/PerlearnerApi.md index a6b650e..beeab4e 100644 --- a/docs/PerlearnerApi.md +++ b/docs/PerlearnerApi.md @@ -594,7 +594,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **perlearner_orgs_users_courses_overview_time_over_time_retrieve** -> Overtime perlearner_orgs_users_courses_overview_time_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal perlearner_orgs_users_courses_overview_time_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -606,7 +606,7 @@ Time spent within a course in secs on a per-day basis Kwargs 1. course_id e.g ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -657,7 +657,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -677,7 +677,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **perlearner_orgs_users_courses_videos_over_time_retrieve** -> Overtime perlearner_orgs_users_courses_videos_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal perlearner_orgs_users_courses_videos_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -689,7 +689,7 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -740,7 +740,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -1313,7 +1313,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **perlearner_orgs_users_overview_time_over_time_retrieve** -> Overtime perlearner_orgs_users_overview_time_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal perlearner_orgs_users_overview_time_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -1325,7 +1325,7 @@ Time spent in secs on a per-day basis Query Params 1. course_id e.g ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -1374,7 +1374,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization @@ -1475,7 +1475,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **perlearner_orgs_users_videos_over_time_retrieve** -> Overtime perlearner_orgs_users_videos_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) +> OverTimeWithTotal perlearner_orgs_users_videos_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date) @@ -1487,7 +1487,7 @@ Name | Type | Description | Notes ```python import iblai -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.rest import ApiException from pprint import pprint @@ -1536,7 +1536,7 @@ Name | Type | Description | Notes ### Return type -[**Overtime**](Overtime.md) +[**OverTimeWithTotal**](OverTimeWithTotal.md) ### Authorization diff --git a/docs/PlatformPublicMetadata.md b/docs/PlatformPublicMetadata.md index d6c3d51..48c772b 100644 --- a/docs/PlatformPublicMetadata.md +++ b/docs/PlatformPublicMetadata.md @@ -8,8 +8,6 @@ Name | Type | Description | Notes **platform_key** | **str** | | [readonly] **platform_name** | **str** | | [readonly] **metadata** | **object** | The public metadata | [optional] -**created_on** | **datetime** | | [readonly] -**last_updated** | **datetime** | | [readonly] ## Example diff --git a/docs/Program.md b/docs/Program.md new file mode 100644 index 0000000..018790c --- /dev/null +++ b/docs/Program.md @@ -0,0 +1,39 @@ +# Program + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**institution** | [**Institution**](Institution.md) | | [readonly] +**institution_id** | **int** | | +**name** | **str** | | +**program_type** | [**ProgramTypeEnum**](ProgramTypeEnum.md) | | +**duration** | **int** | Duration in months | +**description** | **str** | | [optional] +**data** | **object** | Metadata | [optional] +**metadata** | **object** | Metadata | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [readonly] + +## Example + +```python +from iblai.models.program import Program + +# TODO update the JSON string below +json = "{}" +# create an instance of Program from a JSON string +program_instance = Program.from_json(json) +# print the JSON string representation of the object +print(Program.to_json()) + +# convert the object into a dict +program_dict = program_instance.to_dict() +# create an instance of Program from a dict +program_from_dict = Program.from_dict(program_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ProgramTypeEnum.md b/docs/ProgramTypeEnum.md new file mode 100644 index 0000000..4641423 --- /dev/null +++ b/docs/ProgramTypeEnum.md @@ -0,0 +1,23 @@ +# ProgramTypeEnum + +* `bachelors` - Bachelor's Degree * `masters` - Master's Degree * `phd` - PhD * `diploma` - Diploma * `certificate` - Certificate * `ungraded` - Ungraded * `other` - Other + +## Enum + +* `BACHELORS` (value: `'bachelors'`) + +* `MASTERS` (value: `'masters'`) + +* `PHD` (value: `'phd'`) + +* `DIPLOMA` (value: `'diploma'`) + +* `CERTIFICATE` (value: `'certificate'`) + +* `UNGRADED` (value: `'ungraded'`) + +* `OTHER` (value: `'other'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RedirectTokenRequest.md b/docs/RedirectTokenRequest.md new file mode 100644 index 0000000..bfc4a7d --- /dev/null +++ b/docs/RedirectTokenRequest.md @@ -0,0 +1,29 @@ +# RedirectTokenRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | + +## Example + +```python +from iblai.models.redirect_token_request import RedirectTokenRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of RedirectTokenRequest from a JSON string +redirect_token_request_instance = RedirectTokenRequest.from_json(json) +# print the JSON string representation of the object +print(RedirectTokenRequest.to_json()) + +# convert the object into a dict +redirect_token_request_dict = redirect_token_request_instance.to_dict() +# create an instance of RedirectTokenRequest from a dict +redirect_token_request_from_dict = RedirectTokenRequest.from_dict(redirect_token_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RedirectTokenResponse.md b/docs/RedirectTokenResponse.md new file mode 100644 index 0000000..8678637 --- /dev/null +++ b/docs/RedirectTokenResponse.md @@ -0,0 +1,31 @@ +# RedirectTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**platform_key** | **str** | | [readonly] +**url** | **str** | | +**token** | **str** | | [readonly] + +## Example + +```python +from iblai.models.redirect_token_response import RedirectTokenResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of RedirectTokenResponse from a JSON string +redirect_token_response_instance = RedirectTokenResponse.from_json(json) +# print the JSON string representation of the object +print(RedirectTokenResponse.to_json()) + +# convert the object into a dict +redirect_token_response_dict = redirect_token_response_instance.to_dict() +# create an instance of RedirectTokenResponse from a dict +redirect_token_response_from_dict = RedirectTokenResponse.from_dict(redirect_token_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ResourceScrappedData.md b/docs/ResourceScrappedData.md new file mode 100644 index 0000000..878dacf --- /dev/null +++ b/docs/ResourceScrappedData.md @@ -0,0 +1,35 @@ +# ResourceScrappedData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**date_created** | **datetime** | | [readonly] +**last_modified** | **datetime** | | [readonly] +**resource** | **int** | | +**content** | **str** | | [optional] +**content_type** | **str** | | [optional] +**extra_data** | **object** | | [optional] + +## Example + +```python +from iblai.models.resource_scrapped_data import ResourceScrappedData + +# TODO update the JSON string below +json = "{}" +# create an instance of ResourceScrappedData from a JSON string +resource_scrapped_data_instance = ResourceScrappedData.from_json(json) +# print the JSON string representation of the object +print(ResourceScrappedData.to_json()) + +# convert the object into a dict +resource_scrapped_data_dict = resource_scrapped_data_instance.to_dict() +# create an instance of ResourceScrappedData from a dict +resource_scrapped_data_from_dict = ResourceScrappedData.from_dict(resource_scrapped_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RetrieverDocumentEmbedding.md b/docs/RetrieverDocumentEmbedding.md index 5ab022a..0830153 100644 --- a/docs/RetrieverDocumentEmbedding.md +++ b/docs/RetrieverDocumentEmbedding.md @@ -6,8 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | | [readonly] +**metadata** | **object** | | [optional] **document_name** | **str** | | [optional] **document_type** | **str** | | [optional] +**training_status** | [**RetrieverDocumentEmbeddingTrainingStatus**](RetrieverDocumentEmbeddingTrainingStatus.md) | | [optional] **pathway** | **str** | | **url** | **str** | | [optional] **tokens** | **int** | | [optional] diff --git a/docs/RetrieverDocumentEmbeddingTrainingStatus.md b/docs/RetrieverDocumentEmbeddingTrainingStatus.md new file mode 100644 index 0000000..845428e --- /dev/null +++ b/docs/RetrieverDocumentEmbeddingTrainingStatus.md @@ -0,0 +1,28 @@ +# RetrieverDocumentEmbeddingTrainingStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```python +from iblai.models.retriever_document_embedding_training_status import RetrieverDocumentEmbeddingTrainingStatus + +# TODO update the JSON string below +json = "{}" +# create an instance of RetrieverDocumentEmbeddingTrainingStatus from a JSON string +retriever_document_embedding_training_status_instance = RetrieverDocumentEmbeddingTrainingStatus.from_json(json) +# print the JSON string representation of the object +print(RetrieverDocumentEmbeddingTrainingStatus.to_json()) + +# convert the object into a dict +retriever_document_embedding_training_status_dict = retriever_document_embedding_training_status_instance.to_dict() +# create an instance of RetrieverDocumentEmbeddingTrainingStatus from a dict +retriever_document_embedding_training_status_from_dict = RetrieverDocumentEmbeddingTrainingStatus.from_dict(retriever_document_embedding_training_status_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScanWebhookRequest.md b/docs/ScanWebhookRequest.md new file mode 100644 index 0000000..d55859d --- /dev/null +++ b/docs/ScanWebhookRequest.md @@ -0,0 +1,32 @@ +# ScanWebhookRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file_id** | **str** | | +**filename** | **str** | | +**status** | **str** | | +**message** | **str** | | + +## Example + +```python +from iblai.models.scan_webhook_request import ScanWebhookRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanWebhookRequest from a JSON string +scan_webhook_request_instance = ScanWebhookRequest.from_json(json) +# print the JSON string representation of the object +print(ScanWebhookRequest.to_json()) + +# convert the object into a dict +scan_webhook_request_dict = scan_webhook_request_instance.to_dict() +# create an instance of ScanWebhookRequest from a dict +scan_webhook_request_from_dict = ScanWebhookRequest.from_dict(scan_webhook_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScanWebhookResponse.md b/docs/ScanWebhookResponse.md new file mode 100644 index 0000000..016d018 --- /dev/null +++ b/docs/ScanWebhookResponse.md @@ -0,0 +1,29 @@ +# ScanWebhookResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | + +## Example + +```python +from iblai.models.scan_webhook_response import ScanWebhookResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ScanWebhookResponse from a JSON string +scan_webhook_response_instance = ScanWebhookResponse.from_json(json) +# print the JSON string representation of the object +print(ScanWebhookResponse.to_json()) + +# convert the object into a dict +scan_webhook_response_dict = scan_webhook_response_instance.to_dict() +# create an instance of ScanWebhookResponse from a dict +scan_webhook_response_from_dict = ScanWebhookResponse.from_dict(scan_webhook_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SearchApi.md b/docs/SearchApi.md index d0ad367..961fe65 100644 --- a/docs/SearchApi.md +++ b/docs/SearchApi.md @@ -6,9 +6,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**search_ai_search_detail_retrieve**](SearchApi.md#search_ai_search_detail_retrieve) | **GET** /api/search/ai-search/detail/ | [**search_ai_search_retrieve**](SearchApi.md#search_ai_search_retrieve) | **GET** /api/search/ai-search/ | +[**search_catalog_retrieve**](SearchApi.md#search_catalog_retrieve) | **GET** /api/search/catalog/ | [**search_documentsearch_retrieve**](SearchApi.md#search_documentsearch_retrieve) | **GET** /api/search/documentsearch/ | [**search_es_health_retrieve**](SearchApi.md#search_es_health_retrieve) | **GET** /api/search/es-health/ | +[**search_personalized_catalog_retrieve**](SearchApi.md#search_personalized_catalog_retrieve) | **GET** /api/search/personalized-catalog/{username}/ | [**search_search_retrieve**](SearchApi.md#search_search_retrieve) | **GET** /api/search/search/ | +[**search_users_orgs_users_retrieve**](SearchApi.md#search_users_orgs_users_retrieve) | **GET** /api/search/users/orgs/{org}/users/{username}/ | # **search_ai_search_detail_retrieve** @@ -117,6 +120,56 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **search_catalog_retrieve** +> search_catalog_retrieve() + + + +### Example + + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.SearchApi(api_client) + +try: + api_instance.search_catalog_retrieve() +except Exception as e: + print("Exception when calling SearchApi->search_catalog_retrieve: %s\n" % e) +``` + + + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **search_documentsearch_retrieve** > search_documentsearch_retrieve() @@ -229,6 +282,60 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **search_personalized_catalog_retrieve** +> search_personalized_catalog_retrieve(username) + + + +### Example + + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + + +# Create an instance of the API class +api_instance = iblai.SearchApi(api_client) +username = 'username_example' # str | + +try: + api_instance.search_personalized_catalog_retrieve(username) +except Exception as e: + print("Exception when calling SearchApi->search_personalized_catalog_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **search_search_retrieve** > QueryEndpoint search_search_retrieve() @@ -282,3 +389,71 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **search_users_orgs_users_retrieve** +> search_users_orgs_users_retrieve(org, username) + + + +### Example + +* Api Key Authentication (PlatformApiKeyAuthentication): + +```python +import iblai +from iblai.rest import ApiException +from pprint import pprint + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# The APIs use bearer tokens for authentication with a prefix of: `Api-Key` +# You can generate an authenticated client using the following helper method +client = get_platform_api_client( + host="https://base.manager.iblai.app", + key=os.environ["API_KEY"] +) + +# Create an instance of the API class +api_instance = iblai.SearchApi(api_client) +org = 'org_example' # str | +username = 'username_example' # str | + +try: + api_instance.search_users_orgs_users_retrieve(org, username) +except Exception as e: + print("Exception when calling SearchApi->search_users_orgs_users_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **org** | **str**| | + **username** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[PlatformApiKeyAuthentication](../README.md#PlatformApiKeyAuthentication) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SeedMentorsView.md b/docs/SeedMentorsView.md new file mode 100644 index 0000000..0f47f5d --- /dev/null +++ b/docs/SeedMentorsView.md @@ -0,0 +1,29 @@ +# SeedMentorsView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **str** | | + +## Example + +```python +from iblai.models.seed_mentors_view import SeedMentorsView + +# TODO update the JSON string below +json = "{}" +# create an instance of SeedMentorsView from a JSON string +seed_mentors_view_instance = SeedMentorsView.from_json(json) +# print the JSON string representation of the object +print(SeedMentorsView.to_json()) + +# convert the object into a dict +seed_mentors_view_dict = seed_mentors_view_instance.to_dict() +# create an instance of SeedMentorsView from a dict +seed_mentors_view_from_dict = SeedMentorsView.from_dict(seed_mentors_view_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TargetSystemEnum.md b/docs/TargetSystemEnum.md new file mode 100644 index 0000000..bb51bc3 --- /dev/null +++ b/docs/TargetSystemEnum.md @@ -0,0 +1,13 @@ +# TargetSystemEnum + +* `Safety System` - Safety System * `Moderation System` - Moderation System + +## Enum + +* `SAFETY_SYSTEM` (value: `'Safety System'`) + +* `MODERATION_SYSTEM` (value: `'Moderation System'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TemplateMentor.md b/docs/TemplateMentor.md new file mode 100644 index 0000000..bd9c433 --- /dev/null +++ b/docs/TemplateMentor.md @@ -0,0 +1,35 @@ +# TemplateMentor + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**name** | **str** | | +**slug** | **str** | | +**unique_id** | **str** | | [optional] +**description** | **str** | | [optional] +**system_prompt** | **str** | | [optional] +**platform_key** | **str** | | [optional] + +## Example + +```python +from iblai.models.template_mentor import TemplateMentor + +# TODO update the JSON string below +json = "{}" +# create an instance of TemplateMentor from a JSON string +template_mentor_instance = TemplateMentor.from_json(json) +# print the JSON string representation of the object +print(TemplateMentor.to_json()) + +# convert the object into a dict +template_mentor_dict = template_mentor_instance.to_dict() +# create an instance of TemplateMentor from a dict +template_mentor_from_dict = TemplateMentor.from_dict(template_mentor_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ToolResponse.md b/docs/ToolResponse.md index d98dbaf..f29c457 100644 --- a/docs/ToolResponse.md +++ b/docs/ToolResponse.md @@ -7,9 +7,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | | [readonly] **name** | **str** | | +**display_name** | **str** | | [optional] **slug** | **str** | | [optional] **description** | **str** | | [optional] **metadata** | **object** | | [optional] +**allow_retriever_mentors** | **bool** | | [optional] ## Example diff --git a/docs/TrainDocumentViewRequest.md b/docs/TrainDocumentViewRequest.md index 1b4371f..4f37eb8 100644 --- a/docs/TrainDocumentViewRequest.md +++ b/docs/TrainDocumentViewRequest.md @@ -11,6 +11,9 @@ Name | Type | Description | Notes **type** | **str** | Type of document e.g file | **file** | **bytearray** | File to be trained | [optional] **access** | **str** | Accessibilityto the file | [optional] [default to 'private'] +**branch** | **str** | Branch of the repository | [optional] +**google_drive_auth_data** | **object** | Authentication and scoped details of google drive | [optional] +**dropbox_auth_data** | **object** | Authentication and scoped details of dropbox | [optional] ## Example diff --git a/docs/TrainingStatusEnum.md b/docs/TrainingStatusEnum.md index 854dc71..eb9946b 100644 --- a/docs/TrainingStatusEnum.md +++ b/docs/TrainingStatusEnum.md @@ -1,18 +1,16 @@ # TrainingStatusEnum -* `pending` - Pending * `processing` - Processing * `completed` - Completed * `cancelled` - Cancelled * `failed` - Failed +* `trained` - Trained * `failed` - Failed * `pending` - Pending * `untrained` - Untrained ## Enum -* `PENDING` (value: `'pending'`) - -* `PROCESSING` (value: `'processing'`) +* `TRAINED` (value: `'trained'`) -* `COMPLETED` (value: `'completed'`) +* `FAILED` (value: `'failed'`) -* `CANCELLED` (value: `'cancelled'`) +* `PENDING` (value: `'pending'`) -* `FAILED` (value: `'failed'`) +* `UNTRAINED` (value: `'untrained'`) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserInfo.md b/docs/UserInfo.md new file mode 100644 index 0000000..a8e89f7 --- /dev/null +++ b/docs/UserInfo.md @@ -0,0 +1,34 @@ +# UserInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | edX user ID | +**username** | **str** | edX username | [optional] +**name** | **str** | | +**email** | **str** | | +**active** | **bool** | | +**edx_data** | **object** | | + +## Example + +```python +from iblai.models.user_info import UserInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of UserInfo from a JSON string +user_info_instance = UserInfo.from_json(json) +# print the JSON string representation of the object +print(UserInfo.to_json()) + +# convert the object into a dict +user_info_dict = user_info_instance.to_dict() +# create an instance of UserInfo from a dict +user_info_from_dict = UserInfo.from_dict(user_info_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/iblai/__init__.py b/iblai/__init__.py index 85cd87e..d871718 100644 --- a/iblai/__init__.py +++ b/iblai/__init__.py @@ -7,14 +7,14 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. """ # noqa: E501 -__version__ = "2.4.1+ai.plus" +__version__ = "3.6.0+ai.plus" # import apis into sdk package from iblai.api.ai_account_api import AiAccountApi @@ -31,7 +31,7 @@ from iblai.api.credentials_api import CredentialsApi from iblai.api.engagement_api import EngagementApi from iblai.api.finance_api import FinanceApi -from iblai.api.monitoring_api import MonitoringApi +from iblai.api.notification_api import NotificationApi from iblai.api.overview_api import OverviewApi from iblai.api.performance_api import PerformanceApi from iblai.api.perlearner_api import PerlearnerApi @@ -53,6 +53,7 @@ from iblai.exceptions import ApiException # import models into sdk package +from iblai.models.ai_generated_image import AIGeneratedImage from iblai.models.api_token_cost import APITokenCost from iblai.models.acceptance_enum import AcceptanceEnum from iblai.models.active_users_data import ActiveUsersData @@ -77,14 +78,17 @@ from iblai.models.bulk_create_assertion import BulkCreateAssertion from iblai.models.chartsession_mentor import ChartsessionMentor from iblai.models.chat_history import ChatHistory +from iblai.models.chat_history_filter_data import ChatHistoryFilterData from iblai.models.chat_history_item import ChatHistoryItem from iblai.models.chat_history_session_id import ChatHistorySessionId from iblai.models.chat_session_request import ChatSessionRequest from iblai.models.chat_session_response import ChatSessionResponse from iblai.models.chat_session_with_message import ChatSessionWithMessage from iblai.models.check_document_training_status import CheckDocumentTrainingStatus +from iblai.models.company import Company from iblai.models.conversation_message import ConversationMessage from iblai.models.conversation_volume import ConversationVolume +from iblai.models.conversations import Conversations from iblai.models.count import Count from iblai.models.count_data import CountData from iblai.models.course_completion_per_course import CourseCompletionPerCourse @@ -107,18 +111,21 @@ from iblai.models.data_set_create import DataSetCreate from iblai.models.data_set_platform_value import DataSetPlatformValue from iblai.models.data_set_status_enum import DataSetStatusEnum +from iblai.models.date_range import DateRange from iblai.models.desired_skill import DesiredSkill from iblai.models.detailed_grade_subsection import DetailedGradeSubsection from iblai.models.detailed_grade_view import DetailedGradeView from iblai.models.detailed_grade_view_data import DetailedGradeViewData from iblai.models.discord_config import DiscordConfig from iblai.models.discord_webhook import DiscordWebhook +from iblai.models.education import Education from iblai.models.engagement_per_course import EngagementPerCourse from iblai.models.engagement_per_course_data import EngagementPerCourseData from iblai.models.enrollments import Enrollments from iblai.models.enrollments_data import EnrollmentsData from iblai.models.enrollments_per_user import EnrollmentsPerUser from iblai.models.enrollments_per_user_data import EnrollmentsPerUserData +from iblai.models.experience import Experience from iblai.models.float_over_time import FloatOverTime from iblai.models.free_usage_count import FreeUsageCount from iblai.models.grading_per_user import GradingPerUser @@ -128,10 +135,13 @@ from iblai.models.iblai_platform_meta_request import IBLAIPlatformMetaRequest from iblai.models.iblai_platform_meta_update_request import IBLAIPlatformMetaUpdateRequest from iblai.models.image_upload import ImageUpload +from iblai.models.institution import Institution +from iblai.models.institution_type_enum import InstitutionTypeEnum from iblai.models.integration_credential import IntegrationCredential from iblai.models.issuer import Issuer from iblai.models.issuer_authority import IssuerAuthority from iblai.models.job_run import JobRun +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.models.llm_model_for_tenant import LLMModelForTenant from iblai.models.llm_response import LLMResponse from iblai.models.llm_scores_view import LLMScoresView @@ -142,36 +152,51 @@ from iblai.models.languages_view import LanguagesView from iblai.models.learner_information_api import LearnerInformationAPI from iblai.models.learner_information_api_data import LearnerInformationAPIData +from iblai.models.lti_key import LtiKey +from iblai.models.lti_launch_gate import LtiLaunchGate +from iblai.models.lti_tool import LtiTool from iblai.models.main_creds import MainCreds +from iblai.models.memory_status_request_view import MemoryStatusRequestView +from iblai.models.memory_status_view import MemoryStatusView from iblai.models.mentor import Mentor from iblai.models.mentor_category import MentorCategory from iblai.models.mentor_data import MentorData from iblai.models.mentor_detail_analytics import MentorDetailAnalytics from iblai.models.mentor_from_template_request import MentorFromTemplateRequest from iblai.models.mentor_from_template_with_setting_request import MentorFromTemplateWithSettingRequest +from iblai.models.mentor_metadata import MentorMetadata from iblai.models.mentor_settings import MentorSettings from iblai.models.mentor_settings_mentor_visibility import MentorSettingsMentorVisibility from iblai.models.mentor_settings_request import MentorSettingsRequest from iblai.models.mentor_trace import MentorTrace from iblai.models.mentor_visibility_enum import MentorVisibilityEnum from iblai.models.mentor_wizard import MentorWizard +from iblai.models.message_status import MessageStatus from iblai.models.message_view import MessageView from iblai.models.message_view_request import MessageViewRequest from iblai.models.message_view_updat_response import MessageViewUpdatResponse +from iblai.models.metadata import Metadata from iblai.models.model_cost import ModelCost from iblai.models.model_usage import ModelUsage +from iblai.models.moderation_log import ModerationLog from iblai.models.net_revenue_over_time import NetRevenueOverTime +from iblai.models.notification import Notification +from iblai.models.notification_count import NotificationCount +from iblai.models.notification_status_enum import NotificationStatusEnum from iblai.models.null_enum import NullEnum from iblai.models.observation import Observation from iblai.models.order import Order from iblai.models.over_time import OverTime -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.models.overtime_meta import OvertimeMeta from iblai.models.overtime_with_change_info import OvertimeWithChangeInfo from iblai.models.page_content import PageContent +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList +from iblai.models.paginated_conversations_list import PaginatedConversationsList from iblai.models.paginated_data_set_list import PaginatedDataSetList from iblai.models.paginated_job_run_list import PaginatedJobRunList from iblai.models.paginated_mentor_list import PaginatedMentorList +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList from iblai.models.paginated_periodic_agent_list import PaginatedPeriodicAgentList from iblai.models.paginated_periodic_agent_log_list import PaginatedPeriodicAgentLogList from iblai.models.paginated_play_wright_script_list import PaginatedPlayWrightScriptList @@ -184,6 +209,7 @@ from iblai.models.patched_data_set import PatchedDataSet from iblai.models.patched_discord_config import PatchedDiscordConfig from iblai.models.patched_mentor import PatchedMentor +from iblai.models.patched_notification import PatchedNotification from iblai.models.patched_periodic_agent_create import PatchedPeriodicAgentCreate from iblai.models.patched_platform_public_metadata import PatchedPlatformPublicMetadata from iblai.models.patched_play_wright_script import PatchedPlayWrightScript @@ -228,6 +254,8 @@ from iblai.models.previous_agent_status_enum import PreviousAgentStatusEnum from iblai.models.product import Product from iblai.models.product_table import ProductTable +from iblai.models.program import Program +from iblai.models.program_type_enum import ProgramTypeEnum from iblai.models.prompt import Prompt from iblai.models.prompt_category import PromptCategory from iblai.models.prompt_visibility_enum import PromptVisibilityEnum @@ -237,6 +265,8 @@ from iblai.models.rating_enum import RatingEnum from iblai.models.recommend_course_response import RecommendCourseResponse from iblai.models.recommendation_search_api import RecommendationSearchAPI +from iblai.models.redirect_token_request import RedirectTokenRequest +from iblai.models.redirect_token_response import RedirectTokenResponse from iblai.models.related_text import RelatedText from iblai.models.report_create import ReportCreate from iblai.models.report_data import ReportData @@ -246,19 +276,24 @@ from iblai.models.reported_skill import ReportedSkill from iblai.models.request_data_variable import RequestDataVariable from iblai.models.resource_point import ResourcePoint +from iblai.models.resource_scrapped_data import ResourceScrappedData from iblai.models.response_data_variable import ResponseDataVariable from iblai.models.retreiver_train_view_request import RetreiverTrainViewRequest from iblai.models.retreiver_train_view_response import RetreiverTrainViewResponse from iblai.models.retrieve_task import RetrieveTask from iblai.models.retriever_document_embedding import RetrieverDocumentEmbedding from iblai.models.retriever_document_embedding_request import RetrieverDocumentEmbeddingRequest +from iblai.models.retriever_document_embedding_training_status import RetrieverDocumentEmbeddingTrainingStatus from iblai.models.retriever_request_search import RetrieverRequestSearch from iblai.models.retriever_request_search_document import RetrieverRequestSearchDocument from iblai.models.retriever_response_search import RetrieverResponseSearch from iblai.models.reuest_data_variable_list import ReuestDataVariableList from iblai.models.revenue_by_product import RevenueByProduct +from iblai.models.scan_webhook_request import ScanWebhookRequest +from iblai.models.scan_webhook_response import ScanWebhookResponse from iblai.models.score import Score from iblai.models.score_summary import ScoreSummary +from iblai.models.seed_mentors_view import SeedMentorsView from iblai.models.session_browser_screenshot import SessionBrowserScreenshot from iblai.models.session_detail import SessionDetail from iblai.models.shell_logs import ShellLogs @@ -275,7 +310,9 @@ from iblai.models.sub_time_child import SubTimeChild from iblai.models.summary import Summary from iblai.models.tags_view import TagsView +from iblai.models.target_system_enum import TargetSystemEnum from iblai.models.task_view import TaskView +from iblai.models.template_mentor import TemplateMentor from iblai.models.tenant_mentor_traces import TenantMentorTraces from iblai.models.theme_enum import ThemeEnum from iblai.models.time_child_data import TimeChildData @@ -313,6 +350,7 @@ from iblai.models.user_chat_memory_status_view import UserChatMemoryStatusView from iblai.models.user_chat_memory_update_view import UserChatMemoryUpdateView from iblai.models.user_edx_memory import UserEdxMemory +from iblai.models.user_info import UserInfo from iblai.models.user_memory_context_request import UserMemoryContextRequest from iblai.models.user_memory_context_response import UserMemoryContextResponse from iblai.models.user_sentiment_count_view import UserSentimentCountView diff --git a/iblai/api/__init__.py b/iblai/api/__init__.py index 02c4872..6031c28 100644 --- a/iblai/api/__init__.py +++ b/iblai/api/__init__.py @@ -15,7 +15,7 @@ from iblai.api.credentials_api import CredentialsApi from iblai.api.engagement_api import EngagementApi from iblai.api.finance_api import FinanceApi -from iblai.api.monitoring_api import MonitoringApi +from iblai.api.notification_api import NotificationApi from iblai.api.overview_api import OverviewApi from iblai.api.performance_api import PerformanceApi from iblai.api.perlearner_api import PerlearnerApi diff --git a/iblai/api/ai_account_api.py b/iblai/api/ai_account_api.py index 3d42fd4..d0ec293 100644 --- a/iblai/api/ai_account_api.py +++ b/iblai/api/ai_account_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -20,12 +20,12 @@ from typing import List, Optional from typing_extensions import Annotated from iblai.models.api_token_cost import APITokenCost -from iblai.models.credential import Credential from iblai.models.credential_request import CredentialRequest from iblai.models.iblai_platform_meta import IBLAIPlatformMeta from iblai.models.iblai_platform_meta_request import IBLAIPlatformMetaRequest from iblai.models.iblai_platform_meta_update_request import IBLAIPlatformMetaUpdateRequest from iblai.models.integration_credential import IntegrationCredential +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.models.main_creds import MainCreds from iblai.models.patched_credential_request import PatchedCredentialRequest from iblai.models.use_main_creds import UseMainCreds @@ -106,7 +106,7 @@ def ai_account_orgs_credential_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Credential", + '200': "LLMCredentialResponse", } response_data = self.api_client.call_api( *_param, @@ -253,7 +253,7 @@ def ai_account_orgs_credential_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Credential", + '200': "LLMCredentialResponse", } response_data = self.api_client.call_api( *_param, @@ -400,7 +400,7 @@ def ai_account_orgs_credential_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Credential", + '200': "LLMCredentialResponse", } response_data = self.api_client.call_api( *_param, @@ -1950,7 +1950,7 @@ def ai_account_orgs_users_free_trial_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Credential]", + '200': "List[LLMCredentialResponse]", } response_data = self.api_client.call_api( *_param, diff --git a/iblai/api/ai_analytics_api.py b/iblai/api/ai_analytics_api.py index 421fef6..cef8c17 100644 --- a/iblai/api/ai_analytics_api.py +++ b/iblai/api/ai_analytics_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -16,12 +16,14 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from datetime import datetime -from pydantic import Field, StrictStr +from datetime import date, datetime +from pydantic import Field, StrictInt, StrictStr from typing import List, Optional from typing_extensions import Annotated +from iblai.models.chat_history_filter_data import ChatHistoryFilterData from iblai.models.conversation_message import ConversationMessage from iblai.models.conversation_volume import ConversationVolume +from iblai.models.conversations import Conversations from iblai.models.llm_scores_view import LLMScoresView from iblai.models.llm_scores_view_request import LLMScoresViewRequest from iblai.models.llm_scores_view_response import LLMScoresViewResponse @@ -30,6 +32,7 @@ from iblai.models.mentor_detail_analytics import MentorDetailAnalytics from iblai.models.model_cost import ModelCost from iblai.models.model_usage import ModelUsage +from iblai.models.paginated_conversations_list import PaginatedConversationsList from iblai.models.tenant_mentor_traces import TenantMentorTraces from iblai.models.topic import Topic from iblai.models.topic_summary_view import TopicSummaryView @@ -54,12 +57,578 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def ai_analytics_orgs_users_chat_history_filter_retrieve( + self, + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_analytics_orgs_users_chat_history_filter_retrieve + + Retrieve the chat history for a tenant Filter parameters for period are start_date and end date Accessible to tenant Admins only. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_analytics_orgs_users_chat_history_filter_retrieve_serialize( + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ChatHistoryFilterData", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_analytics_orgs_users_chat_history_filter_retrieve_serialize( + self, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history-filter/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_analytics_orgs_users_chat_history_list( + self, + org: StrictStr, + user_id: StrictStr, + end_date: Optional[date] = None, + mentor: Optional[StrictStr] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + sentiment: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + start_date: Optional[date] = None, + topics: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + user_id2: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_analytics_orgs_users_chat_history_list + + Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param end_date: + :type end_date: date + :param mentor: + :type mentor: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param sentiment: + :type sentiment: str + :param start_date: + :type start_date: date + :param topics: + :type topics: str + :param user_id2: + :type user_id2: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_analytics_orgs_users_chat_history_list_serialize( + org=org, + user_id=user_id, + end_date=end_date, + mentor=mentor, + page=page, + page_size=page_size, + sentiment=sentiment, + start_date=start_date, + topics=topics, + user_id2=user_id2, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaginatedConversationsList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_analytics_orgs_users_chat_history_list_serialize( + self, + org, + user_id, + end_date, + mentor, + page, + page_size, + sentiment, + start_date, + topics, + user_id2, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if end_date is not None: + if isinstance(end_date, date): + _query_params.append( + ( + 'end_date', + end_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('end_date', end_date)) + + if mentor is not None: + + _query_params.append(('mentor', mentor)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if sentiment is not None: + + _query_params.append(('sentiment', sentiment)) + + if start_date is not None: + if isinstance(start_date, date): + _query_params.append( + ( + 'start_date', + start_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('start_date', start_date)) + + if topics is not None: + + _query_params.append(('topics', topics)) + + if user_id2 is not None: + + _query_params.append(('user_id', user_id2)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_analytics_orgs_users_chat_history_retrieve( + self, + id: Annotated[StrictStr, Field(description="A UUID string identifying this session.")], + org: StrictStr, + user_id: StrictStr, + end_date: Optional[date] = None, + mentor: Optional[StrictStr] = None, + sentiment: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + start_date: Optional[date] = None, + topics: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + user_id2: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_analytics_orgs_users_chat_history_retrieve + + Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin + + :param id: A UUID string identifying this session. (required) + :type id: str + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param end_date: + :type end_date: date + :param mentor: + :type mentor: str + :param sentiment: + :type sentiment: str + :param start_date: + :type start_date: date + :param topics: + :type topics: str + :param user_id2: + :type user_id2: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_analytics_orgs_users_chat_history_retrieve_serialize( + id=id, + org=org, + user_id=user_id, + end_date=end_date, + mentor=mentor, + sentiment=sentiment, + start_date=start_date, + topics=topics, + user_id2=user_id2, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Conversations", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_analytics_orgs_users_chat_history_retrieve_serialize( + self, + id, + org, + user_id, + end_date, + mentor, + sentiment, + start_date, + topics, + user_id2, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if end_date is not None: + if isinstance(end_date, date): + _query_params.append( + ( + 'end_date', + end_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('end_date', end_date)) + + if mentor is not None: + + _query_params.append(('mentor', mentor)) + + if sentiment is not None: + + _query_params.append(('sentiment', sentiment)) + + if start_date is not None: + if isinstance(start_date, date): + _query_params.append( + ( + 'start_date', + start_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('start_date', start_date)) + + if topics is not None: + + _query_params.append(('topics', topics)) + + if user_id2 is not None: + + _query_params.append(('user_id', user_id2)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def ai_analytics_orgs_users_conversation_retrieve( self, org: StrictStr, user_id: StrictStr, - period: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + end_date: Optional[date] = None, + start_date: Optional[date] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -81,8 +650,10 @@ def ai_analytics_orgs_users_conversation_retrieve( :type org: str :param user_id: (required) :type user_id: str - :param period: - :type period: str + :param end_date: + :type end_date: date + :param start_date: + :type start_date: date :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -108,7 +679,8 @@ def ai_analytics_orgs_users_conversation_retrieve( _param = self._ai_analytics_orgs_users_conversation_retrieve_serialize( org=org, user_id=user_id, - period=period, + end_date=end_date, + start_date=start_date, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -129,7 +701,8 @@ def _ai_analytics_orgs_users_conversation_retrieve_serialize( self, org, user_id, - period, + end_date, + start_date, _request_auth, _content_type, _headers, @@ -154,9 +727,31 @@ def _ai_analytics_orgs_users_conversation_retrieve_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if period is not None: + if end_date is not None: + if isinstance(end_date, date): + _query_params.append( + ( + 'end_date', + end_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('end_date', end_date)) - _query_params.append(('period', period)) + if start_date is not None: + if isinstance(start_date, date): + _query_params.append( + ( + 'start_date', + start_date.strftime( + self.api_client.configuration.date_format + ) + ) + ) + else: + _query_params.append(('start_date', start_date)) # process the header parameters # process the form parameters @@ -2227,9 +2822,9 @@ def ai_analytics_orgs_users_transcripts_retrieve( self, org: StrictStr, user_id: StrictStr, - end_date: Optional[datetime] = None, + end_date: Optional[date] = None, mentor: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, - start_date: Optional[datetime] = None, + start_date: Optional[date] = None, topics: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, _request_timeout: Union[ None, @@ -2253,11 +2848,11 @@ def ai_analytics_orgs_users_transcripts_retrieve( :param user_id: (required) :type user_id: str :param end_date: - :type end_date: datetime + :type end_date: date :param mentor: :type mentor: str :param start_date: - :type start_date: datetime + :type start_date: date :param topics: :type topics: str :param _request_timeout: timeout setting for this request. If one @@ -2338,12 +2933,12 @@ def _ai_analytics_orgs_users_transcripts_retrieve_serialize( _path_params['user_id'] = user_id # process the query parameters if end_date is not None: - if isinstance(end_date, datetime): + if isinstance(end_date, date): _query_params.append( ( 'end_date', end_date.strftime( - self.api_client.configuration.datetime_format + self.api_client.configuration.date_format ) ) ) @@ -2355,12 +2950,12 @@ def _ai_analytics_orgs_users_transcripts_retrieve_serialize( _query_params.append(('mentor', mentor)) if start_date is not None: - if isinstance(start_date, datetime): + if isinstance(start_date, date): _query_params.append( ( 'start_date', start_date.strftime( - self.api_client.configuration.datetime_format + self.api_client.configuration.date_format ) ) ) diff --git a/iblai/api/ai_bot_api.py b/iblai/api/ai_bot_api.py index 130d533..05fbd66 100644 --- a/iblai/api/ai_bot_api.py +++ b/iblai/api/ai_bot_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/ai_finetuning_api.py b/iblai/api/ai_finetuning_api.py index 3a611f6..3fc8930 100644 --- a/iblai/api/ai_finetuning_api.py +++ b/iblai/api/ai_finetuning_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/ai_index_api.py b/iblai/api/ai_index_api.py index f5f0def..41f8371 100644 --- a/iblai/api/ai_index_api.py +++ b/iblai/api/ai_index_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -16,8 +16,11 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictStr +from pydantic import Field, StrictBool, StrictStr +from typing import Optional +from typing_extensions import Annotated from iblai.models.check_document_training_status import CheckDocumentTrainingStatus +from iblai.models.resource_scrapped_data import ResourceScrappedData from iblai.models.retreiver_train_view_request import RetreiverTrainViewRequest from iblai.models.retreiver_train_view_response import RetreiverTrainViewResponse from iblai.models.retriever_document_embedding import RetrieverDocumentEmbedding @@ -25,6 +28,8 @@ from iblai.models.retriever_request_search import RetrieverRequestSearch from iblai.models.retriever_request_search_document import RetrieverRequestSearchDocument from iblai.models.retriever_response_search import RetrieverResponseSearch +from iblai.models.scan_webhook_request import ScanWebhookRequest +from iblai.models.scan_webhook_response import ScanWebhookResponse from iblai.models.train_chat_session_document_view import TrainChatSessionDocumentView from iblai.models.train_chat_session_document_view_request import TrainChatSessionDocumentViewRequest from iblai.models.train_document_view_request import TrainDocumentViewRequest @@ -180,6 +185,160 @@ def _ai_index_orgs_users_documents_destroy_serialize( + @validate_call + def ai_index_orgs_users_documents_graph_train_create( + self, + org: StrictStr, + user_id: StrictStr, + train_document_view_request: TrainDocumentViewRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_index_orgs_users_documents_graph_train_create + + This is for training graph - based documents through the worker. Accessible to tenant admins only. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param train_document_view_request: (required) + :type train_document_view_request: TrainDocumentViewRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_index_orgs_users_documents_graph_train_create_serialize( + org=org, + user_id=user_id, + train_document_view_request=train_document_view_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TrainDocumentViewResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_index_orgs_users_documents_graph_train_create_serialize( + self, + org, + user_id, + train_document_view_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if train_document_view_request is not None: + _body_params = train_document_view_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def ai_index_orgs_users_documents_pathways_retrieve( self, @@ -1533,3 +1692,449 @@ def _ai_index_orgs_users_documents_update_serialize( ) + + + @validate_call + def ai_index_orgs_users_resource_data_scrapped_retrieve( + self, + org: StrictStr, + user_id: StrictStr, + is_archive: Optional[StrictBool] = None, + is_like: Optional[StrictBool] = None, + is_video: Optional[StrictBool] = None, + search_key: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_index_orgs_users_resource_data_scrapped_retrieve + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param is_archive: + :type is_archive: bool + :param is_like: + :type is_like: bool + :param is_video: + :type is_video: bool + :param search_key: + :type search_key: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_index_orgs_users_resource_data_scrapped_retrieve_serialize( + org=org, + user_id=user_id, + is_archive=is_archive, + is_like=is_like, + is_video=is_video, + search_key=search_key, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResourceScrappedData", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_index_orgs_users_resource_data_scrapped_retrieve_serialize( + self, + org, + user_id, + is_archive, + is_like, + is_video, + search_key, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if is_archive is not None: + + _query_params.append(('is_archive', is_archive)) + + if is_like is not None: + + _query_params.append(('is_like', is_like)) + + if is_video is not None: + + _query_params.append(('is_video', is_video)) + + if search_key is not None: + + _query_params.append(('search_key', search_key)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-index/orgs/{org}/users/{user_id}/resource/data/scrapped/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_index_orgs_users_resource_data_scrapped_retrieve2( + self, + org: StrictStr, + resource_id: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_index_orgs_users_resource_data_scrapped_retrieve2 + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param resource_id: (required) + :type resource_id: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_index_orgs_users_resource_data_scrapped_retrieve2_serialize( + org=org, + resource_id=resource_id, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResourceScrappedData", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_index_orgs_users_resource_data_scrapped_retrieve2_serialize( + self, + org, + resource_id, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if resource_id is not None: + _path_params['resource_id'] = resource_id + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-index/orgs/{org}/users/{user_id}/resource/{resource_id}/data/scrapped/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_index_webhook_scan_create( + self, + scan_webhook_request: ScanWebhookRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_index_webhook_scan_create + + Webhook endpoint to receive file scan status. + + :param scan_webhook_request: (required) + :type scan_webhook_request: ScanWebhookRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_index_webhook_scan_create_serialize( + scan_webhook_request=scan_webhook_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScanWebhookResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_index_webhook_scan_create_serialize( + self, + scan_webhook_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if scan_webhook_request is not None: + _body_params = scan_webhook_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-index/webhook/scan/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/iblai/api/ai_mentor_api.py b/iblai/api/ai_mentor_api.py index b154d0c..89e0391 100644 --- a/iblai/api/ai_mentor_api.py +++ b/iblai/api/ai_mentor_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -19,6 +19,7 @@ from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator from typing import List, Optional from typing_extensions import Annotated +from iblai.models.ai_generated_image import AIGeneratedImage from iblai.models.audio_to_text_request import AudioToTextRequest from iblai.models.audio_to_text_response import AudioToTextResponse from iblai.models.chat_history_item import ChatHistoryItem @@ -35,14 +36,18 @@ from iblai.models.mentor_category import MentorCategory from iblai.models.mentor_from_template_request import MentorFromTemplateRequest from iblai.models.mentor_from_template_with_setting_request import MentorFromTemplateWithSettingRequest +from iblai.models.mentor_metadata import MentorMetadata from iblai.models.mentor_settings import MentorSettings from iblai.models.mentor_settings_request import MentorSettingsRequest from iblai.models.mentor_wizard import MentorWizard from iblai.models.message_view import MessageView from iblai.models.message_view_request import MessageViewRequest from iblai.models.message_view_updat_response import MessageViewUpdatResponse +from iblai.models.moderation_log import ModerationLog +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList from iblai.models.paginated_job_run_list import PaginatedJobRunList from iblai.models.paginated_mentor_list import PaginatedMentorList +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList from iblai.models.paginated_periodic_agent_list import PaginatedPeriodicAgentList from iblai.models.paginated_periodic_agent_log_list import PaginatedPeriodicAgentLogList from iblai.models.paginated_play_wright_script_list import PaginatedPlayWrightScriptList @@ -61,10 +66,12 @@ from iblai.models.recommend_course_response import RecommendCourseResponse from iblai.models.related_text import RelatedText from iblai.models.retrieve_task import RetrieveTask +from iblai.models.seed_mentors_view import SeedMentorsView from iblai.models.session_browser_screenshot import SessionBrowserScreenshot from iblai.models.session_detail import SessionDetail from iblai.models.shell_logs import ShellLogs from iblai.models.task_view import TaskView +from iblai.models.template_mentor import TemplateMentor from iblai.models.tool_response import ToolResponse from iblai.models.usage import Usage from iblai.models.user_chat_feedback import UserChatFeedback @@ -92,6 +99,7 @@ def __init__(self, api_client=None) -> None: def ai_mentor_orgs_metadata_create( self, org: StrictStr, + mentor_metadata: MentorMetadata, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -107,10 +115,12 @@ def ai_mentor_orgs_metadata_create( ) -> RESTResponseType: """ai_mentor_orgs_metadata_create - Endpoint for adding mentor metadata. Accessible to tenant admins and students. Returns: 201: Metadata Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Request: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } + Endpoint for adding mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Request: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\", \"mentor_id: 1 } Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\", \"mentor_id: 1 } :param org: (required) :type org: str + :param mentor_metadata: (required) + :type mentor_metadata: MentorMetadata :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -135,6 +145,7 @@ def ai_mentor_orgs_metadata_create( _param = self._ai_mentor_orgs_metadata_create_serialize( org=org, + mentor_metadata=mentor_metadata, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -142,7 +153,7 @@ def ai_mentor_orgs_metadata_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "MentorMetadata", } response_data = self.api_client.call_api( *_param, @@ -154,6 +165,7 @@ def ai_mentor_orgs_metadata_create( def _ai_mentor_orgs_metadata_create_serialize( self, org, + mentor_metadata, _request_auth, _content_type, _headers, @@ -179,9 +191,33 @@ def _ai_mentor_orgs_metadata_create_serialize( # process the header parameters # process the form parameters # process the body parameter + if mentor_metadata is not None: + _body_params = mentor_metadata + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -353,11 +389,11 @@ def _ai_mentor_orgs_sessions_create_serialize( @validate_call - def ai_mentor_orgs_users_audio_to_text_create( + def ai_mentor_orgs_users_ai_generated_images_destroy( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this ai generated image.")], org: StrictStr, user_id: StrictStr, - audio_to_text_request: AudioToTextRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -371,16 +407,16 @@ def ai_mentor_orgs_users_audio_to_text_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_audio_to_text_create + """ai_mentor_orgs_users_ai_generated_images_destroy - Endpoint to convert audio to text. Accessible to tenant admins and students. Returns: 200: audio text object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/audio-to-text/ Request: { \"file\": binary } Response: { \"text\": \"Programming\", } + Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. + :param id: A unique integer value identifying this ai generated image. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param audio_to_text_request: (required) - :type audio_to_text_request: AudioToTextRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -403,10 +439,10 @@ def ai_mentor_orgs_users_audio_to_text_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_audio_to_text_create_serialize( + _param = self._ai_mentor_orgs_users_ai_generated_images_destroy_serialize( + id=id, org=org, user_id=user_id, - audio_to_text_request=audio_to_text_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -414,7 +450,7 @@ def ai_mentor_orgs_users_audio_to_text_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AudioToTextResponse", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -423,11 +459,11 @@ def ai_mentor_orgs_users_audio_to_text_create( return response_data.response - def _ai_mentor_orgs_users_audio_to_text_create_serialize( + def _ai_mentor_orgs_users_ai_generated_images_destroy_serialize( self, + id, org, user_id, - audio_to_text_request, _request_auth, _content_type, _headers, @@ -447,6 +483,8 @@ def _ai_mentor_orgs_users_audio_to_text_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -455,33 +493,9 @@ def _ai_mentor_orgs_users_audio_to_text_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if audio_to_text_request is not None: - _body_params = audio_to_text_request - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -489,8 +503,8 @@ def _ai_mentor_orgs_users_audio_to_text_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/audio-to-text/', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -507,10 +521,17 @@ def _ai_mentor_orgs_users_audio_to_text_create_serialize( @validate_call - def ai_mentor_orgs_users_clear_chathistory_destroy( + def ai_mentor_orgs_users_ai_generated_images_list( self, org: StrictStr, user_id: StrictStr, + model: Optional[StrictStr] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + provider: Optional[StrictStr] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -524,14 +545,28 @@ def ai_mentor_orgs_users_clear_chathistory_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_clear_chathistory_destroy + """ai_mentor_orgs_users_ai_generated_images_list - Endpoint to clear user's chat history Returns: 200: No responde data + Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param model: + :type model: str + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param provider: + :type provider: str + :param search: A search term. + :type search: str + :param username: + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -554,9 +589,16 @@ def ai_mentor_orgs_users_clear_chathistory_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_clear_chathistory_destroy_serialize( + _param = self._ai_mentor_orgs_users_ai_generated_images_list_serialize( org=org, user_id=user_id, + model=model, + ordering=ordering, + page=page, + page_size=page_size, + provider=provider, + search=search, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -564,7 +606,7 @@ def ai_mentor_orgs_users_clear_chathistory_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "PaginatedAIGeneratedImageList", } response_data = self.api_client.call_api( *_param, @@ -573,10 +615,17 @@ def ai_mentor_orgs_users_clear_chathistory_destroy( return response_data.response - def _ai_mentor_orgs_users_clear_chathistory_destroy_serialize( + def _ai_mentor_orgs_users_ai_generated_images_list_serialize( self, org, user_id, + model, + ordering, + page, + page_size, + provider, + search, + username, _request_auth, _content_type, _headers, @@ -601,11 +650,46 @@ def _ai_mentor_orgs_users_clear_chathistory_destroy_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if model is not None: + + _query_params.append(('model', model)) + + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if provider is not None: + + _query_params.append(('provider', provider)) + + if search is not None: + + _query_params.append(('search', search)) + + if username is not None: + + _query_params.append(('username', username)) + # process the header parameters # process the form parameters # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -614,8 +698,8 @@ def _ai_mentor_orgs_users_clear_chathistory_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/clear-chathistory', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -632,16 +716,11 @@ def _ai_mentor_orgs_users_clear_chathistory_destroy_serialize( @validate_call - def ai_mentor_orgs_users_create( + def ai_mentor_orgs_users_ai_generated_images_retrieve( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this ai generated image.")], org: StrictStr, user_id: StrictStr, - mentor: Mentor, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, - metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, - metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, - return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -655,26 +734,16 @@ def ai_mentor_orgs_users_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_create + """ai_mentor_orgs_users_ai_generated_images_retrieve - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + Endpoint to view and delete AI generated images for a user. AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion. optional filtering parameters allowed are - username: The username of the user for which this image was stored. - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate. - model: the text to image model on the provider used to generate the image. This endpoint is accessible to both students and platform admins. + :param id: A unique integer value identifying this ai generated image. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor: (required) - :type mentor: Mentor - :param filter_by: Filter options include, date, name, default is date - :type filter_by: str - :param metadata_key: Metadata key to be queried with - :type metadata_key: str - :param metadata_value: Metadata value to be filter for - :type metadata_value: str - :param return_session_information: Declares if session information should be included in the mentor data - :type return_session_information: bool - :param visibility: visibility type to be queried with - :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -697,15 +766,10 @@ def ai_mentor_orgs_users_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_create_serialize( + _param = self._ai_mentor_orgs_users_ai_generated_images_retrieve_serialize( + id=id, org=org, user_id=user_id, - mentor=mentor, - filter_by=filter_by, - metadata_key=metadata_key, - metadata_value=metadata_value, - return_session_information=return_session_information, - visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -713,7 +777,7 @@ def ai_mentor_orgs_users_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Mentor", + '200': "AIGeneratedImage", } response_data = self.api_client.call_api( *_param, @@ -722,16 +786,11 @@ def ai_mentor_orgs_users_create( return response_data.response - def _ai_mentor_orgs_users_create_serialize( + def _ai_mentor_orgs_users_ai_generated_images_retrieve_serialize( self, + id, org, user_id, - mentor, - filter_by, - metadata_key, - metadata_value, - return_session_information, - visibility, _request_auth, _content_type, _headers, @@ -751,36 +810,16 @@ def _ai_mentor_orgs_users_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if metadata_key is not None: - - _query_params.append(('metadata_key', metadata_key)) - - if metadata_value is not None: - - _query_params.append(('metadata_value', metadata_value)) - - if return_session_information is not None: - - _query_params.append(('return_session_information', return_session_information)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter - if mentor is not None: - _body_params = mentor # set the HTTP header `Accept` @@ -791,21 +830,6 @@ def _ai_mentor_orgs_users_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -813,8 +837,8 @@ def _ai_mentor_orgs_users_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/ai-generated-images/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -831,11 +855,11 @@ def _ai_mentor_orgs_users_create_serialize( @validate_call - def ai_mentor_orgs_users_create_mentor_wizard_create( + def ai_mentor_orgs_users_audio_to_text_create( self, org: StrictStr, user_id: StrictStr, - mentor_wizard: MentorWizard, + audio_to_text_request: AudioToTextRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -849,16 +873,16 @@ def ai_mentor_orgs_users_create_mentor_wizard_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_create_mentor_wizard_create + """ai_mentor_orgs_users_audio_to_text_create - Endpoint to automatically create a mentor given a name and a description of the mentor. All other parameters for the mentor will be automatically populated using an llm. This includes but not limitted to marketing conversations, system prompt, proactive prompt, profile icon and more. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 201: a Mentor instance 400: An error occurred when validating inputs or creating mentor. Example: **Create a mentor** POST: /api/ai-mentor/orgs/main/users/johndoe/create-mentor-wizard/ Request: { \"name\": \"Fashion Expert\", \"description\": \"An expert at Fashion Design } Response: { \"name\": \"Fashion Agent\", \"unique_id\": \"ef425893-877c-4538-9e79-54eb1eebd165\", \"platform\": \"main\", \"slug\": \"df57c4b3-32c5-4a3a-81a4-97e9e2ac8d25\", \"description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"allow_anonymous\": false, \"pathways\": [], \"session_information\": { \"user_count\": 0, \"session_count\": 0, \"users\": {} }, \"suggested_prompts\": [], \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"system_prompt\": \"You are an expert in fashion. Your role is to educate users on the latest fashion trends, styles, and tips in dressing, clothes, shoes, and makeup. Explain concepts clearly and provide practical examples.\", \"metadata\": { \"category\": \"Fashion\" }, \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. Any prompt that is immoral or contains abusive words, insults, query that involve damaging content, and law breaking acts, etc should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"moderation_response\": \"Please keep the conversation within the bounds of what the agent is tasked to do and per your platform's rules.\", \"enable_moderation\": false, \"is_proactive\": false, \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\", \"created_at\": \"2024-07-16T13:53:48.583825+00:00\", \"updated_at\": \"2024-07-16T13:53:48.612369+00:00\", \"seo_tags\": [ { \"name\": \"viewport\", \"content\": \"width=device-width, initial-scale=1.0\" }, { \"name\": \"description\", \"content\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\" }, { \"name\": \"keywords\", \"content\": \"Fashion, Dressing, Clothes, Shoes, Makeup, Trends\" } ], \"marketing_conversations\": [ { \"type\": \"ai\", \"content\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. What would you like to learn about today?\" }, { \"type\": \"human\", \"content\": \"Can you suggest some trendy outfits for this season?\" }, { \"type\": \"ai\", \"content\": \"Absolutely! This season, oversized blazers, high-waisted trousers, and statement boots are trending. Pair these with minimalist accessories for a chic look. Would you like to know more about any specific item?\" }, { \"type\": \"human\", \"content\": \"What makeup trends are popular right now?\" }, { \"type\": \"ai\", \"content\": \"Current makeup trends include bold eyeliner, glitter accents, and natural, glowing skin. Bright lip colors are also making a comeback. Which of these trends would you like to explore more?\" } ], \"tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"created_by\": null, \"settings\": { \"id\": 98, \"display_name\": \"Fashion Agent\", \"profile_image\": \"http://localhost:8000/media/public/mentor/profile/2fc32125-2404-4ca9-8261-bcb66f48f4bb.png\", \"initial_message\": null, \"suggested_message\": null, \"theme\": \"light\", \"user_message_color\": \"#2467EB\", \"mentor_bubble_color\": \"#000000\", \"align_mentor_bubble\": \"left\", \"mentor\": \"Fashion Agent\", \"metadata\": { \"category\": \"Fashion\" }, \"mentor_visibility\": \"viewable_by_anyone\", \"enable_image_generation\": true, \"enable_web_browsing\": false, \"enable_code_interpreter\": false, \"custom_css\": null, \"allow_anonymous\": false, \"mentor_description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"suggested_prompts\": [], \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"mentor_tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\" } } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + Endpoint to convert audio to text. Accessible to tenant admins and students. Returns: 200: audio text object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/audio-to-text/ Request: { \"file\": binary } Response: { \"text\": \"Programming\", } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor_wizard: (required) - :type mentor_wizard: MentorWizard + :param audio_to_text_request: (required) + :type audio_to_text_request: AudioToTextRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -881,10 +905,10 @@ def ai_mentor_orgs_users_create_mentor_wizard_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_create_mentor_wizard_create_serialize( + _param = self._ai_mentor_orgs_users_audio_to_text_create_serialize( org=org, user_id=user_id, - mentor_wizard=mentor_wizard, + audio_to_text_request=audio_to_text_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -892,7 +916,7 @@ def ai_mentor_orgs_users_create_mentor_wizard_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Mentor", + '200': "AudioToTextResponse", } response_data = self.api_client.call_api( *_param, @@ -901,11 +925,11 @@ def ai_mentor_orgs_users_create_mentor_wizard_create( return response_data.response - def _ai_mentor_orgs_users_create_mentor_wizard_create_serialize( + def _ai_mentor_orgs_users_audio_to_text_create_serialize( self, org, user_id, - mentor_wizard, + audio_to_text_request, _request_auth, _content_type, _headers, @@ -933,8 +957,8 @@ def _ai_mentor_orgs_users_create_mentor_wizard_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if mentor_wizard is not None: - _body_params = mentor_wizard + if audio_to_text_request is not None: + _body_params = audio_to_text_request # set the HTTP header `Accept` @@ -968,7 +992,7 @@ def _ai_mentor_orgs_users_create_mentor_wizard_create_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/audio-to-text/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -985,11 +1009,10 @@ def _ai_mentor_orgs_users_create_mentor_wizard_create_serialize( @validate_call - def ai_mentor_orgs_users_custom_instruction_create( + def ai_mentor_orgs_users_available_template_mentors_retrieve( self, org: StrictStr, user_id: StrictStr, - custom_instruction_response: Optional[CustomInstructionResponse] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1003,16 +1026,14 @@ def ai_mentor_orgs_users_custom_instruction_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_custom_instruction_create + """ai_mentor_orgs_users_available_template_mentors_retrieve - Endpoint for Adding user's custom instructions Accessible to tenant admins and students. Returns: 201: Custom Instruction Object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Request: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } + This endpoint list available template mentors for a tenant Returns: 200 : List of Tool objects Example : GET : api/ai-mentor/orgs/main/users/johndoe/available-template-mentors/ Response: [ { \"id\": 1, \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"unique_id\": \"8485a252-eecf-436b-ba25-3f4ea3e7cda9\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", } ] :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param custom_instruction_response: - :type custom_instruction_response: CustomInstructionResponse :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1035,10 +1056,9 @@ def ai_mentor_orgs_users_custom_instruction_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_custom_instruction_create_serialize( + _param = self._ai_mentor_orgs_users_available_template_mentors_retrieve_serialize( org=org, user_id=user_id, - custom_instruction_response=custom_instruction_response, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1046,7 +1066,7 @@ def ai_mentor_orgs_users_custom_instruction_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "CustomInstructionResponse", + '200': "TemplateMentor", } response_data = self.api_client.call_api( *_param, @@ -1055,11 +1075,10 @@ def ai_mentor_orgs_users_custom_instruction_create( return response_data.response - def _ai_mentor_orgs_users_custom_instruction_create_serialize( + def _ai_mentor_orgs_users_available_template_mentors_retrieve_serialize( self, org, user_id, - custom_instruction_response, _request_auth, _content_type, _headers, @@ -1087,8 +1106,6 @@ def _ai_mentor_orgs_users_custom_instruction_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if custom_instruction_response is not None: - _body_params = custom_instruction_response # set the HTTP header `Accept` @@ -1099,21 +1116,6 @@ def _ai_mentor_orgs_users_custom_instruction_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -1121,8 +1123,8 @@ def _ai_mentor_orgs_users_custom_instruction_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/available-template-mentors/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1139,7 +1141,7 @@ def _ai_mentor_orgs_users_custom_instruction_create_serialize( @validate_call - def ai_mentor_orgs_users_custom_instruction_retrieve( + def ai_mentor_orgs_users_clear_chathistory_destroy( self, org: StrictStr, user_id: StrictStr, @@ -1156,9 +1158,9 @@ def ai_mentor_orgs_users_custom_instruction_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_custom_instruction_retrieve + """ai_mentor_orgs_users_clear_chathistory_destroy - Endpoint for getting user's custom prompts Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } + Endpoint to clear user's chat history Returns: 204: No responde data :param org: (required) :type org: str @@ -1186,7 +1188,7 @@ def ai_mentor_orgs_users_custom_instruction_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_custom_instruction_retrieve_serialize( + _param = self._ai_mentor_orgs_users_clear_chathistory_destroy_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -1196,7 +1198,7 @@ def ai_mentor_orgs_users_custom_instruction_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CustomInstructionResponse", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -1205,7 +1207,7 @@ def ai_mentor_orgs_users_custom_instruction_retrieve( return response_data.response - def _ai_mentor_orgs_users_custom_instruction_retrieve_serialize( + def _ai_mentor_orgs_users_clear_chathistory_destroy_serialize( self, org, user_id, @@ -1238,13 +1240,6 @@ def _ai_mentor_orgs_users_custom_instruction_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -1253,8 +1248,8 @@ def _ai_mentor_orgs_users_custom_instruction_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/clear-chathistory', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1271,11 +1266,16 @@ def _ai_mentor_orgs_users_custom_instruction_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_custom_instruction_update( + def ai_mentor_orgs_users_create( self, org: StrictStr, user_id: StrictStr, - custom_instruction_response: Optional[CustomInstructionResponse] = None, + mentor: Mentor, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, + metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1289,16 +1289,26 @@ def ai_mentor_orgs_users_custom_instruction_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_custom_instruction_update + """ai_mentor_orgs_users_create - Endpoint for updating user's custom instructions. Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ REquest: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param custom_instruction_response: - :type custom_instruction_response: CustomInstructionResponse + :param mentor: (required) + :type mentor: Mentor + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str + :param metadata_key: Metadata key to be queried with + :type metadata_key: str + :param metadata_value: Metadata value to be filter for + :type metadata_value: str + :param return_session_information: Declares if session information should be included in the mentor data + :type return_session_information: bool + :param visibility: visibility type to be queried with + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1321,10 +1331,15 @@ def ai_mentor_orgs_users_custom_instruction_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_custom_instruction_update_serialize( + _param = self._ai_mentor_orgs_users_create_serialize( org=org, user_id=user_id, - custom_instruction_response=custom_instruction_response, + mentor=mentor, + filter_by=filter_by, + metadata_key=metadata_key, + metadata_value=metadata_value, + return_session_information=return_session_information, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1332,7 +1347,7 @@ def ai_mentor_orgs_users_custom_instruction_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "CustomInstructionResponse", + '201': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -1341,11 +1356,16 @@ def ai_mentor_orgs_users_custom_instruction_update( return response_data.response - def _ai_mentor_orgs_users_custom_instruction_update_serialize( + def _ai_mentor_orgs_users_create_serialize( self, org, user_id, - custom_instruction_response, + mentor, + filter_by, + metadata_key, + metadata_value, + return_session_information, + visibility, _request_auth, _content_type, _headers, @@ -1370,11 +1390,31 @@ def _ai_mentor_orgs_users_custom_instruction_update_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if metadata_key is not None: + + _query_params.append(('metadata_key', metadata_key)) + + if metadata_value is not None: + + _query_params.append(('metadata_value', metadata_value)) + + if return_session_information is not None: + + _query_params.append(('return_session_information', return_session_information)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter - if custom_instruction_response is not None: - _body_params = custom_instruction_response + if mentor is not None: + _body_params = mentor # set the HTTP header `Accept` @@ -1407,8 +1447,8 @@ def _ai_mentor_orgs_users_custom_instruction_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1425,16 +1465,11 @@ def _ai_mentor_orgs_users_custom_instruction_update_serialize( @validate_call - def ai_mentor_orgs_users_destroy( + def ai_mentor_orgs_users_create_mentor_wizard_create( self, - name: StrictStr, org: StrictStr, user_id: StrictStr, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, - metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, - metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, - return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, + mentor_wizard: MentorWizard, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1448,26 +1483,16 @@ def ai_mentor_orgs_users_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_destroy + """ai_mentor_orgs_users_create_mentor_wizard_create - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + Endpoint to automatically create a mentor given a name and a description of the mentor. All other parameters for the mentor will be automatically populated using an llm. This includes but not limitted to marketing conversations, system prompt, proactive prompt, profile icon and more. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 201: a Mentor instance 400: An error occurred when validating inputs or creating mentor. Example: **Create a mentor** POST: /api/ai-mentor/orgs/main/users/johndoe/create-mentor-wizard/ Request: { \"name\": \"Fashion Expert\", \"description\": \"An expert at Fashion Design } Response: { \"name\": \"Fashion Agent\", \"unique_id\": \"ef425893-877c-4538-9e79-54eb1eebd165\", \"platform\": \"main\", \"slug\": \"df57c4b3-32c5-4a3a-81a4-97e9e2ac8d25\", \"description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"allow_anonymous\": false, \"pathways\": [], \"session_information\": { \"user_count\": 0, \"session_count\": 0, \"users\": {} }, \"suggested_prompts\": [], \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"system_prompt\": \"You are an expert in fashion. Your role is to educate users on the latest fashion trends, styles, and tips in dressing, clothes, shoes, and makeup. Explain concepts clearly and provide practical examples.\", \"metadata\": { \"category\": \"Fashion\" }, \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. Any prompt that is immoral or contains abusive words, insults, query that involve damaging content, and law breaking acts, etc should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"moderation_response\": \"Please keep the conversation within the bounds of what the agent is tasked to do and per your platform's rules.\", \"enable_moderation\": false, \"safety_system_prompt\": \"You are a moderator tasked with identifying whether a message from an ai model to a user is is appropriate or inappropriate. If the message is immoral or contains abusive words, insults, damaging content, and law breaking acts, etc it should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"safety_response\": \"Sorry, the AI model generated an inappropriate response. Kindly refine your prompt or try again with a different prompt.\", \"enable_safety_system\": false, \"is_proactive\": false, \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\", \"created_at\": \"2024-07-16T13:53:48.583825+00:00\", \"updated_at\": \"2024-07-16T13:53:48.612369+00:00\", \"seo_tags\": [ { \"name\": \"viewport\", \"content\": \"width=device-width, initial-scale=1.0\" }, { \"name\": \"description\", \"content\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\" }, { \"name\": \"keywords\", \"content\": \"Fashion, Dressing, Clothes, Shoes, Makeup, Trends\" } ], \"marketing_conversations\": [ { \"type\": \"ai\", \"content\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. What would you like to learn about today?\" }, { \"type\": \"human\", \"content\": \"Can you suggest some trendy outfits for this season?\" }, { \"type\": \"ai\", \"content\": \"Absolutely! This season, oversized blazers, high-waisted trousers, and statement boots are trending. Pair these with minimalist accessories for a chic look. Would you like to know more about any specific item?\" }, { \"type\": \"human\", \"content\": \"What makeup trends are popular right now?\" }, { \"type\": \"ai\", \"content\": \"Current makeup trends include bold eyeliner, glitter accents, and natural, glowing skin. Bright lip colors are also making a comeback. Which of these trends would you like to explore more?\" } ], \"tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"created_by\": null, \"settings\": { \"id\": 98, \"display_name\": \"Fashion Agent\", \"profile_image\": \"http://localhost:8000/media/public/mentor/profile/2fc32125-2404-4ca9-8261-bcb66f48f4bb.png\", \"initial_message\": null, \"suggested_message\": null, \"theme\": \"light\", \"user_message_color\": \"#2467EB\", \"mentor_bubble_color\": \"#000000\", \"align_mentor_bubble\": \"left\", \"mentor\": \"Fashion Agent\", \"metadata\": { \"category\": \"Fashion\" }, \"mentor_visibility\": \"viewable_by_anyone\", \"enable_image_generation\": true, \"enable_web_browsing\": false, \"enable_code_interpreter\": false, \"custom_css\": null, \"allow_anonymous\": false, \"mentor_description\": \"An agent that can teach different fashion ways including dressings, clothes, shoes, makeups and latest trends.\", \"suggested_prompts\": [], \"proactive_message\": \"Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends.\", \"mentor_tools\": [], \"can_use_tools\": false, \"llm_temperature\": null, \"llm_provider\": \"groq\", \"llm_name\": \"llama3-8b-8192\", \"proactive_prompt\": \"Check if there are any previous chats available. If there are previous chats, mention them and offer assistance based on the last conversation. If there are no previous chats, provide a general greeting and introduce yourself with an offer to suggest a topic to learn about. Examples: If there are previous chats: Welcome back! Last time, we discussed [topic from previous chat]. How can I assist you further with that? If there are no previous chats: Hello, I'm Fashion Agent. I can guide you through different fashion tips including dressings, clothes, shoes, makeups and the latest trends. If no chat history is available, do not tell the user that there is no chat history, just answer with the above instructions. Do not make the response specific to a given topic, ask the user for the topic.\" } } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } - :param name: (required) - :type name: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param filter_by: Filter options include, date, name, default is date - :type filter_by: str - :param metadata_key: Metadata key to be queried with - :type metadata_key: str - :param metadata_value: Metadata value to be filter for - :type metadata_value: str - :param return_session_information: Declares if session information should be included in the mentor data - :type return_session_information: bool - :param visibility: visibility type to be queried with - :type visibility: str + :param mentor_wizard: (required) + :type mentor_wizard: MentorWizard :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1490,15 +1515,10 @@ def ai_mentor_orgs_users_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_destroy_serialize( - name=name, + _param = self._ai_mentor_orgs_users_create_mentor_wizard_create_serialize( org=org, user_id=user_id, - filter_by=filter_by, - metadata_key=metadata_key, - metadata_value=metadata_value, - return_session_information=return_session_information, - visibility=visibility, + mentor_wizard=mentor_wizard, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1506,7 +1526,7 @@ def ai_mentor_orgs_users_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '201': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -1515,16 +1535,11 @@ def ai_mentor_orgs_users_destroy( return response_data.response - def _ai_mentor_orgs_users_destroy_serialize( + def _ai_mentor_orgs_users_create_mentor_wizard_create_serialize( self, - name, org, user_id, - filter_by, - metadata_key, - metadata_value, - return_session_information, - visibility, + mentor_wizard, _request_auth, _content_type, _headers, @@ -1544,39 +1559,41 @@ def _ai_mentor_orgs_users_destroy_serialize( _body_params: Optional[bytes] = None # process the path parameters - if name is not None: - _path_params['name'] = name if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if metadata_key is not None: - - _query_params.append(('metadata_key', metadata_key)) - - if metadata_value is not None: - - _query_params.append(('metadata_value', metadata_value)) - - if return_session_information is not None: - - _query_params.append(('return_session_information', return_session_information)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter + if mentor_wizard is not None: + _body_params = mentor_wizard + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -1584,8 +1601,8 @@ def _ai_mentor_orgs_users_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/create-mentor-wizard/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1602,12 +1619,11 @@ def _ai_mentor_orgs_users_destroy_serialize( @validate_call - def ai_mentor_orgs_users_downloads_tasks_retrieve( + def ai_mentor_orgs_users_custom_instruction_create( self, org: StrictStr, - task_id: StrictStr, user_id: StrictStr, - to_csv: Annotated[Optional[StrictBool], Field(description="Choose download in csv or not")] = None, + custom_instruction_response: Optional[CustomInstructionResponse] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1621,18 +1637,16 @@ def ai_mentor_orgs_users_downloads_tasks_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_downloads_tasks_retrieve + """ai_mentor_orgs_users_custom_instruction_create - Endpoint to download user chathistory. Accessible to tenant admins and students. Returns: 200: When task is not ready. 200: chat history object 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/lydiah/downloads/tasks/307be194-2351-44ff-8d7b-24660fd9ec34 Response: { \"state\": \"task_not_ready\" } + Endpoint for Adding user's custom instructions Accessible to tenant admins and students. Returns: 201: Custom Instruction Object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Request: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } :param org: (required) :type org: str - :param task_id: (required) - :type task_id: str :param user_id: (required) :type user_id: str - :param to_csv: Choose download in csv or not - :type to_csv: bool + :param custom_instruction_response: + :type custom_instruction_response: CustomInstructionResponse :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1655,11 +1669,10 @@ def ai_mentor_orgs_users_downloads_tasks_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( + _param = self._ai_mentor_orgs_users_custom_instruction_create_serialize( org=org, - task_id=task_id, user_id=user_id, - to_csv=to_csv, + custom_instruction_response=custom_instruction_response, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1667,7 +1680,7 @@ def ai_mentor_orgs_users_downloads_tasks_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ChatHistoryItem", + '201': "CustomInstructionResponse", } response_data = self.api_client.call_api( *_param, @@ -1676,12 +1689,11 @@ def ai_mentor_orgs_users_downloads_tasks_retrieve( return response_data.response - def _ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( + def _ai_mentor_orgs_users_custom_instruction_create_serialize( self, org, - task_id, user_id, - to_csv, + custom_instruction_response, _request_auth, _content_type, _headers, @@ -1703,18 +1715,14 @@ def _ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if task_id is not None: - _path_params['task_id'] = task_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if to_csv is not None: - - _query_params.append(('to_csv', to_csv)) - # process the header parameters # process the form parameters # process the body parameter + if custom_instruction_response is not None: + _body_params = custom_instruction_response # set the HTTP header `Accept` @@ -1725,20 +1733,35 @@ def _ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( ] ) - - # authentication setting - _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, files=_files, auth_settings=_auth_settings, collection_formats=_collection_formats, @@ -1750,9 +1773,8 @@ def _ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_edx_memory_destroy( + def ai_mentor_orgs_users_custom_instruction_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this user edx memory.")], org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -1768,12 +1790,10 @@ def ai_mentor_orgs_users_edx_memory_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_edx_memory_destroy + """ai_mentor_orgs_users_custom_instruction_retrieve - Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + Endpoint for getting user's custom prompts Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } - :param id: A unique integer value identifying this user edx memory. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) @@ -1800,8 +1820,7 @@ def ai_mentor_orgs_users_edx_memory_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_edx_memory_destroy_serialize( - id=id, + _param = self._ai_mentor_orgs_users_custom_instruction_retrieve_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -1811,7 +1830,7 @@ def ai_mentor_orgs_users_edx_memory_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "CustomInstructionResponse", } response_data = self.api_client.call_api( *_param, @@ -1820,9 +1839,8 @@ def ai_mentor_orgs_users_edx_memory_destroy( return response_data.response - def _ai_mentor_orgs_users_edx_memory_destroy_serialize( + def _ai_mentor_orgs_users_custom_instruction_retrieve_serialize( self, - id, org, user_id, _request_auth, @@ -1844,8 +1862,6 @@ def _ai_mentor_orgs_users_edx_memory_destroy_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -1856,6 +1872,13 @@ def _ai_mentor_orgs_users_edx_memory_destroy_serialize( # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -1864,8 +1887,8 @@ def _ai_mentor_orgs_users_edx_memory_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/{id}/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1882,16 +1905,11 @@ def _ai_mentor_orgs_users_edx_memory_destroy_serialize( @validate_call - def ai_mentor_orgs_users_edx_memory_list( + def ai_mentor_orgs_users_custom_instruction_update( self, org: StrictStr, user_id: StrictStr, - course_id: Optional[StrictStr] = None, - ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - student: Annotated[Optional[StrictInt], Field(description="edX user ID")] = None, - username: Optional[StrictStr] = None, + custom_instruction_response: Optional[CustomInstructionResponse] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1905,26 +1923,16 @@ def ai_mentor_orgs_users_edx_memory_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_edx_memory_list + """ai_mentor_orgs_users_custom_instruction_update - Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + Endpoint for updating user's custom instructions. Accessible to tenant admins and students. Returns: 200: Custom Instruction Object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/custom-instruction/ REquest: Response: { \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } Response: { \"id\": 1, \"about_user\": \"about user data\", \"mentor_tone\": \"kindly\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param course_id: - :type course_id: str - :param ordering: Which field to use when ordering the results. - :type ordering: str - :param page: A page number within the paginated result set. - :type page: int - :param page_size: Number of results to return per page. - :type page_size: int - :param student: edX user ID - :type student: int - :param username: - :type username: str + :param custom_instruction_response: + :type custom_instruction_response: CustomInstructionResponse :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1947,15 +1955,10 @@ def ai_mentor_orgs_users_edx_memory_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_edx_memory_list_serialize( + _param = self._ai_mentor_orgs_users_custom_instruction_update_serialize( org=org, user_id=user_id, - course_id=course_id, - ordering=ordering, - page=page, - page_size=page_size, - student=student, - username=username, + custom_instruction_response=custom_instruction_response, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1963,7 +1966,7 @@ def ai_mentor_orgs_users_edx_memory_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedUserEdxMemoryList", + '200': "CustomInstructionResponse", } response_data = self.api_client.call_api( *_param, @@ -1972,16 +1975,11 @@ def ai_mentor_orgs_users_edx_memory_list( return response_data.response - def _ai_mentor_orgs_users_edx_memory_list_serialize( + def _ai_mentor_orgs_users_custom_instruction_update_serialize( self, org, user_id, - course_id, - ordering, - page, - page_size, - student, - username, + custom_instruction_response, _request_auth, _content_type, _headers, @@ -2006,33 +2004,11 @@ def _ai_mentor_orgs_users_edx_memory_list_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if course_id is not None: - - _query_params.append(('course_id', course_id)) - - if ordering is not None: - - _query_params.append(('ordering', ordering)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if student is not None: - - _query_params.append(('student', student)) - - if username is not None: - - _query_params.append(('username', username)) - # process the header parameters # process the form parameters # process the body parameter + if custom_instruction_response is not None: + _body_params = custom_instruction_response # set the HTTP header `Accept` @@ -2043,6 +2019,21 @@ def _ai_mentor_orgs_users_edx_memory_list_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2050,8 +2041,8 @@ def _ai_mentor_orgs_users_edx_memory_list_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/', + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/custom-instruction/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2068,11 +2059,16 @@ def _ai_mentor_orgs_users_edx_memory_list_serialize( @validate_call - def ai_mentor_orgs_users_edx_memory_retrieve( + def ai_mentor_orgs_users_destroy( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this user edx memory.")], + name: StrictStr, org: StrictStr, user_id: StrictStr, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, + metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2086,16 +2082,26 @@ def ai_mentor_orgs_users_edx_memory_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_edx_memory_retrieve + """ai_mentor_orgs_users_destroy - Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - :param id: A unique integer value identifying this user edx memory. (required) - :type id: int + :param name: (required) + :type name: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str + :param metadata_key: Metadata key to be queried with + :type metadata_key: str + :param metadata_value: Metadata value to be filter for + :type metadata_value: str + :param return_session_information: Declares if session information should be included in the mentor data + :type return_session_information: bool + :param visibility: visibility type to be queried with + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2118,10 +2124,15 @@ def ai_mentor_orgs_users_edx_memory_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_edx_memory_retrieve_serialize( - id=id, + _param = self._ai_mentor_orgs_users_destroy_serialize( + name=name, org=org, user_id=user_id, + filter_by=filter_by, + metadata_key=metadata_key, + metadata_value=metadata_value, + return_session_information=return_session_information, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2129,7 +2140,7 @@ def ai_mentor_orgs_users_edx_memory_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserEdxMemory", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -2138,11 +2149,16 @@ def ai_mentor_orgs_users_edx_memory_retrieve( return response_data.response - def _ai_mentor_orgs_users_edx_memory_retrieve_serialize( + def _ai_mentor_orgs_users_destroy_serialize( self, - id, + name, org, user_id, + filter_by, + metadata_key, + metadata_value, + return_session_information, + visibility, _request_auth, _content_type, _headers, @@ -2162,25 +2178,38 @@ def _ai_mentor_orgs_users_edx_memory_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if name is not None: + _path_params['name'] = name if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if metadata_key is not None: + + _query_params.append(('metadata_key', metadata_key)) + + if metadata_value is not None: + + _query_params.append(('metadata_value', metadata_value)) + + if return_session_information is not None: + + _query_params.append(('return_session_information', return_session_information)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -2189,8 +2218,8 @@ def _ai_mentor_orgs_users_edx_memory_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/{id}/', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2207,11 +2236,12 @@ def _ai_mentor_orgs_users_edx_memory_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_export_chathistory_create( + def ai_mentor_orgs_users_downloads_tasks_retrieve( self, org: StrictStr, + task_id: StrictStr, user_id: StrictStr, - task_view: TaskView, + to_csv: Annotated[Optional[StrictBool], Field(description="Choose download in csv or not")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2225,16 +2255,18 @@ def ai_mentor_orgs_users_export_chathistory_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_export_chathistory_create + """ai_mentor_orgs_users_downloads_tasks_retrieve - Endpoint for worker exporting user chathistory. Accessible to both tenant admins and students. Returns: 200: task id. Example: POST: /api/ai-mentor/orgs/main/users/lydiah/export-chathistory/ Requests: No request data. Response: { \"task_id\": \"307be194-2351-44ff-8d7b-24660fd9ec34\" } + Endpoint to download user chathistory. Accessible to tenant admins and students. Returns: 200: When task is not ready. 200: chat history object 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/lydiah/downloads/tasks/307be194-2351-44ff-8d7b-24660fd9ec34 Response: { \"state\": \"task_not_ready\" } :param org: (required) :type org: str + :param task_id: (required) + :type task_id: str :param user_id: (required) :type user_id: str - :param task_view: (required) - :type task_view: TaskView + :param to_csv: Choose download in csv or not + :type to_csv: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2257,10 +2289,11 @@ def ai_mentor_orgs_users_export_chathistory_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_export_chathistory_create_serialize( + _param = self._ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( org=org, + task_id=task_id, user_id=user_id, - task_view=task_view, + to_csv=to_csv, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2268,7 +2301,7 @@ def ai_mentor_orgs_users_export_chathistory_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "TaskView", + '200': "ChatHistoryItem", } response_data = self.api_client.call_api( *_param, @@ -2277,11 +2310,12 @@ def ai_mentor_orgs_users_export_chathistory_create( return response_data.response - def _ai_mentor_orgs_users_export_chathistory_create_serialize( + def _ai_mentor_orgs_users_downloads_tasks_retrieve_serialize( self, org, + task_id, user_id, - task_view, + to_csv, _request_auth, _content_type, _headers, @@ -2303,14 +2337,18 @@ def _ai_mentor_orgs_users_export_chathistory_create_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if task_id is not None: + _path_params['task_id'] = task_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if to_csv is not None: + + _query_params.append(('to_csv', to_csv)) + # process the header parameters # process the form parameters # process the body parameter - if task_view is not None: - _body_params = task_view # set the HTTP header `Accept` @@ -2321,21 +2359,6 @@ def _ai_mentor_orgs_users_export_chathistory_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2343,8 +2366,8 @@ def _ai_mentor_orgs_users_export_chathistory_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/export-chathistory/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/downloads/tasks/{task_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2361,8 +2384,9 @@ def _ai_mentor_orgs_users_export_chathistory_create_serialize( @validate_call - def ai_mentor_orgs_users_free_usage_count_retrieve( + def ai_mentor_orgs_users_edx_memory_destroy( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this user edx memory.")], org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -2378,10 +2402,12 @@ def ai_mentor_orgs_users_free_usage_count_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_free_usage_count_retrieve + """ai_mentor_orgs_users_edx_memory_destroy - Endpoint to get free usage count. Retrieve the number of questions left for a tenant Accessible to tenant admins and students. Returns: 200: free usage count. 404: When tenant not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/free-usage-count/ Response: { \"count\": 3 } + Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + :param id: A unique integer value identifying this user edx memory. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) @@ -2408,7 +2434,8 @@ def ai_mentor_orgs_users_free_usage_count_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_free_usage_count_retrieve_serialize( + _param = self._ai_mentor_orgs_users_edx_memory_destroy_serialize( + id=id, org=org, user_id=user_id, _request_auth=_request_auth, @@ -2418,7 +2445,7 @@ def ai_mentor_orgs_users_free_usage_count_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FreeUsageCount", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -2427,8 +2454,9 @@ def ai_mentor_orgs_users_free_usage_count_retrieve( return response_data.response - def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( + def _ai_mentor_orgs_users_edx_memory_destroy_serialize( self, + id, org, user_id, _request_auth, @@ -2450,6 +2478,8 @@ def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -2460,13 +2490,6 @@ def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -2475,8 +2498,8 @@ def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/free-usage-count', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2493,17 +2516,16 @@ def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_list( + def ai_mentor_orgs_users_edx_memory_list( self, org: StrictStr, user_id: StrictStr, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, - metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, - metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + course_id: Optional[StrictStr] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, + student: Annotated[Optional[StrictInt], Field(description="edX user ID")] = None, + username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2517,28 +2539,26 @@ def ai_mentor_orgs_users_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_list + """ai_mentor_orgs_users_edx_memory_list - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param filter_by: Filter options include, date, name, default is date - :type filter_by: str - :param metadata_key: Metadata key to be queried with - :type metadata_key: str - :param metadata_value: Metadata value to be filter for - :type metadata_value: str + :param course_id: + :type course_id: str + :param ordering: Which field to use when ordering the results. + :type ordering: str :param page: A page number within the paginated result set. :type page: int :param page_size: Number of results to return per page. :type page_size: int - :param return_session_information: Declares if session information should be included in the mentor data - :type return_session_information: bool - :param visibility: visibility type to be queried with - :type visibility: str + :param student: edX user ID + :type student: int + :param username: + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2561,16 +2581,15 @@ def ai_mentor_orgs_users_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_list_serialize( + _param = self._ai_mentor_orgs_users_edx_memory_list_serialize( org=org, user_id=user_id, - filter_by=filter_by, - metadata_key=metadata_key, - metadata_value=metadata_value, + course_id=course_id, + ordering=ordering, page=page, page_size=page_size, - return_session_information=return_session_information, - visibility=visibility, + student=student, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2578,7 +2597,7 @@ def ai_mentor_orgs_users_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedMentorList", + '200': "PaginatedUserEdxMemoryList", } response_data = self.api_client.call_api( *_param, @@ -2587,17 +2606,16 @@ def ai_mentor_orgs_users_list( return response_data.response - def _ai_mentor_orgs_users_list_serialize( + def _ai_mentor_orgs_users_edx_memory_list_serialize( self, org, user_id, - filter_by, - metadata_key, - metadata_value, + course_id, + ordering, page, page_size, - return_session_information, - visibility, + student, + username, _request_auth, _content_type, _headers, @@ -2622,17 +2640,13 @@ def _ai_mentor_orgs_users_list_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if metadata_key is not None: + if course_id is not None: - _query_params.append(('metadata_key', metadata_key)) + _query_params.append(('course_id', course_id)) - if metadata_value is not None: + if ordering is not None: - _query_params.append(('metadata_value', metadata_value)) + _query_params.append(('ordering', ordering)) if page is not None: @@ -2642,13 +2656,13 @@ def _ai_mentor_orgs_users_list_serialize( _query_params.append(('page_size', page_size)) - if return_session_information is not None: + if student is not None: - _query_params.append(('return_session_information', return_session_information)) + _query_params.append(('student', student)) - if visibility is not None: + if username is not None: - _query_params.append(('visibility', visibility)) + _query_params.append(('username', username)) # process the header parameters # process the form parameters @@ -2671,7 +2685,7 @@ def _ai_mentor_orgs_users_list_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2688,11 +2702,11 @@ def _ai_mentor_orgs_users_list_serialize( @validate_call - def ai_mentor_orgs_users_mentor_categories_create( + def ai_mentor_orgs_users_edx_memory_retrieve( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this user edx memory.")], org: StrictStr, user_id: StrictStr, - mentor_category: MentorCategory, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2706,16 +2720,16 @@ def ai_mentor_orgs_users_mentor_categories_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_categories_create + """ai_mentor_orgs_users_edx_memory_retrieve - This is for adding mentor categories Accessible to tenant admins only. Returns: 200 : Mentor category detail. Example : POST : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } + Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with. This information is passed to the corresponding mentor so the mentor has context information about the course and unit that the user last interracted with. There can be only one UserEdxMemory instance per student and course_id. Url Args: org (str): The organization's platform key. user_id (str): The username identifier of the individual. Returns: 200: A paginated list of UserEdxMemory objects Examples: - List all memories GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/ Request: None Response: { \"count\": 0, \"next\": null, \"previous\": null, \"results\": [{ \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" }] } - Get a single UserEdxMemory object GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/ Request: None Response: { \"student\": 1, \"course_id\": \"course-v1:main+CARBON+2024_Fall\", \"data\": {}, \"date_created\": \"2024-06-25T15:30:26.257140\", \"last_modified\": \"2024-06-25T15:30:26.257140\" } + :param id: A unique integer value identifying this user edx memory. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor_category: (required) - :type mentor_category: MentorCategory :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2738,10 +2752,10 @@ def ai_mentor_orgs_users_mentor_categories_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_categories_create_serialize( + _param = self._ai_mentor_orgs_users_edx_memory_retrieve_serialize( + id=id, org=org, user_id=user_id, - mentor_category=mentor_category, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2749,7 +2763,7 @@ def ai_mentor_orgs_users_mentor_categories_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MentorCategory", + '200': "UserEdxMemory", } response_data = self.api_client.call_api( *_param, @@ -2758,11 +2772,11 @@ def ai_mentor_orgs_users_mentor_categories_create( return response_data.response - def _ai_mentor_orgs_users_mentor_categories_create_serialize( + def _ai_mentor_orgs_users_edx_memory_retrieve_serialize( self, + id, org, user_id, - mentor_category, _request_auth, _content_type, _headers, @@ -2782,6 +2796,8 @@ def _ai_mentor_orgs_users_mentor_categories_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -2790,8 +2806,6 @@ def _ai_mentor_orgs_users_mentor_categories_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if mentor_category is not None: - _body_params = mentor_category # set the HTTP header `Accept` @@ -2802,21 +2816,6 @@ def _ai_mentor_orgs_users_mentor_categories_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2824,8 +2823,8 @@ def _ai_mentor_orgs_users_mentor_categories_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/edx-memory/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2842,10 +2841,11 @@ def _ai_mentor_orgs_users_mentor_categories_create_serialize( @validate_call - def ai_mentor_orgs_users_mentor_categories_destroy( + def ai_mentor_orgs_users_export_chathistory_create( self, org: StrictStr, user_id: StrictStr, + task_view: TaskView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2859,14 +2859,16 @@ def ai_mentor_orgs_users_mentor_categories_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_categories_destroy + """ai_mentor_orgs_users_export_chathistory_create - This is for deleting mentor category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"category\": \"Education\" } Response: No response body. + Endpoint for worker exporting user chathistory. Accessible to both tenant admins and students. Returns: 200: task id. Example: POST: /api/ai-mentor/orgs/main/users/lydiah/export-chathistory/ Requests: No request data. Response: { \"task_id\": \"307be194-2351-44ff-8d7b-24660fd9ec34\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param task_view: (required) + :type task_view: TaskView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2889,9 +2891,10 @@ def ai_mentor_orgs_users_mentor_categories_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_categories_destroy_serialize( + _param = self._ai_mentor_orgs_users_export_chathistory_create_serialize( org=org, user_id=user_id, + task_view=task_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2899,7 +2902,7 @@ def ai_mentor_orgs_users_mentor_categories_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "TaskView", } response_data = self.api_client.call_api( *_param, @@ -2908,10 +2911,11 @@ def ai_mentor_orgs_users_mentor_categories_destroy( return response_data.response - def _ai_mentor_orgs_users_mentor_categories_destroy_serialize( + def _ai_mentor_orgs_users_export_chathistory_create_serialize( self, org, user_id, + task_view, _request_auth, _content_type, _headers, @@ -2939,9 +2943,33 @@ def _ai_mentor_orgs_users_mentor_categories_destroy_serialize( # process the header parameters # process the form parameters # process the body parameter + if task_view is not None: + _body_params = task_view + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2949,8 +2977,8 @@ def _ai_mentor_orgs_users_mentor_categories_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/export-chathistory/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2967,7 +2995,7 @@ def _ai_mentor_orgs_users_mentor_categories_destroy_serialize( @validate_call - def ai_mentor_orgs_users_mentor_categories_retrieve( + def ai_mentor_orgs_users_free_usage_count_retrieve( self, org: StrictStr, user_id: StrictStr, @@ -2984,9 +3012,9 @@ def ai_mentor_orgs_users_mentor_categories_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_categories_retrieve + """ai_mentor_orgs_users_free_usage_count_retrieve - This is for getting mentor categories Accessible to tenant admins and students. Returns: 200 : List of mentor categories. Example : GET : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] + Endpoint to get free usage count. Retrieve the number of questions left for a tenant Accessible to tenant admins and students. Returns: 200: free usage count. 404: When tenant is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/free-usage-count/ Response: { \"count\": 3 } :param org: (required) :type org: str @@ -3014,7 +3042,7 @@ def ai_mentor_orgs_users_mentor_categories_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_categories_retrieve_serialize( + _param = self._ai_mentor_orgs_users_free_usage_count_retrieve_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -3024,7 +3052,7 @@ def ai_mentor_orgs_users_mentor_categories_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MentorCategory", + '200': "FreeUsageCount", } response_data = self.api_client.call_api( *_param, @@ -3033,7 +3061,7 @@ def ai_mentor_orgs_users_mentor_categories_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentor_categories_retrieve_serialize( + def _ai_mentor_orgs_users_free_usage_count_retrieve_serialize( self, org, user_id, @@ -3082,7 +3110,7 @@ def _ai_mentor_orgs_users_mentor_categories_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/free-usage-count', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3099,11 +3127,17 @@ def _ai_mentor_orgs_users_mentor_categories_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentor_feedback_create_create( + def ai_mentor_orgs_users_list( self, org: StrictStr, user_id: StrictStr, - user_chat_feedback: UserChatFeedback, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, + metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3117,16 +3151,28 @@ def ai_mentor_orgs_users_mentor_feedback_create_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_feedback_create_create + """ai_mentor_orgs_users_list - Endpoint to add chat feedback. Accessible to tenant admins and students. Returns: 201: chat feedback object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param user_chat_feedback: (required) - :type user_chat_feedback: UserChatFeedback + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str + :param metadata_key: Metadata key to be queried with + :type metadata_key: str + :param metadata_value: Metadata value to be filter for + :type metadata_value: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param return_session_information: Declares if session information should be included in the mentor data + :type return_session_information: bool + :param visibility: visibility type to be queried with + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3149,10 +3195,16 @@ def ai_mentor_orgs_users_mentor_feedback_create_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_feedback_create_create_serialize( + _param = self._ai_mentor_orgs_users_list_serialize( org=org, user_id=user_id, - user_chat_feedback=user_chat_feedback, + filter_by=filter_by, + metadata_key=metadata_key, + metadata_value=metadata_value, + page=page, + page_size=page_size, + return_session_information=return_session_information, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3160,7 +3212,7 @@ def ai_mentor_orgs_users_mentor_feedback_create_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserChatFeedback", + '200': "PaginatedMentorList", } response_data = self.api_client.call_api( *_param, @@ -3169,11 +3221,17 @@ def ai_mentor_orgs_users_mentor_feedback_create_create( return response_data.response - def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( + def _ai_mentor_orgs_users_list_serialize( self, org, user_id, - user_chat_feedback, + filter_by, + metadata_key, + metadata_value, + page, + page_size, + return_session_information, + visibility, _request_auth, _content_type, _headers, @@ -3198,11 +3256,37 @@ def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if metadata_key is not None: + + _query_params.append(('metadata_key', metadata_key)) + + if metadata_value is not None: + + _query_params.append(('metadata_value', metadata_value)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if return_session_information is not None: + + _query_params.append(('return_session_information', return_session_information)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter - if user_chat_feedback is not None: - _body_params = user_chat_feedback # set the HTTP header `Accept` @@ -3213,21 +3297,6 @@ def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3235,8 +3304,8 @@ def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/create/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3253,11 +3322,11 @@ def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( @validate_call - def ai_mentor_orgs_users_mentor_feedback_retrieve( + def ai_mentor_orgs_users_mentor_categories_create( self, - feedback_id: StrictInt, org: StrictStr, user_id: StrictStr, + mentor_category: MentorCategory, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3271,16 +3340,16 @@ def ai_mentor_orgs_users_mentor_feedback_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_feedback_retrieve + """ai_mentor_orgs_users_mentor_categories_create - Endpoint to get feedback detail. Accessible to tenant admins and students. Returns: 200: feed back detail. 404: When feedback id is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Response: { \"id\": 1, \"username\": \"lydiah\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + This is for adding mentor categories Accessible to tenant admins only. Returns: 200 : Mentor category detail. Example : POST : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } - :param feedback_id: (required) - :type feedback_id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param mentor_category: (required) + :type mentor_category: MentorCategory :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3303,10 +3372,10 @@ def ai_mentor_orgs_users_mentor_feedback_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( - feedback_id=feedback_id, + _param = self._ai_mentor_orgs_users_mentor_categories_create_serialize( org=org, user_id=user_id, + mentor_category=mentor_category, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3314,7 +3383,7 @@ def ai_mentor_orgs_users_mentor_feedback_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserChatFeedback", + '200': "MentorCategory", } response_data = self.api_client.call_api( *_param, @@ -3323,11 +3392,11 @@ def ai_mentor_orgs_users_mentor_feedback_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_categories_create_serialize( self, - feedback_id, org, user_id, + mentor_category, _request_auth, _content_type, _headers, @@ -3347,8 +3416,6 @@ def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if feedback_id is not None: - _path_params['feedback_id'] = feedback_id if org is not None: _path_params['org'] = org if user_id is not None: @@ -3357,6 +3424,8 @@ def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( # process the header parameters # process the form parameters # process the body parameter + if mentor_category is not None: + _body_params = mentor_category # set the HTTP header `Accept` @@ -3367,6 +3436,21 @@ def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3374,8 +3458,8 @@ def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3392,12 +3476,10 @@ def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentor_feedback_update( + def ai_mentor_orgs_users_mentor_categories_destroy( self, - feedback_id: StrictInt, org: StrictStr, user_id: StrictStr, - user_chat_feedback: UserChatFeedback, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3411,18 +3493,14 @@ def ai_mentor_orgs_users_mentor_feedback_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_feedback_update + """ai_mentor_orgs_users_mentor_categories_destroy - Endpoint to update chat feedback. Accessible to tenant admins and students. Returns: 200: chat feed back object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + This is for deleting mentor category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Request: { \"category\": \"Education\" } Response: No response body. - :param feedback_id: (required) - :type feedback_id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param user_chat_feedback: (required) - :type user_chat_feedback: UserChatFeedback :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3445,11 +3523,9 @@ def ai_mentor_orgs_users_mentor_feedback_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_feedback_update_serialize( - feedback_id=feedback_id, + _param = self._ai_mentor_orgs_users_mentor_categories_destroy_serialize( org=org, user_id=user_id, - user_chat_feedback=user_chat_feedback, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3457,7 +3533,7 @@ def ai_mentor_orgs_users_mentor_feedback_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserChatFeedback", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3466,12 +3542,10 @@ def ai_mentor_orgs_users_mentor_feedback_update( return response_data.response - def _ai_mentor_orgs_users_mentor_feedback_update_serialize( + def _ai_mentor_orgs_users_mentor_categories_destroy_serialize( self, - feedback_id, org, user_id, - user_chat_feedback, _request_auth, _content_type, _headers, @@ -3491,8 +3565,6 @@ def _ai_mentor_orgs_users_mentor_feedback_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if feedback_id is not None: - _path_params['feedback_id'] = feedback_id if org is not None: _path_params['org'] = org if user_id is not None: @@ -3501,33 +3573,9 @@ def _ai_mentor_orgs_users_mentor_feedback_update_serialize( # process the header parameters # process the form parameters # process the body parameter - if user_chat_feedback is not None: - _body_params = user_chat_feedback - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3535,8 +3583,8 @@ def _ai_mentor_orgs_users_mentor_feedback_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3553,11 +3601,10 @@ def _ai_mentor_orgs_users_mentor_feedback_update_serialize( @validate_call - def ai_mentor_orgs_users_mentor_from_template_create( + def ai_mentor_orgs_users_mentor_categories_retrieve( self, org: StrictStr, user_id: StrictStr, - mentor_from_template_request: MentorFromTemplateRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3571,16 +3618,14 @@ def ai_mentor_orgs_users_mentor_from_template_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_from_template_create + """ai_mentor_orgs_users_mentor_categories_retrieve - View to create a mentor from a template Accessible to only tenant admins. + This is for getting mentor categories Accessible to tenant admins and students. Returns: 200 : List of mentor categories. Example : GET : /api/ai-mentor/orgs/main/users/johndoe/mentor/categories/ Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor_from_template_request: (required) - :type mentor_from_template_request: MentorFromTemplateRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3603,10 +3648,9 @@ def ai_mentor_orgs_users_mentor_from_template_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_from_template_create_serialize( + _param = self._ai_mentor_orgs_users_mentor_categories_retrieve_serialize( org=org, user_id=user_id, - mentor_from_template_request=mentor_from_template_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3614,7 +3658,7 @@ def ai_mentor_orgs_users_mentor_from_template_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Mentor", + '200': "MentorCategory", } response_data = self.api_client.call_api( *_param, @@ -3623,11 +3667,10 @@ def ai_mentor_orgs_users_mentor_from_template_create( return response_data.response - def _ai_mentor_orgs_users_mentor_from_template_create_serialize( + def _ai_mentor_orgs_users_mentor_categories_retrieve_serialize( self, org, user_id, - mentor_from_template_request, _request_auth, _content_type, _headers, @@ -3655,8 +3698,6 @@ def _ai_mentor_orgs_users_mentor_from_template_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if mentor_from_template_request is not None: - _body_params = mentor_from_template_request # set the HTTP header `Accept` @@ -3667,21 +3708,6 @@ def _ai_mentor_orgs_users_mentor_from_template_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3689,8 +3715,8 @@ def _ai_mentor_orgs_users_mentor_from_template_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-from-template/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/categories/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3707,10 +3733,11 @@ def _ai_mentor_orgs_users_mentor_from_template_create_serialize( @validate_call - def ai_mentor_orgs_users_mentor_llms_retrieve( + def ai_mentor_orgs_users_mentor_feedback_create_create( self, org: StrictStr, user_id: StrictStr, + user_chat_feedback: UserChatFeedback, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3724,14 +3751,16 @@ def ai_mentor_orgs_users_mentor_llms_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_llms_retrieve + """ai_mentor_orgs_users_mentor_feedback_create_create - Endpoint to get mentor llms. Accessible to both students and tenant admins. Returns: 200: list of llms. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-llms/ Response: [ { \"id\": 2, \"name\": \"google\", \"description\": \"Google LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://ai.google.dev/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview </h4> <p> Gemini 1.5 delivers dramatically enhanced performance with a more efficient architecture. The first model we’ve released for early testing, Gemini 1.5 Pro, introduces a breakthrough experimental feature in long-context understanding.</p> <p>The chat-bison model is a large language model that excels at language understanding, language generation and conversations. This chat model is fine-tuned to conduct natural multi-turn conversations. The PaLM 2 Chat Bison is ideal for text tasks that require back-and-forth interactions. For text tasks that can be completed with one API response (without the need for continuous conversation), use the PaLM 2 Text Bison.</p>\", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" }, { \"id\": 1, \"name\": \"openai\", \"description\": \"Openai LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://openai.com/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview. </h4> <p> OpenAI has been at the forefront of developing advanced language models, including the Generative Pre-trained Transformer (GPT) series. </p> <p> With 128k context, fresher knowledge and the broadest set of capabilities, GPT-4 Turbo is more powerful than GPT-4 and offered at a lower price. <a href='https://platform.openai.com/docs/models/gpt-4'> Learn about GPT-4 Turbo <a> </p> <p>With broad general knowledge and domain expertise, GPT-4 can follow complex instructions in natural language and solve difficult problems with accuracy.<a href='https://openai.com/gpt-4'> Learn about GPT-4 <a> </p> <p>GPT-3.5 Turbo models are capable and cost-effective. gpt-3.5-turbo-0125 is the flagship model of this family, supports a 16K context window and is optimized for dialog. gpt-3.5-turbo-instruct is an Instruct model and only supports a 4K context window.<a href='https://platform.openai.com/docs/guides/chat'> Learn about GPT-3.5 Turbo <a></p> <p><a href=''> <a></p> \", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" } ] + Endpoint to add chat feedback. Accessible to tenant admins and students. Returns: 201: chat feedback object. 400: When data is not valid. Example: POST: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param user_chat_feedback: (required) + :type user_chat_feedback: UserChatFeedback :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3754,9 +3783,10 @@ def ai_mentor_orgs_users_mentor_llms_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_llms_retrieve_serialize( + _param = self._ai_mentor_orgs_users_mentor_feedback_create_create_serialize( org=org, user_id=user_id, + user_chat_feedback=user_chat_feedback, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3764,7 +3794,7 @@ def ai_mentor_orgs_users_mentor_llms_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LLMResponse", + '200': "UserChatFeedback", } response_data = self.api_client.call_api( *_param, @@ -3773,10 +3803,11 @@ def ai_mentor_orgs_users_mentor_llms_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentor_llms_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_feedback_create_create_serialize( self, org, user_id, + user_chat_feedback, _request_auth, _content_type, _headers, @@ -3804,6 +3835,8 @@ def _ai_mentor_orgs_users_mentor_llms_retrieve_serialize( # process the header parameters # process the form parameters # process the body parameter + if user_chat_feedback is not None: + _body_params = user_chat_feedback # set the HTTP header `Accept` @@ -3814,15 +3847,29 @@ def _ai_mentor_orgs_users_mentor_llms_retrieve_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-llms/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/create/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3839,8 +3886,9 @@ def _ai_mentor_orgs_users_mentor_llms_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentor_tools_retrieve( + def ai_mentor_orgs_users_mentor_feedback_retrieve( self, + feedback_id: StrictInt, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -3856,10 +3904,12 @@ def ai_mentor_orgs_users_mentor_tools_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_tools_retrieve + """ai_mentor_orgs_users_mentor_feedback_retrieve - Endpoint to get mentor tools. Accessible to tenant admins only. Returns: 200: list of tools. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] + Endpoint to get feedback detail. Accessible to tenant admins and students. Returns: 200: feed back detail. 404: When feedback id is not found. 400: When data is not valid. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Response: { \"id\": 1, \"username\": \"lydiah\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + :param feedback_id: (required) + :type feedback_id: int :param org: (required) :type org: str :param user_id: (required) @@ -3886,7 +3936,8 @@ def ai_mentor_orgs_users_mentor_tools_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_tools_retrieve_serialize( + _param = self._ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( + feedback_id=feedback_id, org=org, user_id=user_id, _request_auth=_request_auth, @@ -3896,7 +3947,7 @@ def ai_mentor_orgs_users_mentor_tools_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ToolResponse", + '200': "UserChatFeedback", } response_data = self.api_client.call_api( *_param, @@ -3905,8 +3956,9 @@ def ai_mentor_orgs_users_mentor_tools_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentor_tools_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_feedback_retrieve_serialize( self, + feedback_id, org, user_id, _request_auth, @@ -3928,6 +3980,8 @@ def _ai_mentor_orgs_users_mentor_tools_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if feedback_id is not None: + _path_params['feedback_id'] = feedback_id if org is not None: _path_params['org'] = org if user_id is not None: @@ -3949,12 +4003,11 @@ def _ai_mentor_orgs_users_mentor_tools_retrieve_serialize( # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-tools/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3971,11 +4024,12 @@ def _ai_mentor_orgs_users_mentor_tools_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentor_with_settings_create( + def ai_mentor_orgs_users_mentor_feedback_update( self, + feedback_id: StrictInt, org: StrictStr, user_id: StrictStr, - mentor_from_template_with_setting_request: MentorFromTemplateWithSettingRequest, + user_chat_feedback: UserChatFeedback, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3989,16 +4043,18 @@ def ai_mentor_orgs_users_mentor_with_settings_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentor_with_settings_create + """ai_mentor_orgs_users_mentor_feedback_update - View to create a mentor from a template with settings. Accessible to tenant admins only. + Endpoint to update chat feedback. Accessible to tenant admins and students. Returns: 200: chat feed back object. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/johndoe/mentor-feedback/1/ Request: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": ai-mentor } Response: { \"id\": 1, \"username\": \"johndoe\", \"session\": \"937d3d46-3048-4f9d-aa5c-ce7c51d85332\", \"user_text\": \"Who is Marc H. Supcoff\", \"ai_response\": \"Marc H. Supcoff is an Adjunct Professor of Law \", \"reason\": \"Good reason\", \"additional_feedback\": \"Good response\", \"rating\": 1, \"mentor\": 12 } + :param feedback_id: (required) + :type feedback_id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor_from_template_with_setting_request: (required) - :type mentor_from_template_with_setting_request: MentorFromTemplateWithSettingRequest + :param user_chat_feedback: (required) + :type user_chat_feedback: UserChatFeedback :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4021,10 +4077,11 @@ def ai_mentor_orgs_users_mentor_with_settings_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentor_with_settings_create_serialize( + _param = self._ai_mentor_orgs_users_mentor_feedback_update_serialize( + feedback_id=feedback_id, org=org, user_id=user_id, - mentor_from_template_with_setting_request=mentor_from_template_with_setting_request, + user_chat_feedback=user_chat_feedback, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4032,7 +4089,7 @@ def ai_mentor_orgs_users_mentor_with_settings_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Mentor", + '200': "UserChatFeedback", } response_data = self.api_client.call_api( *_param, @@ -4041,11 +4098,12 @@ def ai_mentor_orgs_users_mentor_with_settings_create( return response_data.response - def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( + def _ai_mentor_orgs_users_mentor_feedback_update_serialize( self, + feedback_id, org, user_id, - mentor_from_template_with_setting_request, + user_chat_feedback, _request_auth, _content_type, _headers, @@ -4065,6 +4123,8 @@ def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if feedback_id is not None: + _path_params['feedback_id'] = feedback_id if org is not None: _path_params['org'] = org if user_id is not None: @@ -4073,8 +4133,8 @@ def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if mentor_from_template_with_setting_request is not None: - _body_params = mentor_from_template_with_setting_request + if user_chat_feedback is not None: + _body_params = user_chat_feedback # set the HTTP header `Accept` @@ -4103,12 +4163,11 @@ def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-with-settings/', + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-feedback/{feedback_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4125,11 +4184,11 @@ def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( @validate_call - def ai_mentor_orgs_users_mentors_public_settings_retrieve( + def ai_mentor_orgs_users_mentor_from_template_create( self, - mentor: StrictStr, org: StrictStr, user_id: StrictStr, + mentor_from_template_request: MentorFromTemplateRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4143,16 +4202,16 @@ def ai_mentor_orgs_users_mentors_public_settings_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentors_public_settings_retrieve + """ai_mentor_orgs_users_mentor_from_template_create - Endpoint to get mentor public settings. Accessible to any user. + View to create a mentor from a template Accessible to only tenant admins. - :param mentor: (required) - :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param mentor_from_template_request: (required) + :type mentor_from_template_request: MentorFromTemplateRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4175,10 +4234,10 @@ def ai_mentor_orgs_users_mentors_public_settings_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( - mentor=mentor, + _param = self._ai_mentor_orgs_users_mentor_from_template_create_serialize( org=org, user_id=user_id, + mentor_from_template_request=mentor_from_template_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4186,7 +4245,7 @@ def ai_mentor_orgs_users_mentors_public_settings_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MentorSettings", + '200': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -4195,11 +4254,11 @@ def ai_mentor_orgs_users_mentors_public_settings_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_from_template_create_serialize( self, - mentor, org, user_id, + mentor_from_template_request, _request_auth, _content_type, _headers, @@ -4219,8 +4278,6 @@ def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if mentor is not None: - _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -4229,6 +4286,8 @@ def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( # process the header parameters # process the form parameters # process the body parameter + if mentor_from_template_request is not None: + _body_params = mentor_from_template_request # set the HTTP header `Accept` @@ -4239,14 +4298,30 @@ def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-settings/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-from-template/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4263,9 +4338,8 @@ def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentors_retrieve( + def ai_mentor_orgs_users_mentor_llms_retrieve( self, - mentor: StrictStr, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -4281,12 +4355,10 @@ def ai_mentor_orgs_users_mentors_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentors_retrieve + """ai_mentor_orgs_users_mentor_llms_retrieve - This endpoint get mentor detail data. Accessible to tenant admins and students. Returns: 200 : Mentor object. Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/ Response: { \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"allow_anonymous\": false, \"pathways\": [], \"suggested_prompts\": [ \"\" ], \"llm_provider\": \"IBLChatOpenAI\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", \"metadata\": { \"admin\": true, \"student\": true, \"featured\": true, \"allow_to_use_as_template\": true }, \"proactive_message\": \"\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. \", \"enable_moderation\": false, \"created_by\": \"system\" } + Endpoint to get mentor llms. Accessible to both students and tenant admins. Returns: 200: list of llms. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-llms/ Response: [ { \"id\": 2, \"name\": \"google\", \"description\": \"Google LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://ai.google.dev/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview </h4> <p> Gemini 1.5 delivers dramatically enhanced performance with a more efficient architecture. The first model we’ve released for early testing, Gemini 1.5 Pro, introduces a breakthrough experimental feature in long-context understanding.</p> <p>The chat-bison model is a large language model that excels at language understanding, language generation and conversations. This chat model is fine-tuned to conduct natural multi-turn conversations. The PaLM 2 Chat Bison is ideal for text tasks that require back-and-forth interactions. For text tasks that can be completed with one API response (without the need for continuous conversation), use the PaLM 2 Text Bison.</p>\", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" }, { \"id\": 1, \"name\": \"openai\", \"description\": \"Openai LLMs\", \"metadata\": null, \"resource_ids\": [ \"https://openai.com/pricing\" ], \"tags\": { \"tasks\": [ \"Generation\", \"Foundation\" ], \"languages\": [ \"English\" ], \"skill_levels\": [ \"Beginner\", \"Advanced\" ] }, \"overview\": \"<h4> Overview. </h4> <p> OpenAI has been at the forefront of developing advanced language models, including the Generative Pre-trained Transformer (GPT) series. </p> <p> With 128k context, fresher knowledge and the broadest set of capabilities, GPT-4 Turbo is more powerful than GPT-4 and offered at a lower price. <a href='https://platform.openai.com/docs/models/gpt-4'> Learn about GPT-4 Turbo <a> </p> <p>With broad general knowledge and domain expertise, GPT-4 can follow complex instructions in natural language and solve difficult problems with accuracy.<a href='https://openai.com/gpt-4'> Learn about GPT-4 <a> </p> <p>GPT-3.5 Turbo models are capable and cost-effective. gpt-3.5-turbo-0125 is the flagship model of this family, supports a 16K context window and is optimized for dialog. gpt-3.5-turbo-instruct is an Instruct model and only supports a 4K context window.<a href='https://platform.openai.com/docs/guides/chat'> Learn about GPT-3.5 Turbo <a></p> <p><a href=''> <a></p> \", \"use_cases\": \"None\", \"documentation\": \"None\", \"sdk_samples\": \"None\" } ] - :param mentor: (required) - :type mentor: str :param org: (required) :type org: str :param user_id: (required) @@ -4313,8 +4385,7 @@ def ai_mentor_orgs_users_mentors_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentors_retrieve_serialize( - mentor=mentor, + _param = self._ai_mentor_orgs_users_mentor_llms_retrieve_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -4324,7 +4395,7 @@ def ai_mentor_orgs_users_mentors_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Mentor", + '200': "LLMResponse", } response_data = self.api_client.call_api( *_param, @@ -4333,9 +4404,8 @@ def ai_mentor_orgs_users_mentors_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentors_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_llms_retrieve_serialize( self, - mentor, org, user_id, _request_auth, @@ -4357,8 +4427,6 @@ def _ai_mentor_orgs_users_mentors_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if mentor is not None: - _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -4385,7 +4453,7 @@ def _ai_mentor_orgs_users_mentors_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-llms/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4402,9 +4470,8 @@ def _ai_mentor_orgs_users_mentors_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentors_settings_retrieve( + def ai_mentor_orgs_users_mentor_seed_retrieve( self, - mentor: StrictStr, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -4420,12 +4487,10 @@ def ai_mentor_orgs_users_mentors_settings_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentors_settings_retrieve + """ai_mentor_orgs_users_mentor_seed_retrieve - Endpoint to get mentor settings. Accessible to tenant admins only. + Endpoint for seed mentors and prompts for a tenant. Accessible to tenant admins only. Returns: 200: status of seeding. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/seed-mentors/ Response: { \"detail\": \"Mentors seeded\" } - :param mentor: (required) - :type mentor: str :param org: (required) :type org: str :param user_id: (required) @@ -4452,8 +4517,7 @@ def ai_mentor_orgs_users_mentors_settings_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentors_settings_retrieve_serialize( - mentor=mentor, + _param = self._ai_mentor_orgs_users_mentor_seed_retrieve_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -4463,7 +4527,7 @@ def ai_mentor_orgs_users_mentors_settings_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "SeedMentorsView", } response_data = self.api_client.call_api( *_param, @@ -4472,9 +4536,8 @@ def ai_mentor_orgs_users_mentors_settings_retrieve( return response_data.response - def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_seed_retrieve_serialize( self, - mentor, org, user_id, _request_auth, @@ -4496,8 +4559,6 @@ def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if mentor is not None: - _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -4508,6 +4569,13 @@ def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -4517,7 +4585,7 @@ def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor/seed/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4534,12 +4602,10 @@ def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_mentors_settings_update( + def ai_mentor_orgs_users_mentor_tools_retrieve( self, - mentor: StrictStr, org: StrictStr, user_id: StrictStr, - mentor_settings_request: Optional[MentorSettingsRequest] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4553,18 +4619,14 @@ def ai_mentor_orgs_users_mentors_settings_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_mentors_settings_update + """ai_mentor_orgs_users_mentor_tools_retrieve - Endpoint to update mentor settings. Accessible to tenant admins only. + Endpoint to get mentor tools. Accessible to tenant admins only. Returns: 200: list of tools. Example: GET: /api/ai-mentor/orgs/main/users/johndoe/mentor-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] - :param mentor: (required) - :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor_settings_request: - :type mentor_settings_request: MentorSettingsRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4587,11 +4649,9 @@ def ai_mentor_orgs_users_mentors_settings_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_mentors_settings_update_serialize( - mentor=mentor, + _param = self._ai_mentor_orgs_users_mentor_tools_retrieve_serialize( org=org, user_id=user_id, - mentor_settings_request=mentor_settings_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4599,7 +4659,7 @@ def ai_mentor_orgs_users_mentors_settings_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MentorSettings", + '200': "ToolResponse", } response_data = self.api_client.call_api( *_param, @@ -4608,12 +4668,10 @@ def ai_mentor_orgs_users_mentors_settings_update( return response_data.response - def _ai_mentor_orgs_users_mentors_settings_update_serialize( + def _ai_mentor_orgs_users_mentor_tools_retrieve_serialize( self, - mentor, org, user_id, - mentor_settings_request, _request_auth, _content_type, _headers, @@ -4633,8 +4691,6 @@ def _ai_mentor_orgs_users_mentors_settings_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if mentor is not None: - _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -4643,8 +4699,6 @@ def _ai_mentor_orgs_users_mentors_settings_update_serialize( # process the header parameters # process the form parameters # process the body parameter - if mentor_settings_request is not None: - _body_params = mentor_settings_request # set the HTTP header `Accept` @@ -4655,21 +4709,6 @@ def _ai_mentor_orgs_users_mentors_settings_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4677,8 +4716,8 @@ def _ai_mentor_orgs_users_mentors_settings_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-tools/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4695,10 +4734,11 @@ def _ai_mentor_orgs_users_mentors_settings_update_serialize( @validate_call - def ai_mentor_orgs_users_metadata_retrieve( + def ai_mentor_orgs_users_mentor_with_settings_create( self, org: StrictStr, user_id: StrictStr, + mentor_from_template_with_setting_request: MentorFromTemplateWithSettingRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4712,14 +4752,16 @@ def ai_mentor_orgs_users_metadata_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_metadata_retrieve + """ai_mentor_orgs_users_mentor_with_settings_create - Endpoint for getting mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } + View to create a mentor from a template with settings. Accessible to tenant admins only. :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param mentor_from_template_with_setting_request: (required) + :type mentor_from_template_with_setting_request: MentorFromTemplateWithSettingRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4742,9 +4784,10 @@ def ai_mentor_orgs_users_metadata_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_metadata_retrieve_serialize( + _param = self._ai_mentor_orgs_users_mentor_with_settings_create_serialize( org=org, user_id=user_id, + mentor_from_template_with_setting_request=mentor_from_template_with_setting_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4752,7 +4795,7 @@ def ai_mentor_orgs_users_metadata_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -4761,10 +4804,11 @@ def ai_mentor_orgs_users_metadata_retrieve( return response_data.response - def _ai_mentor_orgs_users_metadata_retrieve_serialize( + def _ai_mentor_orgs_users_mentor_with_settings_create_serialize( self, org, user_id, + mentor_from_template_with_setting_request, _request_auth, _content_type, _headers, @@ -4792,9 +4836,33 @@ def _ai_mentor_orgs_users_metadata_retrieve_serialize( # process the header parameters # process the form parameters # process the body parameter + if mentor_from_template_with_setting_request is not None: + _body_params = mentor_from_template_with_setting_request + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4802,8 +4870,8 @@ def _ai_mentor_orgs_users_metadata_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/metadata', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentor-with-settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4820,17 +4888,11 @@ def _ai_mentor_orgs_users_metadata_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_partial_update( + def ai_mentor_orgs_users_mentors_available_tools_retrieve( self, - name: StrictStr, + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, - metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, - metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, - return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, - patched_mentor: Optional[PatchedMentor] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4844,28 +4906,16 @@ def ai_mentor_orgs_users_partial_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_partial_update + """ai_mentor_orgs_users_mentors_available_tools_retrieve - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + This endpoint list tools allowed for a particular mentor. Accessible to tenant admins and students. Returns: 200 : List of Tool objects Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/available-tools/ Response: [ { \"id\": 1, \"name\": \"openai\", \"metadata\": null }, { \"id\": 2, \"name\": \"google\", \"metadata\": null } ] - :param name: (required) - :type name: str - :param org: (required) + :param mentor: (required) + :type mentor: str + :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param filter_by: Filter options include, date, name, default is date - :type filter_by: str - :param metadata_key: Metadata key to be queried with - :type metadata_key: str - :param metadata_value: Metadata value to be filter for - :type metadata_value: str - :param return_session_information: Declares if session information should be included in the mentor data - :type return_session_information: bool - :param visibility: visibility type to be queried with - :type visibility: str - :param patched_mentor: - :type patched_mentor: PatchedMentor :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4888,16 +4938,10 @@ def ai_mentor_orgs_users_partial_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_partial_update_serialize( - name=name, + _param = self._ai_mentor_orgs_users_mentors_available_tools_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, - filter_by=filter_by, - metadata_key=metadata_key, - metadata_value=metadata_value, - return_session_information=return_session_information, - visibility=visibility, - patched_mentor=patched_mentor, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4905,7 +4949,7 @@ def ai_mentor_orgs_users_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Mentor", + '200': "ToolResponse", } response_data = self.api_client.call_api( *_param, @@ -4914,17 +4958,11 @@ def ai_mentor_orgs_users_partial_update( return response_data.response - def _ai_mentor_orgs_users_partial_update_serialize( + def _ai_mentor_orgs_users_mentors_available_tools_retrieve_serialize( self, - name, + mentor, org, user_id, - filter_by, - metadata_key, - metadata_value, - return_session_information, - visibility, - patched_mentor, _request_auth, _content_type, _headers, @@ -4944,38 +4982,16 @@ def _ai_mentor_orgs_users_partial_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if name is not None: - _path_params['name'] = name + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if metadata_key is not None: - - _query_params.append(('metadata_key', metadata_key)) - - if metadata_value is not None: - - _query_params.append(('metadata_value', metadata_value)) - - if return_session_information is not None: - - _query_params.append(('return_session_information', return_session_information)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter - if patched_mentor is not None: - _body_params = patched_mentor # set the HTTP header `Accept` @@ -4986,21 +5002,6 @@ def _ai_mentor_orgs_users_partial_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -5008,8 +5009,8 @@ def _ai_mentor_orgs_users_partial_update_serialize( ] return self.api_client.param_serialize( - method='PATCH', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/available-tools/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5026,19 +5027,11 @@ def _ai_mentor_orgs_users_partial_update_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agent_logs_list( + def ai_mentor_orgs_users_mentors_memory_component_settings_retrieve( self, + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - parent_mentor_id: Optional[StrictStr] = None, - parent_session_id: Optional[StrictStr] = None, - periodic_agent: Optional[StrictInt] = None, - search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, - status: Annotated[Optional[StrictStr], Field(description="* `success` - Success * `error` - Error * `running` - Running")] = None, - username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5052,32 +5045,16 @@ def ai_mentor_orgs_users_periodic_agent_logs_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agent_logs_list + """ai_mentor_orgs_users_mentors_memory_component_settings_retrieve - Endpoint to view logs for periodic agent runs. These logs contain the full mentor output for each run for debugging. Logs are ordered from newest to oldest. However this can be changed. You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL. + Endpoint for toggling the memory component. Accessible to tenant admins and students. Returns: 200: Learner memory status for given mentor and student. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/student0/mentors/main/memory-component-settings/ Request: { \"enabled\": true } Response: { \"detail\": \"Request was successful.\", \"enabled\": true } + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param ordering: Which field to use when ordering the results. - :type ordering: str - :param page: A page number within the paginated result set. - :type page: int - :param page_size: Number of results to return per page. - :type page_size: int - :param parent_mentor_id: - :type parent_mentor_id: str - :param parent_session_id: - :type parent_session_id: str - :param periodic_agent: - :type periodic_agent: int - :param search: A search term. - :type search: str - :param status: * `success` - Success * `error` - Error * `running` - Running - :type status: str - :param username: - :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5100,18 +5077,10 @@ def ai_mentor_orgs_users_periodic_agent_logs_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agent_logs_list_serialize( + _param = self._ai_mentor_orgs_users_mentors_memory_component_settings_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, - ordering=ordering, - page=page, - page_size=page_size, - parent_mentor_id=parent_mentor_id, - parent_session_id=parent_session_id, - periodic_agent=periodic_agent, - search=search, - status=status, - username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5119,7 +5088,7 @@ def ai_mentor_orgs_users_periodic_agent_logs_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedPeriodicAgentLogList", + '200': None, } response_data = self.api_client.call_api( *_param, @@ -5128,19 +5097,11 @@ def ai_mentor_orgs_users_periodic_agent_logs_list( return response_data.response - def _ai_mentor_orgs_users_periodic_agent_logs_list_serialize( + def _ai_mentor_orgs_users_mentors_memory_component_settings_retrieve_serialize( self, + mentor, org, user_id, - ordering, - page, - page_size, - parent_mentor_id, - parent_session_id, - periodic_agent, - search, - status, - username, _request_auth, _content_type, _headers, @@ -5160,59 +5121,18 @@ def _ai_mentor_orgs_users_periodic_agent_logs_list_serialize( _body_params: Optional[bytes] = None # process the path parameters + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if ordering is not None: - - _query_params.append(('ordering', ordering)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if parent_mentor_id is not None: - - _query_params.append(('parent_mentor_id', parent_mentor_id)) - - if parent_session_id is not None: - - _query_params.append(('parent_session_id', parent_session_id)) - - if periodic_agent is not None: - - _query_params.append(('periodic_agent', periodic_agent)) - - if search is not None: - - _query_params.append(('search', search)) - - if status is not None: - - _query_params.append(('status', status)) - - if username is not None: - - _query_params.append(('username', username)) - # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -5222,7 +5142,7 @@ def _ai_mentor_orgs_users_periodic_agent_logs_list_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5239,9 +5159,9 @@ def _ai_mentor_orgs_users_periodic_agent_logs_list_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agent_logs_retrieve( + def ai_mentor_orgs_users_mentors_memory_component_settings_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent log.")], + mentor: StrictStr, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -5257,12 +5177,12 @@ def ai_mentor_orgs_users_periodic_agent_logs_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agent_logs_retrieve + """ai_mentor_orgs_users_mentors_memory_component_settings_update - Endpoint to view logs for periodic agent runs. These logs contain the full mentor output for each run for debugging. Logs are ordered from newest to oldest. However this can be changed. You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL. + Endpoint for toggling the memory component. Accessible to tenant admins and students. Returns: 200: Learner memory status for given mentor and student. 400: When data is not valid. Example: PUT: /api/ai-mentor/orgs/main/users/student0/mentors/main/memory-component-settings/ Request: { \"enabled\": true } Response: { \"detail\": \"Request was successful.\", \"enabled\": true } - :param id: A unique integer value identifying this periodic agent log. (required) - :type id: int + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) @@ -5289,8 +5209,8 @@ def ai_mentor_orgs_users_periodic_agent_logs_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( - id=id, + _param = self._ai_mentor_orgs_users_mentors_memory_component_settings_update_serialize( + mentor=mentor, org=org, user_id=user_id, _request_auth=_request_auth, @@ -5300,7 +5220,7 @@ def ai_mentor_orgs_users_periodic_agent_logs_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PeriodicAgentLog", + '200': None, } response_data = self.api_client.call_api( *_param, @@ -5309,9 +5229,9 @@ def ai_mentor_orgs_users_periodic_agent_logs_retrieve( return response_data.response - def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( + def _ai_mentor_orgs_users_mentors_memory_component_settings_update_serialize( self, - id, + mentor, org, user_id, _request_auth, @@ -5333,8 +5253,8 @@ def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -5345,13 +5265,6 @@ def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -5360,8 +5273,8 @@ def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/{id}/', + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/memory-component-settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5378,11 +5291,11 @@ def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_create( + def ai_mentor_orgs_users_mentors_public_settings_retrieve( self, + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - periodic_agent_create: PeriodicAgentCreate, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5396,16 +5309,16 @@ def ai_mentor_orgs_users_periodic_agents_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_create + """ai_mentor_orgs_users_mentors_public_settings_retrieve - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + Endpoint to get mentor public settings. Accessible to any user. + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param periodic_agent_create: (required) - :type periodic_agent_create: PeriodicAgentCreate :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5428,10 +5341,10 @@ def ai_mentor_orgs_users_periodic_agents_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_create_serialize( + _param = self._ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, - periodic_agent_create=periodic_agent_create, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5439,7 +5352,7 @@ def ai_mentor_orgs_users_periodic_agents_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "PeriodicAgentCreate", + '200': "MentorSettings", } response_data = self.api_client.call_api( *_param, @@ -5448,11 +5361,11 @@ def ai_mentor_orgs_users_periodic_agents_create( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_create_serialize( + def _ai_mentor_orgs_users_mentors_public_settings_retrieve_serialize( self, + mentor, org, user_id, - periodic_agent_create, _request_auth, _content_type, _headers, @@ -5472,6 +5385,8 @@ def _ai_mentor_orgs_users_periodic_agents_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -5480,8 +5395,6 @@ def _ai_mentor_orgs_users_periodic_agents_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if periodic_agent_create is not None: - _body_params = periodic_agent_create # set the HTTP header `Accept` @@ -5492,30 +5405,14 @@ def _ai_mentor_orgs_users_periodic_agents_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/public-settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5532,9 +5429,9 @@ def _ai_mentor_orgs_users_periodic_agents_create_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_destroy( + def ai_mentor_orgs_users_mentors_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + mentor: StrictStr, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -5550,12 +5447,12 @@ def ai_mentor_orgs_users_periodic_agents_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_destroy + """ai_mentor_orgs_users_mentors_retrieve - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + This endpoint get mentor detail data. Accessible to tenant admins and students. Returns: 200 : Mentor object. Example : GET : api/ai-mentor/orgs/main/users/johndoe/mentors/ai-mentor/ Response: { \"name\": \"AI Mentor\", \"platform\": \"main\", \"slug\": \"ai-mentor\", \"description\": \"Upbeat, encouraging tutor helping students understand concepts by explaining ideas and asking questions.\", \"allow_anonymous\": false, \"pathways\": [], \"suggested_prompts\": [ \"\" ], \"llm_provider\": \"IBLChatOpenAI\", \"system_prompt\": \"Wrap all responses in MARKDOWN formatted text.\", \"metadata\": { \"admin\": true, \"student\": true, \"featured\": true, \"allow_to_use_as_template\": true }, \"proactive_message\": \"\", \"moderation_system_prompt\": \"You are a moderator tasked with identifying whether a prompt from a user is appropriate or inappropriate. \", \"enable_moderation\": false, \"safety_system_prompt\": \"You are a moderator tasked with identifying whether a message from an ai model to a user is is appropriate or inappropriate. If the message is immoral or contains abusive words, insults, damaging content, and law breaking acts, etc it should be deemed inappropriate. Otherwise it is deemed appropriate.\", \"safety_response\": \"Sorry, the AI model generated an inappropriate response. Kindly refine your prompt or try again with a different prompt.\", \"enable_safety_system\": false, \"created_by\": \"system\" } - :param id: A unique integer value identifying this periodic agent. (required) - :type id: int + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) @@ -5582,8 +5479,8 @@ def ai_mentor_orgs_users_periodic_agents_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_destroy_serialize( - id=id, + _param = self._ai_mentor_orgs_users_mentors_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, _request_auth=_request_auth, @@ -5593,7 +5490,7 @@ def ai_mentor_orgs_users_periodic_agents_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -5602,9 +5499,9 @@ def ai_mentor_orgs_users_periodic_agents_destroy( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( + def _ai_mentor_orgs_users_mentors_retrieve_serialize( self, - id, + mentor, org, user_id, _request_auth, @@ -5626,8 +5523,8 @@ def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -5638,6 +5535,13 @@ def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -5646,8 +5550,8 @@ def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5664,22 +5568,11 @@ def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_list( + def ai_mentor_orgs_users_mentors_scenarios_retrieve( self, + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - enabled: Optional[StrictBool] = None, - ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - parent_mentor_id: Optional[StrictInt] = None, - parent_session_id: Optional[StrictStr] = None, - previous_agent: Optional[StrictInt] = None, - previous_agent_status: Annotated[Optional[StrictStr], Field(description="The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending")] = None, - search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, - status: Annotated[Optional[StrictStr], Field(description="* `success` - Success * `error` - Error * `running` - Running * `pending` - Pending")] = None, - title: Optional[StrictStr] = None, - username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5693,38 +5586,16 @@ def ai_mentor_orgs_users_periodic_agents_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_list + """ai_mentor_orgs_users_mentors_scenarios_retrieve - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param enabled: - :type enabled: bool - :param ordering: Which field to use when ordering the results. - :type ordering: str - :param page: A page number within the paginated result set. - :type page: int - :param page_size: Number of results to return per page. - :type page_size: int - :param parent_mentor_id: - :type parent_mentor_id: int - :param parent_session_id: - :type parent_session_id: str - :param previous_agent: - :type previous_agent: int - :param previous_agent_status: The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending - :type previous_agent_status: str - :param search: A search term. - :type search: str - :param status: * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending - :type status: str - :param title: - :type title: str - :param username: - :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5747,21 +5618,10 @@ def ai_mentor_orgs_users_periodic_agents_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_list_serialize( + _param = self._ai_mentor_orgs_users_mentors_scenarios_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, - enabled=enabled, - ordering=ordering, - page=page, - page_size=page_size, - parent_mentor_id=parent_mentor_id, - parent_session_id=parent_session_id, - previous_agent=previous_agent, - previous_agent_status=previous_agent_status, - search=search, - status=status, - title=title, - username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5769,7 +5629,7 @@ def ai_mentor_orgs_users_periodic_agents_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedPeriodicAgentList", + '200': None, } response_data = self.api_client.call_api( *_param, @@ -5778,22 +5638,11 @@ def ai_mentor_orgs_users_periodic_agents_list( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_list_serialize( + def _ai_mentor_orgs_users_mentors_scenarios_retrieve_serialize( self, + mentor, org, user_id, - enabled, - ordering, - page, - page_size, - parent_mentor_id, - parent_session_id, - previous_agent, - previous_agent_status, - search, - status, - title, - username, _request_auth, _content_type, _headers, @@ -5813,71 +5662,18 @@ def _ai_mentor_orgs_users_periodic_agents_list_serialize( _body_params: Optional[bytes] = None # process the path parameters + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if enabled is not None: - - _query_params.append(('enabled', enabled)) - - if ordering is not None: - - _query_params.append(('ordering', ordering)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if parent_mentor_id is not None: - - _query_params.append(('parent_mentor_id', parent_mentor_id)) - - if parent_session_id is not None: - - _query_params.append(('parent_session_id', parent_session_id)) - - if previous_agent is not None: - - _query_params.append(('previous_agent', previous_agent)) - - if previous_agent_status is not None: - - _query_params.append(('previous_agent_status', previous_agent_status)) - - if search is not None: - - _query_params.append(('search', search)) - - if status is not None: - - _query_params.append(('status', status)) - - if title is not None: - - _query_params.append(('title', title)) - - if username is not None: - - _query_params.append(('username', username)) - # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -5887,7 +5683,7 @@ def _ai_mentor_orgs_users_periodic_agents_list_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5904,12 +5700,11 @@ def _ai_mentor_orgs_users_periodic_agents_list_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_partial_update( + def ai_mentor_orgs_users_mentors_scenarios_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - patched_periodic_agent_create: Optional[PatchedPeriodicAgentCreate] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5923,18 +5718,16 @@ def ai_mentor_orgs_users_periodic_agents_partial_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_partial_update + """ai_mentor_orgs_users_mentors_scenarios_update - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - :param id: A unique integer value identifying this periodic agent. (required) - :type id: int + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param patched_periodic_agent_create: - :type patched_periodic_agent_create: PatchedPeriodicAgentCreate :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5957,11 +5750,10 @@ def ai_mentor_orgs_users_periodic_agents_partial_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_partial_update_serialize( - id=id, + _param = self._ai_mentor_orgs_users_mentors_scenarios_update_serialize( + mentor=mentor, org=org, user_id=user_id, - patched_periodic_agent_create=patched_periodic_agent_create, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5969,7 +5761,7 @@ def ai_mentor_orgs_users_periodic_agents_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PeriodicAgentCreate", + '200': None, } response_data = self.api_client.call_api( *_param, @@ -5978,12 +5770,11 @@ def ai_mentor_orgs_users_periodic_agents_partial_update( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( + def _ai_mentor_orgs_users_mentors_scenarios_update_serialize( self, - id, + mentor, org, user_id, - patched_periodic_agent_create, _request_auth, _content_type, _headers, @@ -6003,8 +5794,8 @@ def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -6013,33 +5804,9 @@ def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( # process the header parameters # process the form parameters # process the body parameter - if patched_periodic_agent_create is not None: - _body_params = patched_periodic_agent_create - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -6047,8 +5814,8 @@ def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( ] return self.api_client.param_serialize( - method='PATCH', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/scenarios/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6065,9 +5832,9 @@ def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_retrieve( + def ai_mentor_orgs_users_mentors_settings_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + mentor: StrictStr, org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -6083,12 +5850,12 @@ def ai_mentor_orgs_users_periodic_agents_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_retrieve + """ai_mentor_orgs_users_mentors_settings_retrieve - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + Endpoint to get mentor settings. Accessible to tenant admins only. - :param id: A unique integer value identifying this periodic agent. (required) - :type id: int + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) @@ -6115,8 +5882,8 @@ def ai_mentor_orgs_users_periodic_agents_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_retrieve_serialize( - id=id, + _param = self._ai_mentor_orgs_users_mentors_settings_retrieve_serialize( + mentor=mentor, org=org, user_id=user_id, _request_auth=_request_auth, @@ -6126,7 +5893,7 @@ def ai_mentor_orgs_users_periodic_agents_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PeriodicAgent", + '200': "MentorSettings", } response_data = self.api_client.call_api( *_param, @@ -6135,9 +5902,9 @@ def ai_mentor_orgs_users_periodic_agents_retrieve( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_retrieve_serialize( + def _ai_mentor_orgs_users_mentors_settings_retrieve_serialize( self, - id, + mentor, org, user_id, _request_auth, @@ -6159,8 +5926,8 @@ def _ai_mentor_orgs_users_periodic_agents_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -6187,7 +5954,7 @@ def _ai_mentor_orgs_users_periodic_agents_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6204,12 +5971,12 @@ def _ai_mentor_orgs_users_periodic_agents_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_periodic_agents_update( + def ai_mentor_orgs_users_mentors_settings_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + mentor: StrictStr, org: StrictStr, user_id: StrictStr, - periodic_agent_create: PeriodicAgentCreate, + mentor_settings_request: Optional[MentorSettingsRequest] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6223,18 +5990,18 @@ def ai_mentor_orgs_users_periodic_agents_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_periodic_agents_update + """ai_mentor_orgs_users_mentors_settings_update - Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. + Endpoint to update mentor settings. Accessible to tenant admins only. - :param id: A unique integer value identifying this periodic agent. (required) - :type id: int + :param mentor: (required) + :type mentor: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param periodic_agent_create: (required) - :type periodic_agent_create: PeriodicAgentCreate + :param mentor_settings_request: + :type mentor_settings_request: MentorSettingsRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -6257,11 +6024,11 @@ def ai_mentor_orgs_users_periodic_agents_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_periodic_agents_update_serialize( - id=id, + _param = self._ai_mentor_orgs_users_mentors_settings_update_serialize( + mentor=mentor, org=org, user_id=user_id, - periodic_agent_create=periodic_agent_create, + mentor_settings_request=mentor_settings_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6269,7 +6036,7 @@ def ai_mentor_orgs_users_periodic_agents_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PeriodicAgentCreate", + '200': "MentorSettings", } response_data = self.api_client.call_api( *_param, @@ -6278,12 +6045,12 @@ def ai_mentor_orgs_users_periodic_agents_update( return response_data.response - def _ai_mentor_orgs_users_periodic_agents_update_serialize( + def _ai_mentor_orgs_users_mentors_settings_update_serialize( self, - id, + mentor, org, user_id, - periodic_agent_create, + mentor_settings_request, _request_auth, _content_type, _headers, @@ -6303,8 +6070,8 @@ def _ai_mentor_orgs_users_periodic_agents_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if mentor is not None: + _path_params['mentor'] = mentor if org is not None: _path_params['org'] = org if user_id is not None: @@ -6313,8 +6080,8 @@ def _ai_mentor_orgs_users_periodic_agents_update_serialize( # process the header parameters # process the form parameters # process the body parameter - if periodic_agent_create is not None: - _body_params = periodic_agent_create + if mentor_settings_request is not None: + _body_params = mentor_settings_request # set the HTTP header `Accept` @@ -6348,7 +6115,7 @@ def _ai_mentor_orgs_users_periodic_agents_update_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/settings/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6365,11 +6132,10 @@ def _ai_mentor_orgs_users_periodic_agents_update_serialize( @validate_call - def ai_mentor_orgs_users_pin_message_create( + def ai_mentor_orgs_users_metadata_retrieve( self, org: StrictStr, user_id: StrictStr, - pinned_message_request: PinnedMessageRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6383,16 +6149,14 @@ def ai_mentor_orgs_users_pin_message_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_pin_message_create + """ai_mentor_orgs_users_metadata_retrieve - Endpoint to create a pinned message Accessible to both tenant admins and student + Endpoint for getting mentor metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"mentor\": \"testing\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param pinned_message_request: (required) - :type pinned_message_request: PinnedMessageRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -6415,10 +6179,9 @@ def ai_mentor_orgs_users_pin_message_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_pin_message_create_serialize( + _param = self._ai_mentor_orgs_users_metadata_retrieve_serialize( org=org, user_id=user_id, - pinned_message_request=pinned_message_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6426,7 +6189,7 @@ def ai_mentor_orgs_users_pin_message_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PinnedMessageCreate", + '200': "MentorMetadata", } response_data = self.api_client.call_api( *_param, @@ -6435,11 +6198,10 @@ def ai_mentor_orgs_users_pin_message_create( return response_data.response - def _ai_mentor_orgs_users_pin_message_create_serialize( + def _ai_mentor_orgs_users_metadata_retrieve_serialize( self, org, user_id, - pinned_message_request, _request_auth, _content_type, _headers, @@ -6467,8 +6229,6 @@ def _ai_mentor_orgs_users_pin_message_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if pinned_message_request is not None: - _body_params = pinned_message_request # set the HTTP header `Accept` @@ -6479,21 +6239,6 @@ def _ai_mentor_orgs_users_pin_message_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -6501,8 +6246,8 @@ def _ai_mentor_orgs_users_pin_message_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/metadata', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6519,8 +6264,9 @@ def _ai_mentor_orgs_users_pin_message_create_serialize( @validate_call - def ai_mentor_orgs_users_pin_message_destroy( + def ai_mentor_orgs_users_moderation_logs_destroy( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this moderation log.")], org: StrictStr, user_id: StrictStr, _request_timeout: Union[ @@ -6536,10 +6282,12 @@ def ai_mentor_orgs_users_pin_message_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_pin_message_destroy + """ai_mentor_orgs_users_moderation_logs_destroy - Endpoint to delete a pinned message Accessible to both tenant admins and student + Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + :param id: A unique integer value identifying this moderation log. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) @@ -6566,7 +6314,8 @@ def ai_mentor_orgs_users_pin_message_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_pin_message_destroy_serialize( + _param = self._ai_mentor_orgs_users_moderation_logs_destroy_serialize( + id=id, org=org, user_id=user_id, _request_auth=_request_auth, @@ -6585,8 +6334,9 @@ def ai_mentor_orgs_users_pin_message_destroy( return response_data.response - def _ai_mentor_orgs_users_pin_message_destroy_serialize( + def _ai_mentor_orgs_users_moderation_logs_destroy_serialize( self, + id, org, user_id, _request_auth, @@ -6608,6 +6358,8 @@ def _ai_mentor_orgs_users_pin_message_destroy_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -6627,7 +6379,7 @@ def _ai_mentor_orgs_users_pin_message_destroy_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6644,10 +6396,18 @@ def _ai_mentor_orgs_users_pin_message_destroy_serialize( @validate_call - def ai_mentor_orgs_users_pin_message_retrieve( + def ai_mentor_orgs_users_moderation_logs_list( self, org: StrictStr, user_id: StrictStr, + mentor: Optional[StrictInt] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + platform_key: Optional[StrictStr] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + target_system: Annotated[Optional[StrictStr], Field(description="* `Safety System` - Safety System * `Moderation System` - Moderation System")] = None, + username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6661,14 +6421,30 @@ def ai_mentor_orgs_users_pin_message_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_pin_message_retrieve + """ai_mentor_orgs_users_moderation_logs_list - Endpoint to get a pinned message Accessible to both tenant admins and student + Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param mentor: + :type mentor: int + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param platform_key: + :type platform_key: str + :param search: A search term. + :type search: str + :param target_system: * `Safety System` - Safety System * `Moderation System` - Moderation System + :type target_system: str + :param username: + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -6691,9 +6467,17 @@ def ai_mentor_orgs_users_pin_message_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_pin_message_retrieve_serialize( + _param = self._ai_mentor_orgs_users_moderation_logs_list_serialize( org=org, user_id=user_id, + mentor=mentor, + ordering=ordering, + page=page, + page_size=page_size, + platform_key=platform_key, + search=search, + target_system=target_system, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6701,7 +6485,7 @@ def ai_mentor_orgs_users_pin_message_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PinnedMessageCreate", + '200': "PaginatedModerationLogList", } response_data = self.api_client.call_api( *_param, @@ -6710,10 +6494,18 @@ def ai_mentor_orgs_users_pin_message_retrieve( return response_data.response - def _ai_mentor_orgs_users_pin_message_retrieve_serialize( + def _ai_mentor_orgs_users_moderation_logs_list_serialize( self, org, user_id, + mentor, + ordering, + page, + page_size, + platform_key, + search, + target_system, + username, _request_auth, _content_type, _headers, @@ -6738,6 +6530,38 @@ def _ai_mentor_orgs_users_pin_message_retrieve_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if mentor is not None: + + _query_params.append(('mentor', mentor)) + + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + + if search is not None: + + _query_params.append(('search', search)) + + if target_system is not None: + + _query_params.append(('target_system', target_system)) + + if username is not None: + + _query_params.append(('username', username)) + # process the header parameters # process the form parameters # process the body parameter @@ -6759,7 +6583,7 @@ def _ai_mentor_orgs_users_pin_message_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6776,16 +6600,11 @@ def _ai_mentor_orgs_users_pin_message_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_planned_jobs_list( + def ai_mentor_orgs_users_moderation_logs_retrieve( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this moderation log.")], org: StrictStr, user_id: StrictStr, - active: Optional[StrictBool] = None, - ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, - session: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6799,26 +6618,16 @@ def ai_mentor_orgs_users_planned_jobs_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_planned_jobs_list + """ai_mentor_orgs_users_moderation_logs_retrieve - Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time. + Endpoint to view and delete Moderation Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + :param id: A unique integer value identifying this moderation log. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param active: - :type active: bool - :param ordering: Which field to use when ordering the results. - :type ordering: str - :param page: A page number within the paginated result set. - :type page: int - :param page_size: Number of results to return per page. - :type page_size: int - :param search: A search term. - :type search: str - :param session: - :type session: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -6841,15 +6650,10 @@ def ai_mentor_orgs_users_planned_jobs_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_planned_jobs_list_serialize( + _param = self._ai_mentor_orgs_users_moderation_logs_retrieve_serialize( + id=id, org=org, user_id=user_id, - active=active, - ordering=ordering, - page=page, - page_size=page_size, - search=search, - session=session, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6857,7 +6661,7 @@ def ai_mentor_orgs_users_planned_jobs_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedJobRunList", + '200': "ModerationLog", } response_data = self.api_client.call_api( *_param, @@ -6866,16 +6670,11 @@ def ai_mentor_orgs_users_planned_jobs_list( return response_data.response - def _ai_mentor_orgs_users_planned_jobs_list_serialize( + def _ai_mentor_orgs_users_moderation_logs_retrieve_serialize( self, + id, org, user_id, - active, - ordering, - page, - page_size, - search, - session, _request_auth, _content_type, _headers, @@ -6895,35 +6694,13 @@ def _ai_mentor_orgs_users_planned_jobs_list_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if active is not None: - - _query_params.append(('active', active)) - - if ordering is not None: - - _query_params.append(('ordering', ordering)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if search is not None: - - _query_params.append(('search', search)) - - if session is not None: - - _query_params.append(('session', session)) - # process the header parameters # process the form parameters # process the body parameter @@ -6945,7 +6722,7 @@ def _ai_mentor_orgs_users_planned_jobs_list_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/moderation-logs/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6962,11 +6739,17 @@ def _ai_mentor_orgs_users_planned_jobs_list_serialize( @validate_call - def ai_mentor_orgs_users_planned_jobs_retrieve( + def ai_mentor_orgs_users_partial_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this job run.")], + name: StrictStr, org: StrictStr, user_id: StrictStr, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, + metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, + patched_mentor: Optional[PatchedMentor] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6980,16 +6763,28 @@ def ai_mentor_orgs_users_planned_jobs_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_planned_jobs_retrieve + """ai_mentor_orgs_users_partial_update - Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time. + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - :param id: A unique integer value identifying this job run. (required) - :type id: int + :param name: (required) + :type name: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str + :param metadata_key: Metadata key to be queried with + :type metadata_key: str + :param metadata_value: Metadata value to be filter for + :type metadata_value: str + :param return_session_information: Declares if session information should be included in the mentor data + :type return_session_information: bool + :param visibility: visibility type to be queried with + :type visibility: str + :param patched_mentor: + :type patched_mentor: PatchedMentor :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7012,10 +6807,16 @@ def ai_mentor_orgs_users_planned_jobs_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_planned_jobs_retrieve_serialize( - id=id, + _param = self._ai_mentor_orgs_users_partial_update_serialize( + name=name, org=org, user_id=user_id, + filter_by=filter_by, + metadata_key=metadata_key, + metadata_value=metadata_value, + return_session_information=return_session_information, + visibility=visibility, + patched_mentor=patched_mentor, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7023,7 +6824,7 @@ def ai_mentor_orgs_users_planned_jobs_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "JobRun", + '200': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -7032,13 +6833,2581 @@ def ai_mentor_orgs_users_planned_jobs_retrieve( return response_data.response - def _ai_mentor_orgs_users_planned_jobs_retrieve_serialize( + def _ai_mentor_orgs_users_partial_update_serialize( self, - id, + name, org, user_id, - _request_auth, - _content_type, + filter_by, + metadata_key, + metadata_value, + return_session_information, + visibility, + patched_mentor, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if name is not None: + _path_params['name'] = name + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if metadata_key is not None: + + _query_params.append(('metadata_key', metadata_key)) + + if metadata_value is not None: + + _query_params.append(('metadata_value', metadata_value)) + + if return_session_information is not None: + + _query_params.append(('return_session_information', return_session_information)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + + # process the header parameters + # process the form parameters + # process the body parameter + if patched_mentor is not None: + _body_params = patched_mentor + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agent_logs_list( + self, + org: StrictStr, + user_id: StrictStr, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + parent_mentor_id: Optional[StrictStr] = None, + parent_session_id: Optional[StrictStr] = None, + periodic_agent: Optional[StrictInt] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + status: Annotated[Optional[StrictStr], Field(description="* `success` - Success * `error` - Error * `running` - Running")] = None, + username: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agent_logs_list + + Endpoint to view logs for periodic agent runs. These logs contain the full mentor output for each run for debugging. Logs are ordered from newest to oldest. However this can be changed. You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param parent_mentor_id: + :type parent_mentor_id: str + :param parent_session_id: + :type parent_session_id: str + :param periodic_agent: + :type periodic_agent: int + :param search: A search term. + :type search: str + :param status: * `success` - Success * `error` - Error * `running` - Running + :type status: str + :param username: + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agent_logs_list_serialize( + org=org, + user_id=user_id, + ordering=ordering, + page=page, + page_size=page_size, + parent_mentor_id=parent_mentor_id, + parent_session_id=parent_session_id, + periodic_agent=periodic_agent, + search=search, + status=status, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaginatedPeriodicAgentLogList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agent_logs_list_serialize( + self, + org, + user_id, + ordering, + page, + page_size, + parent_mentor_id, + parent_session_id, + periodic_agent, + search, + status, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if parent_mentor_id is not None: + + _query_params.append(('parent_mentor_id', parent_mentor_id)) + + if parent_session_id is not None: + + _query_params.append(('parent_session_id', parent_session_id)) + + if periodic_agent is not None: + + _query_params.append(('periodic_agent', periodic_agent)) + + if search is not None: + + _query_params.append(('search', search)) + + if status is not None: + + _query_params.append(('status', status)) + + if username is not None: + + _query_params.append(('username', username)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agent_logs_retrieve( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent log.")], + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agent_logs_retrieve + + Endpoint to view logs for periodic agent runs. These logs contain the full mentor output for each run for debugging. Logs are ordered from newest to oldest. However this can be changed. You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL. + + :param id: A unique integer value identifying this periodic agent log. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( + id=id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodicAgentLog", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agent_logs_retrieve_serialize( + self, + id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agent-logs/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_create( + self, + org: StrictStr, + user_id: StrictStr, + periodic_agent_create: PeriodicAgentCreate, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_create + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param periodic_agent_create: (required) + :type periodic_agent_create: PeriodicAgentCreate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_create_serialize( + org=org, + user_id=user_id, + periodic_agent_create=periodic_agent_create, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PeriodicAgentCreate", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_create_serialize( + self, + org, + user_id, + periodic_agent_create, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if periodic_agent_create is not None: + _body_params = periodic_agent_create + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_destroy( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_destroy + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param id: A unique integer value identifying this periodic agent. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_destroy_serialize( + id=id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_destroy_serialize( + self, + id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_list( + self, + org: StrictStr, + user_id: StrictStr, + enabled: Optional[StrictBool] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + parent_mentor_id: Optional[StrictInt] = None, + parent_session_id: Optional[StrictStr] = None, + previous_agent: Optional[StrictInt] = None, + previous_agent_status: Annotated[Optional[StrictStr], Field(description="The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending")] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + status: Annotated[Optional[StrictStr], Field(description="* `success` - Success * `error` - Error * `running` - Running * `pending` - Pending")] = None, + title: Optional[StrictStr] = None, + username: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_list + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param enabled: + :type enabled: bool + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param parent_mentor_id: + :type parent_mentor_id: int + :param parent_session_id: + :type parent_session_id: str + :param previous_agent: + :type previous_agent: int + :param previous_agent_status: The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending + :type previous_agent_status: str + :param search: A search term. + :type search: str + :param status: * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending + :type status: str + :param title: + :type title: str + :param username: + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_list_serialize( + org=org, + user_id=user_id, + enabled=enabled, + ordering=ordering, + page=page, + page_size=page_size, + parent_mentor_id=parent_mentor_id, + parent_session_id=parent_session_id, + previous_agent=previous_agent, + previous_agent_status=previous_agent_status, + search=search, + status=status, + title=title, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaginatedPeriodicAgentList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_list_serialize( + self, + org, + user_id, + enabled, + ordering, + page, + page_size, + parent_mentor_id, + parent_session_id, + previous_agent, + previous_agent_status, + search, + status, + title, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if enabled is not None: + + _query_params.append(('enabled', enabled)) + + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if parent_mentor_id is not None: + + _query_params.append(('parent_mentor_id', parent_mentor_id)) + + if parent_session_id is not None: + + _query_params.append(('parent_session_id', parent_session_id)) + + if previous_agent is not None: + + _query_params.append(('previous_agent', previous_agent)) + + if previous_agent_status is not None: + + _query_params.append(('previous_agent_status', previous_agent_status)) + + if search is not None: + + _query_params.append(('search', search)) + + if status is not None: + + _query_params.append(('status', status)) + + if title is not None: + + _query_params.append(('title', title)) + + if username is not None: + + _query_params.append(('username', username)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_partial_update( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + org: StrictStr, + user_id: StrictStr, + patched_periodic_agent_create: Optional[PatchedPeriodicAgentCreate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_partial_update + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param id: A unique integer value identifying this periodic agent. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param patched_periodic_agent_create: + :type patched_periodic_agent_create: PatchedPeriodicAgentCreate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_partial_update_serialize( + id=id, + org=org, + user_id=user_id, + patched_periodic_agent_create=patched_periodic_agent_create, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodicAgentCreate", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_partial_update_serialize( + self, + id, + org, + user_id, + patched_periodic_agent_create, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if patched_periodic_agent_create is not None: + _body_params = patched_periodic_agent_create + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_retrieve( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_retrieve + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param id: A unique integer value identifying this periodic agent. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_retrieve_serialize( + id=id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodicAgent", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_retrieve_serialize( + self, + id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_periodic_agents_update( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this periodic agent.")], + org: StrictStr, + user_id: StrictStr, + periodic_agent_create: PeriodicAgentCreate, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_periodic_agents_update + + Endpoint to create and view, update and delete periodic agents. Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any) as well as a cron schedule to trigger the periodic agent. Access to these are restricted to platform admins and tenant administrators Session information for running the periodic agent will be generated with the credentials of the user (platform administrator) who created the agent. A Periodic Agent is allowed to have a `callback_url` and `callback_secret`. When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp of the run will be made to the callback_url provided. Here is the payload structure: ``` { \"timestamp\": \"timestamp when the run completed\", \"status\": \"status of the periodic agent\", \"prompt\": \"input prompt to agent, \"agent_output\": \"...final response of agent\", \"log\": \"... full agent run log\", \"log_id\": periodic agent log id., } ``` The payload is encrypted using the `callback_secret` provided. You can validate the payload using the X-Hub-Signature-256 signature header for request data. This is a Sha256 encoded HMAC hex digest of the payload body. ```python import hmac import haslib def validate_payload(request: HttpRequest, callback_secret: str): # Get the X-Hub-Signature-256 header from the request received_signature = request.META.get(\"HTTP_X_HUB_SIGNATURE_256\", \"\") if not received_signature.startswith(\"sha256=\"): # Invalid signature format return False received_signature = received_signature[len(\"sha256=\") :] try: # Get the raw request body payload = request.body # Compute the expected signature using the app_secret expected_signature = hmac.new( callback_secret.encode(), payload, hashlib.sha256 ).hexdigest() if hmac.compare_digest(received_signature, expected_signature): # Signatures match, the payload is genuine return True else: # Signatures don't match return False except Exception as e: # Handle any errors that may occur during validation return False ``` + + :param id: A unique integer value identifying this periodic agent. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param periodic_agent_create: (required) + :type periodic_agent_create: PeriodicAgentCreate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_periodic_agents_update_serialize( + id=id, + org=org, + user_id=user_id, + periodic_agent_create=periodic_agent_create, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodicAgentCreate", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_periodic_agents_update_serialize( + self, + id, + org, + user_id, + periodic_agent_create, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if periodic_agent_create is not None: + _body_params = periodic_agent_create + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/periodic-agents/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_pin_message_create( + self, + org: StrictStr, + user_id: StrictStr, + pinned_message_request: PinnedMessageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_pin_message_create + + Endpoint to create a pinned message Accessible to both tenant admins and student + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param pinned_message_request: (required) + :type pinned_message_request: PinnedMessageRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_pin_message_create_serialize( + org=org, + user_id=user_id, + pinned_message_request=pinned_message_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PinnedMessageCreate", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_pin_message_create_serialize( + self, + org, + user_id, + pinned_message_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if pinned_message_request is not None: + _body_params = pinned_message_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_pin_message_destroy( + self, + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_pin_message_destroy + + Endpoint to delete a pinned message Accessible to both tenant admins and student + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_pin_message_destroy_serialize( + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_pin_message_destroy_serialize( + self, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_pin_message_retrieve( + self, + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_pin_message_retrieve + + Endpoint to get a pinned message Accessible to both tenant admins and student + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_pin_message_retrieve_serialize( + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PinnedMessageCreate", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_pin_message_retrieve_serialize( + self, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/pin-message/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_planned_jobs_list( + self, + org: StrictStr, + user_id: StrictStr, + active: Optional[StrictBool] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + session: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_planned_jobs_list + + Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param active: + :type active: bool + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param search: A search term. + :type search: str + :param session: + :type session: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_planned_jobs_list_serialize( + org=org, + user_id=user_id, + active=active, + ordering=ordering, + page=page, + page_size=page_size, + search=search, + session=session, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaginatedJobRunList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_planned_jobs_list_serialize( + self, + org, + user_id, + active, + ordering, + page, + page_size, + search, + session, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if active is not None: + + _query_params.append(('active', active)) + + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if search is not None: + + _query_params.append(('search', search)) + + if session is not None: + + _query_params.append(('session', session)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_planned_jobs_retrieve( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this job run.")], + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_planned_jobs_retrieve + + Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time. + + :param id: A unique integer value identifying this job run. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_planned_jobs_retrieve_serialize( + id=id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JobRun", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_planned_jobs_retrieve_serialize( + self, + id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_playwright_scripts_create( + self, + org: StrictStr, + user_id: StrictStr, + play_wright_script: PlayWrightScript, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_playwright_scripts_create + + Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param play_wright_script: (required) + :type play_wright_script: PlayWrightScript + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_playwright_scripts_create_serialize( + org=org, + user_id=user_id, + play_wright_script=play_wright_script, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PlayWrightScript", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_playwright_scripts_create_serialize( + self, + org, + user_id, + play_wright_script, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if play_wright_script is not None: + _body_params = play_wright_script + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_playwright_scripts_destroy( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_playwright_scripts_destroy + + Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + + :param id: A unique integer value identifying this play wright script. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_playwright_scripts_destroy_serialize( + id=id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_playwright_scripts_destroy_serialize( + self, + id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_mentor_orgs_users_playwright_scripts_list( + self, + org: StrictStr, + user_id: StrictStr, + is_public: Optional[StrictBool] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + student: Annotated[Optional[StrictInt], Field(description="edX user ID")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_mentor_orgs_users_playwright_scripts_list + + Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param is_public: + :type is_public: bool + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param search: A search term. + :type search: str + :param student: edX user ID + :type student: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_mentor_orgs_users_playwright_scripts_list_serialize( + org=org, + user_id=user_id, + is_public=is_public, + ordering=ordering, + page=page, + page_size=page_size, + search=search, + student=student, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaginatedPlayWrightScriptList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_mentor_orgs_users_playwright_scripts_list_serialize( + self, + org, + user_id, + is_public, + ordering, + page, + page_size, + search, + student, + _request_auth, + _content_type, _headers, _host_index, ) -> RequestSerialized: @@ -7056,13 +9425,35 @@ def _ai_mentor_orgs_users_planned_jobs_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if is_public is not None: + + _query_params.append(('is_public', is_public)) + + if ordering is not None: + + _query_params.append(('ordering', ordering)) + + if page is not None: + + _query_params.append(('page', page)) + + if page_size is not None: + + _query_params.append(('page_size', page_size)) + + if search is not None: + + _query_params.append(('search', search)) + + if student is not None: + + _query_params.append(('student', student)) + # process the header parameters # process the form parameters # process the body parameter @@ -7084,7 +9475,7 @@ def _ai_mentor_orgs_users_planned_jobs_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/{id}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7101,11 +9492,12 @@ def _ai_mentor_orgs_users_planned_jobs_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_create( + def ai_mentor_orgs_users_playwright_scripts_partial_update( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, user_id: StrictStr, - play_wright_script: PlayWrightScript, + patched_play_wright_script: Optional[PatchedPlayWrightScript] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7119,16 +9511,18 @@ def ai_mentor_orgs_users_playwright_scripts_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_create + """ai_mentor_orgs_users_playwright_scripts_partial_update Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + :param id: A unique integer value identifying this play wright script. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param play_wright_script: (required) - :type play_wright_script: PlayWrightScript + :param patched_play_wright_script: + :type patched_play_wright_script: PatchedPlayWrightScript :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7151,10 +9545,11 @@ def ai_mentor_orgs_users_playwright_scripts_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_create_serialize( + _param = self._ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( + id=id, org=org, user_id=user_id, - play_wright_script=play_wright_script, + patched_play_wright_script=patched_play_wright_script, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7162,7 +9557,7 @@ def ai_mentor_orgs_users_playwright_scripts_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "PlayWrightScript", + '200': "PlayWrightScript", } response_data = self.api_client.call_api( *_param, @@ -7171,11 +9566,12 @@ def ai_mentor_orgs_users_playwright_scripts_create( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_create_serialize( + def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( self, + id, org, user_id, - play_wright_script, + patched_play_wright_script, _request_auth, _content_type, _headers, @@ -7195,6 +9591,8 @@ def _ai_mentor_orgs_users_playwright_scripts_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -7203,8 +9601,8 @@ def _ai_mentor_orgs_users_playwright_scripts_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if play_wright_script is not None: - _body_params = play_wright_script + if patched_play_wright_script is not None: + _body_params = patched_play_wright_script # set the HTTP header `Accept` @@ -7237,8 +9635,8 @@ def _ai_mentor_orgs_users_playwright_scripts_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/', + method='PATCH', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7255,7 +9653,7 @@ def _ai_mentor_orgs_users_playwright_scripts_create_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_destroy( + def ai_mentor_orgs_users_playwright_scripts_retrieve( self, id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, @@ -7273,7 +9671,7 @@ def ai_mentor_orgs_users_playwright_scripts_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_destroy + """ai_mentor_orgs_users_playwright_scripts_retrieve Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. @@ -7305,7 +9703,7 @@ def ai_mentor_orgs_users_playwright_scripts_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_destroy_serialize( + _param = self._ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( id=id, org=org, user_id=user_id, @@ -7316,7 +9714,7 @@ def ai_mentor_orgs_users_playwright_scripts_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "PlayWrightScript", } response_data = self.api_client.call_api( *_param, @@ -7325,7 +9723,7 @@ def ai_mentor_orgs_users_playwright_scripts_destroy( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_destroy_serialize( + def _ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( self, id, org, @@ -7361,6 +9759,13 @@ def _ai_mentor_orgs_users_playwright_scripts_destroy_serialize( # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -7369,7 +9774,7 @@ def _ai_mentor_orgs_users_playwright_scripts_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', + method='GET', resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', path_params=_path_params, query_params=_query_params, @@ -7387,16 +9792,12 @@ def _ai_mentor_orgs_users_playwright_scripts_destroy_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_list( + def ai_mentor_orgs_users_playwright_scripts_update( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, user_id: StrictStr, - is_public: Optional[StrictBool] = None, - ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, - search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, - student: Annotated[Optional[StrictInt], Field(description="edX user ID")] = None, + play_wright_script: PlayWrightScript, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7410,26 +9811,18 @@ def ai_mentor_orgs_users_playwright_scripts_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_list + """ai_mentor_orgs_users_playwright_scripts_update Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + :param id: A unique integer value identifying this play wright script. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param is_public: - :type is_public: bool - :param ordering: Which field to use when ordering the results. - :type ordering: str - :param page: A page number within the paginated result set. - :type page: int - :param page_size: Number of results to return per page. - :type page_size: int - :param search: A search term. - :type search: str - :param student: edX user ID - :type student: int + :param play_wright_script: (required) + :type play_wright_script: PlayWrightScript :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7452,15 +9845,11 @@ def ai_mentor_orgs_users_playwright_scripts_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_list_serialize( + _param = self._ai_mentor_orgs_users_playwright_scripts_update_serialize( + id=id, org=org, user_id=user_id, - is_public=is_public, - ordering=ordering, - page=page, - page_size=page_size, - search=search, - student=student, + play_wright_script=play_wright_script, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7468,7 +9857,7 @@ def ai_mentor_orgs_users_playwright_scripts_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PaginatedPlayWrightScriptList", + '200': "PlayWrightScript", } response_data = self.api_client.call_api( *_param, @@ -7477,16 +9866,12 @@ def ai_mentor_orgs_users_playwright_scripts_list( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_list_serialize( + def _ai_mentor_orgs_users_playwright_scripts_update_serialize( self, + id, org, user_id, - is_public, - ordering, - page, - page_size, - search, - student, + play_wright_script, _request_auth, _content_type, _headers, @@ -7506,38 +9891,18 @@ def _ai_mentor_orgs_users_playwright_scripts_list_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if is_public is not None: - - _query_params.append(('is_public', is_public)) - - if ordering is not None: - - _query_params.append(('ordering', ordering)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if search is not None: - - _query_params.append(('search', search)) - - if student is not None: - - _query_params.append(('student', student)) - # process the header parameters # process the form parameters # process the body parameter + if play_wright_script is not None: + _body_params = play_wright_script # set the HTTP header `Accept` @@ -7548,6 +9913,21 @@ def _ai_mentor_orgs_users_playwright_scripts_list_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -7555,8 +9935,8 @@ def _ai_mentor_orgs_users_playwright_scripts_list_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/', + method='PUT', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7573,12 +9953,11 @@ def _ai_mentor_orgs_users_playwright_scripts_list_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_partial_update( + def ai_mentor_orgs_users_predictive_analytics_create( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, user_id: StrictStr, - patched_play_wright_script: Optional[PatchedPlayWrightScript] = None, + predictive_analytics_request: PredictiveAnalyticsRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7592,18 +9971,16 @@ def ai_mentor_orgs_users_playwright_scripts_partial_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_partial_update + """ai_mentor_orgs_users_predictive_analytics_create - Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + This is for getting predictive analytics. Accessible to tenant admins only. Returns: 200 : Object of List of predicted data. 400 : When ai response can not be loaded to json. 404: When OpenAI key for tenant is not set. 429: When OpenAI request have exceeded the rate limit. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/ Requests: { \"prompt\": { \"data_variables\": [ { \"variable_name\": \"registered_users\", \"data_set\": { \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, \"2023-10-09\": 5, \"2023-10-10\": 4 }, \"number_of_data_points\": 5 }, { \"variable_name\": \"courses_enrolled\", \"data_set\": { \"2023-08-09\": 0, \"2023-08-10\": 0, \"2023-08-11\": 0, \"2023-08-12\": 0, \"2023-08-13\": 0 }, \"number_of_data_points\": 6 }, { \"variable_name\": \"completed_courses\", \"data_set\": { \"2023-10-04\": 0, \"2023-10-05\": 4, \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, }, \"number_of_data_points\": 5 } ] } } Response: { \"predictions\": [ { \"variable_name\": \"registered_users\", \"predicted_data\": { \"2023-10-11\": 2, \"2023-10-12\": 2, \"2023-10-13\": 1, \"2023-10-14\": 1, \"2023-10-15\": 1 }, \"narrative\": \"The number of registered users has been relatively stable with some fluctuations. There is a slight increase in the number of registered users over time.\" }, { \"variable_name\": \"courses_enrolled\", \"predicted_data\": { \"2023-10-09\": 0, \"2023-10-10\": 0, \"2023-10-11\": 0, \"2023-10-12\": 0, \"2023-10-13\": 0 }, \"narrative\": \"No courses have been enrolled recently, indicating a decline in enrollment. It is expected that the number of courses enrolled will remain at 0 for the next 31 data points.\" }, { \"variable_name\": \"completed_courses\", \"predicted_data\": { \"2023-10-10\": 4, \"2023-10-11\": 4, \"2023-10-12\": 4, \"2023-10-13\": 4, \"2023-10-14\": 4 }, \"narrative\": \"The number of completed courses has remained constant at 4. There is no indication of any change in the near future.\" } ] } - :param id: A unique integer value identifying this play wright script. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param patched_play_wright_script: - :type patched_play_wright_script: PatchedPlayWrightScript + :param predictive_analytics_request: (required) + :type predictive_analytics_request: PredictiveAnalyticsRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7626,11 +10003,10 @@ def ai_mentor_orgs_users_playwright_scripts_partial_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( - id=id, + _param = self._ai_mentor_orgs_users_predictive_analytics_create_serialize( org=org, user_id=user_id, - patched_play_wright_script=patched_play_wright_script, + predictive_analytics_request=predictive_analytics_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7638,7 +10014,7 @@ def ai_mentor_orgs_users_playwright_scripts_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlayWrightScript", + '200': "PredictiveAnalyticsResponse", } response_data = self.api_client.call_api( *_param, @@ -7647,12 +10023,11 @@ def ai_mentor_orgs_users_playwright_scripts_partial_update( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( + def _ai_mentor_orgs_users_predictive_analytics_create_serialize( self, - id, org, user_id, - patched_play_wright_script, + predictive_analytics_request, _request_auth, _content_type, _headers, @@ -7672,8 +10047,6 @@ def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: @@ -7682,8 +10055,8 @@ def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( # process the header parameters # process the form parameters # process the body parameter - if patched_play_wright_script is not None: - _body_params = patched_play_wright_script + if predictive_analytics_request is not None: + _body_params = predictive_analytics_request # set the HTTP header `Accept` @@ -7716,8 +10089,8 @@ def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( ] return self.api_client.param_serialize( - method='PATCH', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', + method='POST', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/predictive-analytics/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7734,11 +10107,11 @@ def _ai_mentor_orgs_users_playwright_scripts_partial_update_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_retrieve( + def ai_mentor_orgs_users_recent_messages_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, user_id: StrictStr, + mentor: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Name or slug of the mentor")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7752,16 +10125,16 @@ def ai_mentor_orgs_users_playwright_scripts_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_retrieve + """ai_mentor_orgs_users_recent_messages_retrieve - Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + Get chat messages - :param id: A unique integer value identifying this play wright script. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param mentor: Name or slug of the mentor + :type mentor: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7784,10 +10157,10 @@ def ai_mentor_orgs_users_playwright_scripts_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( - id=id, + _param = self._ai_mentor_orgs_users_recent_messages_retrieve_serialize( org=org, user_id=user_id, + mentor=mentor, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7795,7 +10168,7 @@ def ai_mentor_orgs_users_playwright_scripts_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlayWrightScript", + '200': "ChatSessionWithMessage", } response_data = self.api_client.call_api( *_param, @@ -7804,11 +10177,11 @@ def ai_mentor_orgs_users_playwright_scripts_retrieve( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( + def _ai_mentor_orgs_users_recent_messages_retrieve_serialize( self, - id, org, user_id, + mentor, _request_auth, _content_type, _headers, @@ -7828,13 +10201,15 @@ def _ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if mentor is not None: + + _query_params.append(('mentor', mentor)) + # process the header parameters # process the form parameters # process the body parameter @@ -7856,7 +10231,7 @@ def _ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recent-messages/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7873,12 +10248,16 @@ def _ai_mentor_orgs_users_playwright_scripts_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_playwright_scripts_update( + def ai_mentor_orgs_users_recommend_courses_block_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this play wright script.")], org: StrictStr, user_id: StrictStr, - play_wright_script: PlayWrightScript, + include_learner_skills: Annotated[Optional[StrictBool], Field(description="Include available learner skills for search")] = None, + include_main_courses: Annotated[Optional[StrictBool], Field(description="Include courses from the main tenant")] = None, + rank_by_difficulty: Annotated[Optional[StrictBool], Field(description="Rank by course difficulty")] = None, + return_course_data: Annotated[Optional[StrictBool], Field(description="Return course data")] = None, + return_number: Annotated[Optional[StrictInt], Field(description="Number of courses to return")] = None, + search_terms: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Terms to be searched")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7892,18 +10271,26 @@ def ai_mentor_orgs_users_playwright_scripts_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_playwright_scripts_update + """ai_mentor_orgs_users_recommend_courses_block_retrieve - Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user. + Endpoint to get recomended course blocks. Accessible to tenant admins and students. By default, it uses course from the main tenant for recommedations. More information about the course is returned when return_couse_data is set to true Returns: 200: List of recommended course. 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/johndoe/recommend-courses-block/?return_course_data=false&&include_main_courses=true Response: { \"blocks\": [ { \"id\": \"course-v1:ACI+500+957\" }, ] } - :param id: A unique integer value identifying this play wright script. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param play_wright_script: (required) - :type play_wright_script: PlayWrightScript + :param include_learner_skills: Include available learner skills for search + :type include_learner_skills: bool + :param include_main_courses: Include courses from the main tenant + :type include_main_courses: bool + :param rank_by_difficulty: Rank by course difficulty + :type rank_by_difficulty: bool + :param return_course_data: Return course data + :type return_course_data: bool + :param return_number: Number of courses to return + :type return_number: int + :param search_terms: Terms to be searched + :type search_terms: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -7926,11 +10313,15 @@ def ai_mentor_orgs_users_playwright_scripts_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_playwright_scripts_update_serialize( - id=id, + _param = self._ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( org=org, user_id=user_id, - play_wright_script=play_wright_script, + include_learner_skills=include_learner_skills, + include_main_courses=include_main_courses, + rank_by_difficulty=rank_by_difficulty, + return_course_data=return_course_data, + return_number=return_number, + search_terms=search_terms, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7938,7 +10329,7 @@ def ai_mentor_orgs_users_playwright_scripts_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlayWrightScript", + '200': "RecommendCourseResponse", } response_data = self.api_client.call_api( *_param, @@ -7947,12 +10338,16 @@ def ai_mentor_orgs_users_playwright_scripts_update( return response_data.response - def _ai_mentor_orgs_users_playwright_scripts_update_serialize( + def _ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( self, - id, org, user_id, - play_wright_script, + include_learner_skills, + include_main_courses, + rank_by_difficulty, + return_course_data, + return_number, + search_terms, _request_auth, _content_type, _headers, @@ -7972,18 +10367,38 @@ def _ai_mentor_orgs_users_playwright_scripts_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if include_learner_skills is not None: + + _query_params.append(('include_learner_skills', include_learner_skills)) + + if include_main_courses is not None: + + _query_params.append(('include_main_courses', include_main_courses)) + + if rank_by_difficulty is not None: + + _query_params.append(('rank_by_difficulty', rank_by_difficulty)) + + if return_course_data is not None: + + _query_params.append(('return_course_data', return_course_data)) + + if return_number is not None: + + _query_params.append(('return_number', return_number)) + + if search_terms is not None: + + _query_params.append(('search_terms', search_terms)) + # process the header parameters # process the form parameters # process the body parameter - if play_wright_script is not None: - _body_params = play_wright_script # set the HTTP header `Accept` @@ -7994,21 +10409,6 @@ def _ai_mentor_orgs_users_playwright_scripts_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -8016,8 +10416,8 @@ def _ai_mentor_orgs_users_playwright_scripts_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/{id}/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses-block/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8034,11 +10434,16 @@ def _ai_mentor_orgs_users_playwright_scripts_update_serialize( @validate_call - def ai_mentor_orgs_users_predictive_analytics_create( + def ai_mentor_orgs_users_recommend_courses_retrieve( self, org: StrictStr, user_id: StrictStr, - predictive_analytics_request: PredictiveAnalyticsRequest, + include_learner_skills: Annotated[Optional[StrictBool], Field(description="Include available learner skills for search")] = None, + include_main_courses: Annotated[Optional[StrictBool], Field(description="Include courses from the main tenant")] = None, + rank_by_difficulty: Annotated[Optional[StrictBool], Field(description="Rank by course difficulty")] = None, + return_course_data: Annotated[Optional[StrictBool], Field(description="Return course data")] = None, + return_number: Annotated[Optional[StrictInt], Field(description="Number of courses to return")] = None, + search_terms: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Terms to be searched")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8052,16 +10457,26 @@ def ai_mentor_orgs_users_predictive_analytics_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_predictive_analytics_create + """ai_mentor_orgs_users_recommend_courses_retrieve - This is for getting predictive analytics. Accessible to tenant admins only. Returns: 200 : Object of List of predicted data. 400 : When ai response can not be loaded to json. 404: When openai key for tenant is not set. 429: When openai request have exceeded the rate limit. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/ Requests: { \"prompt\": { \"data_variables\": [ { \"variable_name\": \"registered_users\", \"data_set\": { \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, \"2023-10-09\": 5, \"2023-10-10\": 4 }, \"number_of_data_points\": 5 }, { \"variable_name\": \"courses_enrolled\", \"data_set\": { \"2023-08-09\": 0, \"2023-08-10\": 0, \"2023-08-11\": 0, \"2023-08-12\": 0, \"2023-08-13\": 0 }, \"number_of_data_points\": 6 }, { \"variable_name\": \"completed_courses\", \"data_set\": { \"2023-10-04\": 0, \"2023-10-05\": 4, \"2023-10-06\": 4, \"2023-10-07\": 1, \"2023-10-08\": 0, }, \"number_of_data_points\": 5 } ] } } Response: { \"predictions\": [ { \"variable_name\": \"registered_users\", \"predicted_data\": { \"2023-10-11\": 2, \"2023-10-12\": 2, \"2023-10-13\": 1, \"2023-10-14\": 1, \"2023-10-15\": 1 }, \"narrative\": \"The number of registered users has been relatively stable with some fluctuations. There is a slight increase in the number of registered users over time.\" }, { \"variable_name\": \"courses_enrolled\", \"predicted_data\": { \"2023-10-09\": 0, \"2023-10-10\": 0, \"2023-10-11\": 0, \"2023-10-12\": 0, \"2023-10-13\": 0 }, \"narrative\": \"No courses have been enrolled recently, indicating a decline in enrollment. It is expected that the number of courses enrolled will remain at 0 for the next 31 data points.\" }, { \"variable_name\": \"completed_courses\", \"predicted_data\": { \"2023-10-10\": 4, \"2023-10-11\": 4, \"2023-10-12\": 4, \"2023-10-13\": 4, \"2023-10-14\": 4 }, \"narrative\": \"The number of completed courses has remained constant at 4. There is no indication of any change in the near future.\" } ] } + Endpoint to get recomended course. Accessible to tenant admins and students. By default, it uses course from the main tenant for recommedations. More information about the course is returned when return_couse_data is set to true Returns: 200: List of recommended course. 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/johndoe/recommend-courses/?return_course_data=false&&include_main_courses=true Response: { \"courses\": [ { \"id\": \"course-v1:ACI+500+957\" }, ] } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param predictive_analytics_request: (required) - :type predictive_analytics_request: PredictiveAnalyticsRequest + :param include_learner_skills: Include available learner skills for search + :type include_learner_skills: bool + :param include_main_courses: Include courses from the main tenant + :type include_main_courses: bool + :param rank_by_difficulty: Rank by course difficulty + :type rank_by_difficulty: bool + :param return_course_data: Return course data + :type return_course_data: bool + :param return_number: Number of courses to return + :type return_number: int + :param search_terms: Terms to be searched + :type search_terms: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -8084,10 +10499,15 @@ def ai_mentor_orgs_users_predictive_analytics_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_predictive_analytics_create_serialize( + _param = self._ai_mentor_orgs_users_recommend_courses_retrieve_serialize( org=org, user_id=user_id, - predictive_analytics_request=predictive_analytics_request, + include_learner_skills=include_learner_skills, + include_main_courses=include_main_courses, + rank_by_difficulty=rank_by_difficulty, + return_course_data=return_course_data, + return_number=return_number, + search_terms=search_terms, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8095,7 +10515,7 @@ def ai_mentor_orgs_users_predictive_analytics_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PredictiveAnalyticsResponse", + '200': "RecommendCourseResponse", } response_data = self.api_client.call_api( *_param, @@ -8104,11 +10524,16 @@ def ai_mentor_orgs_users_predictive_analytics_create( return response_data.response - def _ai_mentor_orgs_users_predictive_analytics_create_serialize( + def _ai_mentor_orgs_users_recommend_courses_retrieve_serialize( self, org, user_id, - predictive_analytics_request, + include_learner_skills, + include_main_courses, + rank_by_difficulty, + return_course_data, + return_number, + search_terms, _request_auth, _content_type, _headers, @@ -8133,11 +10558,33 @@ def _ai_mentor_orgs_users_predictive_analytics_create_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if include_learner_skills is not None: + + _query_params.append(('include_learner_skills', include_learner_skills)) + + if include_main_courses is not None: + + _query_params.append(('include_main_courses', include_main_courses)) + + if rank_by_difficulty is not None: + + _query_params.append(('rank_by_difficulty', rank_by_difficulty)) + + if return_course_data is not None: + + _query_params.append(('return_course_data', return_course_data)) + + if return_number is not None: + + _query_params.append(('return_number', return_number)) + + if search_terms is not None: + + _query_params.append(('search_terms', search_terms)) + # process the header parameters # process the form parameters # process the body parameter - if predictive_analytics_request is not None: - _body_params = predictive_analytics_request # set the HTTP header `Accept` @@ -8148,21 +10595,6 @@ def _ai_mentor_orgs_users_predictive_analytics_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -8170,8 +10602,8 @@ def _ai_mentor_orgs_users_predictive_analytics_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/predictive-analytics/', + method='GET', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8188,11 +10620,16 @@ def _ai_mentor_orgs_users_predictive_analytics_create_serialize( @validate_call - def ai_mentor_orgs_users_recent_messages_retrieve( + def ai_mentor_orgs_users_retrieve( self, + name: StrictStr, org: StrictStr, user_id: StrictStr, - mentor: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Name or slug of the mentor")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, + metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, + return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8206,16 +10643,26 @@ def ai_mentor_orgs_users_recent_messages_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_recent_messages_retrieve + """ai_mentor_orgs_users_retrieve - Get chat messages + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + :param name: (required) + :type name: str :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param mentor: Name or slug of the mentor - :type mentor: str + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str + :param metadata_key: Metadata key to be queried with + :type metadata_key: str + :param metadata_value: Metadata value to be filter for + :type metadata_value: str + :param return_session_information: Declares if session information should be included in the mentor data + :type return_session_information: bool + :param visibility: visibility type to be queried with + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -8238,10 +10685,15 @@ def ai_mentor_orgs_users_recent_messages_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_recent_messages_retrieve_serialize( + _param = self._ai_mentor_orgs_users_retrieve_serialize( + name=name, org=org, user_id=user_id, - mentor=mentor, + filter_by=filter_by, + metadata_key=metadata_key, + metadata_value=metadata_value, + return_session_information=return_session_information, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8249,7 +10701,7 @@ def ai_mentor_orgs_users_recent_messages_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ChatSessionWithMessage", + '200': "Mentor", } response_data = self.api_client.call_api( *_param, @@ -8258,11 +10710,16 @@ def ai_mentor_orgs_users_recent_messages_retrieve( return response_data.response - def _ai_mentor_orgs_users_recent_messages_retrieve_serialize( + def _ai_mentor_orgs_users_retrieve_serialize( self, + name, org, user_id, - mentor, + filter_by, + metadata_key, + metadata_value, + return_session_information, + visibility, _request_auth, _content_type, _headers, @@ -8282,14 +10739,32 @@ def _ai_mentor_orgs_users_recent_messages_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if name is not None: + _path_params['name'] = name if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if mentor is not None: + if filter_by is not None: - _query_params.append(('mentor', mentor)) + _query_params.append(('filter_by', filter_by)) + + if metadata_key is not None: + + _query_params.append(('metadata_key', metadata_key)) + + if metadata_value is not None: + + _query_params.append(('metadata_value', metadata_value)) + + if return_session_information is not None: + + _query_params.append(('return_session_information', return_session_information)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) # process the header parameters # process the form parameters @@ -8312,7 +10787,7 @@ def _ai_mentor_orgs_users_recent_messages_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recent-messages/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8329,16 +10804,11 @@ def _ai_mentor_orgs_users_recent_messages_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_recommend_courses_block_retrieve( + def ai_mentor_orgs_users_safety_logs_destroy( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this moderation log.")], org: StrictStr, user_id: StrictStr, - include_learner_skills: Annotated[Optional[StrictBool], Field(description="Include available learner skills for search")] = None, - include_main_courses: Annotated[Optional[StrictBool], Field(description="Include courses from the main tenant")] = None, - rank_by_difficulty: Annotated[Optional[StrictBool], Field(description="Rank by course difficulty")] = None, - return_course_data: Annotated[Optional[StrictBool], Field(description="Return course data")] = None, - return_number: Annotated[Optional[StrictInt], Field(description="Number of courses to return")] = None, - search_terms: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Terms to be searched")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8352,26 +10822,16 @@ def ai_mentor_orgs_users_recommend_courses_block_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_recommend_courses_block_retrieve + """ai_mentor_orgs_users_safety_logs_destroy - Endpoint to get recomended course blocks. Accessible to tenant admins and students. By default, it uses course from the main tenant for recommedations. More information about the course is returned when return_couse_data is set to true Returns: 200: List of recommended course. 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/johndoe/recommend-courses-block/?return_course_data=false&&include_main_courses=true Response: { \"blocks\": [ { \"id\": \"course-v1:ACI+500+957\" }, ] } + Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. + :param id: A unique integer value identifying this moderation log. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param include_learner_skills: Include available learner skills for search - :type include_learner_skills: bool - :param include_main_courses: Include courses from the main tenant - :type include_main_courses: bool - :param rank_by_difficulty: Rank by course difficulty - :type rank_by_difficulty: bool - :param return_course_data: Return course data - :type return_course_data: bool - :param return_number: Number of courses to return - :type return_number: int - :param search_terms: Terms to be searched - :type search_terms: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -8394,15 +10854,10 @@ def ai_mentor_orgs_users_recommend_courses_block_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( + _param = self._ai_mentor_orgs_users_safety_logs_destroy_serialize( + id=id, org=org, user_id=user_id, - include_learner_skills=include_learner_skills, - include_main_courses=include_main_courses, - rank_by_difficulty=rank_by_difficulty, - return_course_data=return_course_data, - return_number=return_number, - search_terms=search_terms, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8410,7 +10865,7 @@ def ai_mentor_orgs_users_recommend_courses_block_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "RecommendCourseResponse", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -8419,16 +10874,11 @@ def ai_mentor_orgs_users_recommend_courses_block_retrieve( return response_data.response - def _ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( + def _ai_mentor_orgs_users_safety_logs_destroy_serialize( self, + id, org, user_id, - include_learner_skills, - include_main_courses, - rank_by_difficulty, - return_course_data, - return_number, - search_terms, _request_auth, _content_type, _headers, @@ -8448,47 +10898,18 @@ def _ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if include_learner_skills is not None: - - _query_params.append(('include_learner_skills', include_learner_skills)) - - if include_main_courses is not None: - - _query_params.append(('include_main_courses', include_main_courses)) - - if rank_by_difficulty is not None: - - _query_params.append(('rank_by_difficulty', rank_by_difficulty)) - - if return_course_data is not None: - - _query_params.append(('return_course_data', return_course_data)) - - if return_number is not None: - - _query_params.append(('return_number', return_number)) - - if search_terms is not None: - - _query_params.append(('search_terms', search_terms)) - # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -8497,8 +10918,8 @@ def _ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses-block/', + method='DELETE', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8515,16 +10936,18 @@ def _ai_mentor_orgs_users_recommend_courses_block_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_recommend_courses_retrieve( + def ai_mentor_orgs_users_safety_logs_list( self, org: StrictStr, user_id: StrictStr, - include_learner_skills: Annotated[Optional[StrictBool], Field(description="Include available learner skills for search")] = None, - include_main_courses: Annotated[Optional[StrictBool], Field(description="Include courses from the main tenant")] = None, - rank_by_difficulty: Annotated[Optional[StrictBool], Field(description="Rank by course difficulty")] = None, - return_course_data: Annotated[Optional[StrictBool], Field(description="Return course data")] = None, - return_number: Annotated[Optional[StrictInt], Field(description="Number of courses to return")] = None, - search_terms: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Terms to be searched")] = None, + mentor: Optional[StrictInt] = None, + ordering: Annotated[Optional[StrictStr], Field(description="Which field to use when ordering the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="A page number within the paginated result set.")] = None, + page_size: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None, + platform_key: Optional[StrictStr] = None, + search: Annotated[Optional[StrictStr], Field(description="A search term.")] = None, + target_system: Annotated[Optional[StrictStr], Field(description="* `Safety System` - Safety System * `Moderation System` - Moderation System")] = None, + username: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8538,26 +10961,30 @@ def ai_mentor_orgs_users_recommend_courses_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_recommend_courses_retrieve + """ai_mentor_orgs_users_safety_logs_list - Endpoint to get recomended course. Accessible to tenant admins and students. By default, it uses course from the main tenant for recommedations. More information about the course is returned when return_couse_data is set to true Returns: 200: List of recommended course. 400: When data is not valid. Example: GET: api/ai-mentor/orgs/main/users/johndoe/recommend-courses/?return_course_data=false&&include_main_courses=true Response: { \"courses\": [ { \"id\": \"course-v1:ACI+500+957\" }, ] } + Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param include_learner_skills: Include available learner skills for search - :type include_learner_skills: bool - :param include_main_courses: Include courses from the main tenant - :type include_main_courses: bool - :param rank_by_difficulty: Rank by course difficulty - :type rank_by_difficulty: bool - :param return_course_data: Return course data - :type return_course_data: bool - :param return_number: Number of courses to return - :type return_number: int - :param search_terms: Terms to be searched - :type search_terms: str + :param mentor: + :type mentor: int + :param ordering: Which field to use when ordering the results. + :type ordering: str + :param page: A page number within the paginated result set. + :type page: int + :param page_size: Number of results to return per page. + :type page_size: int + :param platform_key: + :type platform_key: str + :param search: A search term. + :type search: str + :param target_system: * `Safety System` - Safety System * `Moderation System` - Moderation System + :type target_system: str + :param username: + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -8580,15 +11007,17 @@ def ai_mentor_orgs_users_recommend_courses_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_recommend_courses_retrieve_serialize( + _param = self._ai_mentor_orgs_users_safety_logs_list_serialize( org=org, user_id=user_id, - include_learner_skills=include_learner_skills, - include_main_courses=include_main_courses, - rank_by_difficulty=rank_by_difficulty, - return_course_data=return_course_data, - return_number=return_number, - search_terms=search_terms, + mentor=mentor, + ordering=ordering, + page=page, + page_size=page_size, + platform_key=platform_key, + search=search, + target_system=target_system, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8596,7 +11025,7 @@ def ai_mentor_orgs_users_recommend_courses_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "RecommendCourseResponse", + '200': "PaginatedModerationLogList", } response_data = self.api_client.call_api( *_param, @@ -8605,16 +11034,18 @@ def ai_mentor_orgs_users_recommend_courses_retrieve( return response_data.response - def _ai_mentor_orgs_users_recommend_courses_retrieve_serialize( + def _ai_mentor_orgs_users_safety_logs_list_serialize( self, org, user_id, - include_learner_skills, - include_main_courses, - rank_by_difficulty, - return_course_data, - return_number, - search_terms, + mentor, + ordering, + page, + page_size, + platform_key, + search, + target_system, + username, _request_auth, _content_type, _headers, @@ -8639,29 +11070,37 @@ def _ai_mentor_orgs_users_recommend_courses_retrieve_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if include_learner_skills is not None: + if mentor is not None: - _query_params.append(('include_learner_skills', include_learner_skills)) + _query_params.append(('mentor', mentor)) - if include_main_courses is not None: + if ordering is not None: - _query_params.append(('include_main_courses', include_main_courses)) + _query_params.append(('ordering', ordering)) - if rank_by_difficulty is not None: + if page is not None: - _query_params.append(('rank_by_difficulty', rank_by_difficulty)) + _query_params.append(('page', page)) - if return_course_data is not None: + if page_size is not None: - _query_params.append(('return_course_data', return_course_data)) + _query_params.append(('page_size', page_size)) - if return_number is not None: + if platform_key is not None: - _query_params.append(('return_number', return_number)) + _query_params.append(('platform_key', platform_key)) - if search_terms is not None: + if search is not None: - _query_params.append(('search_terms', search_terms)) + _query_params.append(('search', search)) + + if target_system is not None: + + _query_params.append(('target_system', target_system)) + + if username is not None: + + _query_params.append(('username', username)) # process the header parameters # process the form parameters @@ -8684,7 +11123,7 @@ def _ai_mentor_orgs_users_recommend_courses_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/recommend-courses/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8701,16 +11140,11 @@ def _ai_mentor_orgs_users_recommend_courses_retrieve_serialize( @validate_call - def ai_mentor_orgs_users_retrieve( + def ai_mentor_orgs_users_safety_logs_retrieve( self, - name: StrictStr, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this moderation log.")], org: StrictStr, user_id: StrictStr, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, - metadata_key: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata key to be queried with")] = None, - metadata_value: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Metadata value to be filter for")] = None, - return_session_information: Annotated[Optional[StrictBool], Field(description="Declares if session information should be included in the mentor data")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="visibility type to be queried with")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8724,26 +11158,16 @@ def ai_mentor_orgs_users_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_mentor_orgs_users_retrieve + """ai_mentor_orgs_users_safety_logs_retrieve - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + Endpoint to view and delete Safety System Logs for a tenant. These can be filtered by username, platform_key and mentor id A search query can be conducted to search through the prompts and reason for the moderation catch event. - :param name: (required) - :type name: str + :param id: A unique integer value identifying this moderation log. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param filter_by: Filter options include, date, name, default is date - :type filter_by: str - :param metadata_key: Metadata key to be queried with - :type metadata_key: str - :param metadata_value: Metadata value to be filter for - :type metadata_value: str - :param return_session_information: Declares if session information should be included in the mentor data - :type return_session_information: bool - :param visibility: visibility type to be queried with - :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -8766,15 +11190,10 @@ def ai_mentor_orgs_users_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_mentor_orgs_users_retrieve_serialize( - name=name, + _param = self._ai_mentor_orgs_users_safety_logs_retrieve_serialize( + id=id, org=org, user_id=user_id, - filter_by=filter_by, - metadata_key=metadata_key, - metadata_value=metadata_value, - return_session_information=return_session_information, - visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8782,7 +11201,7 @@ def ai_mentor_orgs_users_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Mentor", + '200': "ModerationLog", } response_data = self.api_client.call_api( *_param, @@ -8791,16 +11210,11 @@ def ai_mentor_orgs_users_retrieve( return response_data.response - def _ai_mentor_orgs_users_retrieve_serialize( + def _ai_mentor_orgs_users_safety_logs_retrieve_serialize( self, - name, + id, org, user_id, - filter_by, - metadata_key, - metadata_value, - return_session_information, - visibility, _request_auth, _content_type, _headers, @@ -8820,33 +11234,13 @@ def _ai_mentor_orgs_users_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if name is not None: - _path_params['name'] = name + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if metadata_key is not None: - - _query_params.append(('metadata_key', metadata_key)) - - if metadata_value is not None: - - _query_params.append(('metadata_value', metadata_value)) - - if return_session_information is not None: - - _query_params.append(('return_session_information', return_session_information)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter @@ -8868,7 +11262,7 @@ def _ai_mentor_orgs_users_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/{name}/', + resource_path='/api/ai-mentor/orgs/{org}/users/{user_id}/safety-logs/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9486,7 +11880,6 @@ def ai_mentor_orgs_users_sessions_destroy( ) -> RESTResponseType: """ai_mentor_orgs_users_sessions_destroy - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent :param org: (required) :type org: str @@ -9576,7 +11969,6 @@ def _ai_mentor_orgs_users_sessions_destroy_serialize( # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( @@ -9863,7 +12255,6 @@ def _ai_mentor_orgs_users_sessions_retrieve_serialize( # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( @@ -10466,7 +12857,6 @@ def _ai_mentor_orgs_users_sessions_update_serialize( # authentication setting _auth_settings: List[str] = [ - 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( diff --git a/iblai/api/ai_prompt_api.py b/iblai/api/ai_prompt_api.py index 0f04a3d..76201ff 100644 --- a/iblai/api/ai_prompt_api.py +++ b/iblai/api/ai_prompt_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -21,6 +21,9 @@ from typing_extensions import Annotated from iblai.models.guided_prompts_response import GuidedPromptsResponse from iblai.models.languages_view import LanguagesView +from iblai.models.memory_status_request_view import MemoryStatusRequestView +from iblai.models.memory_status_view import MemoryStatusView +from iblai.models.metadata import Metadata from iblai.models.patched_prompt import PatchedPrompt from iblai.models.prompt import Prompt from iblai.models.prompt_category import PromptCategory @@ -57,6 +60,7 @@ def __init__(self, api_client=None) -> None: def ai_prompt_orgs_metadata_create( self, org: StrictStr, + metadata: Metadata, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -76,6 +80,8 @@ def ai_prompt_orgs_metadata_create( :param org: (required) :type org: str + :param metadata: (required) + :type metadata: Metadata :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -100,6 +106,7 @@ def ai_prompt_orgs_metadata_create( _param = self._ai_prompt_orgs_metadata_create_serialize( org=org, + metadata=metadata, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -107,7 +114,7 @@ def ai_prompt_orgs_metadata_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "Metadata", } response_data = self.api_client.call_api( *_param, @@ -119,6 +126,7 @@ def ai_prompt_orgs_metadata_create( def _ai_prompt_orgs_metadata_create_serialize( self, org, + metadata, _request_auth, _content_type, _headers, @@ -144,9 +152,33 @@ def _ai_prompt_orgs_metadata_create_serialize( # process the header parameters # process the form parameters # process the body parameter + if metadata is not None: + _body_params = metadata + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -719,6 +751,7 @@ def ai_prompt_orgs_users_all_chats_memory_update( self, org: StrictStr, user_id: StrictStr, + user_all_chat_memory_view: UserAllChatMemoryView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -740,6 +773,8 @@ def ai_prompt_orgs_users_all_chats_memory_update( :type org: str :param user_id: (required) :type user_id: str + :param user_all_chat_memory_view: (required) + :type user_all_chat_memory_view: UserAllChatMemoryView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -765,6 +800,7 @@ def ai_prompt_orgs_users_all_chats_memory_update( _param = self._ai_prompt_orgs_users_all_chats_memory_update_serialize( org=org, user_id=user_id, + user_all_chat_memory_view=user_all_chat_memory_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -785,6 +821,7 @@ def _ai_prompt_orgs_users_all_chats_memory_update_serialize( self, org, user_id, + user_all_chat_memory_view, _request_auth, _content_type, _headers, @@ -812,6 +849,8 @@ def _ai_prompt_orgs_users_all_chats_memory_update_serialize( # process the header parameters # process the form parameters # process the body parameter + if user_all_chat_memory_view is not None: + _body_params = user_all_chat_memory_view # set the HTTP header `Accept` @@ -822,6 +861,21 @@ def _ai_prompt_orgs_users_all_chats_memory_update_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2159,10 +2213,11 @@ def _ai_prompt_orgs_users_memory_context_update_serialize( @validate_call - def ai_prompt_orgs_users_metadata_retrieve( + def ai_prompt_orgs_users_memory_create( self, org: StrictStr, user_id: StrictStr, + user_catalog_item_memory_view: UserCatalogItemMemoryView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2176,14 +2231,16 @@ def ai_prompt_orgs_users_metadata_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_metadata_retrieve + """ai_prompt_orgs_users_memory_create - Endpoint for getting prompt metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"prompt\": \"testing\" } + Endpoint for Adding user catalog item memory. Accessible to tenant admins and students. Returns: 201: user catalog item memory Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param user_catalog_item_memory_view: (required) + :type user_catalog_item_memory_view: UserCatalogItemMemoryView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2206,9 +2263,10 @@ def ai_prompt_orgs_users_metadata_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_metadata_retrieve_serialize( + _param = self._ai_prompt_orgs_users_memory_create_serialize( org=org, user_id=user_id, + user_catalog_item_memory_view=user_catalog_item_memory_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2216,7 +2274,7 @@ def ai_prompt_orgs_users_metadata_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '201': "UserCatalogItemMemoryView", } response_data = self.api_client.call_api( *_param, @@ -2225,10 +2283,11 @@ def ai_prompt_orgs_users_metadata_retrieve( return response_data.response - def _ai_prompt_orgs_users_metadata_retrieve_serialize( + def _ai_prompt_orgs_users_memory_create_serialize( self, org, user_id, + user_catalog_item_memory_view, _request_auth, _content_type, _headers, @@ -2256,9 +2315,33 @@ def _ai_prompt_orgs_users_metadata_retrieve_serialize( # process the header parameters # process the form parameters # process the body parameter + if user_catalog_item_memory_view is not None: + _body_params = user_catalog_item_memory_view + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2266,8 +2349,8 @@ def _ai_prompt_orgs_users_metadata_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/metadata', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2284,17 +2367,10 @@ def _ai_prompt_orgs_users_metadata_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_prompt_create( + def ai_prompt_orgs_users_memory_destroy( self, org: StrictStr, user_id: StrictStr, - prompt: Prompt, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2308,28 +2384,14 @@ def ai_prompt_orgs_users_prompt_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_create + """ai_prompt_orgs_users_memory_destroy - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for clearing user catalog item memories. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/ Response: No response Data :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param prompt: (required) - :type prompt: Prompt - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2352,16 +2414,9 @@ def ai_prompt_orgs_users_prompt_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_create_serialize( + _param = self._ai_prompt_orgs_users_memory_destroy_serialize( org=org, user_id=user_id, - prompt=prompt, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2369,7 +2424,7 @@ def ai_prompt_orgs_users_prompt_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Prompt", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -2378,17 +2433,10 @@ def ai_prompt_orgs_users_prompt_create( return response_data.response - def _ai_prompt_orgs_users_prompt_create_serialize( + def _ai_prompt_orgs_users_memory_destroy_serialize( self, org, user_id, - prompt, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, _request_auth, _content_type, _headers, @@ -2413,60 +2461,12 @@ def _ai_prompt_orgs_users_prompt_create_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter - if prompt is not None: - _body_params = prompt - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -2474,8 +2474,8 @@ def _ai_prompt_orgs_users_prompt_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/', + method='DELETE', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2492,17 +2492,11 @@ def _ai_prompt_orgs_users_prompt_create_serialize( @validate_call - def ai_prompt_orgs_users_prompt_destroy( + def ai_prompt_orgs_users_memory_destroy2( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], + memory_id: StrictInt, org: StrictStr, user_id: StrictStr, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2516,28 +2510,16 @@ def ai_prompt_orgs_users_prompt_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_destroy + """ai_prompt_orgs_users_memory_destroy2 - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for deleting user catalog item memory Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/1/ Response: No response Data - :param id: A unique integer value identifying this prompt. (required) - :type id: int + :param memory_id: (required) + :type memory_id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2560,16 +2542,10 @@ def ai_prompt_orgs_users_prompt_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_destroy_serialize( - id=id, + _param = self._ai_prompt_orgs_users_memory_destroy2_serialize( + memory_id=memory_id, org=org, user_id=user_id, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2586,17 +2562,11 @@ def ai_prompt_orgs_users_prompt_destroy( return response_data.response - def _ai_prompt_orgs_users_prompt_destroy_serialize( + def _ai_prompt_orgs_users_memory_destroy2_serialize( self, - id, + memory_id, org, user_id, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, _request_auth, _content_type, _headers, @@ -2616,37 +2586,13 @@ def _ai_prompt_orgs_users_prompt_destroy_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if memory_id is not None: + _path_params['memory_id'] = memory_id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter @@ -2661,7 +2607,7 @@ def _ai_prompt_orgs_users_prompt_destroy_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2678,16 +2624,10 @@ def _ai_prompt_orgs_users_prompt_destroy_serialize( @validate_call - def ai_prompt_orgs_users_prompt_list( + def ai_prompt_orgs_users_memory_retrieve( self, org: StrictStr, user_id: StrictStr, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2701,26 +2641,14 @@ def ai_prompt_orgs_users_prompt_list( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_list + """ai_prompt_orgs_users_memory_retrieve - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for getting user catalog item memories. Accessible to tenant admins and students. Returns: 200: List of user catalog item memories. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/memory/ Response: [ { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" }, } ] :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2743,15 +2671,9 @@ def ai_prompt_orgs_users_prompt_list( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_list_serialize( + _param = self._ai_prompt_orgs_users_memory_retrieve_serialize( org=org, user_id=user_id, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2759,7 +2681,7 @@ def ai_prompt_orgs_users_prompt_list( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[Prompt]", + '200': "UserCatalogItemMemoryView", } response_data = self.api_client.call_api( *_param, @@ -2768,16 +2690,10 @@ def ai_prompt_orgs_users_prompt_list( return response_data.response - def _ai_prompt_orgs_users_prompt_list_serialize( + def _ai_prompt_orgs_users_memory_retrieve_serialize( self, org, user_id, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, _request_auth, _content_type, _headers, @@ -2802,30 +2718,6 @@ def _ai_prompt_orgs_users_prompt_list_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter @@ -2847,7 +2739,7 @@ def _ai_prompt_orgs_users_prompt_list_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2864,18 +2756,10 @@ def _ai_prompt_orgs_users_prompt_list_serialize( @validate_call - def ai_prompt_orgs_users_prompt_partial_update( + def ai_prompt_orgs_users_memory_status_retrieve( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], org: StrictStr, user_id: StrictStr, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, - patched_prompt: Optional[PatchedPrompt] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2889,30 +2773,14 @@ def ai_prompt_orgs_users_prompt_partial_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_partial_update + """ai_prompt_orgs_users_memory_status_retrieve - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for getting memory status. Accessible to tenant admins and students. Returns: 200: Obbject of memory status. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/memory-status/ Response: { \"id\": 1, \"username\": \"johndoes\", \"platform_key\": \"main\", \"enabled\": false } - :param id: A unique integer value identifying this prompt. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str - :param patched_prompt: - :type patched_prompt: PatchedPrompt :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2935,17 +2803,9 @@ def ai_prompt_orgs_users_prompt_partial_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_partial_update_serialize( - id=id, + _param = self._ai_prompt_orgs_users_memory_status_retrieve_serialize( org=org, user_id=user_id, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, - patched_prompt=patched_prompt, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2953,7 +2813,7 @@ def ai_prompt_orgs_users_prompt_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Prompt", + '200': "MemoryStatusView", } response_data = self.api_client.call_api( *_param, @@ -2962,18 +2822,10 @@ def ai_prompt_orgs_users_prompt_partial_update( return response_data.response - def _ai_prompt_orgs_users_prompt_partial_update_serialize( + def _ai_prompt_orgs_users_memory_status_retrieve_serialize( self, - id, org, user_id, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, - patched_prompt, _request_auth, _content_type, _headers, @@ -2993,42 +2845,14 @@ def _ai_prompt_orgs_users_prompt_partial_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter - if patched_prompt is not None: - _body_params = patched_prompt # set the HTTP header `Accept` @@ -3039,21 +2863,6 @@ def _ai_prompt_orgs_users_prompt_partial_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3061,8 +2870,8 @@ def _ai_prompt_orgs_users_prompt_partial_update_serialize( ] return self.api_client.param_serialize( - method='PATCH', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3079,17 +2888,11 @@ def _ai_prompt_orgs_users_prompt_partial_update_serialize( @validate_call - def ai_prompt_orgs_users_prompt_retrieve( + def ai_prompt_orgs_users_memory_status_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], org: StrictStr, user_id: StrictStr, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, + memory_status_request_view: MemoryStatusRequestView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3103,28 +2906,16 @@ def ai_prompt_orgs_users_prompt_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_retrieve + """ai_prompt_orgs_users_memory_status_update - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for updating user memory status. Accessible to tenant admins and students. Returns: 200: user chat memory status Object. 400: When data is not valid. Example: PUT: /api/ai-prompt/orgs/main/users/johndoe/memory-status/ Request: { \"enabled\": false } Response: { \"id\": 1, \"username\": \"johndoes\", \"platform_key\": \"main\", \"enabled\": false } - :param id: A unique integer value identifying this prompt. (required) - :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str + :param memory_status_request_view: (required) + :type memory_status_request_view: MemoryStatusRequestView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3147,16 +2938,10 @@ def ai_prompt_orgs_users_prompt_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_retrieve_serialize( - id=id, + _param = self._ai_prompt_orgs_users_memory_status_update_serialize( org=org, user_id=user_id, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, + memory_status_request_view=memory_status_request_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3164,7 +2949,7 @@ def ai_prompt_orgs_users_prompt_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Prompt", + '200': "MemoryStatusView", } response_data = self.api_client.call_api( *_param, @@ -3173,17 +2958,11 @@ def ai_prompt_orgs_users_prompt_retrieve( return response_data.response - def _ai_prompt_orgs_users_prompt_retrieve_serialize( + def _ai_prompt_orgs_users_memory_status_update_serialize( self, - id, org, user_id, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, + memory_status_request_view, _request_auth, _content_type, _headers, @@ -3203,40 +2982,16 @@ def _ai_prompt_orgs_users_prompt_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter + if memory_status_request_view is not None: + _body_params = memory_status_request_view # set the HTTP header `Accept` @@ -3247,6 +3002,21 @@ def _ai_prompt_orgs_users_prompt_retrieve_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3254,8 +3024,8 @@ def _ai_prompt_orgs_users_prompt_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + method='PUT', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory-status/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3272,18 +3042,12 @@ def _ai_prompt_orgs_users_prompt_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_prompt_update( + def ai_prompt_orgs_users_memory_update( self, - id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], + memory_id: StrictInt, org: StrictStr, user_id: StrictStr, - prompt: Prompt, - category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, - created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, - mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, - tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, - visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, + user_catalog_item_memory_view: UserCatalogItemMemoryView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3297,30 +3061,18 @@ def ai_prompt_orgs_users_prompt_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompt_update + """ai_prompt_orgs_users_memory_update - View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + Endpoint for updating user catalog item memory. Accessible to tenant admins and students. Returns: 200: user catalog item memory object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/memory/1/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": \"i learnt about x and y\", \"next_steps\": \"learning about z\" } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } - :param id: A unique integer value identifying this prompt. (required) - :type id: int + :param memory_id: (required) + :type memory_id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param prompt: (required) - :type prompt: Prompt - :param category: Category of the prompt - :type category: int - :param created_by: Option to filter by username of the prompt creators. - :type created_by: str - :param filter_by: Filter options include, date, prompt, default is date - :type filter_by: str - :param mentor_unique_id: Mentor unique id of the prompt - :type mentor_unique_id: str - :param tag: Tag of the prompt - :type tag: int - :param visibility: Visibility trype the mentor of the prompt - :type visibility: str + :param user_catalog_item_memory_view: (required) + :type user_catalog_item_memory_view: UserCatalogItemMemoryView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3343,17 +3095,11 @@ def ai_prompt_orgs_users_prompt_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompt_update_serialize( - id=id, + _param = self._ai_prompt_orgs_users_memory_update_serialize( + memory_id=memory_id, org=org, user_id=user_id, - prompt=prompt, - category=category, - created_by=created_by, - filter_by=filter_by, - mentor_unique_id=mentor_unique_id, - tag=tag, - visibility=visibility, + user_catalog_item_memory_view=user_catalog_item_memory_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3361,7 +3107,7 @@ def ai_prompt_orgs_users_prompt_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Prompt", + '200': "UserCatalogItemMemoryView", } response_data = self.api_client.call_api( *_param, @@ -3370,18 +3116,12 @@ def ai_prompt_orgs_users_prompt_update( return response_data.response - def _ai_prompt_orgs_users_prompt_update_serialize( + def _ai_prompt_orgs_users_memory_update_serialize( self, - id, + memory_id, org, user_id, - prompt, - category, - created_by, - filter_by, - mentor_unique_id, - tag, - visibility, + user_catalog_item_memory_view, _request_auth, _content_type, _headers, @@ -3401,42 +3141,18 @@ def _ai_prompt_orgs_users_prompt_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id is not None: - _path_params['id'] = id + if memory_id is not None: + _path_params['memory_id'] = memory_id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if category is not None: - - _query_params.append(('category', category)) - - if created_by is not None: - - _query_params.append(('created_by', created_by)) - - if filter_by is not None: - - _query_params.append(('filter_by', filter_by)) - - if mentor_unique_id is not None: - - _query_params.append(('mentor_unique_id', mentor_unique_id)) - - if tag is not None: - - _query_params.append(('tag', tag)) - - if visibility is not None: - - _query_params.append(('visibility', visibility)) - # process the header parameters # process the form parameters # process the body parameter - if prompt is not None: - _body_params = prompt + if user_catalog_item_memory_view is not None: + _body_params = user_catalog_item_memory_view # set the HTTP header `Accept` @@ -3470,7 +3186,7 @@ def _ai_prompt_orgs_users_prompt_update_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/memory/{memory_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3487,11 +3203,10 @@ def _ai_prompt_orgs_users_prompt_update_serialize( @validate_call - def ai_prompt_orgs_users_prompts_category_create( + def ai_prompt_orgs_users_metadata_retrieve( self, org: StrictStr, user_id: StrictStr, - prompt_category: PromptCategory, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3505,16 +3220,14 @@ def ai_prompt_orgs_users_prompts_category_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompts_category_create + """ai_prompt_orgs_users_metadata_retrieve - This is for adding prompt categories Accessible to tenant admins only. Returns: 200 : Prompt category detail. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } + Endpoint for getting prompt metadata. Accessible to tenant admins and students. Returns: 200: Metadata Object. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/metadata/ Response: { \"metadata\": { \"test\": \"test\" }, \"prompt\": \"testing\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param prompt_category: (required) - :type prompt_category: PromptCategory :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3537,10 +3250,9 @@ def ai_prompt_orgs_users_prompts_category_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompts_category_create_serialize( + _param = self._ai_prompt_orgs_users_metadata_retrieve_serialize( org=org, user_id=user_id, - prompt_category=prompt_category, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3548,7 +3260,7 @@ def ai_prompt_orgs_users_prompts_category_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PromptCategory", + '200': "Metadata", } response_data = self.api_client.call_api( *_param, @@ -3557,11 +3269,10 @@ def ai_prompt_orgs_users_prompts_category_create( return response_data.response - def _ai_prompt_orgs_users_prompts_category_create_serialize( + def _ai_prompt_orgs_users_metadata_retrieve_serialize( self, org, user_id, - prompt_category, _request_auth, _content_type, _headers, @@ -3589,8 +3300,6 @@ def _ai_prompt_orgs_users_prompts_category_create_serialize( # process the header parameters # process the form parameters # process the body parameter - if prompt_category is not None: - _body_params = prompt_category # set the HTTP header `Accept` @@ -3601,21 +3310,6 @@ def _ai_prompt_orgs_users_prompts_category_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3623,8 +3317,8 @@ def _ai_prompt_orgs_users_prompts_category_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/metadata', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3641,10 +3335,17 @@ def _ai_prompt_orgs_users_prompts_category_create_serialize( @validate_call - def ai_prompt_orgs_users_prompts_category_destroy( + def ai_prompt_orgs_users_prompt_create( self, org: StrictStr, user_id: StrictStr, + prompt: Prompt, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3658,14 +3359,28 @@ def ai_prompt_orgs_users_prompts_category_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompts_category_destroy + """ai_prompt_orgs_users_prompt_create - This is for deleting prompt category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"category\": \"Education\" } Response: No response body. + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param prompt: (required) + :type prompt: Prompt + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date + :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3688,9 +3403,16 @@ def ai_prompt_orgs_users_prompts_category_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompts_category_destroy_serialize( + _param = self._ai_prompt_orgs_users_prompt_create_serialize( org=org, user_id=user_id, + prompt=prompt, + category=category, + created_by=created_by, + filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3698,7 +3420,7 @@ def ai_prompt_orgs_users_prompts_category_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '201': "Prompt", } response_data = self.api_client.call_api( *_param, @@ -3707,10 +3429,17 @@ def ai_prompt_orgs_users_prompts_category_destroy( return response_data.response - def _ai_prompt_orgs_users_prompts_category_destroy_serialize( + def _ai_prompt_orgs_users_prompt_create_serialize( self, org, user_id, + prompt, + category, + created_by, + filter_by, + mentor_unique_id, + tag, + visibility, _request_auth, _content_type, _headers, @@ -3735,12 +3464,60 @@ def _ai_prompt_orgs_users_prompts_category_destroy_serialize( if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if category is not None: + + _query_params.append(('category', category)) + + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter + if prompt is not None: + _body_params = prompt + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -3748,8 +3525,8 @@ def _ai_prompt_orgs_users_prompts_category_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3766,11 +3543,17 @@ def _ai_prompt_orgs_users_prompts_category_destroy_serialize( @validate_call - def ai_prompt_orgs_users_prompts_category_retrieve( + def ai_prompt_orgs_users_prompt_destroy( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], org: StrictStr, user_id: StrictStr, - filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3784,16 +3567,28 @@ def ai_prompt_orgs_users_prompts_category_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_prompts_category_retrieve + """ai_prompt_orgs_users_prompt_destroy - This is for getting prompt categories Accessible to tenant admins and students. Returns: 200 : List of prompt categories. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + :param id: A unique integer value identifying this prompt. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param filter_by: Filter options include, date, name, default is date + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3816,10 +3611,16 @@ def ai_prompt_orgs_users_prompts_category_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_prompts_category_retrieve_serialize( + _param = self._ai_prompt_orgs_users_prompt_destroy_serialize( + id=id, org=org, user_id=user_id, + category=category, + created_by=created_by, filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3827,7 +3628,7 @@ def ai_prompt_orgs_users_prompts_category_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PromptCategory", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3836,11 +3637,17 @@ def ai_prompt_orgs_users_prompts_category_retrieve( return response_data.response - def _ai_prompt_orgs_users_prompts_category_retrieve_serialize( + def _ai_prompt_orgs_users_prompt_destroy_serialize( self, + id, org, user_id, + category, + created_by, filter_by, + mentor_unique_id, + tag, + visibility, _request_auth, _content_type, _headers, @@ -3860,17 +3667,218 @@ def _ai_prompt_orgs_users_prompts_category_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters - if filter_by is not None: + if category is not None: - _query_params.append(('filter_by', filter_by)) + _query_params.append(('category', category)) - # process the header parameters - # process the form parameters + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_prompt_orgs_users_prompt_list( + self, + org: StrictStr, + user_id: StrictStr, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_prompt_orgs_users_prompt_list + + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date + :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_prompt_orgs_users_prompt_list_serialize( + org=org, + user_id=user_id, + category=category, + created_by=created_by, + filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[Prompt]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_prompt_orgs_users_prompt_list_serialize( + self, + org, + user_id, + category, + created_by, + filter_by, + mentor_unique_id, + tag, + visibility, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if category is not None: + + _query_params.append(('category', category)) + + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + + # process the header parameters + # process the form parameters # process the body parameter @@ -3890,7 +3898,7 @@ def _ai_prompt_orgs_users_prompts_category_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3907,11 +3915,232 @@ def _ai_prompt_orgs_users_prompts_category_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( + def ai_prompt_orgs_users_prompt_partial_update( + self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], + org: StrictStr, + user_id: StrictStr, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, + patched_prompt: Optional[PatchedPrompt] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """ai_prompt_orgs_users_prompt_partial_update + + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + + :param id: A unique integer value identifying this prompt. (required) + :type id: int + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date + :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str + :param patched_prompt: + :type patched_prompt: PatchedPrompt + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ai_prompt_orgs_users_prompt_partial_update_serialize( + id=id, + org=org, + user_id=user_id, + category=category, + created_by=created_by, + filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, + patched_prompt=patched_prompt, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Prompt", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ai_prompt_orgs_users_prompt_partial_update_serialize( + self, + id, + org, + user_id, + category, + created_by, + filter_by, + mentor_unique_id, + tag, + visibility, + patched_prompt, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if category is not None: + + _query_params.append(('category', category)) + + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + + # process the header parameters + # process the form parameters + # process the body parameter + if patched_prompt is not None: + _body_params = patched_prompt + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ai_prompt_orgs_users_prompt_retrieve( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], org: StrictStr, - session_id: StrictStr, user_id: StrictStr, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3925,16 +4154,28 @@ def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_sessions_guided_prompts_retrieve + """ai_prompt_orgs_users_prompt_retrieve - This is for getting guided prompts for a chat session session. Accessible to tenant admins and students. Returns: 200 : Object of list of guided prompts. 500 : When ai response can not be loaded to json. 404: When openai key for tenant is not set. 429: When openai request have exceeded the rate limit. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/sessions/4194d20c-37d5-4148-882f-f7d2d91f7769/guided-prompts/ Response: { \"ai_prompts\": [ \"What are the benefits of regular exercise?\", \"How can I create a healthy meal plan?\", \"What are some effective stress management techniques?\" ] } + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + :param id: A unique integer value identifying this prompt. (required) + :type id: int :param org: (required) :type org: str - :param session_id: (required) - :type session_id: str :param user_id: (required) :type user_id: str + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date + :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -3957,10 +4198,16 @@ def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( + _param = self._ai_prompt_orgs_users_prompt_retrieve_serialize( + id=id, org=org, - session_id=session_id, user_id=user_id, + category=category, + created_by=created_by, + filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3968,7 +4215,7 @@ def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "GuidedPromptsResponse", + '200': "Prompt", } response_data = self.api_client.call_api( *_param, @@ -3977,11 +4224,17 @@ def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( return response_data.response - def _ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( + def _ai_prompt_orgs_users_prompt_retrieve_serialize( self, + id, org, - session_id, user_id, + category, + created_by, + filter_by, + mentor_unique_id, + tag, + visibility, _request_auth, _content_type, _headers, @@ -4001,13 +4254,37 @@ def _ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org - if session_id is not None: - _path_params['session_id'] = session_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if category is not None: + + _query_params.append(('category', category)) + + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter @@ -4029,7 +4306,7 @@ def _ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/sessions/{session_id}/guided-prompts/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4046,11 +4323,18 @@ def _ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_styles_create( + def ai_prompt_orgs_users_prompt_update( self, + id: Annotated[StrictInt, Field(description="A unique integer value identifying this prompt.")], org: StrictStr, user_id: StrictStr, - styles_view: StylesView, + prompt: Prompt, + category: Annotated[Optional[StrictInt], Field(description="Category of the prompt")] = None, + created_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Option to filter by username of the prompt creators.")] = None, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, prompt, default is date")] = None, + mentor_unique_id: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Mentor unique id of the prompt")] = None, + tag: Annotated[Optional[StrictInt], Field(description="Tag of the prompt")] = None, + visibility: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Visibility trype the mentor of the prompt")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4064,16 +4348,30 @@ def ai_prompt_orgs_users_styles_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_styles_create + """ai_prompt_orgs_users_prompt_update - Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 201: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } + View to create/retrieve/update a prompt. Accessible to both tenant admins and students. + :param id: A unique integer value identifying this prompt. (required) + :type id: int :param org: (required) :type org: str :param user_id: (required) :type user_id: str - :param styles_view: (required) - :type styles_view: StylesView + :param prompt: (required) + :type prompt: Prompt + :param category: Category of the prompt + :type category: int + :param created_by: Option to filter by username of the prompt creators. + :type created_by: str + :param filter_by: Filter options include, date, prompt, default is date + :type filter_by: str + :param mentor_unique_id: Mentor unique id of the prompt + :type mentor_unique_id: str + :param tag: Tag of the prompt + :type tag: int + :param visibility: Visibility trype the mentor of the prompt + :type visibility: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4096,10 +4394,17 @@ def ai_prompt_orgs_users_styles_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_styles_create_serialize( + _param = self._ai_prompt_orgs_users_prompt_update_serialize( + id=id, org=org, user_id=user_id, - styles_view=styles_view, + prompt=prompt, + category=category, + created_by=created_by, + filter_by=filter_by, + mentor_unique_id=mentor_unique_id, + tag=tag, + visibility=visibility, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4107,7 +4412,7 @@ def ai_prompt_orgs_users_styles_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "StylesView", + '200': "Prompt", } response_data = self.api_client.call_api( *_param, @@ -4116,11 +4421,18 @@ def ai_prompt_orgs_users_styles_create( return response_data.response - def _ai_prompt_orgs_users_styles_create_serialize( + def _ai_prompt_orgs_users_prompt_update_serialize( self, + id, org, user_id, - styles_view, + prompt, + category, + created_by, + filter_by, + mentor_unique_id, + tag, + visibility, _request_auth, _content_type, _headers, @@ -4140,16 +4452,42 @@ def _ai_prompt_orgs_users_styles_create_serialize( _body_params: Optional[bytes] = None # process the path parameters + if id is not None: + _path_params['id'] = id if org is not None: _path_params['org'] = org if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if category is not None: + + _query_params.append(('category', category)) + + if created_by is not None: + + _query_params.append(('created_by', created_by)) + + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + + if mentor_unique_id is not None: + + _query_params.append(('mentor_unique_id', mentor_unique_id)) + + if tag is not None: + + _query_params.append(('tag', tag)) + + if visibility is not None: + + _query_params.append(('visibility', visibility)) + # process the header parameters # process the form parameters # process the body parameter - if styles_view is not None: - _body_params = styles_view + if prompt is not None: + _body_params = prompt # set the HTTP header `Accept` @@ -4182,8 +4520,8 @@ def _ai_prompt_orgs_users_styles_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/', + method='PUT', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompt/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4200,11 +4538,11 @@ def _ai_prompt_orgs_users_styles_create_serialize( @validate_call - def ai_prompt_orgs_users_styles_destroy( + def ai_prompt_orgs_users_prompts_category_create( self, org: StrictStr, - style_id: StrictInt, user_id: StrictStr, + prompt_category: PromptCategory, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4218,16 +4556,16 @@ def ai_prompt_orgs_users_styles_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_styles_destroy + """ai_prompt_orgs_users_prompts_category_create - Endpoint for deleting prompt style. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Response: No response Data + This is for adding prompt categories Accessible to tenant admins only. Returns: 200 : Prompt category detail. Example : POST : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"name\": \"Education\", \"description\": \"education testing\" } Response: { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } :param org: (required) :type org: str - :param style_id: (required) - :type style_id: int :param user_id: (required) :type user_id: str + :param prompt_category: (required) + :type prompt_category: PromptCategory :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4250,10 +4588,10 @@ def ai_prompt_orgs_users_styles_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_styles_destroy_serialize( + _param = self._ai_prompt_orgs_users_prompts_category_create_serialize( org=org, - style_id=style_id, user_id=user_id, + prompt_category=prompt_category, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4261,7 +4599,7 @@ def ai_prompt_orgs_users_styles_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "PromptCategory", } response_data = self.api_client.call_api( *_param, @@ -4270,11 +4608,11 @@ def ai_prompt_orgs_users_styles_destroy( return response_data.response - def _ai_prompt_orgs_users_styles_destroy_serialize( + def _ai_prompt_orgs_users_prompts_category_create_serialize( self, org, - style_id, user_id, + prompt_category, _request_auth, _content_type, _headers, @@ -4296,17 +4634,39 @@ def _ai_prompt_orgs_users_styles_destroy_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if style_id is not None: - _path_params['style_id'] = style_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if prompt_category is not None: + _body_params = prompt_category + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4314,8 +4674,8 @@ def _ai_prompt_orgs_users_styles_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4332,7 +4692,7 @@ def _ai_prompt_orgs_users_styles_destroy_serialize( @validate_call - def ai_prompt_orgs_users_styles_retrieve( + def ai_prompt_orgs_users_prompts_category_destroy( self, org: StrictStr, user_id: StrictStr, @@ -4349,9 +4709,9 @@ def ai_prompt_orgs_users_styles_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_styles_retrieve + """ai_prompt_orgs_users_prompts_category_destroy - Endpoint for getting prompt styles. Accessible to tenant admins and students. Returns: 200: List of styles. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/styles/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] + This is for deleting prompt category Accessible to tenant admins only. Returns: 204 : No Content. 400 : When data is invalid. 400 : When data is invalid. Example : DELETE : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Request: { \"category\": \"Education\" } Response: No response body. :param org: (required) :type org: str @@ -4379,7 +4739,7 @@ def ai_prompt_orgs_users_styles_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_styles_retrieve_serialize( + _param = self._ai_prompt_orgs_users_prompts_category_destroy_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -4389,7 +4749,7 @@ def ai_prompt_orgs_users_styles_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "StylesView", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -4398,7 +4758,7 @@ def ai_prompt_orgs_users_styles_retrieve( return response_data.response - def _ai_prompt_orgs_users_styles_retrieve_serialize( + def _ai_prompt_orgs_users_prompts_category_destroy_serialize( self, org, user_id, @@ -4431,13 +4791,6 @@ def _ai_prompt_orgs_users_styles_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -4446,8 +4799,8 @@ def _ai_prompt_orgs_users_styles_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/', + method='DELETE', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4464,12 +4817,11 @@ def _ai_prompt_orgs_users_styles_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_styles_update( + def ai_prompt_orgs_users_prompts_category_retrieve( self, org: StrictStr, - style_id: StrictInt, user_id: StrictStr, - styles_view: StylesView, + filter_by: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Filter options include, date, name, default is date ")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4483,18 +4835,16 @@ def ai_prompt_orgs_users_styles_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_styles_update + """ai_prompt_orgs_users_prompts_category_retrieve - Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 200: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } + This is for getting prompt categories Accessible to tenant admins and students. Returns: 200 : List of prompt categories. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/prompts/category Response: [ { \"id\": 1, \"name\": \"Education\", \"description\": \"education testing\" } ] :param org: (required) :type org: str - :param style_id: (required) - :type style_id: int :param user_id: (required) :type user_id: str - :param styles_view: (required) - :type styles_view: StylesView + :param filter_by: Filter options include, date, name, default is date + :type filter_by: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4517,11 +4867,10 @@ def ai_prompt_orgs_users_styles_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_styles_update_serialize( + _param = self._ai_prompt_orgs_users_prompts_category_retrieve_serialize( org=org, - style_id=style_id, user_id=user_id, - styles_view=styles_view, + filter_by=filter_by, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4529,7 +4878,7 @@ def ai_prompt_orgs_users_styles_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "StylesView", + '200': "PromptCategory", } response_data = self.api_client.call_api( *_param, @@ -4538,12 +4887,11 @@ def ai_prompt_orgs_users_styles_update( return response_data.response - def _ai_prompt_orgs_users_styles_update_serialize( + def _ai_prompt_orgs_users_prompts_category_retrieve_serialize( self, org, - style_id, user_id, - styles_view, + filter_by, _request_auth, _content_type, _headers, @@ -4565,16 +4913,16 @@ def _ai_prompt_orgs_users_styles_update_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if style_id is not None: - _path_params['style_id'] = style_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters + if filter_by is not None: + + _query_params.append(('filter_by', filter_by)) + # process the header parameters # process the form parameters # process the body parameter - if styles_view is not None: - _body_params = styles_view # set the HTTP header `Accept` @@ -4585,21 +4933,6 @@ def _ai_prompt_orgs_users_styles_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4607,8 +4940,8 @@ def _ai_prompt_orgs_users_styles_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/prompts/category/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4625,11 +4958,11 @@ def _ai_prompt_orgs_users_styles_update_serialize( @validate_call - def ai_prompt_orgs_users_tags_create( + def ai_prompt_orgs_users_sessions_guided_prompts_retrieve( self, org: StrictStr, + session_id: StrictStr, user_id: StrictStr, - tags_view: TagsView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4643,16 +4976,16 @@ def ai_prompt_orgs_users_tags_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tags_create + """ai_prompt_orgs_users_sessions_guided_prompts_retrieve - Endpoint for Adding prompt tag. Accessible to tenant admins and students. Returns: 201: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ Request: Response: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } + This is for getting guided prompts for a chat session session. Accessible to tenant admins and students. Returns: 200 : Object of list of guided prompts. 500 : When ai response can not be loaded to json. 404: When OpenAI key for tenant is not set. 429: When OpenAI requests have exceeded the rate limit. Example : GET : /api/ai-prompt/orgs/main/users/johndoe/sessions/4194d20c-37d5-4148-882f-f7d2d91f7769/guided-prompts/ Response: { \"ai_prompts\": [ \"What are the benefits of regular exercise?\", \"How can I create a healthy meal plan?\", \"What are some effective stress management techniques?\" ] } :param org: (required) :type org: str + :param session_id: (required) + :type session_id: str :param user_id: (required) :type user_id: str - :param tags_view: (required) - :type tags_view: TagsView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4675,10 +5008,10 @@ def ai_prompt_orgs_users_tags_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tags_create_serialize( + _param = self._ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( org=org, + session_id=session_id, user_id=user_id, - tags_view=tags_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4686,7 +5019,7 @@ def ai_prompt_orgs_users_tags_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "TagsView", + '200': "GuidedPromptsResponse", } response_data = self.api_client.call_api( *_param, @@ -4695,11 +5028,11 @@ def ai_prompt_orgs_users_tags_create( return response_data.response - def _ai_prompt_orgs_users_tags_create_serialize( + def _ai_prompt_orgs_users_sessions_guided_prompts_retrieve_serialize( self, org, + session_id, user_id, - tags_view, _request_auth, _content_type, _headers, @@ -4721,14 +5054,14 @@ def _ai_prompt_orgs_users_tags_create_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if session_id is not None: + _path_params['session_id'] = session_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if tags_view is not None: - _body_params = tags_view # set the HTTP header `Accept` @@ -4739,21 +5072,6 @@ def _ai_prompt_orgs_users_tags_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4761,8 +5079,8 @@ def _ai_prompt_orgs_users_tags_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/sessions/{session_id}/guided-prompts/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4779,11 +5097,11 @@ def _ai_prompt_orgs_users_tags_create_serialize( @validate_call - def ai_prompt_orgs_users_tags_destroy( + def ai_prompt_orgs_users_styles_create( self, org: StrictStr, - tag_id: StrictInt, user_id: StrictStr, + styles_view: StylesView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4797,16 +5115,16 @@ def ai_prompt_orgs_users_tags_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tags_destroy + """ai_prompt_orgs_users_styles_create - Endpoint for deleting prompt tag. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Response: No response Data + Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 201: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } :param org: (required) :type org: str - :param tag_id: (required) - :type tag_id: int :param user_id: (required) :type user_id: str + :param styles_view: (required) + :type styles_view: StylesView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -4829,10 +5147,10 @@ def ai_prompt_orgs_users_tags_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tags_destroy_serialize( + _param = self._ai_prompt_orgs_users_styles_create_serialize( org=org, - tag_id=tag_id, user_id=user_id, + styles_view=styles_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4840,7 +5158,7 @@ def ai_prompt_orgs_users_tags_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '201': "StylesView", } response_data = self.api_client.call_api( *_param, @@ -4849,11 +5167,11 @@ def ai_prompt_orgs_users_tags_destroy( return response_data.response - def _ai_prompt_orgs_users_tags_destroy_serialize( + def _ai_prompt_orgs_users_styles_create_serialize( self, org, - tag_id, user_id, + styles_view, _request_auth, _content_type, _headers, @@ -4875,17 +5193,39 @@ def _ai_prompt_orgs_users_tags_destroy_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if tag_id is not None: - _path_params['tag_id'] = tag_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if styles_view is not None: + _body_params = styles_view + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -4893,8 +5233,8 @@ def _ai_prompt_orgs_users_tags_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4911,9 +5251,10 @@ def _ai_prompt_orgs_users_tags_destroy_serialize( @validate_call - def ai_prompt_orgs_users_tags_retrieve( + def ai_prompt_orgs_users_styles_destroy( self, org: StrictStr, + style_id: StrictInt, user_id: StrictStr, _request_timeout: Union[ None, @@ -4928,12 +5269,14 @@ def ai_prompt_orgs_users_tags_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tags_retrieve + """ai_prompt_orgs_users_styles_destroy - Endpoint for getting prompt tags. Accessible to tenant admins and students. Returns: 200: List of tags. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tags/ Response: [ { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ] + Endpoint for deleting prompt style. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Response: No response Data :param org: (required) :type org: str + :param style_id: (required) + :type style_id: int :param user_id: (required) :type user_id: str :param _request_timeout: timeout setting for this request. If one @@ -4958,8 +5301,9 @@ def ai_prompt_orgs_users_tags_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tags_retrieve_serialize( + _param = self._ai_prompt_orgs_users_styles_destroy_serialize( org=org, + style_id=style_id, user_id=user_id, _request_auth=_request_auth, _content_type=_content_type, @@ -4968,7 +5312,7 @@ def ai_prompt_orgs_users_tags_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "TagsView", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -4977,9 +5321,10 @@ def ai_prompt_orgs_users_tags_retrieve( return response_data.response - def _ai_prompt_orgs_users_tags_retrieve_serialize( + def _ai_prompt_orgs_users_styles_destroy_serialize( self, org, + style_id, user_id, _request_auth, _content_type, @@ -5002,6 +5347,8 @@ def _ai_prompt_orgs_users_tags_retrieve_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if style_id is not None: + _path_params['style_id'] = style_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters @@ -5010,13 +5357,6 @@ def _ai_prompt_orgs_users_tags_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -5025,8 +5365,8 @@ def _ai_prompt_orgs_users_tags_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/', + method='DELETE', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5043,12 +5383,10 @@ def _ai_prompt_orgs_users_tags_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_tags_update( + def ai_prompt_orgs_users_styles_retrieve( self, org: StrictStr, - tag_id: StrictInt, user_id: StrictStr, - tags_view: TagsView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5062,18 +5400,14 @@ def ai_prompt_orgs_users_tags_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tags_update + """ai_prompt_orgs_users_styles_retrieve - Endpoint for updating prompt tag. Accessible to tenant admins and students. Returns: 200: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Request: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } + Endpoint for getting prompt styles. Accessible to tenant admins and students. Returns: 200: List of styles. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/styles/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] :param org: (required) :type org: str - :param tag_id: (required) - :type tag_id: int :param user_id: (required) :type user_id: str - :param tags_view: (required) - :type tags_view: TagsView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5096,11 +5430,9 @@ def ai_prompt_orgs_users_tags_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tags_update_serialize( + _param = self._ai_prompt_orgs_users_styles_retrieve_serialize( org=org, - tag_id=tag_id, user_id=user_id, - tags_view=tags_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5108,7 +5440,7 @@ def ai_prompt_orgs_users_tags_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "TagsView", + '200': "StylesView", } response_data = self.api_client.call_api( *_param, @@ -5117,12 +5449,10 @@ def ai_prompt_orgs_users_tags_update( return response_data.response - def _ai_prompt_orgs_users_tags_update_serialize( + def _ai_prompt_orgs_users_styles_retrieve_serialize( self, org, - tag_id, user_id, - tags_view, _request_auth, _content_type, _headers, @@ -5144,16 +5474,12 @@ def _ai_prompt_orgs_users_tags_update_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if tag_id is not None: - _path_params['tag_id'] = tag_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if tags_view is not None: - _body_params = tags_view # set the HTTP header `Accept` @@ -5164,21 +5490,6 @@ def _ai_prompt_orgs_users_tags_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -5186,8 +5497,8 @@ def _ai_prompt_orgs_users_tags_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5204,11 +5515,12 @@ def _ai_prompt_orgs_users_tags_update_serialize( @validate_call - def ai_prompt_orgs_users_tones_create( + def ai_prompt_orgs_users_styles_update( self, org: StrictStr, + style_id: StrictInt, user_id: StrictStr, - tones_view: Optional[TonesView] = None, + styles_view: StylesView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5222,16 +5534,18 @@ def ai_prompt_orgs_users_tones_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tones_create + """ai_prompt_orgs_users_styles_update - Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: 201: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } + Endpoint for Adding prompt style. Accessible to tenant admins only. Returns: 200: style Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/styles/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } :param org: (required) :type org: str + :param style_id: (required) + :type style_id: int :param user_id: (required) :type user_id: str - :param tones_view: - :type tones_view: TonesView + :param styles_view: (required) + :type styles_view: StylesView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5254,10 +5568,11 @@ def ai_prompt_orgs_users_tones_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tones_create_serialize( + _param = self._ai_prompt_orgs_users_styles_update_serialize( org=org, + style_id=style_id, user_id=user_id, - tones_view=tones_view, + styles_view=styles_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5265,7 +5580,7 @@ def ai_prompt_orgs_users_tones_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "TonesView", + '200': "StylesView", } response_data = self.api_client.call_api( *_param, @@ -5274,11 +5589,12 @@ def ai_prompt_orgs_users_tones_create( return response_data.response - def _ai_prompt_orgs_users_tones_create_serialize( + def _ai_prompt_orgs_users_styles_update_serialize( self, org, + style_id, user_id, - tones_view, + styles_view, _request_auth, _content_type, _headers, @@ -5300,14 +5616,16 @@ def _ai_prompt_orgs_users_tones_create_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if style_id is not None: + _path_params['style_id'] = style_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if tones_view is not None: - _body_params = tones_view + if styles_view is not None: + _body_params = styles_view # set the HTTP header `Accept` @@ -5340,8 +5658,8 @@ def _ai_prompt_orgs_users_tones_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/', + method='PUT', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/styles/{style_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5358,11 +5676,11 @@ def _ai_prompt_orgs_users_tones_create_serialize( @validate_call - def ai_prompt_orgs_users_tones_destroy( + def ai_prompt_orgs_users_tags_create( self, org: StrictStr, - tone_id: StrictInt, user_id: StrictStr, + tags_view: TagsView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5376,16 +5694,16 @@ def ai_prompt_orgs_users_tones_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tones_destroy + """ai_prompt_orgs_users_tags_create - Endpoint for deleting prompt tone. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tone/1/ Response: No response Data + Endpoint for Adding prompt tag. Accessible to tenant admins and students. Returns: 201: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/ Request: Response: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } :param org: (required) :type org: str - :param tone_id: (required) - :type tone_id: int :param user_id: (required) :type user_id: str + :param tags_view: (required) + :type tags_view: TagsView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5408,10 +5726,10 @@ def ai_prompt_orgs_users_tones_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tones_destroy_serialize( + _param = self._ai_prompt_orgs_users_tags_create_serialize( org=org, - tone_id=tone_id, user_id=user_id, + tags_view=tags_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5419,7 +5737,7 @@ def ai_prompt_orgs_users_tones_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '201': "TagsView", } response_data = self.api_client.call_api( *_param, @@ -5428,11 +5746,11 @@ def ai_prompt_orgs_users_tones_destroy( return response_data.response - def _ai_prompt_orgs_users_tones_destroy_serialize( + def _ai_prompt_orgs_users_tags_create_serialize( self, org, - tone_id, user_id, + tags_view, _request_auth, _content_type, _headers, @@ -5454,17 +5772,39 @@ def _ai_prompt_orgs_users_tones_destroy_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if tone_id is not None: - _path_params['tone_id'] = tone_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if tags_view is not None: + _body_params = tags_view + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -5472,8 +5812,8 @@ def _ai_prompt_orgs_users_tones_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5490,9 +5830,10 @@ def _ai_prompt_orgs_users_tones_destroy_serialize( @validate_call - def ai_prompt_orgs_users_tones_retrieve( + def ai_prompt_orgs_users_tags_destroy( self, org: StrictStr, + tag_id: StrictInt, user_id: StrictStr, _request_timeout: Union[ None, @@ -5507,12 +5848,14 @@ def ai_prompt_orgs_users_tones_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tones_retrieve + """ai_prompt_orgs_users_tags_destroy - Endpoint for getting prompt tones. Accessible to tenant admins and students. Returns: 200: List of tones. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tones/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] + Endpoint for deleting prompt tag. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Response: No response Data :param org: (required) :type org: str + :param tag_id: (required) + :type tag_id: int :param user_id: (required) :type user_id: str :param _request_timeout: timeout setting for this request. If one @@ -5537,8 +5880,9 @@ def ai_prompt_orgs_users_tones_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tones_retrieve_serialize( + _param = self._ai_prompt_orgs_users_tags_destroy_serialize( org=org, + tag_id=tag_id, user_id=user_id, _request_auth=_request_auth, _content_type=_content_type, @@ -5547,7 +5891,7 @@ def ai_prompt_orgs_users_tones_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "TonesView", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -5556,9 +5900,10 @@ def ai_prompt_orgs_users_tones_retrieve( return response_data.response - def _ai_prompt_orgs_users_tones_retrieve_serialize( + def _ai_prompt_orgs_users_tags_destroy_serialize( self, org, + tag_id, user_id, _request_auth, _content_type, @@ -5581,6 +5926,8 @@ def _ai_prompt_orgs_users_tones_retrieve_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if tag_id is not None: + _path_params['tag_id'] = tag_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters @@ -5589,13 +5936,6 @@ def _ai_prompt_orgs_users_tones_retrieve_serialize( # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -5604,8 +5944,8 @@ def _ai_prompt_orgs_users_tones_retrieve_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/', + method='DELETE', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5622,12 +5962,10 @@ def _ai_prompt_orgs_users_tones_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_tones_update( + def ai_prompt_orgs_users_tags_retrieve( self, org: StrictStr, - tone_id: StrictInt, user_id: StrictStr, - tones_view: Optional[TonesView] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5641,18 +5979,14 @@ def ai_prompt_orgs_users_tones_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_tones_update + """ai_prompt_orgs_users_tags_retrieve - Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: 200: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } + Endpoint for getting prompt tags. Accessible to tenant admins and students. Returns: 200: List of tags. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tags/ Response: [ { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } ] :param org: (required) :type org: str - :param tone_id: (required) - :type tone_id: int :param user_id: (required) :type user_id: str - :param tones_view: - :type tones_view: TonesView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5675,11 +6009,9 @@ def ai_prompt_orgs_users_tones_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_tones_update_serialize( + _param = self._ai_prompt_orgs_users_tags_retrieve_serialize( org=org, - tone_id=tone_id, user_id=user_id, - tones_view=tones_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5687,7 +6019,7 @@ def ai_prompt_orgs_users_tones_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "TonesView", + '200': "TagsView", } response_data = self.api_client.call_api( *_param, @@ -5696,12 +6028,10 @@ def ai_prompt_orgs_users_tones_update( return response_data.response - def _ai_prompt_orgs_users_tones_update_serialize( + def _ai_prompt_orgs_users_tags_retrieve_serialize( self, org, - tone_id, user_id, - tones_view, _request_auth, _content_type, _headers, @@ -5723,16 +6053,12 @@ def _ai_prompt_orgs_users_tones_update_serialize( # process the path parameters if org is not None: _path_params['org'] = org - if tone_id is not None: - _path_params['tone_id'] = tone_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if tones_view is not None: - _body_params = tones_view # set the HTTP header `Accept` @@ -5743,21 +6069,6 @@ def _ai_prompt_orgs_users_tones_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -5765,8 +6076,8 @@ def _ai_prompt_orgs_users_tones_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/', + method='GET', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5783,11 +6094,12 @@ def _ai_prompt_orgs_users_tones_update_serialize( @validate_call - def ai_prompt_orgs_users_user_catalog_item_memory_create( + def ai_prompt_orgs_users_tags_update( self, org: StrictStr, + tag_id: StrictInt, user_id: StrictStr, - user_catalog_item_memory_view: UserCatalogItemMemoryView, + tags_view: TagsView, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5801,16 +6113,18 @@ def ai_prompt_orgs_users_user_catalog_item_memory_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_user_catalog_item_memory_create + """ai_prompt_orgs_users_tags_update - Endpoint for Adding user catalog item memory. Accessible to tenant admins and students. Returns: 201: user catalog item memory Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } + Endpoint for updating prompt tag. Accessible to tenant admins and students. Returns: 200: tag Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tags/1/ Request: { \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } Response: { \"id\": 1, \"name\": \"Programming\", \"description\": \"tags for programing prompts\" } :param org: (required) :type org: str + :param tag_id: (required) + :type tag_id: int :param user_id: (required) :type user_id: str - :param user_catalog_item_memory_view: (required) - :type user_catalog_item_memory_view: UserCatalogItemMemoryView + :param tags_view: (required) + :type tags_view: TagsView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5833,10 +6147,11 @@ def ai_prompt_orgs_users_user_catalog_item_memory_create( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_user_catalog_item_memory_create_serialize( + _param = self._ai_prompt_orgs_users_tags_update_serialize( org=org, + tag_id=tag_id, user_id=user_id, - user_catalog_item_memory_view=user_catalog_item_memory_view, + tags_view=tags_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5844,7 +6159,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_create( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "UserCatalogItemMemoryView", + '200': "TagsView", } response_data = self.api_client.call_api( *_param, @@ -5853,11 +6168,12 @@ def ai_prompt_orgs_users_user_catalog_item_memory_create( return response_data.response - def _ai_prompt_orgs_users_user_catalog_item_memory_create_serialize( + def _ai_prompt_orgs_users_tags_update_serialize( self, org, + tag_id, user_id, - user_catalog_item_memory_view, + tags_view, _request_auth, _content_type, _headers, @@ -5879,14 +6195,16 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_create_serialize( # process the path parameters if org is not None: _path_params['org'] = org + if tag_id is not None: + _path_params['tag_id'] = tag_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if user_catalog_item_memory_view is not None: - _body_params = user_catalog_item_memory_view + if tags_view is not None: + _body_params = tags_view # set the HTTP header `Accept` @@ -5919,8 +6237,8 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/', + method='PUT', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tags/{tag_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5937,10 +6255,11 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_create_serialize( @validate_call - def ai_prompt_orgs_users_user_catalog_item_memory_destroy( + def ai_prompt_orgs_users_tones_create( self, org: StrictStr, user_id: StrictStr, + tones_view: Optional[TonesView] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5954,14 +6273,16 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_user_catalog_item_memory_destroy + """ai_prompt_orgs_users_tones_create - Endpoint for clearing user catalog item memories. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Response: No response Data + Endpoint for Adding prompt tone. Accessible to tenant admins only. Returns: 201: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/ Request: Response: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } :param org: (required) :type org: str :param user_id: (required) :type user_id: str + :param tones_view: + :type tones_view: TonesView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5984,9 +6305,10 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_user_catalog_item_memory_destroy_serialize( + _param = self._ai_prompt_orgs_users_tones_create_serialize( org=org, user_id=user_id, + tones_view=tones_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5994,7 +6316,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '201': "TonesView", } response_data = self.api_client.call_api( *_param, @@ -6003,10 +6325,11 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy( return response_data.response - def _ai_prompt_orgs_users_user_catalog_item_memory_destroy_serialize( + def _ai_prompt_orgs_users_tones_create_serialize( self, org, user_id, + tones_view, _request_auth, _content_type, _headers, @@ -6034,9 +6357,33 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy_serialize( # process the header parameters # process the form parameters # process the body parameter + if tones_view is not None: + _body_params = tones_view + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -6044,8 +6391,8 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy_serialize( ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/', + method='POST', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6062,10 +6409,10 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy_serialize( @validate_call - def ai_prompt_orgs_users_user_catalog_item_memory_destroy2( + def ai_prompt_orgs_users_tones_destroy( self, - memory_id: StrictInt, org: StrictStr, + tone_id: StrictInt, user_id: StrictStr, _request_timeout: Union[ None, @@ -6080,14 +6427,14 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy2( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_user_catalog_item_memory_destroy2 + """ai_prompt_orgs_users_tones_destroy - Endpoint for deleting user catalog item memory Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/1/ Response: No response Data + Endpoint for deleting prompt tone. Accessible to tenant admins and students. Returns: 204: No response data. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tone/1/ Response: No response Data - :param memory_id: (required) - :type memory_id: int :param org: (required) :type org: str + :param tone_id: (required) + :type tone_id: int :param user_id: (required) :type user_id: str :param _request_timeout: timeout setting for this request. If one @@ -6112,9 +6459,9 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy2( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_user_catalog_item_memory_destroy2_serialize( - memory_id=memory_id, + _param = self._ai_prompt_orgs_users_tones_destroy_serialize( org=org, + tone_id=tone_id, user_id=user_id, _request_auth=_request_auth, _content_type=_content_type, @@ -6132,10 +6479,10 @@ def ai_prompt_orgs_users_user_catalog_item_memory_destroy2( return response_data.response - def _ai_prompt_orgs_users_user_catalog_item_memory_destroy2_serialize( + def _ai_prompt_orgs_users_tones_destroy_serialize( self, - memory_id, org, + tone_id, user_id, _request_auth, _content_type, @@ -6156,10 +6503,10 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy2_serialize( _body_params: Optional[bytes] = None # process the path parameters - if memory_id is not None: - _path_params['memory_id'] = memory_id if org is not None: _path_params['org'] = org + if tone_id is not None: + _path_params['tone_id'] = tone_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters @@ -6177,7 +6524,7 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy2_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6194,7 +6541,7 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_destroy2_serialize( @validate_call - def ai_prompt_orgs_users_user_catalog_item_memory_retrieve( + def ai_prompt_orgs_users_tones_retrieve( self, org: StrictStr, user_id: StrictStr, @@ -6211,9 +6558,9 @@ def ai_prompt_orgs_users_user_catalog_item_memory_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_user_catalog_item_memory_retrieve + """ai_prompt_orgs_users_tones_retrieve - Endpoint for getting user catalog item memories. Accessible to tenant admins and students. Returns: 200: List of user catalog item memories. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/ Response: [ { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" }, } ] + Endpoint for getting prompt tones. Accessible to tenant admins and students. Returns: 200: List of tones. Example: GET: /api/ai-prompt/orgs/main/users/johndoe/tones/ Response: [ { \"id\": 1, \"description\": \"Sympathetic\" } ] :param org: (required) :type org: str @@ -6241,7 +6588,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_user_catalog_item_memory_retrieve_serialize( + _param = self._ai_prompt_orgs_users_tones_retrieve_serialize( org=org, user_id=user_id, _request_auth=_request_auth, @@ -6251,7 +6598,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserCatalogItemMemoryView", + '200': "TonesView", } response_data = self.api_client.call_api( *_param, @@ -6260,7 +6607,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_retrieve( return response_data.response - def _ai_prompt_orgs_users_user_catalog_item_memory_retrieve_serialize( + def _ai_prompt_orgs_users_tones_retrieve_serialize( self, org, user_id, @@ -6309,7 +6656,7 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6326,12 +6673,12 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_retrieve_serialize( @validate_call - def ai_prompt_orgs_users_user_catalog_item_memory_update( + def ai_prompt_orgs_users_tones_update( self, - memory_id: StrictInt, org: StrictStr, + tone_id: StrictInt, user_id: StrictStr, - user_catalog_item_memory_view: UserCatalogItemMemoryView, + tones_view: Optional[TonesView] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6345,18 +6692,18 @@ def ai_prompt_orgs_users_user_catalog_item_memory_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """ai_prompt_orgs_users_user_catalog_item_memory_update + """ai_prompt_orgs_users_tones_update - Endpoint for updating user catalog item memory. Accessible to tenant admins and students. Returns: 200: user catalog item memory object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/user-catalog-item-memory/1/ Request: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": \"i learnt about x and y\", \"next_steps\": \"learning about z\" } Response: { \"id\": 1, \"student\": \"johndoes\", \"platform\": \"main\", \"catalog_item\": \"Loves programming\", \"lessons\": { \"gaming\": \"i learnt how to play chess\" }, \"next_steps\": { \"gaming\": \"I want to learn how to play golf\", \"singing\": \"I want to learn how to sing pop music\" } } + Endpoint for updating prompt tone. Accessible to tenant admins only. Returns: 200: tone Object. 400: When data is not valid. Example: POST: /api/ai-prompt/orgs/main/users/johndoe/tones/1/ Request: { \"description\": \"Sympathetic\" } Response: { \"id\": 1, \"description\": \"Sympathetic\" } - :param memory_id: (required) - :type memory_id: int :param org: (required) :type org: str + :param tone_id: (required) + :type tone_id: int :param user_id: (required) :type user_id: str - :param user_catalog_item_memory_view: (required) - :type user_catalog_item_memory_view: UserCatalogItemMemoryView + :param tones_view: + :type tones_view: TonesView :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -6379,11 +6726,11 @@ def ai_prompt_orgs_users_user_catalog_item_memory_update( :return: Returns the result object. """ # noqa: E501 - _param = self._ai_prompt_orgs_users_user_catalog_item_memory_update_serialize( - memory_id=memory_id, + _param = self._ai_prompt_orgs_users_tones_update_serialize( org=org, + tone_id=tone_id, user_id=user_id, - user_catalog_item_memory_view=user_catalog_item_memory_view, + tones_view=tones_view, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6391,7 +6738,7 @@ def ai_prompt_orgs_users_user_catalog_item_memory_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "UserCatalogItemMemoryView", + '200': "TonesView", } response_data = self.api_client.call_api( *_param, @@ -6400,12 +6747,12 @@ def ai_prompt_orgs_users_user_catalog_item_memory_update( return response_data.response - def _ai_prompt_orgs_users_user_catalog_item_memory_update_serialize( + def _ai_prompt_orgs_users_tones_update_serialize( self, - memory_id, org, + tone_id, user_id, - user_catalog_item_memory_view, + tones_view, _request_auth, _content_type, _headers, @@ -6425,18 +6772,18 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if memory_id is not None: - _path_params['memory_id'] = memory_id if org is not None: _path_params['org'] = org + if tone_id is not None: + _path_params['tone_id'] = tone_id if user_id is not None: _path_params['user_id'] = user_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if user_catalog_item_memory_view is not None: - _body_params = user_catalog_item_memory_view + if tones_view is not None: + _body_params = tones_view # set the HTTP header `Accept` @@ -6470,7 +6817,7 @@ def _ai_prompt_orgs_users_user_catalog_item_memory_update_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/user-catalog-item-memory/{memory_id}/', + resource_path='/api/ai-prompt/orgs/{org}/users/{user_id}/tones/{tone_id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/iblai/api/analytics_api.py b/iblai/api/analytics_api.py index de52d70..bf0315d 100644 --- a/iblai/api/analytics_api.py +++ b/iblai/api/analytics_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/audience_api.py b/iblai/api/audience_api.py index 8f0ad7e..83ec3cd 100644 --- a/iblai/api/audience_api.py +++ b/iblai/api/audience_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/career_api.py b/iblai/api/career_api.py index 81edb96..097c851 100644 --- a/iblai/api/career_api.py +++ b/iblai/api/career_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,6 +17,11 @@ from typing_extensions import Annotated from pydantic import StrictStr +from iblai.models.company import Company +from iblai.models.education import Education +from iblai.models.experience import Experience +from iblai.models.institution import Institution +from iblai.models.program import Program from iblai.api_client import ApiClient, RequestSerialized from iblai.api_response import ApiResponse @@ -36,11 +41,2816 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def career_orgs_companies_users_create( + self, + org: StrictStr, + username: StrictStr, + company: Company, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_companies_users_create + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param company: (required) + :type company: Company + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_companies_users_create_serialize( + org=org, + username=username, + company=company, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Company", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_companies_users_create_serialize( + self, + org, + username, + company, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if company is not None: + _body_params = company + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/career/orgs/{org}/companies/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_companies_users_destroy( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_companies_users_destroy + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_companies_users_destroy_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_companies_users_destroy_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/career/orgs/{org}/companies/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_companies_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_companies_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_companies_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Company", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_companies_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/career/orgs/{org}/companies/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_companies_users_update( + self, + org: StrictStr, + username: StrictStr, + company: Company, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_companies_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param company: (required) + :type company: Company + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_companies_users_update_serialize( + org=org, + username=username, + company=company, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Company", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_companies_users_update_serialize( + self, + org, + username, + company, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if company is not None: + _body_params = company + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/orgs/{org}/companies/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_education_users_create( + self, + org: StrictStr, + username: StrictStr, + education: Education, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_education_users_create + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param education: (required) + :type education: Education + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_education_users_create_serialize( + org=org, + username=username, + education=education, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Education", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_education_users_create_serialize( + self, + org, + username, + education, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if education is not None: + _body_params = education + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/career/orgs/{org}/education/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_education_users_destroy( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_education_users_destroy + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_education_users_destroy_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_education_users_destroy_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/career/orgs/{org}/education/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_education_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_education_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_education_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Education", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_education_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/career/orgs/{org}/education/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_education_users_update( + self, + org: StrictStr, + username: StrictStr, + education: Education, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_education_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param education: (required) + :type education: Education + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_education_users_update_serialize( + org=org, + username=username, + education=education, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Education", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_education_users_update_serialize( + self, + org, + username, + education, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if education is not None: + _body_params = education + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/orgs/{org}/education/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_experience_users_create( + self, + org: StrictStr, + username: StrictStr, + experience: Experience, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_experience_users_create + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param experience: (required) + :type experience: Experience + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_experience_users_create_serialize( + org=org, + username=username, + experience=experience, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Experience", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_experience_users_create_serialize( + self, + org, + username, + experience, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if experience is not None: + _body_params = experience + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/career/orgs/{org}/experience/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_experience_users_destroy( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_experience_users_destroy + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_experience_users_destroy_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_experience_users_destroy_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/career/orgs/{org}/experience/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_experience_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_experience_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_experience_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Experience", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_experience_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/career/orgs/{org}/experience/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_experience_users_update( + self, + org: StrictStr, + username: StrictStr, + experience: Experience, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_experience_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param experience: (required) + :type experience: Experience + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_experience_users_update_serialize( + org=org, + username=username, + experience=experience, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Experience", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_experience_users_update_serialize( + self, + org, + username, + experience, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if experience is not None: + _body_params = experience + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/orgs/{org}/experience/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_institutions_users_create( + self, + org: StrictStr, + username: StrictStr, + institution: Institution, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_institutions_users_create + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param institution: (required) + :type institution: Institution + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_institutions_users_create_serialize( + org=org, + username=username, + institution=institution, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Institution", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_institutions_users_create_serialize( + self, + org, + username, + institution, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if institution is not None: + _body_params = institution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/career/orgs/{org}/institutions/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_institutions_users_destroy( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_institutions_users_destroy + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_institutions_users_destroy_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_institutions_users_destroy_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/career/orgs/{org}/institutions/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_institutions_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_institutions_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_institutions_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Institution", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_institutions_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/career/orgs/{org}/institutions/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_institutions_users_update( + self, + org: StrictStr, + username: StrictStr, + institution: Institution, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_institutions_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param institution: (required) + :type institution: Institution + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_institutions_users_update_serialize( + org=org, + username=username, + institution=institution, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Institution", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_institutions_users_update_serialize( + self, + org, + username, + institution, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if institution is not None: + _body_params = institution + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/orgs/{org}/institutions/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_programs_users_create( + self, + org: StrictStr, + username: StrictStr, + program: Program, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_programs_users_create + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param program: (required) + :type program: Program + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_programs_users_create_serialize( + org=org, + username=username, + program=program, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Program", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_programs_users_create_serialize( + self, + org, + username, + program, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if program is not None: + _body_params = program + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/career/orgs/{org}/programs/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_programs_users_destroy( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_programs_users_destroy + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_programs_users_destroy_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_programs_users_destroy_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/career/orgs/{org}/programs/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_programs_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_programs_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_programs_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Program", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_programs_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/career/orgs/{org}/programs/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_orgs_programs_users_update( + self, + org: StrictStr, + username: StrictStr, + program: Program, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_orgs_programs_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param program: (required) + :type program: Program + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_orgs_programs_users_update_serialize( + org=org, + username=username, + program=program, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Program", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_orgs_programs_users_update_serialize( + self, + org, + username, + program, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if program is not None: + _body_params = program + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/orgs/{org}/programs/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def career_resume_orgs_users_create( self, - orgs: StrictStr, - user_id: StrictStr, + org: StrictStr, + username: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -56,12 +2866,11 @@ def career_resume_orgs_users_create( ) -> RESTResponseType: """career_resume_orgs_users_create - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - :param orgs: (required) - :type orgs: str - :param user_id: (required) - :type user_id: str + :param org: (required) + :type org: str + :param username: (required) + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -85,8 +2894,8 @@ def career_resume_orgs_users_create( """ # noqa: E501 _param = self._career_resume_orgs_users_create_serialize( - orgs=orgs, - user_id=user_id, + org=org, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -105,8 +2914,8 @@ def career_resume_orgs_users_create( def _career_resume_orgs_users_create_serialize( self, - orgs, - user_id, + org, + username, _request_auth, _content_type, _headers, @@ -126,10 +2935,10 @@ def _career_resume_orgs_users_create_serialize( _body_params: Optional[bytes] = None # process the path parameters - if orgs is not None: - _path_params['orgs'] = orgs - if user_id is not None: - _path_params['user_id'] = user_id + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username # process the query parameters # process the header parameters # process the form parameters @@ -145,7 +2954,7 @@ def _career_resume_orgs_users_create_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/api/career/resume/orgs/{orgs}/users/{user_id}/', + resource_path='/api/career/resume/orgs/{org}/users/{username}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -164,8 +2973,8 @@ def _career_resume_orgs_users_create_serialize( @validate_call def career_resume_orgs_users_retrieve( self, - orgs: StrictStr, - user_id: StrictStr, + org: StrictStr, + username: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -181,12 +2990,11 @@ def career_resume_orgs_users_retrieve( ) -> RESTResponseType: """career_resume_orgs_users_retrieve - Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent - :param orgs: (required) - :type orgs: str - :param user_id: (required) - :type user_id: str + :param org: (required) + :type org: str + :param username: (required) + :type username: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -210,8 +3018,8 @@ def career_resume_orgs_users_retrieve( """ # noqa: E501 _param = self._career_resume_orgs_users_retrieve_serialize( - orgs=orgs, - user_id=user_id, + org=org, + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -230,8 +3038,8 @@ def career_resume_orgs_users_retrieve( def _career_resume_orgs_users_retrieve_serialize( self, - orgs, - user_id, + org, + username, _request_auth, _content_type, _headers, @@ -251,10 +3059,10 @@ def _career_resume_orgs_users_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if orgs is not None: - _path_params['orgs'] = orgs - if user_id is not None: - _path_params['user_id'] = user_id + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username # process the query parameters # process the header parameters # process the form parameters @@ -270,7 +3078,131 @@ def _career_resume_orgs_users_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/career/resume/orgs/{orgs}/users/{user_id}/', + resource_path='/api/career/resume/orgs/{org}/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def career_resume_orgs_users_update( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """career_resume_orgs_users_update + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._career_resume_orgs_users_update_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _career_resume_orgs_users_update_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/career/resume/orgs/{org}/users/{username}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/iblai/api/core_api.py b/iblai/api/core_api.py index 7f7299c..22a039d 100644 --- a/iblai/api/core_api.py +++ b/iblai/api/core_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -16,11 +16,16 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictStr -from typing import Any, Dict, Optional +from pydantic import Field, StrictStr +from typing import Any, Dict, List, Optional +from typing_extensions import Annotated from iblai.models.image_upload import ImageUpload +from iblai.models.lti_key import LtiKey +from iblai.models.lti_tool import LtiTool from iblai.models.patched_platform_public_metadata import PatchedPlatformPublicMetadata from iblai.models.platform_public_metadata import PlatformPublicMetadata +from iblai.models.redirect_token_request import RedirectTokenRequest +from iblai.models.redirect_token_response import RedirectTokenResponse from iblai.api_client import ApiClient, RequestSerialized from iblai.api_response import ApiResponse @@ -41,10 +46,9 @@ def __init__(self, api_client=None) -> None: @validate_call - def core_orgs_dark_mode_logo_create_create( + def core_lti1p3_provider_lti_keys_create( self, - org: StrictStr, - image_upload: ImageUpload, + lti_key: LtiKey, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -58,14 +62,12 @@ def core_orgs_dark_mode_logo_create_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_dark_mode_logo_create_create + """core_lti1p3_provider_lti_keys_create - Upload a new platform logo + Create a new LTI Provider Key - :param org: (required) - :type org: str - :param image_upload: (required) - :type image_upload: ImageUpload + :param lti_key: (required) + :type lti_key: LtiKey :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -88,9 +90,8 @@ def core_orgs_dark_mode_logo_create_create( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_dark_mode_logo_create_create_serialize( - org=org, - image_upload=image_upload, + _param = self._core_lti1p3_provider_lti_keys_create_serialize( + lti_key=lti_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -98,7 +99,7 @@ def core_orgs_dark_mode_logo_create_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ImageUpload", + '201': "LtiKey", } response_data = self.api_client.call_api( *_param, @@ -107,10 +108,9 @@ def core_orgs_dark_mode_logo_create_create( return response_data.response - def _core_orgs_dark_mode_logo_create_create_serialize( + def _core_lti1p3_provider_lti_keys_create_serialize( self, - org, - image_upload, + lti_key, _request_auth, _content_type, _headers, @@ -130,14 +130,12 @@ def _core_orgs_dark_mode_logo_create_create_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if image_upload is not None: - _body_params = image_upload + if lti_key is not None: + _body_params = lti_key # set the HTTP header `Accept` @@ -171,7 +169,7 @@ def _core_orgs_dark_mode_logo_create_create_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/api/core/orgs/{org}/dark-mode-logo/create/', + resource_path='/api/core/lti/1p3/provider/lti-keys/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -188,9 +186,10 @@ def _core_orgs_dark_mode_logo_create_create_serialize( @validate_call - def core_orgs_dark_mode_logo_retrieve( + def core_lti1p3_provider_lti_keys_destroy( self, - org: StrictStr, + id: StrictStr, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -204,12 +203,14 @@ def core_orgs_dark_mode_logo_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_dark_mode_logo_retrieve + """core_lti1p3_provider_lti_keys_destroy - Get platform logo + Delete an LTI Provider Key **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one. - :param org: (required) - :type org: str + :param id: (required) + :type id: str + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -232,8 +233,9 @@ def core_orgs_dark_mode_logo_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_dark_mode_logo_retrieve_serialize( - org=org, + _param = self._core_lti1p3_provider_lti_keys_destroy_serialize( + id=id, + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -241,7 +243,7 @@ def core_orgs_dark_mode_logo_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Dict[str, object]", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -250,9 +252,10 @@ def core_orgs_dark_mode_logo_retrieve( return response_data.response - def _core_orgs_dark_mode_logo_retrieve_serialize( + def _core_lti1p3_provider_lti_keys_destroy_serialize( self, - org, + id, + platform_key, _request_auth, _content_type, _headers, @@ -272,30 +275,28 @@ def _core_orgs_dark_mode_logo_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org + if id is not None: + _path_params['id'] = id # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/core/orgs/{org}/dark-mode-logo/', + method='DELETE', + resource_path='/api/core/lti/1p3/provider/lti-keys/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -312,10 +313,9 @@ def _core_orgs_dark_mode_logo_retrieve_serialize( @validate_call - def core_orgs_favicon_create_create( + def core_lti1p3_provider_lti_keys_list( self, - org: StrictStr, - image_upload: ImageUpload, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -329,14 +329,12 @@ def core_orgs_favicon_create_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_favicon_create_create + """core_lti1p3_provider_lti_keys_list - Upload a new platform logo + List your LTI Provider Key's - :param org: (required) - :type org: str - :param image_upload: (required) - :type image_upload: ImageUpload + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -359,9 +357,8 @@ def core_orgs_favicon_create_create( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_favicon_create_create_serialize( - org=org, - image_upload=image_upload, + _param = self._core_lti1p3_provider_lti_keys_list_serialize( + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -369,7 +366,7 @@ def core_orgs_favicon_create_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ImageUpload", + '200': "List[LtiKey]", } response_data = self.api_client.call_api( *_param, @@ -378,10 +375,9 @@ def core_orgs_favicon_create_create( return response_data.response - def _core_orgs_favicon_create_create_serialize( + def _core_lti1p3_provider_lti_keys_list_serialize( self, - org, - image_upload, + platform_key, _request_auth, _content_type, _headers, @@ -401,14 +397,14 @@ def _core_orgs_favicon_create_create_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter - if image_upload is not None: - _body_params = image_upload # set the HTTP header `Accept` @@ -419,21 +415,6 @@ def _core_orgs_favicon_create_create_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -441,8 +422,8 @@ def _core_orgs_favicon_create_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/core/orgs/{org}/favicon/create/', + method='GET', + resource_path='/api/core/lti/1p3/provider/lti-keys/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -459,9 +440,10 @@ def _core_orgs_favicon_create_create_serialize( @validate_call - def core_orgs_favicon_retrieve( + def core_lti1p3_provider_lti_keys_retrieve( self, - org: StrictStr, + id: StrictStr, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -475,12 +457,14 @@ def core_orgs_favicon_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_favicon_retrieve + """core_lti1p3_provider_lti_keys_retrieve - Get platform logo + Get details about a specific LTI Provider Key - :param org: (required) - :type org: str + :param id: (required) + :type id: str + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -503,8 +487,9 @@ def core_orgs_favicon_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_favicon_retrieve_serialize( - org=org, + _param = self._core_lti1p3_provider_lti_keys_retrieve_serialize( + id=id, + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -512,7 +497,7 @@ def core_orgs_favicon_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Dict[str, object]", + '200': "LtiKey", } response_data = self.api_client.call_api( *_param, @@ -521,9 +506,10 @@ def core_orgs_favicon_retrieve( return response_data.response - def _core_orgs_favicon_retrieve_serialize( + def _core_lti1p3_provider_lti_keys_retrieve_serialize( self, - org, + id, + platform_key, _request_auth, _content_type, _headers, @@ -543,9 +529,13 @@ def _core_orgs_favicon_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org + if id is not None: + _path_params['id'] = id # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter @@ -562,11 +552,12 @@ def _core_orgs_favicon_retrieve_serialize( # authentication setting _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( method='GET', - resource_path='/api/core/orgs/{org}/favicon/', + resource_path='/api/core/lti/1p3/provider/lti-keys/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -583,10 +574,10 @@ def _core_orgs_favicon_retrieve_serialize( @validate_call - def core_orgs_logo_create_create( + def core_lti1p3_provider_lti_keys_update( self, - org: StrictStr, - image_upload: ImageUpload, + id: StrictStr, + lti_key: LtiKey, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -600,14 +591,14 @@ def core_orgs_logo_create_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_logo_create_create + """core_lti1p3_provider_lti_keys_update - Upload a new platform logo + Update an LTI Provider Key - :param org: (required) - :type org: str - :param image_upload: (required) - :type image_upload: ImageUpload + :param id: (required) + :type id: str + :param lti_key: (required) + :type lti_key: LtiKey :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -630,9 +621,9 @@ def core_orgs_logo_create_create( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_logo_create_create_serialize( - org=org, - image_upload=image_upload, + _param = self._core_lti1p3_provider_lti_keys_update_serialize( + id=id, + lti_key=lti_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -640,7 +631,7 @@ def core_orgs_logo_create_create( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ImageUpload", + '200': "LtiKey", } response_data = self.api_client.call_api( *_param, @@ -649,10 +640,10 @@ def core_orgs_logo_create_create( return response_data.response - def _core_orgs_logo_create_create_serialize( + def _core_lti1p3_provider_lti_keys_update_serialize( self, - org, - image_upload, + id, + lti_key, _request_auth, _content_type, _headers, @@ -672,14 +663,14 @@ def _core_orgs_logo_create_create_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org + if id is not None: + _path_params['id'] = id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if image_upload is not None: - _body_params = image_upload + if lti_key is not None: + _body_params = lti_key # set the HTTP header `Accept` @@ -712,8 +703,8 @@ def _core_orgs_logo_create_create_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/core/orgs/{org}/logo/create/', + method='PUT', + resource_path='/api/core/lti/1p3/provider/lti-keys/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -730,9 +721,9 @@ def _core_orgs_logo_create_create_serialize( @validate_call - def core_orgs_logo_retrieve( + def core_lti1p3_provider_lti_tools_create( self, - org: StrictStr, + lti_tool: LtiTool, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -746,12 +737,12 @@ def core_orgs_logo_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_logo_retrieve + """core_lti1p3_provider_lti_tools_create - Get platform logo + Create a new LTI Tool - :param org: (required) - :type org: str + :param lti_tool: (required) + :type lti_tool: LtiTool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -774,8 +765,8 @@ def core_orgs_logo_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_logo_retrieve_serialize( - org=org, + _param = self._core_lti1p3_provider_lti_tools_create_serialize( + lti_tool=lti_tool, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -783,7 +774,7 @@ def core_orgs_logo_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Dict[str, object]", + '201': "LtiTool", } response_data = self.api_client.call_api( *_param, @@ -792,9 +783,9 @@ def core_orgs_logo_retrieve( return response_data.response - def _core_orgs_logo_retrieve_serialize( + def _core_lti1p3_provider_lti_tools_create_serialize( self, - org, + lti_tool, _request_auth, _content_type, _headers, @@ -814,12 +805,12 @@ def _core_orgs_logo_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if lti_tool is not None: + _body_params = lti_tool # set the HTTP header `Accept` @@ -830,14 +821,30 @@ def _core_orgs_logo_retrieve_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/core/orgs/{org}/logo/', + method='POST', + resource_path='/api/core/lti/1p3/provider/lti-tools/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -854,10 +861,10 @@ def _core_orgs_logo_retrieve_serialize( @validate_call - def core_orgs_metadata_partial_update( + def core_lti1p3_provider_lti_tools_destroy( self, - org: StrictStr, - patched_platform_public_metadata: Optional[PatchedPlatformPublicMetadata] = None, + id: StrictStr, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -871,13 +878,14 @@ def core_orgs_metadata_partial_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_metadata_partial_update + """core_lti1p3_provider_lti_tools_destroy + Delete an LTI Tool - :param org: (required) - :type org: str - :param patched_platform_public_metadata: - :type patched_platform_public_metadata: PatchedPlatformPublicMetadata + :param id: (required) + :type id: str + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -900,9 +908,9 @@ def core_orgs_metadata_partial_update( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_metadata_partial_update_serialize( - org=org, - patched_platform_public_metadata=patched_platform_public_metadata, + _param = self._core_lti1p3_provider_lti_tools_destroy_serialize( + id=id, + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -910,7 +918,7 @@ def core_orgs_metadata_partial_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlatformPublicMetadata", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -919,10 +927,10 @@ def core_orgs_metadata_partial_update( return response_data.response - def _core_orgs_metadata_partial_update_serialize( + def _core_lti1p3_provider_lti_tools_destroy_serialize( self, - org, - patched_platform_public_metadata, + id, + platform_key, _request_auth, _content_type, _headers, @@ -942,39 +950,19 @@ def _core_orgs_metadata_partial_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org + if id is not None: + _path_params['id'] = id # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter - if patched_platform_public_metadata is not None: - _body_params = patched_platform_public_metadata - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -982,8 +970,8 @@ def _core_orgs_metadata_partial_update_serialize( ] return self.api_client.param_serialize( - method='PATCH', - resource_path='/api/core/orgs/{org}/metadata/', + method='DELETE', + resource_path='/api/core/lti/1p3/provider/lti-tools/{id}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1000,9 +988,9 @@ def _core_orgs_metadata_partial_update_serialize( @validate_call - def core_orgs_metadata_retrieve( + def core_lti1p3_provider_lti_tools_list( self, - org: StrictStr, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1016,11 +1004,12 @@ def core_orgs_metadata_retrieve( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_metadata_retrieve + """core_lti1p3_provider_lti_tools_list + List your LTI Tool's - :param org: (required) - :type org: str + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1043,8 +1032,8 @@ def core_orgs_metadata_retrieve( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_metadata_retrieve_serialize( - org=org, + _param = self._core_lti1p3_provider_lti_tools_list_serialize( + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1052,7 +1041,7 @@ def core_orgs_metadata_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlatformPublicMetadata", + '200': "List[LtiTool]", } response_data = self.api_client.call_api( *_param, @@ -1061,9 +1050,9 @@ def core_orgs_metadata_retrieve( return response_data.response - def _core_orgs_metadata_retrieve_serialize( + def _core_lti1p3_provider_lti_tools_list_serialize( self, - org, + platform_key, _request_auth, _content_type, _headers, @@ -1083,9 +1072,11 @@ def _core_orgs_metadata_retrieve_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter @@ -1107,7 +1098,7 @@ def _core_orgs_metadata_retrieve_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/core/orgs/{org}/metadata/', + resource_path='/api/core/lti/1p3/provider/lti-tools/', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1124,10 +1115,10 @@ def _core_orgs_metadata_retrieve_serialize( @validate_call - def core_orgs_metadata_update( + def core_lti1p3_provider_lti_tools_retrieve( self, - org: StrictStr, - platform_public_metadata: Optional[PlatformPublicMetadata] = None, + id: StrictStr, + platform_key: Annotated[str, Field(min_length=1, strict=True, description="Platform Key")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1141,13 +1132,14 @@ def core_orgs_metadata_update( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """core_orgs_metadata_update + """core_lti1p3_provider_lti_tools_retrieve + Get details about a specific LTI Tool - :param org: (required) - :type org: str - :param platform_public_metadata: - :type platform_public_metadata: PlatformPublicMetadata + :param id: (required) + :type id: str + :param platform_key: Platform Key (required) + :type platform_key: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1170,9 +1162,9 @@ def core_orgs_metadata_update( :return: Returns the result object. """ # noqa: E501 - _param = self._core_orgs_metadata_update_serialize( - org=org, - platform_public_metadata=platform_public_metadata, + _param = self._core_lti1p3_provider_lti_tools_retrieve_serialize( + id=id, + platform_key=platform_key, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1180,7 +1172,7 @@ def core_orgs_metadata_update( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "PlatformPublicMetadata", + '200': "LtiTool", } response_data = self.api_client.call_api( *_param, @@ -1189,10 +1181,10 @@ def core_orgs_metadata_update( return response_data.response - def _core_orgs_metadata_update_serialize( + def _core_lti1p3_provider_lti_tools_retrieve_serialize( self, - org, - platform_public_metadata, + id, + platform_key, _request_auth, _content_type, _headers, @@ -1212,14 +1204,16 @@ def _core_orgs_metadata_update_serialize( _body_params: Optional[bytes] = None # process the path parameters - if org is not None: - _path_params['org'] = org + if id is not None: + _path_params['id'] = id # process the query parameters + if platform_key is not None: + + _query_params.append(('platform_key', platform_key)) + # process the header parameters # process the form parameters # process the body parameter - if platform_public_metadata is not None: - _body_params = platform_public_metadata # set the HTTP header `Accept` @@ -1230,21 +1224,6 @@ def _core_orgs_metadata_update_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json', - 'application/x-www-form-urlencoded', - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -1252,8 +1231,1788 @@ def _core_orgs_metadata_update_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/core/orgs/{org}/metadata/', + method='GET', + resource_path='/api/core/lti/1p3/provider/lti-tools/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_lti1p3_provider_lti_tools_update( + self, + id: StrictStr, + lti_tool: LtiTool, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_lti1p3_provider_lti_tools_update + + Update an LTI Tool + + :param id: (required) + :type id: str + :param lti_tool: (required) + :type lti_tool: LtiTool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_lti1p3_provider_lti_tools_update_serialize( + id=id, + lti_tool=lti_tool, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LtiTool", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_lti1p3_provider_lti_tools_update_serialize( + self, + id, + lti_tool, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if lti_tool is not None: + _body_params = lti_tool + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/core/lti/1p3/provider/lti-tools/{id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_dark_mode_logo_create_create( + self, + org: StrictStr, + image_upload: ImageUpload, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_dark_mode_logo_create_create + + Upload a new platform logo + + :param org: (required) + :type org: str + :param image_upload: (required) + :type image_upload: ImageUpload + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_dark_mode_logo_create_create_serialize( + org=org, + image_upload=image_upload, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ImageUpload", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_dark_mode_logo_create_create_serialize( + self, + org, + image_upload, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if image_upload is not None: + _body_params = image_upload + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/core/orgs/{org}/dark-mode-logo/create/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_dark_mode_logo_retrieve( + self, + org: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_dark_mode_logo_retrieve + + Get platform logo + + :param org: (required) + :type org: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_dark_mode_logo_retrieve_serialize( + org=org, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_dark_mode_logo_retrieve_serialize( + self, + org, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/core/orgs/{org}/dark-mode-logo/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_favicon_create_create( + self, + org: StrictStr, + image_upload: ImageUpload, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_favicon_create_create + + Upload a new platform logo + + :param org: (required) + :type org: str + :param image_upload: (required) + :type image_upload: ImageUpload + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_favicon_create_create_serialize( + org=org, + image_upload=image_upload, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ImageUpload", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_favicon_create_create_serialize( + self, + org, + image_upload, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if image_upload is not None: + _body_params = image_upload + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/core/orgs/{org}/favicon/create/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_favicon_retrieve( + self, + org: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_favicon_retrieve + + Get platform logo + + :param org: (required) + :type org: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_favicon_retrieve_serialize( + org=org, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_favicon_retrieve_serialize( + self, + org, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/core/orgs/{org}/favicon/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_logo_create_create( + self, + org: StrictStr, + image_upload: ImageUpload, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_logo_create_create + + Upload a new platform logo + + :param org: (required) + :type org: str + :param image_upload: (required) + :type image_upload: ImageUpload + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_logo_create_create_serialize( + org=org, + image_upload=image_upload, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ImageUpload", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_logo_create_create_serialize( + self, + org, + image_upload, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if image_upload is not None: + _body_params = image_upload + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/core/orgs/{org}/logo/create/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_logo_retrieve( + self, + org: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_logo_retrieve + + Get platform logo + + :param org: (required) + :type org: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_logo_retrieve_serialize( + org=org, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Dict[str, object]", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_logo_retrieve_serialize( + self, + org, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/core/orgs/{org}/logo/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_metadata_partial_update( + self, + org: StrictStr, + patched_platform_public_metadata: Optional[PatchedPlatformPublicMetadata] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_metadata_partial_update + + + :param org: (required) + :type org: str + :param patched_platform_public_metadata: + :type patched_platform_public_metadata: PatchedPlatformPublicMetadata + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_metadata_partial_update_serialize( + org=org, + patched_platform_public_metadata=patched_platform_public_metadata, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlatformPublicMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_metadata_partial_update_serialize( + self, + org, + patched_platform_public_metadata, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if patched_platform_public_metadata is not None: + _body_params = patched_platform_public_metadata + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/core/orgs/{org}/metadata/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_metadata_retrieve( + self, + org: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_metadata_retrieve + + + :param org: (required) + :type org: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_metadata_retrieve_serialize( + org=org, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlatformPublicMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_metadata_retrieve_serialize( + self, + org, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/core/orgs/{org}/metadata/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_metadata_update( + self, + org: StrictStr, + platform_public_metadata: Optional[PlatformPublicMetadata] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_metadata_update + + + :param org: (required) + :type org: str + :param platform_public_metadata: + :type platform_public_metadata: PlatformPublicMetadata + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_metadata_update_serialize( + org=org, + platform_public_metadata=platform_public_metadata, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlatformPublicMetadata", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_metadata_update_serialize( + self, + org, + platform_public_metadata, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if platform_public_metadata is not None: + _body_params = platform_public_metadata + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/core/orgs/{org}/metadata/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_redirect_tokens_create( + self, + org: StrictStr, + redirect_token_request: RedirectTokenRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_redirect_tokens_create + + Creates redirect tokens for a URL specified by for a platform + + :param org: (required) + :type org: str + :param redirect_token_request: (required) + :type redirect_token_request: RedirectTokenRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_redirect_tokens_create_serialize( + org=org, + redirect_token_request=redirect_token_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "RedirectTokenResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_redirect_tokens_create_serialize( + self, + org, + redirect_token_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if redirect_token_request is not None: + _body_params = redirect_token_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/core/orgs/{org}/redirect-tokens/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_redirect_tokens_delete_destroy( + self, + org: StrictStr, + redirect_token: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_redirect_tokens_delete_destroy + + Delete specific token + + :param org: (required) + :type org: str + :param redirect_token: (required) + :type redirect_token: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_redirect_tokens_delete_destroy_serialize( + org=org, + redirect_token=redirect_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_redirect_tokens_delete_destroy_serialize( + self, + org, + redirect_token, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if redirect_token is not None: + _path_params['redirect_token'] = redirect_token + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def core_orgs_redirect_tokens_retrieve( + self, + org: StrictStr, + redirect_token: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """core_orgs_redirect_tokens_retrieve + + Returns Redirect URL for the token specified. ``` Requires user to be a member of the platform with the token passed ``` + + :param org: (required) + :type org: str + :param redirect_token: (required) + :type redirect_token: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._core_orgs_redirect_tokens_retrieve_serialize( + org=org, + redirect_token=redirect_token, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "RedirectTokenResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _core_orgs_redirect_tokens_retrieve_serialize( + self, + org, + redirect_token, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if redirect_token is not None: + _path_params['redirect_token'] = redirect_token + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/core/orgs/{org}/redirect-tokens/{redirect_token}/', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/iblai/api/credentials_api.py b/iblai/api/credentials_api.py index dc24357..461d35f 100644 --- a/iblai/api/credentials_api.py +++ b/iblai/api/credentials_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/engagement_api.py b/iblai/api/engagement_api.py index 64282e7..54c8da9 100644 --- a/iblai/api/engagement_api.py +++ b/iblai/api/engagement_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -22,7 +22,7 @@ from iblai.models.average_overtime import AverageOvertime from iblai.models.course_completion_per_course import CourseCompletionPerCourse from iblai.models.engagement_per_course import EngagementPerCourse -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.models.overtime_with_change_info import OvertimeWithChangeInfo from iblai.models.per_learner_time_spent_in_course_tree import PerLearnerTimeSpentInCourseTree from iblai.models.time_detail import TimeDetail @@ -926,7 +926,7 @@ def engagement_orgs_courses_time_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -1273,7 +1273,7 @@ def engagement_orgs_courses_time_users_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -1630,7 +1630,7 @@ def engagement_orgs_courses_videos_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -2906,7 +2906,7 @@ def engagement_orgs_videos_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, diff --git a/iblai/api/finance_api.py b/iblai/api/finance_api.py index f7b4939..be76137 100644 --- a/iblai/api/finance_api.py +++ b/iblai/api/finance_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/monitoring_api.py b/iblai/api/monitoring_api.py deleted file mode 100644 index dd72232..0000000 --- a/iblai/api/monitoring_api.py +++ /dev/null @@ -1,144 +0,0 @@ -# coding: utf-8 - -""" - ibl-data-manager - - API for iblai - - The version of the OpenAPI document: 2.4.1-ai-plus - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - - -from iblai.api_client import ApiClient, RequestSerialized -from iblai.api_response import ApiResponse -from iblai.rest import RESTResponseType - - -class MonitoringApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def monitoring_connectors_retrieve( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """monitoring_connectors_retrieve - - - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._monitoring_connectors_retrieve_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _monitoring_connectors_retrieve_serialize( - self, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/monitoring/connectors/', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - diff --git a/iblai/api/notification_api.py b/iblai/api/notification_api.py new file mode 100644 index 0000000..06e0acb --- /dev/null +++ b/iblai/api/notification_api.py @@ -0,0 +1,1272 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from iblai.models.notification import Notification +from iblai.models.notification_count import NotificationCount +from iblai.models.patched_notification import PatchedNotification + +from iblai.api_client import ApiClient, RequestSerialized +from iblai.api_response import ApiResponse +from iblai.rest import RESTResponseType + + +class NotificationApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def notification_v1_orgs_notifications_bulk_update_partial_update( + self, + org: StrictStr, + patched_notification: Optional[PatchedNotification] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_notifications_bulk_update_partial_update + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param patched_notification: + :type patched_notification: PatchedNotification + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_notifications_bulk_update_partial_update_serialize( + org=org, + patched_notification=patched_notification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_notifications_bulk_update_partial_update_serialize( + self, + org, + patched_notification, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if patched_notification is not None: + _body_params = patched_notification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/notification/v1/orgs/{org}/notifications/bulk-update/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_notifications_retrieve( + self, + org: StrictStr, + channel: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + end_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + exclude_channel: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + start_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + status: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_notifications_retrieve + + Get notifications for a user + + :param org: (required) + :type org: str + :param channel: + :type channel: str + :param end_date: + :type end_date: str + :param exclude_channel: + :type exclude_channel: str + :param start_date: + :type start_date: str + :param status: + :type status: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_notifications_retrieve_serialize( + org=org, + channel=channel, + end_date=end_date, + exclude_channel=exclude_channel, + start_date=start_date, + status=status, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_notifications_retrieve_serialize( + self, + org, + channel, + end_date, + exclude_channel, + start_date, + status, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + if channel is not None: + + _query_params.append(('channel', channel)) + + if end_date is not None: + + _query_params.append(('end_date', end_date)) + + if exclude_channel is not None: + + _query_params.append(('exclude_channel', exclude_channel)) + + if start_date is not None: + + _query_params.append(('start_date', start_date)) + + if status is not None: + + _query_params.append(('status', status)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/notification/v1/orgs/{org}/notifications/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_notifications_update( + self, + org: StrictStr, + notification: Notification, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_notifications_update + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param notification: (required) + :type notification: Notification + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_notifications_update_serialize( + org=org, + notification=notification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_notifications_update_serialize( + self, + org, + notification, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if notification is not None: + _body_params = notification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/notification/v1/orgs/{org}/notifications/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_users_notifications_bulk_update_partial_update( + self, + org: StrictStr, + user_id: StrictStr, + patched_notification: Optional[PatchedNotification] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_users_notifications_bulk_update_partial_update + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param patched_notification: + :type patched_notification: PatchedNotification + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_users_notifications_bulk_update_partial_update_serialize( + org=org, + user_id=user_id, + patched_notification=patched_notification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_users_notifications_bulk_update_partial_update_serialize( + self, + org, + user_id, + patched_notification, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if patched_notification is not None: + _body_params = patched_notification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_users_notifications_count_retrieve( + self, + org: StrictStr, + user_id: StrictStr, + channel: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + status: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_users_notifications_count_retrieve + + Get notifications count for a user + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param channel: + :type channel: str + :param status: + :type status: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_users_notifications_count_retrieve_serialize( + org=org, + user_id=user_id, + channel=channel, + status=status, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationCount", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_users_notifications_count_retrieve_serialize( + self, + org, + user_id, + channel, + status, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if channel is not None: + + _query_params.append(('channel', channel)) + + if status is not None: + + _query_params.append(('status', status)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/notification/v1/orgs/{org}/users/{user_id}/notifications-count/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_users_notifications_destroy( + self, + notification_id: StrictStr, + org: StrictStr, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_users_notifications_destroy + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param notification_id: (required) + :type notification_id: str + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_users_notifications_destroy_serialize( + notification_id=notification_id, + org=org, + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_users_notifications_destroy_serialize( + self, + notification_id, + org, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if notification_id is not None: + _path_params['notification_id'] = notification_id + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/notification/v1/orgs/{org}/users/{user_id}/notifications/{notification_id}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_users_notifications_retrieve( + self, + org: StrictStr, + user_id: StrictStr, + channel: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + end_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + exclude_channel: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + start_date: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + status: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_users_notifications_retrieve + + Get notifications for a user + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param channel: + :type channel: str + :param end_date: + :type end_date: str + :param exclude_channel: + :type exclude_channel: str + :param start_date: + :type start_date: str + :param status: + :type status: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_users_notifications_retrieve_serialize( + org=org, + user_id=user_id, + channel=channel, + end_date=end_date, + exclude_channel=exclude_channel, + start_date=start_date, + status=status, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_users_notifications_retrieve_serialize( + self, + org, + user_id, + channel, + end_date, + exclude_channel, + start_date, + status, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + if channel is not None: + + _query_params.append(('channel', channel)) + + if end_date is not None: + + _query_params.append(('end_date', end_date)) + + if exclude_channel is not None: + + _query_params.append(('exclude_channel', exclude_channel)) + + if start_date is not None: + + _query_params.append(('start_date', start_date)) + + if status is not None: + + _query_params.append(('status', status)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/notification/v1/orgs/{org}/users/{user_id}/notifications/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def notification_v1_orgs_users_notifications_update( + self, + org: StrictStr, + user_id: StrictStr, + notification: Notification, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """notification_v1_orgs_users_notifications_update + + Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent + + :param org: (required) + :type org: str + :param user_id: (required) + :type user_id: str + :param notification: (required) + :type notification: Notification + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notification_v1_orgs_users_notifications_update_serialize( + org=org, + user_id=user_id, + notification=notification, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Notification", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _notification_v1_orgs_users_notifications_update_serialize( + self, + org, + user_id, + notification, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if user_id is not None: + _path_params['user_id'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if notification is not None: + _body_params = notification + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json', + 'application/x-www-form-urlencoded', + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/notification/v1/orgs/{org}/users/{user_id}/notifications/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/iblai/api/overview_api.py b/iblai/api/overview_api.py index 5f6a59c..8b15f81 100644 --- a/iblai/api/overview_api.py +++ b/iblai/api/overview_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/performance_api.py b/iblai/api/performance_api.py index ef25d31..d57e5bd 100644 --- a/iblai/api/performance_api.py +++ b/iblai/api/performance_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/perlearner_api.py b/iblai/api/perlearner_api.py index 6947e61..af12e4e 100644 --- a/iblai/api/perlearner_api.py +++ b/iblai/api/perlearner_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -23,7 +23,7 @@ from iblai.models.average import Average from iblai.models.detailed_grade_view import DetailedGradeView from iblai.models.learner_information_api import LearnerInformationAPI -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.models.per_learner_course_videos_watched import PerLearnerCourseVideosWatched from iblai.models.per_learner_last_access import PerLearnerLastAccess from iblai.models.perlearner_engagement_videos_watched_per_course import PerlearnerEngagementVideosWatchedPerCourse @@ -1293,7 +1293,7 @@ def perlearner_orgs_users_courses_overview_time_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -1468,7 +1468,7 @@ def perlearner_orgs_users_courses_videos_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -2750,7 +2750,7 @@ def perlearner_orgs_users_overview_time_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, @@ -3088,7 +3088,7 @@ def perlearner_orgs_users_videos_over_time_retrieve( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Overtime", + '200': "OverTimeWithTotal", } response_data = self.api_client.call_api( *_param, diff --git a/iblai/api/platform_api.py b/iblai/api/platform_api.py index 4229e82..85718c1 100644 --- a/iblai/api/platform_api.py +++ b/iblai/api/platform_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/recommendations_api.py b/iblai/api/recommendations_api.py index 3cf670c..070dc71 100644 --- a/iblai/api/recommendations_api.py +++ b/iblai/api/recommendations_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/reports_api.py b/iblai/api/reports_api.py index ccb00d2..4bf7ef0 100644 --- a/iblai/api/reports_api.py +++ b/iblai/api/reports_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api/search_api.py b/iblai/api/search_api.py index 3b12502..5a700f1 100644 --- a/iblai/api/search_api.py +++ b/iblai/api/search_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -16,6 +16,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated +from pydantic import StrictStr from iblai.models.query_endpoint import QueryEndpoint from iblai.api_client import ApiClient, RequestSerialized @@ -268,6 +269,115 @@ def _search_ai_search_retrieve_serialize( + @validate_call + def search_catalog_retrieve( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """search_catalog_retrieve + + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_catalog_retrieve_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_catalog_retrieve_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/search/catalog/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def search_documentsearch_retrieve( self, @@ -487,6 +597,122 @@ def _search_es_health_retrieve_serialize( + @validate_call + def search_personalized_catalog_retrieve( + self, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """search_personalized_catalog_retrieve + + + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_personalized_catalog_retrieve_serialize( + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_personalized_catalog_retrieve_serialize( + self, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/search/personalized-catalog/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def search_search_retrieve( self, @@ -601,3 +827,127 @@ def _search_search_retrieve_serialize( ) + + + @validate_call + def search_users_orgs_users_retrieve( + self, + org: StrictStr, + username: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """search_users_orgs_users_retrieve + + + :param org: (required) + :type org: str + :param username: (required) + :type username: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_users_orgs_users_retrieve_serialize( + org=org, + username=username, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_users_orgs_users_retrieve_serialize( + self, + org, + username, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if org is not None: + _path_params['org'] = org + if username is not None: + _path_params['username'] = username + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'PlatformApiKeyAuthentication' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/search/users/orgs/{org}/users/{username}/', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/iblai/api/skills_api.py b/iblai/api/skills_api.py index 05d9c4d..7079a2c 100644 --- a/iblai/api/skills_api.py +++ b/iblai/api/skills_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/api_client.py b/iblai/api_client.py index 7f23520..f3f8b4f 100644 --- a/iblai/api_client.py +++ b/iblai/api_client.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -88,7 +88,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2.4.1+ai.plus/python' + self.user_agent = 'OpenAPI-Generator/3.6.0+ai.plus/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/iblai/configuration.py b/iblai/configuration.py index 6930718..854ef91 100644 --- a/iblai/configuration.py +++ b/iblai/configuration.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -412,8 +412,8 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 2.4.1-ai-plus\n"\ - "SDK Package Version: 2.4.1+ai.plus".\ + "Version of the API: 3.6.0-ai-plus\n"\ + "SDK Package Version: 3.6.0+ai.plus".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/iblai/exceptions.py b/iblai/exceptions.py index a0a465c..f516218 100644 --- a/iblai/exceptions.py +++ b/iblai/exceptions.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/__init__.py b/iblai/models/__init__.py index 1f0ba22..628d6aa 100644 --- a/iblai/models/__init__.py +++ b/iblai/models/__init__.py @@ -6,7 +6,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -14,6 +14,7 @@ # import models into model package +from iblai.models.ai_generated_image import AIGeneratedImage from iblai.models.api_token_cost import APITokenCost from iblai.models.acceptance_enum import AcceptanceEnum from iblai.models.active_users_data import ActiveUsersData @@ -38,14 +39,17 @@ from iblai.models.bulk_create_assertion import BulkCreateAssertion from iblai.models.chartsession_mentor import ChartsessionMentor from iblai.models.chat_history import ChatHistory +from iblai.models.chat_history_filter_data import ChatHistoryFilterData from iblai.models.chat_history_item import ChatHistoryItem from iblai.models.chat_history_session_id import ChatHistorySessionId from iblai.models.chat_session_request import ChatSessionRequest from iblai.models.chat_session_response import ChatSessionResponse from iblai.models.chat_session_with_message import ChatSessionWithMessage from iblai.models.check_document_training_status import CheckDocumentTrainingStatus +from iblai.models.company import Company from iblai.models.conversation_message import ConversationMessage from iblai.models.conversation_volume import ConversationVolume +from iblai.models.conversations import Conversations from iblai.models.count import Count from iblai.models.count_data import CountData from iblai.models.course_completion_per_course import CourseCompletionPerCourse @@ -68,18 +72,21 @@ from iblai.models.data_set_create import DataSetCreate from iblai.models.data_set_platform_value import DataSetPlatformValue from iblai.models.data_set_status_enum import DataSetStatusEnum +from iblai.models.date_range import DateRange from iblai.models.desired_skill import DesiredSkill from iblai.models.detailed_grade_subsection import DetailedGradeSubsection from iblai.models.detailed_grade_view import DetailedGradeView from iblai.models.detailed_grade_view_data import DetailedGradeViewData from iblai.models.discord_config import DiscordConfig from iblai.models.discord_webhook import DiscordWebhook +from iblai.models.education import Education from iblai.models.engagement_per_course import EngagementPerCourse from iblai.models.engagement_per_course_data import EngagementPerCourseData from iblai.models.enrollments import Enrollments from iblai.models.enrollments_data import EnrollmentsData from iblai.models.enrollments_per_user import EnrollmentsPerUser from iblai.models.enrollments_per_user_data import EnrollmentsPerUserData +from iblai.models.experience import Experience from iblai.models.float_over_time import FloatOverTime from iblai.models.free_usage_count import FreeUsageCount from iblai.models.grading_per_user import GradingPerUser @@ -89,10 +96,13 @@ from iblai.models.iblai_platform_meta_request import IBLAIPlatformMetaRequest from iblai.models.iblai_platform_meta_update_request import IBLAIPlatformMetaUpdateRequest from iblai.models.image_upload import ImageUpload +from iblai.models.institution import Institution +from iblai.models.institution_type_enum import InstitutionTypeEnum from iblai.models.integration_credential import IntegrationCredential from iblai.models.issuer import Issuer from iblai.models.issuer_authority import IssuerAuthority from iblai.models.job_run import JobRun +from iblai.models.llm_credential_response import LLMCredentialResponse from iblai.models.llm_model_for_tenant import LLMModelForTenant from iblai.models.llm_response import LLMResponse from iblai.models.llm_scores_view import LLMScoresView @@ -103,36 +113,51 @@ from iblai.models.languages_view import LanguagesView from iblai.models.learner_information_api import LearnerInformationAPI from iblai.models.learner_information_api_data import LearnerInformationAPIData +from iblai.models.lti_key import LtiKey +from iblai.models.lti_launch_gate import LtiLaunchGate +from iblai.models.lti_tool import LtiTool from iblai.models.main_creds import MainCreds +from iblai.models.memory_status_request_view import MemoryStatusRequestView +from iblai.models.memory_status_view import MemoryStatusView from iblai.models.mentor import Mentor from iblai.models.mentor_category import MentorCategory from iblai.models.mentor_data import MentorData from iblai.models.mentor_detail_analytics import MentorDetailAnalytics from iblai.models.mentor_from_template_request import MentorFromTemplateRequest from iblai.models.mentor_from_template_with_setting_request import MentorFromTemplateWithSettingRequest +from iblai.models.mentor_metadata import MentorMetadata from iblai.models.mentor_settings import MentorSettings from iblai.models.mentor_settings_mentor_visibility import MentorSettingsMentorVisibility from iblai.models.mentor_settings_request import MentorSettingsRequest from iblai.models.mentor_trace import MentorTrace from iblai.models.mentor_visibility_enum import MentorVisibilityEnum from iblai.models.mentor_wizard import MentorWizard +from iblai.models.message_status import MessageStatus from iblai.models.message_view import MessageView from iblai.models.message_view_request import MessageViewRequest from iblai.models.message_view_updat_response import MessageViewUpdatResponse +from iblai.models.metadata import Metadata from iblai.models.model_cost import ModelCost from iblai.models.model_usage import ModelUsage +from iblai.models.moderation_log import ModerationLog from iblai.models.net_revenue_over_time import NetRevenueOverTime +from iblai.models.notification import Notification +from iblai.models.notification_count import NotificationCount +from iblai.models.notification_status_enum import NotificationStatusEnum from iblai.models.null_enum import NullEnum from iblai.models.observation import Observation from iblai.models.order import Order from iblai.models.over_time import OverTime -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal from iblai.models.overtime_meta import OvertimeMeta from iblai.models.overtime_with_change_info import OvertimeWithChangeInfo from iblai.models.page_content import PageContent +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList +from iblai.models.paginated_conversations_list import PaginatedConversationsList from iblai.models.paginated_data_set_list import PaginatedDataSetList from iblai.models.paginated_job_run_list import PaginatedJobRunList from iblai.models.paginated_mentor_list import PaginatedMentorList +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList from iblai.models.paginated_periodic_agent_list import PaginatedPeriodicAgentList from iblai.models.paginated_periodic_agent_log_list import PaginatedPeriodicAgentLogList from iblai.models.paginated_play_wright_script_list import PaginatedPlayWrightScriptList @@ -145,6 +170,7 @@ from iblai.models.patched_data_set import PatchedDataSet from iblai.models.patched_discord_config import PatchedDiscordConfig from iblai.models.patched_mentor import PatchedMentor +from iblai.models.patched_notification import PatchedNotification from iblai.models.patched_periodic_agent_create import PatchedPeriodicAgentCreate from iblai.models.patched_platform_public_metadata import PatchedPlatformPublicMetadata from iblai.models.patched_play_wright_script import PatchedPlayWrightScript @@ -189,6 +215,8 @@ from iblai.models.previous_agent_status_enum import PreviousAgentStatusEnum from iblai.models.product import Product from iblai.models.product_table import ProductTable +from iblai.models.program import Program +from iblai.models.program_type_enum import ProgramTypeEnum from iblai.models.prompt import Prompt from iblai.models.prompt_category import PromptCategory from iblai.models.prompt_visibility_enum import PromptVisibilityEnum @@ -198,6 +226,8 @@ from iblai.models.rating_enum import RatingEnum from iblai.models.recommend_course_response import RecommendCourseResponse from iblai.models.recommendation_search_api import RecommendationSearchAPI +from iblai.models.redirect_token_request import RedirectTokenRequest +from iblai.models.redirect_token_response import RedirectTokenResponse from iblai.models.related_text import RelatedText from iblai.models.report_create import ReportCreate from iblai.models.report_data import ReportData @@ -207,19 +237,24 @@ from iblai.models.reported_skill import ReportedSkill from iblai.models.request_data_variable import RequestDataVariable from iblai.models.resource_point import ResourcePoint +from iblai.models.resource_scrapped_data import ResourceScrappedData from iblai.models.response_data_variable import ResponseDataVariable from iblai.models.retreiver_train_view_request import RetreiverTrainViewRequest from iblai.models.retreiver_train_view_response import RetreiverTrainViewResponse from iblai.models.retrieve_task import RetrieveTask from iblai.models.retriever_document_embedding import RetrieverDocumentEmbedding from iblai.models.retriever_document_embedding_request import RetrieverDocumentEmbeddingRequest +from iblai.models.retriever_document_embedding_training_status import RetrieverDocumentEmbeddingTrainingStatus from iblai.models.retriever_request_search import RetrieverRequestSearch from iblai.models.retriever_request_search_document import RetrieverRequestSearchDocument from iblai.models.retriever_response_search import RetrieverResponseSearch from iblai.models.reuest_data_variable_list import ReuestDataVariableList from iblai.models.revenue_by_product import RevenueByProduct +from iblai.models.scan_webhook_request import ScanWebhookRequest +from iblai.models.scan_webhook_response import ScanWebhookResponse from iblai.models.score import Score from iblai.models.score_summary import ScoreSummary +from iblai.models.seed_mentors_view import SeedMentorsView from iblai.models.session_browser_screenshot import SessionBrowserScreenshot from iblai.models.session_detail import SessionDetail from iblai.models.shell_logs import ShellLogs @@ -236,7 +271,9 @@ from iblai.models.sub_time_child import SubTimeChild from iblai.models.summary import Summary from iblai.models.tags_view import TagsView +from iblai.models.target_system_enum import TargetSystemEnum from iblai.models.task_view import TaskView +from iblai.models.template_mentor import TemplateMentor from iblai.models.tenant_mentor_traces import TenantMentorTraces from iblai.models.theme_enum import ThemeEnum from iblai.models.time_child_data import TimeChildData @@ -274,6 +311,7 @@ from iblai.models.user_chat_memory_status_view import UserChatMemoryStatusView from iblai.models.user_chat_memory_update_view import UserChatMemoryUpdateView from iblai.models.user_edx_memory import UserEdxMemory +from iblai.models.user_info import UserInfo from iblai.models.user_memory_context_request import UserMemoryContextRequest from iblai.models.user_memory_context_response import UserMemoryContextResponse from iblai.models.user_sentiment_count_view import UserSentimentCountView diff --git a/iblai/models/acceptance_enum.py b/iblai/models/acceptance_enum.py index 04d3701..66261fd 100644 --- a/iblai/models/acceptance_enum.py +++ b/iblai/models/acceptance_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/active_users_data.py b/iblai/models/active_users_data.py index 12d981b..c16f6d4 100644 --- a/iblai/models/active_users_data.py +++ b/iblai/models/active_users_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/active_users_list.py b/iblai/models/active_users_list.py index 932e94d..aca45d8 100644 --- a/iblai/models/active_users_list.py +++ b/iblai/models/active_users_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/active_users_per_course.py b/iblai/models/active_users_per_course.py index c4f9296..cddce87 100644 --- a/iblai/models/active_users_per_course.py +++ b/iblai/models/active_users_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/active_users_per_course_data.py b/iblai/models/active_users_per_course_data.py index 8ec05ff..09a5a6d 100644 --- a/iblai/models/active_users_per_course_data.py +++ b/iblai/models/active_users_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/activity_api.py b/iblai/models/activity_api.py index c0464b9..9fcd72a 100644 --- a/iblai/models/activity_api.py +++ b/iblai/models/activity_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/activity_data.py b/iblai/models/activity_data.py index fb6d780..6460064 100644 --- a/iblai/models/activity_data.py +++ b/iblai/models/activity_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/ai_generated_image.py b/iblai/models/ai_generated_image.py new file mode 100644 index 0000000..2c17970 --- /dev/null +++ b/iblai/models/ai_generated_image.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AIGeneratedImage(BaseModel): + """ + AIGeneratedImage + """ # noqa: E501 + id: StrictInt + user: StrictInt = Field(description="edX user ID") + image: StrictStr + platform: StrictInt + prompt: Optional[StrictStr] = None + model: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + provider: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + date_created: datetime + __properties: ClassVar[List[str]] = ["id", "user", "image", "platform", "prompt", "model", "provider", "date_created"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AIGeneratedImage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "date_created", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AIGeneratedImage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "user": obj.get("user"), + "image": obj.get("image"), + "platform": obj.get("platform"), + "prompt": obj.get("prompt"), + "model": obj.get("model"), + "provider": obj.get("provider"), + "date_created": obj.get("date_created") + }) + return _obj + + diff --git a/iblai/models/align_mentor_bubble_enum.py b/iblai/models/align_mentor_bubble_enum.py index 93db4b7..f17c8d0 100644 --- a/iblai/models/align_mentor_bubble_enum.py +++ b/iblai/models/align_mentor_bubble_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/api_token_cost.py b/iblai/models/api_token_cost.py index 28f615a..70b130f 100644 --- a/iblai/models/api_token_cost.py +++ b/iblai/models/api_token_cost.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/assertion.py b/iblai/models/assertion.py index 638525e..e65da21 100644 --- a/iblai/models/assertion.py +++ b/iblai/models/assertion.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/audio_to_text_request.py b/iblai/models/audio_to_text_request.py index 7ba40a6..110fd02 100644 --- a/iblai/models/audio_to_text_request.py +++ b/iblai/models/audio_to_text_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/audio_to_text_response.py b/iblai/models/audio_to_text_response.py index 727c3c7..ec21f4d 100644 --- a/iblai/models/audio_to_text_response.py +++ b/iblai/models/audio_to_text_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/average.py b/iblai/models/average.py index d046aa8..cee403d 100644 --- a/iblai/models/average.py +++ b/iblai/models/average.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/average_data.py b/iblai/models/average_data.py index 4df5cff..5df2dcb 100644 --- a/iblai/models/average_data.py +++ b/iblai/models/average_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/average_overtime.py b/iblai/models/average_overtime.py index e7efcf4..0761228 100644 --- a/iblai/models/average_overtime.py +++ b/iblai/models/average_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/avg_course_grade_with_cutoff.py b/iblai/models/avg_course_grade_with_cutoff.py index e7df2dd..7d3e3c3 100644 --- a/iblai/models/avg_course_grade_with_cutoff.py +++ b/iblai/models/avg_course_grade_with_cutoff.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/avg_course_grade_with_cutoff_data.py b/iblai/models/avg_course_grade_with_cutoff_data.py index 11bf0cc..415d765 100644 --- a/iblai/models/avg_course_grade_with_cutoff_data.py +++ b/iblai/models/avg_course_grade_with_cutoff_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/blank_enum.py b/iblai/models/blank_enum.py index 0797afa..6fadd5a 100644 --- a/iblai/models/blank_enum.py +++ b/iblai/models/blank_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/bot.py b/iblai/models/bot.py index 06175bc..d907a0c 100644 --- a/iblai/models/bot.py +++ b/iblai/models/bot.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/bot_command.py b/iblai/models/bot_command.py index d278436..6161956 100644 --- a/iblai/models/bot_command.py +++ b/iblai/models/bot_command.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/bot_create.py b/iblai/models/bot_create.py index 03eb458..634f4a7 100644 --- a/iblai/models/bot_create.py +++ b/iblai/models/bot_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/bulk_create_assertion.py b/iblai/models/bulk_create_assertion.py index 9148c0d..57cadd2 100644 --- a/iblai/models/bulk_create_assertion.py +++ b/iblai/models/bulk_create_assertion.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chartsession_mentor.py b/iblai/models/chartsession_mentor.py index 3a83506..d5443d7 100644 --- a/iblai/models/chartsession_mentor.py +++ b/iblai/models/chartsession_mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chat_history.py b/iblai/models/chat_history.py index b577589..ac17153 100644 --- a/iblai/models/chat_history.py +++ b/iblai/models/chat_history.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -31,7 +31,7 @@ class ChatHistory(BaseModel): message: Optional[Any] = None inserted_at: datetime title: Optional[StrictStr] = None - feedback: StrictStr + feedback: Optional[Any] document_sources: Optional[Any] = None __properties: ClassVar[List[str]] = ["id", "message", "inserted_at", "title", "feedback", "document_sources"] @@ -90,6 +90,11 @@ def to_dict(self) -> Dict[str, Any]: if self.title is None and "title" in self.model_fields_set: _dict['title'] = None + # set to None if feedback (nullable) is None + # and model_fields_set contains the field + if self.feedback is None and "feedback" in self.model_fields_set: + _dict['feedback'] = None + # set to None if document_sources (nullable) is None # and model_fields_set contains the field if self.document_sources is None and "document_sources" in self.model_fields_set: diff --git a/iblai/models/chat_history_filter_data.py b/iblai/models/chat_history_filter_data.py new file mode 100644 index 0000000..07449e9 --- /dev/null +++ b/iblai/models/chat_history_filter_data.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.date_range import DateRange +from iblai.models.topic_model import TopicModel +from typing import Optional, Set +from typing_extensions import Self + +class ChatHistoryFilterData(BaseModel): + """ + ChatHistoryFilterData + """ # noqa: E501 + topics: List[TopicModel] + date_ranges: Optional[List[DateRange]] = None + sentiment: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["topics", "date_ranges", "sentiment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ChatHistoryFilterData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in topics (list) + _items = [] + if self.topics: + for _item in self.topics: + if _item: + _items.append(_item.to_dict()) + _dict['topics'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in date_ranges (list) + _items = [] + if self.date_ranges: + for _item in self.date_ranges: + if _item: + _items.append(_item.to_dict()) + _dict['date_ranges'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ChatHistoryFilterData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "topics": [TopicModel.from_dict(_item) for _item in obj["topics"]] if obj.get("topics") is not None else None, + "date_ranges": [DateRange.from_dict(_item) for _item in obj["date_ranges"]] if obj.get("date_ranges") is not None else None, + "sentiment": obj.get("sentiment") + }) + return _obj + + diff --git a/iblai/models/chat_history_item.py b/iblai/models/chat_history_item.py index 78beafe..a9b6dda 100644 --- a/iblai/models/chat_history_item.py +++ b/iblai/models/chat_history_item.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chat_history_session_id.py b/iblai/models/chat_history_session_id.py index 9a59b63..76b40b1 100644 --- a/iblai/models/chat_history_session_id.py +++ b/iblai/models/chat_history_session_id.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chat_session_request.py b/iblai/models/chat_session_request.py index adedbd9..f3ae2aa 100644 --- a/iblai/models/chat_session_request.py +++ b/iblai/models/chat_session_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chat_session_response.py b/iblai/models/chat_session_response.py index 1d00071..7e5dc95 100644 --- a/iblai/models/chat_session_response.py +++ b/iblai/models/chat_session_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/chat_session_with_message.py b/iblai/models/chat_session_with_message.py index b698ac0..d4d26e6 100644 --- a/iblai/models/chat_session_with_message.py +++ b/iblai/models/chat_session_with_message.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/check_document_training_status.py b/iblai/models/check_document_training_status.py index 89035dc..2e91886 100644 --- a/iblai/models/check_document_training_status.py +++ b/iblai/models/check_document_training_status.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/company.py b/iblai/models/company.py new file mode 100644 index 0000000..195ad20 --- /dev/null +++ b/iblai/models/company.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.user_info import UserInfo +from typing import Optional, Set +from typing_extensions import Self + +class Company(BaseModel): + """ + Company + """ # noqa: E501 + id: StrictInt + user: StrictInt = Field(description="edX user ID") + user_info: UserInfo + name: Annotated[str, Field(strict=True, max_length=100)] + industry: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + website: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + logo_url: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + data: Optional[Any] = Field(default=None, description="Metadata") + metadata: Optional[Any] = Field(default=None, description="Metadata") + created_at: Optional[datetime] = None + updated_at: datetime + __properties: ClassVar[List[str]] = ["id", "user", "user_info", "name", "industry", "website", "logo_url", "data", "metadata", "created_at", "updated_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Company from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "user", + "user_info", + "updated_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_info + if self.user_info: + _dict['user_info'] = self.user_info.to_dict() + # set to None if industry (nullable) is None + # and model_fields_set contains the field + if self.industry is None and "industry" in self.model_fields_set: + _dict['industry'] = None + + # set to None if website (nullable) is None + # and model_fields_set contains the field + if self.website is None and "website" in self.model_fields_set: + _dict['website'] = None + + # set to None if logo_url (nullable) is None + # and model_fields_set contains the field + if self.logo_url is None and "logo_url" in self.model_fields_set: + _dict['logo_url'] = None + + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Company from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "user": obj.get("user"), + "user_info": UserInfo.from_dict(obj["user_info"]) if obj.get("user_info") is not None else None, + "name": obj.get("name"), + "industry": obj.get("industry"), + "website": obj.get("website"), + "logo_url": obj.get("logo_url"), + "data": obj.get("data"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at") + }) + return _obj + + diff --git a/iblai/models/conversation_message.py b/iblai/models/conversation_message.py index 0db6c96..567a16a 100644 --- a/iblai/models/conversation_message.py +++ b/iblai/models/conversation_message.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -18,7 +18,7 @@ import json from datetime import datetime -from pydantic import BaseModel, ConfigDict, StrictStr +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List from iblai.models.topic_model import TopicModel from typing import Optional, Set @@ -32,7 +32,7 @@ class ConversationMessage(BaseModel): topics: List[TopicModel] id: StrictStr user_id: StrictStr - message_count: StrictStr + message_count: StrictInt model: StrictStr inserted_at: datetime user_sentiment: StrictStr diff --git a/iblai/models/conversation_volume.py b/iblai/models/conversation_volume.py index b2f1fb6..3d0cc3b 100644 --- a/iblai/models/conversation_volume.py +++ b/iblai/models/conversation_volume.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/conversations.py b/iblai/models/conversations.py new file mode 100644 index 0000000..623e9ae --- /dev/null +++ b/iblai/models/conversations.py @@ -0,0 +1,157 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.topic_model import TopicModel +from typing import Optional, Set +from typing_extensions import Self + +class Conversations(BaseModel): + """ + Conversations + """ # noqa: E501 + id: StrictStr + messages: StrictStr + topics: List[TopicModel] + sentiment: StrictStr + mentor: StrictStr + student: StrictStr + model: StrictStr + rating: StrictStr + inserted_at: datetime + has_document: Optional[StrictBool] = None + memory_tracked: Optional[StrictBool] = None + llm_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + llm_provider: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + metadata: Optional[Any] = None + platform: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["id", "messages", "topics", "sentiment", "mentor", "student", "model", "rating", "inserted_at", "has_document", "memory_tracked", "llm_name", "llm_provider", "metadata", "platform"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Conversations from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "messages", + "sentiment", + "student", + "rating", + "inserted_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in topics (list) + _items = [] + if self.topics: + for _item in self.topics: + if _item: + _items.append(_item.to_dict()) + _dict['topics'] = _items + # set to None if llm_name (nullable) is None + # and model_fields_set contains the field + if self.llm_name is None and "llm_name" in self.model_fields_set: + _dict['llm_name'] = None + + # set to None if llm_provider (nullable) is None + # and model_fields_set contains the field + if self.llm_provider is None and "llm_provider" in self.model_fields_set: + _dict['llm_provider'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + # set to None if platform (nullable) is None + # and model_fields_set contains the field + if self.platform is None and "platform" in self.model_fields_set: + _dict['platform'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Conversations from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "messages": obj.get("messages"), + "topics": [TopicModel.from_dict(_item) for _item in obj["topics"]] if obj.get("topics") is not None else None, + "sentiment": obj.get("sentiment"), + "mentor": obj.get("mentor"), + "student": obj.get("student"), + "model": obj.get("model"), + "rating": obj.get("rating"), + "inserted_at": obj.get("inserted_at"), + "has_document": obj.get("has_document"), + "memory_tracked": obj.get("memory_tracked"), + "llm_name": obj.get("llm_name"), + "llm_provider": obj.get("llm_provider"), + "metadata": obj.get("metadata"), + "platform": obj.get("platform") + }) + return _obj + + diff --git a/iblai/models/count.py b/iblai/models/count.py index b3120d3..42e4015 100644 --- a/iblai/models/count.py +++ b/iblai/models/count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/count_data.py b/iblai/models/count_data.py index c57a10a..34508f4 100644 --- a/iblai/models/count_data.py +++ b/iblai/models/count_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_completion_per_course.py b/iblai/models/course_completion_per_course.py index 31848ff..8bc7dc1 100644 --- a/iblai/models/course_completion_per_course.py +++ b/iblai/models/course_completion_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_completion_per_course_data.py b/iblai/models/course_completion_per_course_data.py index 9d6329d..fc0718a 100644 --- a/iblai/models/course_completion_per_course_data.py +++ b/iblai/models/course_completion_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_completion_summary_data_overtime.py b/iblai/models/course_completion_summary_data_overtime.py index 99766fa..c8ce7f9 100644 --- a/iblai/models/course_completion_summary_data_overtime.py +++ b/iblai/models/course_completion_summary_data_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_completion_summary_overtime.py b/iblai/models/course_completion_summary_overtime.py index 4b4f7f6..2d91dec 100644 --- a/iblai/models/course_completion_summary_overtime.py +++ b/iblai/models/course_completion_summary_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grade_detail_block.py b/iblai/models/course_grade_detail_block.py index 14229bd..39979b2 100644 --- a/iblai/models/course_grade_detail_block.py +++ b/iblai/models/course_grade_detail_block.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grade_detail_sub_section.py b/iblai/models/course_grade_detail_sub_section.py index 10dc123..87244c0 100644 --- a/iblai/models/course_grade_detail_sub_section.py +++ b/iblai/models/course_grade_detail_sub_section.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grade_summary.py b/iblai/models/course_grade_summary.py index 2bbedcc..db692d7 100644 --- a/iblai/models/course_grade_summary.py +++ b/iblai/models/course_grade_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grade_summary_data.py b/iblai/models/course_grade_summary_data.py index f5174df..6b5fab8 100644 --- a/iblai/models/course_grade_summary_data.py +++ b/iblai/models/course_grade_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grading_detail.py b/iblai/models/course_grading_detail.py index 75e22da..0542f0b 100644 --- a/iblai/models/course_grading_detail.py +++ b/iblai/models/course_grading_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_grading_detail_data.py b/iblai/models/course_grading_detail_data.py index b0a2bc1..a218db1 100644 --- a/iblai/models/course_grading_detail_data.py +++ b/iblai/models/course_grading_detail_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_point.py b/iblai/models/course_point.py index 16883c3..9d87144 100644 --- a/iblai/models/course_point.py +++ b/iblai/models/course_point.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/course_skill.py b/iblai/models/course_skill.py index e11f92d..fe421ff 100644 --- a/iblai/models/course_skill.py +++ b/iblai/models/course_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/credential.py b/iblai/models/credential.py index 2eebc6a..dccc44d 100644 --- a/iblai/models/credential.py +++ b/iblai/models/credential.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,7 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from typing import Optional, Set @@ -27,10 +28,28 @@ class Credential(BaseModel): """ Credential """ # noqa: E501 - name: Annotated[str, Field(strict=True, max_length=255)] - value: Optional[Any] = None - platform: StrictStr = Field(description="The platform key") - __properties: ClassVar[List[str]] = ["name", "value", "platform"] + entity_id: StrictStr = Field(alias="entityId") + name: Annotated[str, Field(strict=True, max_length=1000)] + name_override: Optional[Annotated[str, Field(strict=True, max_length=1000)]] = None + description: Optional[StrictStr] = None + criteria_url: StrictStr = Field(alias="criteriaUrl") + criteria_narrative: StrictStr = Field(alias="criteriaNarrative") + created_at: datetime = Field(alias="createdAt") + icon_image: StrictStr = Field(alias="iconImage") + background_image: StrictStr = Field(alias="backgroundImage") + thumbnail_image: StrictStr = Field(alias="thumbnailImage") + catalog_items: List[StrictStr] + courses: List[Dict[str, StrictStr]] + programs: List[Dict[str, StrictStr]] + issuer_details: Dict[str, StrictStr] = Field(alias="issuerDetails") + html_template: Optional[StrictStr] = None + css_template: Optional[StrictStr] = None + metadata: Optional[Any] = None + credential_type: StrictStr = Field(alias="credentialType") + expires: Dict[str, StrictInt] + tags: Optional[Any] = None + signatories: List[Dict[str, StrictStr]] + __properties: ClassVar[List[str]] = ["entityId", "name", "name_override", "description", "criteriaUrl", "criteriaNarrative", "createdAt", "iconImage", "backgroundImage", "thumbnailImage", "catalog_items", "courses", "programs", "issuerDetails", "html_template", "css_template", "metadata", "credentialType", "expires", "tags", "signatories"] model_config = ConfigDict( populate_by_name=True, @@ -62,8 +81,20 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ + "catalog_items", + "courses", + "programs", + "issuer_details", + "expires", + "signatories", ]) _dict = self.model_dump( @@ -71,10 +102,35 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # set to None if value (nullable) is None + # set to None if name_override (nullable) is None # and model_fields_set contains the field - if self.value is None and "value" in self.model_fields_set: - _dict['value'] = None + if self.name_override is None and "name_override" in self.model_fields_set: + _dict['name_override'] = None + + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if html_template (nullable) is None + # and model_fields_set contains the field + if self.html_template is None and "html_template" in self.model_fields_set: + _dict['html_template'] = None + + # set to None if css_template (nullable) is None + # and model_fields_set contains the field + if self.css_template is None and "css_template" in self.model_fields_set: + _dict['css_template'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + # set to None if tags (nullable) is None + # and model_fields_set contains the field + if self.tags is None and "tags" in self.model_fields_set: + _dict['tags'] = None return _dict @@ -88,9 +144,27 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "entityId": obj.get("entityId"), "name": obj.get("name"), - "value": obj.get("value"), - "platform": obj.get("platform") + "name_override": obj.get("name_override"), + "description": obj.get("description"), + "criteriaUrl": obj.get("criteriaUrl"), + "criteriaNarrative": obj.get("criteriaNarrative"), + "createdAt": obj.get("createdAt"), + "iconImage": obj.get("iconImage"), + "backgroundImage": obj.get("backgroundImage"), + "thumbnailImage": obj.get("thumbnailImage"), + "catalog_items": obj.get("catalog_items"), + "courses": obj.get("courses"), + "programs": obj.get("programs"), + "issuerDetails": obj.get("issuerDetails"), + "html_template": obj.get("html_template"), + "css_template": obj.get("css_template"), + "metadata": obj.get("metadata"), + "credentialType": obj.get("credentialType"), + "expires": obj.get("expires"), + "tags": obj.get("tags"), + "signatories": obj.get("signatories") }) return _obj diff --git a/iblai/models/credential_request.py b/iblai/models/credential_request.py index 0d23ccd..bd90e77 100644 --- a/iblai/models/credential_request.py +++ b/iblai/models/credential_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/crontab_schedule.py b/iblai/models/crontab_schedule.py index 26498d0..49a7c89 100644 --- a/iblai/models/crontab_schedule.py +++ b/iblai/models/crontab_schedule.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/custom_instruction_response.py b/iblai/models/custom_instruction_response.py index 5b71631..46d186a 100644 --- a/iblai/models/custom_instruction_response.py +++ b/iblai/models/custom_instruction_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/data_set.py b/iblai/models/data_set.py index 2f9318f..1d9fe38 100644 --- a/iblai/models/data_set.py +++ b/iblai/models/data_set.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/data_set_create.py b/iblai/models/data_set_create.py index 0bdba4f..054e52d 100644 --- a/iblai/models/data_set_create.py +++ b/iblai/models/data_set_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/data_set_platform_value.py b/iblai/models/data_set_platform_value.py index fb3bbe1..7680cca 100644 --- a/iblai/models/data_set_platform_value.py +++ b/iblai/models/data_set_platform_value.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/data_set_status_enum.py b/iblai/models/data_set_status_enum.py index 7f9d9aa..93defc3 100644 --- a/iblai/models/data_set_status_enum.py +++ b/iblai/models/data_set_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/date_range.py b/iblai/models/date_range.py new file mode 100644 index 0000000..6343526 --- /dev/null +++ b/iblai/models/date_range.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class DateRange(BaseModel): + """ + DateRange + """ # noqa: E501 + start_date: date + end_date: date + __properties: ClassVar[List[str]] = ["start_date", "end_date"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DateRange from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DateRange from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date") + }) + return _obj + + diff --git a/iblai/models/desired_skill.py b/iblai/models/desired_skill.py index df5c194..1331f53 100644 --- a/iblai/models/desired_skill.py +++ b/iblai/models/desired_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/detailed_grade_subsection.py b/iblai/models/detailed_grade_subsection.py index e1e0fa4..01ce619 100644 --- a/iblai/models/detailed_grade_subsection.py +++ b/iblai/models/detailed_grade_subsection.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/detailed_grade_view.py b/iblai/models/detailed_grade_view.py index 36a4153..4262f60 100644 --- a/iblai/models/detailed_grade_view.py +++ b/iblai/models/detailed_grade_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/detailed_grade_view_data.py b/iblai/models/detailed_grade_view_data.py index 5b73d0e..eacfc07 100644 --- a/iblai/models/detailed_grade_view_data.py +++ b/iblai/models/detailed_grade_view_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/discord_config.py b/iblai/models/discord_config.py index 5d19f0e..23a41c2 100644 --- a/iblai/models/discord_config.py +++ b/iblai/models/discord_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/discord_webhook.py b/iblai/models/discord_webhook.py index ab157d8..48d34f7 100644 --- a/iblai/models/discord_webhook.py +++ b/iblai/models/discord_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/education.py b/iblai/models/education.py new file mode 100644 index 0000000..b10dee0 --- /dev/null +++ b/iblai/models/education.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.institution import Institution +from iblai.models.user_info import UserInfo +from typing import Optional, Set +from typing_extensions import Self + +class Education(BaseModel): + """ + Education + """ # noqa: E501 + id: StrictInt + user: StrictInt = Field(description="edX user ID") + user_info: UserInfo + institution: Institution + institution_id: StrictInt + degree: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + field_of_study: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + start_date: date + end_date: Optional[date] = None + grade: Optional[Annotated[str, Field(strict=True)]] = None + activities: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + description: Optional[StrictStr] = None + data: Optional[Any] = Field(default=None, description="Metadata") + metadata: Optional[Any] = Field(default=None, description="Metadata") + created_at: Optional[datetime] = None + updated_at: datetime + is_current: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["id", "user", "user_info", "institution", "institution_id", "degree", "field_of_study", "start_date", "end_date", "grade", "activities", "description", "data", "metadata", "created_at", "updated_at", "is_current"] + + @field_validator('grade') + def grade_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^-?\d{0,1}(?:\.\d{0,2})?$", value): + raise ValueError(r"must validate the regular expression /^-?\d{0,1}(?:\.\d{0,2})?$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Education from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "user", + "user_info", + "institution", + "updated_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_info + if self.user_info: + _dict['user_info'] = self.user_info.to_dict() + # override the default output from pydantic by calling `to_dict()` of institution + if self.institution: + _dict['institution'] = self.institution.to_dict() + # set to None if degree (nullable) is None + # and model_fields_set contains the field + if self.degree is None and "degree" in self.model_fields_set: + _dict['degree'] = None + + # set to None if field_of_study (nullable) is None + # and model_fields_set contains the field + if self.field_of_study is None and "field_of_study" in self.model_fields_set: + _dict['field_of_study'] = None + + # set to None if end_date (nullable) is None + # and model_fields_set contains the field + if self.end_date is None and "end_date" in self.model_fields_set: + _dict['end_date'] = None + + # set to None if grade (nullable) is None + # and model_fields_set contains the field + if self.grade is None and "grade" in self.model_fields_set: + _dict['grade'] = None + + # set to None if activities (nullable) is None + # and model_fields_set contains the field + if self.activities is None and "activities" in self.model_fields_set: + _dict['activities'] = None + + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + # set to None if is_current (nullable) is None + # and model_fields_set contains the field + if self.is_current is None and "is_current" in self.model_fields_set: + _dict['is_current'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Education from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "user": obj.get("user"), + "user_info": UserInfo.from_dict(obj["user_info"]) if obj.get("user_info") is not None else None, + "institution": Institution.from_dict(obj["institution"]) if obj.get("institution") is not None else None, + "institution_id": obj.get("institution_id"), + "degree": obj.get("degree"), + "field_of_study": obj.get("field_of_study"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "grade": obj.get("grade"), + "activities": obj.get("activities"), + "description": obj.get("description"), + "data": obj.get("data"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + "is_current": obj.get("is_current") + }) + return _obj + + diff --git a/iblai/models/engagement_per_course.py b/iblai/models/engagement_per_course.py index dc07720..374e2b1 100644 --- a/iblai/models/engagement_per_course.py +++ b/iblai/models/engagement_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/engagement_per_course_data.py b/iblai/models/engagement_per_course_data.py index 3ed395b..4d10916 100644 --- a/iblai/models/engagement_per_course_data.py +++ b/iblai/models/engagement_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/enrollments.py b/iblai/models/enrollments.py index 598b7b0..c1c5bd3 100644 --- a/iblai/models/enrollments.py +++ b/iblai/models/enrollments.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/enrollments_data.py b/iblai/models/enrollments_data.py index 088b704..542a257 100644 --- a/iblai/models/enrollments_data.py +++ b/iblai/models/enrollments_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/enrollments_per_user.py b/iblai/models/enrollments_per_user.py index 066af8e..67d9f9d 100644 --- a/iblai/models/enrollments_per_user.py +++ b/iblai/models/enrollments_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/enrollments_per_user_data.py b/iblai/models/enrollments_per_user_data.py index 2520178..b835622 100644 --- a/iblai/models/enrollments_per_user_data.py +++ b/iblai/models/enrollments_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/experience.py b/iblai/models/experience.py new file mode 100644 index 0000000..2e3260a --- /dev/null +++ b/iblai/models/experience.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import date, datetime +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.company import Company +from iblai.models.user_info import UserInfo +from typing import Optional, Set +from typing_extensions import Self + +class Experience(BaseModel): + """ + Experience + """ # noqa: E501 + id: StrictInt + user: StrictInt = Field(description="edX user ID") + user_info: UserInfo + company: Company + company_id: StrictInt + title: Annotated[str, Field(strict=True, max_length=100)] + employment_type: Optional[Annotated[str, Field(strict=True, max_length=50)]] = None + location: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + start_date: date + end_date: Optional[date] = None + is_current: Optional[StrictBool] = None + description: Optional[StrictStr] = None + data: Optional[Any] = Field(default=None, description="Metadata") + metadata: Optional[Any] = Field(default=None, description="Metadata") + created_at: Optional[datetime] = None + updated_at: datetime + __properties: ClassVar[List[str]] = ["id", "user", "user_info", "company", "company_id", "title", "employment_type", "location", "start_date", "end_date", "is_current", "description", "data", "metadata", "created_at", "updated_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Experience from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "user", + "user_info", + "company", + "updated_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_info + if self.user_info: + _dict['user_info'] = self.user_info.to_dict() + # override the default output from pydantic by calling `to_dict()` of company + if self.company: + _dict['company'] = self.company.to_dict() + # set to None if employment_type (nullable) is None + # and model_fields_set contains the field + if self.employment_type is None and "employment_type" in self.model_fields_set: + _dict['employment_type'] = None + + # set to None if location (nullable) is None + # and model_fields_set contains the field + if self.location is None and "location" in self.model_fields_set: + _dict['location'] = None + + # set to None if end_date (nullable) is None + # and model_fields_set contains the field + if self.end_date is None and "end_date" in self.model_fields_set: + _dict['end_date'] = None + + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Experience from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "user": obj.get("user"), + "user_info": UserInfo.from_dict(obj["user_info"]) if obj.get("user_info") is not None else None, + "company": Company.from_dict(obj["company"]) if obj.get("company") is not None else None, + "company_id": obj.get("company_id"), + "title": obj.get("title"), + "employment_type": obj.get("employment_type"), + "location": obj.get("location"), + "start_date": obj.get("start_date"), + "end_date": obj.get("end_date"), + "is_current": obj.get("is_current"), + "description": obj.get("description"), + "data": obj.get("data"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at") + }) + return _obj + + diff --git a/iblai/models/float_over_time.py b/iblai/models/float_over_time.py index abfe5c1..f923430 100644 --- a/iblai/models/float_over_time.py +++ b/iblai/models/float_over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/free_usage_count.py b/iblai/models/free_usage_count.py index 7253ab7..12543da 100644 --- a/iblai/models/free_usage_count.py +++ b/iblai/models/free_usage_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/grading_per_user.py b/iblai/models/grading_per_user.py index 21edb6f..c83563f 100644 --- a/iblai/models/grading_per_user.py +++ b/iblai/models/grading_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/grading_per_user_data.py b/iblai/models/grading_per_user_data.py index 9940900..8d52b81 100644 --- a/iblai/models/grading_per_user_data.py +++ b/iblai/models/grading_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/guided_prompts_response.py b/iblai/models/guided_prompts_response.py index f2ec942..7d1785e 100644 --- a/iblai/models/guided_prompts_response.py +++ b/iblai/models/guided_prompts_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/iblai_platform_meta.py b/iblai/models/iblai_platform_meta.py index 53f6837..61764fd 100644 --- a/iblai/models/iblai_platform_meta.py +++ b/iblai/models/iblai_platform_meta.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/iblai_platform_meta_request.py b/iblai/models/iblai_platform_meta_request.py index 8478c0d..1c83c23 100644 --- a/iblai/models/iblai_platform_meta_request.py +++ b/iblai/models/iblai_platform_meta_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/iblai_platform_meta_update_request.py b/iblai/models/iblai_platform_meta_update_request.py index ee98464..56a8e52 100644 --- a/iblai/models/iblai_platform_meta_update_request.py +++ b/iblai/models/iblai_platform_meta_update_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/image_upload.py b/iblai/models/image_upload.py index 8ceb0bf..a5bb4f0 100644 --- a/iblai/models/image_upload.py +++ b/iblai/models/image_upload.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/institution.py b/iblai/models/institution.py new file mode 100644 index 0000000..c282f36 --- /dev/null +++ b/iblai/models/institution.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.institution_type_enum import InstitutionTypeEnum +from typing import Optional, Set +from typing_extensions import Self + +class Institution(BaseModel): + """ + Institution + """ # noqa: E501 + id: StrictInt + name: Annotated[str, Field(strict=True, max_length=100)] + institution_type: Optional[InstitutionTypeEnum] = None + location: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + website: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + accreditation: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None + established_year: Optional[StrictInt] = None + data: Optional[Any] = Field(default=None, description="Metadata") + metadata: Optional[Any] = Field(default=None, description="Metadata") + created_at: Optional[datetime] = None + updated_at: datetime + __properties: ClassVar[List[str]] = ["id", "name", "institution_type", "location", "website", "accreditation", "established_year", "data", "metadata", "created_at", "updated_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Institution from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "updated_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if location (nullable) is None + # and model_fields_set contains the field + if self.location is None and "location" in self.model_fields_set: + _dict['location'] = None + + # set to None if website (nullable) is None + # and model_fields_set contains the field + if self.website is None and "website" in self.model_fields_set: + _dict['website'] = None + + # set to None if accreditation (nullable) is None + # and model_fields_set contains the field + if self.accreditation is None and "accreditation" in self.model_fields_set: + _dict['accreditation'] = None + + # set to None if established_year (nullable) is None + # and model_fields_set contains the field + if self.established_year is None and "established_year" in self.model_fields_set: + _dict['established_year'] = None + + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Institution from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "institution_type": obj.get("institution_type"), + "location": obj.get("location"), + "website": obj.get("website"), + "accreditation": obj.get("accreditation"), + "established_year": obj.get("established_year"), + "data": obj.get("data"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at") + }) + return _obj + + diff --git a/iblai/models/institution_type_enum.py b/iblai/models/institution_type_enum.py new file mode 100644 index 0000000..0228c2a --- /dev/null +++ b/iblai/models/institution_type_enum.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class InstitutionTypeEnum(str, Enum): + """ + * `university` - University * `college` - College * `institute` - Institute * `academy` - Academy * `other` - Other + """ + + """ + allowed enum values + """ + UNIVERSITY = 'university' + COLLEGE = 'college' + INSTITUTE = 'institute' + ACADEMY = 'academy' + OTHER = 'other' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InstitutionTypeEnum from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/iblai/models/integration_credential.py b/iblai/models/integration_credential.py index dc7247c..667c840 100644 --- a/iblai/models/integration_credential.py +++ b/iblai/models/integration_credential.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/issuer.py b/iblai/models/issuer.py index 4dc8b98..458b63f 100644 --- a/iblai/models/issuer.py +++ b/iblai/models/issuer.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/issuer_authority.py b/iblai/models/issuer_authority.py index 7df409b..009401c 100644 --- a/iblai/models/issuer_authority.py +++ b/iblai/models/issuer_authority.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/job_run.py b/iblai/models/job_run.py index 7fcc146..4142ee9 100644 --- a/iblai/models/job_run.py +++ b/iblai/models/job_run.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/languages_view.py b/iblai/models/languages_view.py index 80f9032..b20bb72 100644 --- a/iblai/models/languages_view.py +++ b/iblai/models/languages_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/learner_information_api.py b/iblai/models/learner_information_api.py index 0690135..211a97d 100644 --- a/iblai/models/learner_information_api.py +++ b/iblai/models/learner_information_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/learner_information_api_data.py b/iblai/models/learner_information_api_data.py index 56a03b7..bd78170 100644 --- a/iblai/models/learner_information_api_data.py +++ b/iblai/models/learner_information_api_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_credential_response.py b/iblai/models/llm_credential_response.py new file mode 100644 index 0000000..a8aaec7 --- /dev/null +++ b/iblai/models/llm_credential_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class LLMCredentialResponse(BaseModel): + """ + LLMCredentialResponse + """ # noqa: E501 + name: Annotated[str, Field(strict=True, max_length=255)] + value: Optional[Any] = None + platform: StrictStr = Field(description="The platform key") + __properties: ClassVar[List[str]] = ["name", "value", "platform"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LLMCredentialResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if value (nullable) is None + # and model_fields_set contains the field + if self.value is None and "value" in self.model_fields_set: + _dict['value'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LLMCredentialResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "value": obj.get("value"), + "platform": obj.get("platform") + }) + return _obj + + diff --git a/iblai/models/llm_model_for_tenant.py b/iblai/models/llm_model_for_tenant.py index c3bde63..514a09c 100644 --- a/iblai/models/llm_model_for_tenant.py +++ b/iblai/models/llm_model_for_tenant.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_response.py b/iblai/models/llm_response.py index 022336a..048e6bf 100644 --- a/iblai/models/llm_response.py +++ b/iblai/models/llm_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_scores_view.py b/iblai/models/llm_scores_view.py index 1bef32b..3417532 100644 --- a/iblai/models/llm_scores_view.py +++ b/iblai/models/llm_scores_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_scores_view_request.py b/iblai/models/llm_scores_view_request.py index dadec0a..58dcd90 100644 --- a/iblai/models/llm_scores_view_request.py +++ b/iblai/models/llm_scores_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_scores_view_response.py b/iblai/models/llm_scores_view_response.py index 11562fd..4eaae10 100644 --- a/iblai/models/llm_scores_view_response.py +++ b/iblai/models/llm_scores_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_trace_detail.py b/iblai/models/llm_trace_detail.py index 888ef02..ca5b423 100644 --- a/iblai/models/llm_trace_detail.py +++ b/iblai/models/llm_trace_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/llm_traces_list_response.py b/iblai/models/llm_traces_list_response.py index 752ed83..993b41e 100644 --- a/iblai/models/llm_traces_list_response.py +++ b/iblai/models/llm_traces_list_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/lti_key.py b/iblai/models/lti_key.py new file mode 100644 index 0000000..ca4fd7f --- /dev/null +++ b/iblai/models/lti_key.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class LtiKey(BaseModel): + """ + LtiKey + """ # noqa: E501 + id: StrictInt + name: StrictStr = Field(description="Name of the RSA Key") + public_key: StrictStr = Field(description="Public Key in PEM format") + public_jwk: Optional[Any] = Field(description="Public key in JWK format") + platform_key: StrictStr = Field(description="Platform Key") + __properties: ClassVar[List[str]] = ["id", "name", "public_key", "public_jwk", "platform_key"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LtiKey from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "public_key", + "public_jwk", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if public_jwk (nullable) is None + # and model_fields_set contains the field + if self.public_jwk is None and "public_jwk" in self.model_fields_set: + _dict['public_jwk'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LtiKey from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "public_key": obj.get("public_key"), + "public_jwk": obj.get("public_jwk"), + "platform_key": obj.get("platform_key") + }) + return _obj + + diff --git a/iblai/models/lti_launch_gate.py b/iblai/models/lti_launch_gate.py new file mode 100644 index 0000000..ec4eed6 --- /dev/null +++ b/iblai/models/lti_launch_gate.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class LtiLaunchGate(BaseModel): + """ + LtiLaunchGate + """ # noqa: E501 + allowed_keys: Optional[List[StrictStr]] = None + allowed_courses: Optional[List[StrictStr]] = None + allow_all_within_org: Optional[StrictBool] = Field(default=False, description="If True, a target_link_uri will work with any content within this org") + __properties: ClassVar[List[str]] = ["allowed_keys", "allowed_courses", "allow_all_within_org"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LtiLaunchGate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LtiLaunchGate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allowed_keys": obj.get("allowed_keys"), + "allowed_courses": obj.get("allowed_courses"), + "allow_all_within_org": obj.get("allow_all_within_org") if obj.get("allow_all_within_org") is not None else False + }) + return _obj + + diff --git a/iblai/models/lti_tool.py b/iblai/models/lti_tool.py new file mode 100644 index 0000000..a3c1ee1 --- /dev/null +++ b/iblai/models/lti_tool.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.lti_launch_gate import LtiLaunchGate +from typing import Optional, Set +from typing_extensions import Self + +class LtiTool(BaseModel): + """ + LtiTool + """ # noqa: E501 + id: StrictInt + title: StrictStr = Field(description="The title of the tool") + issuer: StrictStr = Field(description="This value will look someting like https://example.com. Value provided by Lti 1.3 Platform.") + client_id: StrictStr = Field(description="The client id provided by Lti 1.3 Platform") + auth_login_url: StrictStr = Field(description="The Platforms OIDC Login endpoint. Value provided by LTI 1.3 Platform.") + auth_token_url: StrictStr = Field(description="The Platforms OIDC Token endpoint. Value provided by LTI 1.3 Platform.") + auth_audience: Optional[StrictStr] = Field(default=None, description="The platforms Oauth2 Audience (aud). Usually can be skipped.") + key_set_url: Optional[StrictStr] = Field(default=None, description="The platforms JWKS endpoint. Value provided by LTI 1.3 Platform.") + key_set: Optional[Any] = Field(default=None, description="In case Platform's JWKS endpoint is not available, you can provide the JWKS here. Value provided by LTI 1.3 Platform.") + tool_key: StrictInt = Field(description="Reference to Lti Tool") + deployment_ids: List[StrictStr] = Field(description="List of deployment ids. Example: [\"1\", \"deployment-2\"]. Value(s) provided by LTI 1.3 Platform.") + platform_key: StrictStr + launch_gate: LtiLaunchGate + __properties: ClassVar[List[str]] = ["id", "title", "issuer", "client_id", "auth_login_url", "auth_token_url", "auth_audience", "key_set_url", "key_set", "tool_key", "deployment_ids", "platform_key", "launch_gate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LtiTool from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of launch_gate + if self.launch_gate: + _dict['launch_gate'] = self.launch_gate.to_dict() + # set to None if auth_audience (nullable) is None + # and model_fields_set contains the field + if self.auth_audience is None and "auth_audience" in self.model_fields_set: + _dict['auth_audience'] = None + + # set to None if key_set_url (nullable) is None + # and model_fields_set contains the field + if self.key_set_url is None and "key_set_url" in self.model_fields_set: + _dict['key_set_url'] = None + + # set to None if key_set (nullable) is None + # and model_fields_set contains the field + if self.key_set is None and "key_set" in self.model_fields_set: + _dict['key_set'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LtiTool from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "title": obj.get("title"), + "issuer": obj.get("issuer"), + "client_id": obj.get("client_id"), + "auth_login_url": obj.get("auth_login_url"), + "auth_token_url": obj.get("auth_token_url"), + "auth_audience": obj.get("auth_audience"), + "key_set_url": obj.get("key_set_url"), + "key_set": obj.get("key_set"), + "tool_key": obj.get("tool_key"), + "deployment_ids": obj.get("deployment_ids"), + "platform_key": obj.get("platform_key"), + "launch_gate": LtiLaunchGate.from_dict(obj["launch_gate"]) if obj.get("launch_gate") is not None else None + }) + return _obj + + diff --git a/iblai/models/main_creds.py b/iblai/models/main_creds.py index 5443795..c8a4137 100644 --- a/iblai/models/main_creds.py +++ b/iblai/models/main_creds.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/memory_status_request_view.py b/iblai/models/memory_status_request_view.py new file mode 100644 index 0000000..340083f --- /dev/null +++ b/iblai/models/memory_status_request_view.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class MemoryStatusRequestView(BaseModel): + """ + MemoryStatusRequestView + """ # noqa: E501 + enabled: StrictBool = Field(description="Enable or disable memory use") + __properties: ClassVar[List[str]] = ["enabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MemoryStatusRequestView from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MemoryStatusRequestView from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "enabled": obj.get("enabled") + }) + return _obj + + diff --git a/iblai/models/memory_status_view.py b/iblai/models/memory_status_view.py new file mode 100644 index 0000000..cd96457 --- /dev/null +++ b/iblai/models/memory_status_view.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class MemoryStatusView(BaseModel): + """ + MemoryStatusView + """ # noqa: E501 + id: StrictInt + username: Annotated[str, Field(strict=True, max_length=500)] + platform_key: Annotated[str, Field(strict=True, max_length=500)] + enabled: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["id", "username", "platform_key", "enabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MemoryStatusView from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MemoryStatusView from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "username": obj.get("username"), + "platform_key": obj.get("platform_key"), + "enabled": obj.get("enabled") + }) + return _obj + + diff --git a/iblai/models/mentor.py b/iblai/models/mentor.py index a6f017c..e19e9c9 100644 --- a/iblai/models/mentor.py +++ b/iblai/models/mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -40,11 +40,14 @@ class Mentor(BaseModel): proactive_prompt: Optional[StrictStr] = Field(default=None, description="Prompt to start a conversation with a user. This prompt will be fed to the mentor as soon as the user enters the chatroom. This is used if is_proactive is true.") moderation_system_prompt: Optional[StrictStr] = Field(default=None, description="The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.") moderation_response: Optional[StrictStr] = Field(default=None, description="Desired feedback to return to the user when their prompt is deemed inappropriate.") + safety_system_prompt: Optional[StrictStr] = Field(default=None, description="Prompt to check whether the models response is appropriate or not.") + safety_response: Optional[StrictStr] = Field(default=None, description="Feedback given to the user when a model generates an inappropriate response") + enable_safety_system: Optional[StrictBool] = None proactive_message: Optional[StrictStr] = Field(default=None, description="Prompt to start a conversation with a user.") created_by: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None created_at: Optional[datetime] updated_at: Optional[datetime] - __properties: ClassVar[List[str]] = ["name", "unique_id", "flow", "slug", "platform", "allow_anonymous", "metadata", "enable_moderation", "is_proactive", "proactive_prompt", "moderation_system_prompt", "moderation_response", "proactive_message", "created_by", "created_at", "updated_at"] + __properties: ClassVar[List[str]] = ["name", "unique_id", "flow", "slug", "platform", "allow_anonymous", "metadata", "enable_moderation", "is_proactive", "proactive_prompt", "moderation_system_prompt", "moderation_response", "safety_system_prompt", "safety_response", "enable_safety_system", "proactive_message", "created_by", "created_at", "updated_at"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -150,6 +153,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "proactive_prompt": obj.get("proactive_prompt"), "moderation_system_prompt": obj.get("moderation_system_prompt"), "moderation_response": obj.get("moderation_response"), + "safety_system_prompt": obj.get("safety_system_prompt"), + "safety_response": obj.get("safety_response"), + "enable_safety_system": obj.get("enable_safety_system"), "proactive_message": obj.get("proactive_message"), "created_by": obj.get("created_by"), "created_at": obj.get("created_at"), diff --git a/iblai/models/mentor_category.py b/iblai/models/mentor_category.py index d68d7af..5d479f2 100644 --- a/iblai/models/mentor_category.py +++ b/iblai/models/mentor_category.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_data.py b/iblai/models/mentor_data.py index 30cdd98..b013556 100644 --- a/iblai/models/mentor_data.py +++ b/iblai/models/mentor_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_detail_analytics.py b/iblai/models/mentor_detail_analytics.py index dd9b3e4..4ce77b1 100644 --- a/iblai/models/mentor_detail_analytics.py +++ b/iblai/models/mentor_detail_analytics.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_from_template_request.py b/iblai/models/mentor_from_template_request.py index cbfb21c..468acdc 100644 --- a/iblai/models/mentor_from_template_request.py +++ b/iblai/models/mentor_from_template_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_from_template_with_setting_request.py b/iblai/models/mentor_from_template_with_setting_request.py index 94ca9bd..606160e 100644 --- a/iblai/models/mentor_from_template_with_setting_request.py +++ b/iblai/models/mentor_from_template_with_setting_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -54,7 +54,10 @@ class MentorFromTemplateWithSettingRequest(BaseModel): seo_tags: Optional[Any] = None marketing_conversations: Optional[Any] = None proactive_prompt: Optional[StrictStr] = None - __properties: ClassVar[List[str]] = ["template_name", "display_name", "description", "profile_image", "initial_message", "suggested_message", "new_mentor_name", "theme", "user_message_color", "mentor_bubble_color", "align_mentor_bubble", "system_prompt", "llm_provider", "llm_name", "mentor_visibility", "enable_image_generation", "enable_web_browsing", "enable_code_interpreter", "metadata", "custom_css", "uploaded_profile_image", "proactive_message", "tool_slugs", "llm_temperature", "seo_tags", "marketing_conversations", "proactive_prompt"] + moderation_system_prompt: Optional[StrictStr] = None + moderation_response: Optional[StrictStr] = None + enable_moderation: Optional[StrictBool] = False + __properties: ClassVar[List[str]] = ["template_name", "display_name", "description", "profile_image", "initial_message", "suggested_message", "new_mentor_name", "theme", "user_message_color", "mentor_bubble_color", "align_mentor_bubble", "system_prompt", "llm_provider", "llm_name", "mentor_visibility", "enable_image_generation", "enable_web_browsing", "enable_code_interpreter", "metadata", "custom_css", "uploaded_profile_image", "proactive_message", "tool_slugs", "llm_temperature", "seo_tags", "marketing_conversations", "proactive_prompt", "moderation_system_prompt", "moderation_response", "enable_moderation"] model_config = ConfigDict( populate_by_name=True, @@ -148,7 +151,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "llm_temperature": obj.get("llm_temperature"), "seo_tags": obj.get("seo_tags"), "marketing_conversations": obj.get("marketing_conversations"), - "proactive_prompt": obj.get("proactive_prompt") + "proactive_prompt": obj.get("proactive_prompt"), + "moderation_system_prompt": obj.get("moderation_system_prompt"), + "moderation_response": obj.get("moderation_response"), + "enable_moderation": obj.get("enable_moderation") if obj.get("enable_moderation") is not None else False }) return _obj diff --git a/iblai/models/mentor_metadata.py b/iblai/models/mentor_metadata.py new file mode 100644 index 0000000..7d7481b --- /dev/null +++ b/iblai/models/mentor_metadata.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class MentorMetadata(BaseModel): + """ + MentorMetadata + """ # noqa: E501 + metadata: Optional[Any] + mentor: Optional[StrictStr] = None + mentor_id: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["metadata", "mentor", "mentor_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MentorMetadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MentorMetadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "metadata": obj.get("metadata"), + "mentor": obj.get("mentor"), + "mentor_id": obj.get("mentor_id") + }) + return _obj + + diff --git a/iblai/models/mentor_settings.py b/iblai/models/mentor_settings.py index a3a7deb..bc3ebbc 100644 --- a/iblai/models/mentor_settings.py +++ b/iblai/models/mentor_settings.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,8 +17,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated from iblai.models.align_mentor_bubble_enum import AlignMentorBubbleEnum from iblai.models.mentor_settings_mentor_visibility import MentorSettingsMentorVisibility @@ -42,19 +42,19 @@ class MentorSettings(BaseModel): mentor: StrictStr mentor_slug: StrictStr mentor_unique_id: StrictStr - metadata: StrictStr + metadata: Optional[Any] mentor_visibility: Optional[MentorSettingsMentorVisibility] = None enable_image_generation: Optional[StrictBool] = None enable_web_browsing: Optional[StrictBool] = None enable_code_interpreter: Optional[StrictBool] = None custom_css: Optional[StrictStr] = None - allow_anonymous: StrictStr + allow_anonymous: StrictBool mentor_description: StrictStr - suggested_prompts: StrictStr + suggested_prompts: Optional[Any] proactive_message: StrictStr - mentor_tools: StrictStr - can_use_tools: StrictStr - llm_temperature: StrictStr + mentor_tools: Optional[Any] + can_use_tools: StrictBool + llm_temperature: Union[StrictFloat, StrictInt] llm_provider: StrictStr llm_name: StrictStr proactive_prompt: StrictStr @@ -152,6 +152,11 @@ def to_dict(self) -> Dict[str, Any]: if self.suggested_message is None and "suggested_message" in self.model_fields_set: _dict['suggested_message'] = None + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + # set to None if mentor_visibility (nullable) is None # and model_fields_set contains the field if self.mentor_visibility is None and "mentor_visibility" in self.model_fields_set: @@ -177,6 +182,16 @@ def to_dict(self) -> Dict[str, Any]: if self.custom_css is None and "custom_css" in self.model_fields_set: _dict['custom_css'] = None + # set to None if suggested_prompts (nullable) is None + # and model_fields_set contains the field + if self.suggested_prompts is None and "suggested_prompts" in self.model_fields_set: + _dict['suggested_prompts'] = None + + # set to None if mentor_tools (nullable) is None + # and model_fields_set contains the field + if self.mentor_tools is None and "mentor_tools" in self.model_fields_set: + _dict['mentor_tools'] = None + return _dict @classmethod diff --git a/iblai/models/mentor_settings_mentor_visibility.py b/iblai/models/mentor_settings_mentor_visibility.py index 41a867f..332629c 100644 --- a/iblai/models/mentor_settings_mentor_visibility.py +++ b/iblai/models/mentor_settings_mentor_visibility.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_settings_request.py b/iblai/models/mentor_settings_request.py index 4ac0a0c..d9a0ad9 100644 --- a/iblai/models/mentor_settings_request.py +++ b/iblai/models/mentor_settings_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated from typing import Optional, Set @@ -27,6 +27,7 @@ class MentorSettingsRequest(BaseModel): """ MentorSettingsRequest """ # noqa: E501 + mentor_name: Optional[StrictStr] = None display_name: Optional[StrictStr] = None profile_image: Optional[StrictStr] = None initial_message: Optional[StrictStr] = None @@ -38,20 +39,28 @@ class MentorSettingsRequest(BaseModel): system_prompt: Optional[StrictStr] = None llm_provider: Optional[StrictStr] = None llm_name: Optional[StrictStr] = None - featured: Optional[StrictStr] = None + featured: Optional[StrictBool] = None metadata: Optional[Any] = None custom_css: Optional[StrictStr] = None mentor_visibility: Optional[StrictStr] = None - enable_image_generation: Optional[StrictStr] = None - enable_web_browsing: Optional[StrictStr] = None - enable_code_interpreter: Optional[StrictStr] = None - allow_anonymous: Optional[StrictStr] = None + enable_image_generation: Optional[StrictBool] = None + enable_web_browsing: Optional[StrictBool] = None + enable_code_interpreter: Optional[StrictBool] = None + allow_anonymous: Optional[StrictBool] = None mentor_description: Optional[StrictStr] = None uploaded_profile_image: Optional[StrictStr] = None proactive_message: Optional[StrictStr] = None + can_use_tools: Optional[StrictBool] = None tool_slugs: Optional[List[StrictStr]] = None llm_temperature: Optional[Union[Annotated[float, Field(le=1.0, strict=True, ge=0.0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = None - __properties: ClassVar[List[str]] = ["display_name", "profile_image", "initial_message", "suggested_message", "theme", "user_message_color", "mentor_bubble_color", "align_mentor_bubble", "system_prompt", "llm_provider", "llm_name", "featured", "metadata", "custom_css", "mentor_visibility", "enable_image_generation", "enable_web_browsing", "enable_code_interpreter", "allow_anonymous", "mentor_description", "uploaded_profile_image", "proactive_message", "tool_slugs", "llm_temperature"] + proactive_prompt: Optional[StrictStr] = None + moderation_system_prompt: Optional[StrictStr] = None + moderation_response: Optional[StrictStr] = None + enable_moderation: Optional[StrictBool] = False + safety_system_prompt: Optional[StrictStr] = None + safety_response: Optional[StrictStr] = None + enable_safety_system: Optional[StrictBool] = False + __properties: ClassVar[List[str]] = ["mentor_name", "display_name", "profile_image", "initial_message", "suggested_message", "theme", "user_message_color", "mentor_bubble_color", "align_mentor_bubble", "system_prompt", "llm_provider", "llm_name", "featured", "metadata", "custom_css", "mentor_visibility", "enable_image_generation", "enable_web_browsing", "enable_code_interpreter", "allow_anonymous", "mentor_description", "uploaded_profile_image", "proactive_message", "can_use_tools", "tool_slugs", "llm_temperature", "proactive_prompt", "moderation_system_prompt", "moderation_response", "enable_moderation", "safety_system_prompt", "safety_response", "enable_safety_system"] model_config = ConfigDict( populate_by_name=True, @@ -92,11 +101,26 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # set to None if initial_message (nullable) is None + # and model_fields_set contains the field + if self.initial_message is None and "initial_message" in self.model_fields_set: + _dict['initial_message'] = None + + # set to None if suggested_message (nullable) is None + # and model_fields_set contains the field + if self.suggested_message is None and "suggested_message" in self.model_fields_set: + _dict['suggested_message'] = None + # set to None if metadata (nullable) is None # and model_fields_set contains the field if self.metadata is None and "metadata" in self.model_fields_set: _dict['metadata'] = None + # set to None if custom_css (nullable) is None + # and model_fields_set contains the field + if self.custom_css is None and "custom_css" in self.model_fields_set: + _dict['custom_css'] = None + return _dict @classmethod @@ -109,6 +133,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "mentor_name": obj.get("mentor_name"), "display_name": obj.get("display_name"), "profile_image": obj.get("profile_image"), "initial_message": obj.get("initial_message"), @@ -131,8 +156,16 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "mentor_description": obj.get("mentor_description"), "uploaded_profile_image": obj.get("uploaded_profile_image"), "proactive_message": obj.get("proactive_message"), + "can_use_tools": obj.get("can_use_tools"), "tool_slugs": obj.get("tool_slugs"), - "llm_temperature": obj.get("llm_temperature") + "llm_temperature": obj.get("llm_temperature"), + "proactive_prompt": obj.get("proactive_prompt"), + "moderation_system_prompt": obj.get("moderation_system_prompt"), + "moderation_response": obj.get("moderation_response"), + "enable_moderation": obj.get("enable_moderation") if obj.get("enable_moderation") is not None else False, + "safety_system_prompt": obj.get("safety_system_prompt"), + "safety_response": obj.get("safety_response"), + "enable_safety_system": obj.get("enable_safety_system") if obj.get("enable_safety_system") is not None else False }) return _obj diff --git a/iblai/models/mentor_trace.py b/iblai/models/mentor_trace.py index e1cfc4f..f27fd2d 100644 --- a/iblai/models/mentor_trace.py +++ b/iblai/models/mentor_trace.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_visibility_enum.py b/iblai/models/mentor_visibility_enum.py index 680e58c..5209915 100644 --- a/iblai/models/mentor_visibility_enum.py +++ b/iblai/models/mentor_visibility_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/mentor_wizard.py b/iblai/models/mentor_wizard.py index 53b6505..1f4be01 100644 --- a/iblai/models/mentor_wizard.py +++ b/iblai/models/mentor_wizard.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/message_status.py b/iblai/models/message_status.py new file mode 100644 index 0000000..c7bcc3b --- /dev/null +++ b/iblai/models/message_status.py @@ -0,0 +1,137 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from iblai.models.blank_enum import BlankEnum +from iblai.models.notification_status_enum import NotificationStatusEnum +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +MESSAGESTATUS_ONE_OF_SCHEMAS = ["BlankEnum", "NotificationStatusEnum"] + +class MessageStatus(BaseModel): + """ + MessageStatus + """ + # data type: NotificationStatusEnum + oneof_schema_1_validator: Optional[NotificationStatusEnum] = None + # data type: BlankEnum + oneof_schema_2_validator: Optional[BlankEnum] = None + actual_instance: Optional[Union[BlankEnum, NotificationStatusEnum]] = None + one_of_schemas: Set[str] = { "BlankEnum", "NotificationStatusEnum" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = MessageStatus.model_construct() + error_messages = [] + match = 0 + # validate data type: NotificationStatusEnum + if not isinstance(v, NotificationStatusEnum): + error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationStatusEnum`") + else: + match += 1 + # validate data type: BlankEnum + if not isinstance(v, BlankEnum): + error_messages.append(f"Error! Input type `{type(v)}` is not `BlankEnum`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in MessageStatus with oneOf schemas: BlankEnum, NotificationStatusEnum. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in MessageStatus with oneOf schemas: BlankEnum, NotificationStatusEnum. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into NotificationStatusEnum + try: + instance.actual_instance = NotificationStatusEnum.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into BlankEnum + try: + instance.actual_instance = BlankEnum.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into MessageStatus with oneOf schemas: BlankEnum, NotificationStatusEnum. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into MessageStatus with oneOf schemas: BlankEnum, NotificationStatusEnum. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], BlankEnum, NotificationStatusEnum]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/iblai/models/message_view.py b/iblai/models/message_view.py index 4744e58..57b9099 100644 --- a/iblai/models/message_view.py +++ b/iblai/models/message_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/message_view_request.py b/iblai/models/message_view_request.py index 8dba5af..eae200d 100644 --- a/iblai/models/message_view_request.py +++ b/iblai/models/message_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/message_view_updat_response.py b/iblai/models/message_view_updat_response.py index 0deece8..94ae540 100644 --- a/iblai/models/message_view_updat_response.py +++ b/iblai/models/message_view_updat_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/metadata.py b/iblai/models/metadata.py new file mode 100644 index 0000000..da31556 --- /dev/null +++ b/iblai/models/metadata.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Metadata(BaseModel): + """ + Metadata + """ # noqa: E501 + metadata: Optional[Any] + prompt: Optional[StrictStr] = None + prompt_id: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["metadata", "prompt", "prompt_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Metadata from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Metadata from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "metadata": obj.get("metadata"), + "prompt": obj.get("prompt"), + "prompt_id": obj.get("prompt_id") + }) + return _obj + + diff --git a/iblai/models/model_cost.py b/iblai/models/model_cost.py index 5cdd36a..db47c44 100644 --- a/iblai/models/model_cost.py +++ b/iblai/models/model_cost.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/model_usage.py b/iblai/models/model_usage.py index fe45b38..5922ff4 100644 --- a/iblai/models/model_usage.py +++ b/iblai/models/model_usage.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/moderation_log.py b/iblai/models/moderation_log.py new file mode 100644 index 0000000..397b946 --- /dev/null +++ b/iblai/models/moderation_log.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.target_system_enum import TargetSystemEnum +from typing import Optional, Set +from typing_extensions import Self + +class ModerationLog(BaseModel): + """ + ModerationLog + """ # noqa: E501 + id: StrictInt + username: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None + platform_key: Annotated[str, Field(strict=True, max_length=200)] + mentor: StrictInt + prompt: StrictStr + reason: StrictStr + target_system: Optional[TargetSystemEnum] = None + date_created: datetime + __properties: ClassVar[List[str]] = ["id", "username", "platform_key", "mentor", "prompt", "reason", "target_system", "date_created"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ModerationLog from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "date_created", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ModerationLog from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "username": obj.get("username"), + "platform_key": obj.get("platform_key"), + "mentor": obj.get("mentor"), + "prompt": obj.get("prompt"), + "reason": obj.get("reason"), + "target_system": obj.get("target_system"), + "date_created": obj.get("date_created") + }) + return _obj + + diff --git a/iblai/models/net_revenue_over_time.py b/iblai/models/net_revenue_over_time.py index 3a1ee58..c987905 100644 --- a/iblai/models/net_revenue_over_time.py +++ b/iblai/models/net_revenue_over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/notification.py b/iblai/models/notification.py new file mode 100644 index 0000000..80d7ceb --- /dev/null +++ b/iblai/models/notification.py @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.message_status import MessageStatus +from typing import Optional, Set +from typing_extensions import Self + +class Notification(BaseModel): + """ + Notification + """ # noqa: E501 + id: StrictStr + username: StrictStr + title: StrictStr + body: StrictStr + status: Optional[MessageStatus] = None + channel: Optional[StrictInt] = None + context: Optional[Any] = None + short_message: StrictStr + created_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = ["id", "username", "title", "body", "status", "channel", "context", "short_message", "created_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Notification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "title", + "body", + "short_message", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of status + if self.status: + _dict['status'] = self.status.to_dict() + # set to None if channel (nullable) is None + # and model_fields_set contains the field + if self.channel is None and "channel" in self.model_fields_set: + _dict['channel'] = None + + # set to None if context (nullable) is None + # and model_fields_set contains the field + if self.context is None and "context" in self.model_fields_set: + _dict['context'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Notification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "username": obj.get("username"), + "title": obj.get("title"), + "body": obj.get("body"), + "status": MessageStatus.from_dict(obj["status"]) if obj.get("status") is not None else None, + "channel": obj.get("channel"), + "context": obj.get("context"), + "short_message": obj.get("short_message"), + "created_at": obj.get("created_at") + }) + return _obj + + diff --git a/iblai/models/notification_count.py b/iblai/models/notification_count.py new file mode 100644 index 0000000..4cea989 --- /dev/null +++ b/iblai/models/notification_count.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class NotificationCount(BaseModel): + """ + NotificationCount + """ # noqa: E501 + status: Optional[StrictStr] = None + channel: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["status", "channel"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of NotificationCount from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of NotificationCount from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "status": obj.get("status"), + "channel": obj.get("channel") + }) + return _obj + + diff --git a/iblai/models/notification_status_enum.py b/iblai/models/notification_status_enum.py new file mode 100644 index 0000000..36300a6 --- /dev/null +++ b/iblai/models/notification_status_enum.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class NotificationStatusEnum(str, Enum): + """ + * `READ` - Read * `UNREAD` - Unread * `CANCELLED` - Cancelled + """ + + """ + allowed enum values + """ + READ = 'READ' + UNREAD = 'UNREAD' + CANCELLED = 'CANCELLED' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of NotificationStatusEnum from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/iblai/models/null_enum.py b/iblai/models/null_enum.py index 33533f5..8841586 100644 --- a/iblai/models/null_enum.py +++ b/iblai/models/null_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/observation.py b/iblai/models/observation.py index 1a23821..7858fb1 100644 --- a/iblai/models/observation.py +++ b/iblai/models/observation.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/order.py b/iblai/models/order.py index 721e357..aa3f1a7 100644 --- a/iblai/models/order.py +++ b/iblai/models/order.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/over_time.py b/iblai/models/over_time.py index 5db170c..2e66fab 100644 --- a/iblai/models/over_time.py +++ b/iblai/models/over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/overtime.py b/iblai/models/over_time_with_total.py similarity index 91% rename from iblai/models/overtime.py rename to iblai/models/over_time_with_total.py index ccde2f4..cc6c14b 100644 --- a/iblai/models/overtime.py +++ b/iblai/models/over_time_with_total.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -22,7 +22,7 @@ from typing import Optional, Set from typing_extensions import Self -class Overtime(BaseModel): +class OverTimeWithTotal(BaseModel): """ Returns { \"data\": { \"2022-04-26\": 0, \"2022-04-27\": 0, ... \"2023-01-01\": 0 }, \"total\": 0 } """ # noqa: E501 @@ -48,7 +48,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of Overtime from a JSON string""" + """Create an instance of OverTimeWithTotal from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -73,7 +73,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of Overtime from a dict""" + """Create an instance of OverTimeWithTotal from a dict""" if obj is None: return None diff --git a/iblai/models/overtime_meta.py b/iblai/models/overtime_meta.py index c90e4b5..c57f301 100644 --- a/iblai/models/overtime_meta.py +++ b/iblai/models/overtime_meta.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/overtime_with_change_info.py b/iblai/models/overtime_with_change_info.py index 54a2655..68ba0cf 100644 --- a/iblai/models/overtime_with_change_info.py +++ b/iblai/models/overtime_with_change_info.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/page_content.py b/iblai/models/page_content.py index a99d183..636491d 100644 --- a/iblai/models/page_content.py +++ b/iblai/models/page_content.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_ai_generated_image_list.py b/iblai/models/paginated_ai_generated_image_list.py new file mode 100644 index 0000000..353492f --- /dev/null +++ b/iblai/models/paginated_ai_generated_image_list.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.ai_generated_image import AIGeneratedImage +from typing import Optional, Set +from typing_extensions import Self + +class PaginatedAIGeneratedImageList(BaseModel): + """ + PaginatedAIGeneratedImageList + """ # noqa: E501 + count: Optional[StrictInt] = None + next: Optional[StrictStr] = None + previous: Optional[StrictStr] = None + results: Optional[List[AIGeneratedImage]] = None + __properties: ClassVar[List[str]] = ["count", "next", "previous", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaginatedAIGeneratedImageList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # set to None if next (nullable) is None + # and model_fields_set contains the field + if self.next is None and "next" in self.model_fields_set: + _dict['next'] = None + + # set to None if previous (nullable) is None + # and model_fields_set contains the field + if self.previous is None and "previous" in self.model_fields_set: + _dict['previous'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaginatedAIGeneratedImageList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "next": obj.get("next"), + "previous": obj.get("previous"), + "results": [AIGeneratedImage.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/iblai/models/paginated_conversations_list.py b/iblai/models/paginated_conversations_list.py new file mode 100644 index 0000000..ba9b8cd --- /dev/null +++ b/iblai/models/paginated_conversations_list.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.conversations import Conversations +from typing import Optional, Set +from typing_extensions import Self + +class PaginatedConversationsList(BaseModel): + """ + PaginatedConversationsList + """ # noqa: E501 + count: Optional[StrictInt] = None + next: Optional[StrictStr] = None + previous: Optional[StrictStr] = None + results: Optional[List[Conversations]] = None + __properties: ClassVar[List[str]] = ["count", "next", "previous", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaginatedConversationsList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # set to None if next (nullable) is None + # and model_fields_set contains the field + if self.next is None and "next" in self.model_fields_set: + _dict['next'] = None + + # set to None if previous (nullable) is None + # and model_fields_set contains the field + if self.previous is None and "previous" in self.model_fields_set: + _dict['previous'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaginatedConversationsList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "next": obj.get("next"), + "previous": obj.get("previous"), + "results": [Conversations.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/iblai/models/paginated_data_set_list.py b/iblai/models/paginated_data_set_list.py index aec80c2..5cadbfa 100644 --- a/iblai/models/paginated_data_set_list.py +++ b/iblai/models/paginated_data_set_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_job_run_list.py b/iblai/models/paginated_job_run_list.py index 8bed636..5470248 100644 --- a/iblai/models/paginated_job_run_list.py +++ b/iblai/models/paginated_job_run_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_mentor_list.py b/iblai/models/paginated_mentor_list.py index 115f3bf..62191e5 100644 --- a/iblai/models/paginated_mentor_list.py +++ b/iblai/models/paginated_mentor_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_moderation_log_list.py b/iblai/models/paginated_moderation_log_list.py new file mode 100644 index 0000000..5f26c52 --- /dev/null +++ b/iblai/models/paginated_moderation_log_list.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.moderation_log import ModerationLog +from typing import Optional, Set +from typing_extensions import Self + +class PaginatedModerationLogList(BaseModel): + """ + PaginatedModerationLogList + """ # noqa: E501 + count: Optional[StrictInt] = None + next: Optional[StrictStr] = None + previous: Optional[StrictStr] = None + results: Optional[List[ModerationLog]] = None + __properties: ClassVar[List[str]] = ["count", "next", "previous", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaginatedModerationLogList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # set to None if next (nullable) is None + # and model_fields_set contains the field + if self.next is None and "next" in self.model_fields_set: + _dict['next'] = None + + # set to None if previous (nullable) is None + # and model_fields_set contains the field + if self.previous is None and "previous" in self.model_fields_set: + _dict['previous'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaginatedModerationLogList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "count": obj.get("count"), + "next": obj.get("next"), + "previous": obj.get("previous"), + "results": [ModerationLog.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/iblai/models/paginated_periodic_agent_list.py b/iblai/models/paginated_periodic_agent_list.py index 1a96f7e..2f9b4b1 100644 --- a/iblai/models/paginated_periodic_agent_list.py +++ b/iblai/models/paginated_periodic_agent_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_periodic_agent_log_list.py b/iblai/models/paginated_periodic_agent_log_list.py index d667d95..4bf2546 100644 --- a/iblai/models/paginated_periodic_agent_log_list.py +++ b/iblai/models/paginated_periodic_agent_log_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_play_wright_script_list.py b/iblai/models/paginated_play_wright_script_list.py index 194c1a2..f22ba5c 100644 --- a/iblai/models/paginated_play_wright_script_list.py +++ b/iblai/models/paginated_play_wright_script_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_training_list.py b/iblai/models/paginated_training_list.py index c76db77..0909ae4 100644 --- a/iblai/models/paginated_training_list.py +++ b/iblai/models/paginated_training_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/paginated_user_edx_memory_list.py b/iblai/models/paginated_user_edx_memory_list.py index 2bf0672..c6793f1 100644 --- a/iblai/models/paginated_user_edx_memory_list.py +++ b/iblai/models/paginated_user_edx_memory_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/pagination.py b/iblai/models/pagination.py index 63dde48..c092e0d 100644 --- a/iblai/models/pagination.py +++ b/iblai/models/pagination.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_bot_command.py b/iblai/models/patched_bot_command.py index a2c88bf..b8ed6a6 100644 --- a/iblai/models/patched_bot_command.py +++ b/iblai/models/patched_bot_command.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_bot_create.py b/iblai/models/patched_bot_create.py index dc708ba..ff9769a 100644 --- a/iblai/models/patched_bot_create.py +++ b/iblai/models/patched_bot_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_credential_request.py b/iblai/models/patched_credential_request.py index 528eb57..2397f45 100644 --- a/iblai/models/patched_credential_request.py +++ b/iblai/models/patched_credential_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_data_set.py b/iblai/models/patched_data_set.py index 50ad5f4..5993e83 100644 --- a/iblai/models/patched_data_set.py +++ b/iblai/models/patched_data_set.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_discord_config.py b/iblai/models/patched_discord_config.py index 905ec30..f8bc276 100644 --- a/iblai/models/patched_discord_config.py +++ b/iblai/models/patched_discord_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_mentor.py b/iblai/models/patched_mentor.py index 774e993..7344b11 100644 --- a/iblai/models/patched_mentor.py +++ b/iblai/models/patched_mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -40,11 +40,14 @@ class PatchedMentor(BaseModel): proactive_prompt: Optional[StrictStr] = Field(default=None, description="Prompt to start a conversation with a user. This prompt will be fed to the mentor as soon as the user enters the chatroom. This is used if is_proactive is true.") moderation_system_prompt: Optional[StrictStr] = Field(default=None, description="The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.") moderation_response: Optional[StrictStr] = Field(default=None, description="Desired feedback to return to the user when their prompt is deemed inappropriate.") + safety_system_prompt: Optional[StrictStr] = Field(default=None, description="Prompt to check whether the models response is appropriate or not.") + safety_response: Optional[StrictStr] = Field(default=None, description="Feedback given to the user when a model generates an inappropriate response") + enable_safety_system: Optional[StrictBool] = None proactive_message: Optional[StrictStr] = Field(default=None, description="Prompt to start a conversation with a user.") created_by: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None created_at: Optional[datetime] = None updated_at: Optional[datetime] = None - __properties: ClassVar[List[str]] = ["name", "unique_id", "flow", "slug", "platform", "allow_anonymous", "metadata", "enable_moderation", "is_proactive", "proactive_prompt", "moderation_system_prompt", "moderation_response", "proactive_message", "created_by", "created_at", "updated_at"] + __properties: ClassVar[List[str]] = ["name", "unique_id", "flow", "slug", "platform", "allow_anonymous", "metadata", "enable_moderation", "is_proactive", "proactive_prompt", "moderation_system_prompt", "moderation_response", "safety_system_prompt", "safety_response", "enable_safety_system", "proactive_message", "created_by", "created_at", "updated_at"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -153,6 +156,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "proactive_prompt": obj.get("proactive_prompt"), "moderation_system_prompt": obj.get("moderation_system_prompt"), "moderation_response": obj.get("moderation_response"), + "safety_system_prompt": obj.get("safety_system_prompt"), + "safety_response": obj.get("safety_response"), + "enable_safety_system": obj.get("enable_safety_system"), "proactive_message": obj.get("proactive_message"), "created_by": obj.get("created_by"), "created_at": obj.get("created_at"), diff --git a/iblai/models/patched_notification.py b/iblai/models/patched_notification.py new file mode 100644 index 0000000..31d85e8 --- /dev/null +++ b/iblai/models/patched_notification.py @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.message_status import MessageStatus +from typing import Optional, Set +from typing_extensions import Self + +class PatchedNotification(BaseModel): + """ + PatchedNotification + """ # noqa: E501 + id: Optional[StrictStr] = None + username: Optional[StrictStr] = None + title: Optional[StrictStr] = None + body: Optional[StrictStr] = None + status: Optional[MessageStatus] = None + channel: Optional[StrictInt] = None + context: Optional[Any] = None + short_message: Optional[StrictStr] = None + created_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = ["id", "username", "title", "body", "status", "channel", "context", "short_message", "created_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PatchedNotification from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "title", + "body", + "short_message", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of status + if self.status: + _dict['status'] = self.status.to_dict() + # set to None if channel (nullable) is None + # and model_fields_set contains the field + if self.channel is None and "channel" in self.model_fields_set: + _dict['channel'] = None + + # set to None if context (nullable) is None + # and model_fields_set contains the field + if self.context is None and "context" in self.model_fields_set: + _dict['context'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PatchedNotification from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "username": obj.get("username"), + "title": obj.get("title"), + "body": obj.get("body"), + "status": MessageStatus.from_dict(obj["status"]) if obj.get("status") is not None else None, + "channel": obj.get("channel"), + "context": obj.get("context"), + "short_message": obj.get("short_message"), + "created_at": obj.get("created_at") + }) + return _obj + + diff --git a/iblai/models/patched_periodic_agent_create.py b/iblai/models/patched_periodic_agent_create.py index 9792063..eee87b1 100644 --- a/iblai/models/patched_periodic_agent_create.py +++ b/iblai/models/patched_periodic_agent_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -43,12 +43,14 @@ class PatchedPeriodicAgentCreate(BaseModel): one_off: Optional[StrictStr] = None platform_key: Optional[StrictStr] = None pathway: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + callback_url: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None + callback_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None parent_session_id: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None parent_mentor_id: Optional[StrictInt] = None previous_agent: Optional[StrictInt] = Field(default=None, description="Agent that needs to run before the current agent runs.") previous_agent_status: Optional[PreviousAgentStatusEnum] = Field(default=None, description="The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending") previous_agent_output: Optional[StrictStr] = Field(default=None, description="This will be fed into the run of this agent as part of its input prompt.") - __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] + __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "callback_url", "callback_secret", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] model_config = ConfigDict( populate_by_name=True, @@ -143,6 +145,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "one_off": obj.get("one_off"), "platform_key": obj.get("platform_key"), "pathway": obj.get("pathway"), + "callback_url": obj.get("callback_url"), + "callback_secret": obj.get("callback_secret"), "parent_session_id": obj.get("parent_session_id"), "parent_mentor_id": obj.get("parent_mentor_id"), "previous_agent": obj.get("previous_agent"), diff --git a/iblai/models/patched_platform_public_metadata.py b/iblai/models/patched_platform_public_metadata.py index b850941..6058f8d 100644 --- a/iblai/models/patched_platform_public_metadata.py +++ b/iblai/models/patched_platform_public_metadata.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,7 +17,6 @@ import re # noqa: F401 import json -from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set @@ -30,9 +29,7 @@ class PatchedPlatformPublicMetadata(BaseModel): platform_key: Optional[StrictStr] = None platform_name: Optional[StrictStr] = None metadata: Optional[Any] = Field(default=None, description="The public metadata") - created_on: Optional[datetime] = None - last_updated: Optional[datetime] = None - __properties: ClassVar[List[str]] = ["platform_key", "platform_name", "metadata", "created_on", "last_updated"] + __properties: ClassVar[List[str]] = ["platform_key", "platform_name", "metadata"] model_config = ConfigDict( populate_by_name=True, @@ -66,14 +63,10 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "platform_key", "platform_name", - "created_on", - "last_updated", ]) _dict = self.model_dump( @@ -100,9 +93,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "platform_key": obj.get("platform_key"), "platform_name": obj.get("platform_name"), - "metadata": obj.get("metadata"), - "created_on": obj.get("created_on"), - "last_updated": obj.get("last_updated") + "metadata": obj.get("metadata") }) return _obj diff --git a/iblai/models/patched_play_wright_script.py b/iblai/models/patched_play_wright_script.py index af824bd..f277be9 100644 --- a/iblai/models/patched_play_wright_script.py +++ b/iblai/models/patched_play_wright_script.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_prompt.py b/iblai/models/patched_prompt.py index 64869ba..d0f7fd2 100644 --- a/iblai/models/patched_prompt.py +++ b/iblai/models/patched_prompt.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_prompt_prompt_visibility.py b/iblai/models/patched_prompt_prompt_visibility.py index f905084..a972999 100644 --- a/iblai/models/patched_prompt_prompt_visibility.py +++ b/iblai/models/patched_prompt_prompt_visibility.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_skill_threshold.py b/iblai/models/patched_skill_threshold.py index 8c9e9d9..59bacd7 100644 --- a/iblai/models/patched_skill_threshold.py +++ b/iblai/models/patched_skill_threshold.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_slack_config.py b/iblai/models/patched_slack_config.py index af8d8c4..c2d5c93 100644 --- a/iblai/models/patched_slack_config.py +++ b/iblai/models/patched_slack_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_training_create.py b/iblai/models/patched_training_create.py index 1366c2f..4b63ac2 100644 --- a/iblai/models/patched_training_create.py +++ b/iblai/models/patched_training_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/patched_whatsapp_config.py b/iblai/models/patched_whatsapp_config.py index d8bdbaa..dd41936 100644 --- a/iblai/models/patched_whatsapp_config.py +++ b/iblai/models/patched_whatsapp_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_course_last_access_data.py b/iblai/models/per_learner_course_last_access_data.py index 3c80676..db53c63 100644 --- a/iblai/models/per_learner_course_last_access_data.py +++ b/iblai/models/per_learner_course_last_access_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_course_videos_watched.py b/iblai/models/per_learner_course_videos_watched.py index fd52eb5..f78733a 100644 --- a/iblai/models/per_learner_course_videos_watched.py +++ b/iblai/models/per_learner_course_videos_watched.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_course_videos_watched_data.py b/iblai/models/per_learner_course_videos_watched_data.py index 5175839..1da33a7 100644 --- a/iblai/models/per_learner_course_videos_watched_data.py +++ b/iblai/models/per_learner_course_videos_watched_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_last_access.py b/iblai/models/per_learner_last_access.py index 2cf7453..f84acf6 100644 --- a/iblai/models/per_learner_last_access.py +++ b/iblai/models/per_learner_last_access.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_last_access_data.py b/iblai/models/per_learner_last_access_data.py index 3817880..95532f2 100644 --- a/iblai/models/per_learner_last_access_data.py +++ b/iblai/models/per_learner_last_access_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/per_learner_time_spent_in_course_tree.py b/iblai/models/per_learner_time_spent_in_course_tree.py index a18afeb..a5403a0 100644 --- a/iblai/models/per_learner_time_spent_in_course_tree.py +++ b/iblai/models/per_learner_time_spent_in_course_tree.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/performance_grades_per_course.py b/iblai/models/performance_grades_per_course.py index c9bba7c..5ff8754 100644 --- a/iblai/models/performance_grades_per_course.py +++ b/iblai/models/performance_grades_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/performance_grades_per_course_data.py b/iblai/models/performance_grades_per_course_data.py index 232966a..6a731e2 100644 --- a/iblai/models/performance_grades_per_course_data.py +++ b/iblai/models/performance_grades_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/periodic_agent.py b/iblai/models/periodic_agent.py index 714c878..3d279bc 100644 --- a/iblai/models/periodic_agent.py +++ b/iblai/models/periodic_agent.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -44,12 +44,14 @@ class PeriodicAgent(BaseModel): one_off: StrictStr platform_key: StrictStr pathway: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + callback_url: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None + callback_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None parent_session_id: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None parent_mentor_id: Optional[StrictInt] = None previous_agent: Optional[StrictInt] = Field(default=None, description="Agent that needs to run before the current agent runs.") previous_agent_status: Optional[PreviousAgentStatusEnum] = Field(default=None, description="The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending") previous_agent_output: StrictStr = Field(description="This will be fed into the run of this agent as part of its input prompt.") - __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] + __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "callback_url", "callback_secret", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] model_config = ConfigDict( populate_by_name=True, @@ -147,6 +149,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "one_off": obj.get("one_off"), "platform_key": obj.get("platform_key"), "pathway": obj.get("pathway"), + "callback_url": obj.get("callback_url"), + "callback_secret": obj.get("callback_secret"), "parent_session_id": obj.get("parent_session_id"), "parent_mentor_id": obj.get("parent_mentor_id"), "previous_agent": obj.get("previous_agent"), diff --git a/iblai/models/periodic_agent_create.py b/iblai/models/periodic_agent_create.py index e6e42b3..790eeaa 100644 --- a/iblai/models/periodic_agent_create.py +++ b/iblai/models/periodic_agent_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -43,12 +43,14 @@ class PeriodicAgentCreate(BaseModel): one_off: StrictStr platform_key: StrictStr pathway: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None + callback_url: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None + callback_secret: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None parent_session_id: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None parent_mentor_id: Optional[StrictInt] = None previous_agent: Optional[StrictInt] = Field(default=None, description="Agent that needs to run before the current agent runs.") previous_agent_status: Optional[PreviousAgentStatusEnum] = Field(default=None, description="The status that the previous agent must be in before this agent gets scheduled. * `success` - Success * `error` - Error * `running` - Running * `pending` - Pending") previous_agent_output: StrictStr = Field(description="This will be fed into the run of this agent as part of its input prompt.") - __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] + __properties: ClassVar[List[str]] = ["id", "mentor", "title", "username", "description", "prompt", "task", "created_at", "modified_at", "enabled", "one_off", "platform_key", "pathway", "callback_url", "callback_secret", "parent_session_id", "parent_mentor_id", "previous_agent", "previous_agent_status", "previous_agent_output"] model_config = ConfigDict( populate_by_name=True, @@ -143,6 +145,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "one_off": obj.get("one_off"), "platform_key": obj.get("platform_key"), "pathway": obj.get("pathway"), + "callback_url": obj.get("callback_url"), + "callback_secret": obj.get("callback_secret"), "parent_session_id": obj.get("parent_session_id"), "parent_mentor_id": obj.get("parent_mentor_id"), "previous_agent": obj.get("previous_agent"), diff --git a/iblai/models/periodic_agent_log.py b/iblai/models/periodic_agent_log.py index 14394a1..b92c446 100644 --- a/iblai/models/periodic_agent_log.py +++ b/iblai/models/periodic_agent_log.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/periodic_agent_log_status_enum.py b/iblai/models/periodic_agent_log_status_enum.py index feb6091..831b8fe 100644 --- a/iblai/models/periodic_agent_log_status_enum.py +++ b/iblai/models/periodic_agent_log_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/periodic_task.py b/iblai/models/periodic_task.py index 983c15a..bc42161 100644 --- a/iblai/models/periodic_task.py +++ b/iblai/models/periodic_task.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_course_progress.py b/iblai/models/perlearner_course_progress.py index ec65a71..65ae1e7 100644 --- a/iblai/models/perlearner_course_progress.py +++ b/iblai/models/perlearner_course_progress.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_course_progress_data.py b/iblai/models/perlearner_course_progress_data.py index 46cf647..ceda814 100644 --- a/iblai/models/perlearner_course_progress_data.py +++ b/iblai/models/perlearner_course_progress_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_engagement_videos_data.py b/iblai/models/perlearner_engagement_videos_data.py index 1abdcc2..9b6a6d6 100644 --- a/iblai/models/perlearner_engagement_videos_data.py +++ b/iblai/models/perlearner_engagement_videos_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_engagement_videos_watched_per_course.py b/iblai/models/perlearner_engagement_videos_watched_per_course.py index deae791..0f91ec4 100644 --- a/iblai/models/perlearner_engagement_videos_watched_per_course.py +++ b/iblai/models/perlearner_engagement_videos_watched_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grade_summary.py b/iblai/models/perlearner_grade_summary.py index 19e838a..c70b4ab 100644 --- a/iblai/models/perlearner_grade_summary.py +++ b/iblai/models/perlearner_grade_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grade_summary_data.py b/iblai/models/perlearner_grade_summary_data.py index ce793e0..6028422 100644 --- a/iblai/models/perlearner_grade_summary_data.py +++ b/iblai/models/perlearner_grade_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grade_with_cut_off.py b/iblai/models/perlearner_grade_with_cut_off.py index 0f66ab3..0fefb12 100644 --- a/iblai/models/perlearner_grade_with_cut_off.py +++ b/iblai/models/perlearner_grade_with_cut_off.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grade_with_cut_off_data.py b/iblai/models/perlearner_grade_with_cut_off_data.py index 0417e34..d03e728 100644 --- a/iblai/models/perlearner_grade_with_cut_off_data.py +++ b/iblai/models/perlearner_grade_with_cut_off_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grading_per_course_api.py b/iblai/models/perlearner_grading_per_course_api.py index 516b205..2d75130 100644 --- a/iblai/models/perlearner_grading_per_course_api.py +++ b/iblai/models/perlearner_grading_per_course_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_grading_per_course_api_data.py b/iblai/models/perlearner_grading_per_course_api_data.py index 8a57e08..45c3ed9 100644 --- a/iblai/models/perlearner_grading_per_course_api_data.py +++ b/iblai/models/perlearner_grading_per_course_api_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_user_list.py b/iblai/models/perlearner_user_list.py index 9df56e8..e6081cd 100644 --- a/iblai/models/perlearner_user_list.py +++ b/iblai/models/perlearner_user_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/perlearner_user_list_data.py b/iblai/models/perlearner_user_list_data.py index 5ae8336..3c645d3 100644 --- a/iblai/models/perlearner_user_list_data.py +++ b/iblai/models/perlearner_user_list_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/pinned_message_create.py b/iblai/models/pinned_message_create.py index 0be1708..5b91dfd 100644 --- a/iblai/models/pinned_message_create.py +++ b/iblai/models/pinned_message_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/pinned_message_request.py b/iblai/models/pinned_message_request.py index 5189f6b..052e731 100644 --- a/iblai/models/pinned_message_request.py +++ b/iblai/models/pinned_message_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/platform_public_metadata.py b/iblai/models/platform_public_metadata.py index 77071ae..46d47d2 100644 --- a/iblai/models/platform_public_metadata.py +++ b/iblai/models/platform_public_metadata.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,7 +17,6 @@ import re # noqa: F401 import json -from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set @@ -30,9 +29,7 @@ class PlatformPublicMetadata(BaseModel): platform_key: StrictStr platform_name: StrictStr metadata: Optional[Any] = Field(default=None, description="The public metadata") - created_on: datetime - last_updated: datetime - __properties: ClassVar[List[str]] = ["platform_key", "platform_name", "metadata", "created_on", "last_updated"] + __properties: ClassVar[List[str]] = ["platform_key", "platform_name", "metadata"] model_config = ConfigDict( populate_by_name=True, @@ -66,14 +63,10 @@ def to_dict(self) -> Dict[str, Any]: are ignored. * OpenAPI `readOnly` fields are excluded. * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. - * OpenAPI `readOnly` fields are excluded. """ excluded_fields: Set[str] = set([ "platform_key", "platform_name", - "created_on", - "last_updated", ]) _dict = self.model_dump( @@ -100,9 +93,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "platform_key": obj.get("platform_key"), "platform_name": obj.get("platform_name"), - "metadata": obj.get("metadata"), - "created_on": obj.get("created_on"), - "last_updated": obj.get("last_updated") + "metadata": obj.get("metadata") }) return _obj diff --git a/iblai/models/play_wright_script.py b/iblai/models/play_wright_script.py index fe80d62..fd25340 100644 --- a/iblai/models/play_wright_script.py +++ b/iblai/models/play_wright_script.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/points_percentile.py b/iblai/models/points_percentile.py index cb8b527..009622b 100644 --- a/iblai/models/points_percentile.py +++ b/iblai/models/points_percentile.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/predictive_analytics_request.py b/iblai/models/predictive_analytics_request.py index 19670c3..d29d2f6 100644 --- a/iblai/models/predictive_analytics_request.py +++ b/iblai/models/predictive_analytics_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/predictive_analytics_response.py b/iblai/models/predictive_analytics_response.py index 573e85f..edd0371 100644 --- a/iblai/models/predictive_analytics_response.py +++ b/iblai/models/predictive_analytics_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/previous_agent_status_enum.py b/iblai/models/previous_agent_status_enum.py index 4a242b3..dd11acb 100644 --- a/iblai/models/previous_agent_status_enum.py +++ b/iblai/models/previous_agent_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/product.py b/iblai/models/product.py index 30920b6..765c0ee 100644 --- a/iblai/models/product.py +++ b/iblai/models/product.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/product_table.py b/iblai/models/product_table.py index 1029f46..c7f6e69 100644 --- a/iblai/models/product_table.py +++ b/iblai/models/product_table.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/program.py b/iblai/models/program.py new file mode 100644 index 0000000..f0b87cc --- /dev/null +++ b/iblai/models/program.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from iblai.models.institution import Institution +from iblai.models.program_type_enum import ProgramTypeEnum +from typing import Optional, Set +from typing_extensions import Self + +class Program(BaseModel): + """ + Program + """ # noqa: E501 + id: StrictInt + institution: Institution + institution_id: StrictInt + name: Annotated[str, Field(strict=True, max_length=100)] + program_type: ProgramTypeEnum + duration: StrictInt = Field(description="Duration in months") + description: Optional[StrictStr] = None + data: Optional[Any] = Field(default=None, description="Metadata") + metadata: Optional[Any] = Field(default=None, description="Metadata") + created_at: Optional[datetime] = None + updated_at: datetime + __properties: ClassVar[List[str]] = ["id", "institution", "institution_id", "name", "program_type", "duration", "description", "data", "metadata", "created_at", "updated_at"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Program from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "institution", + "updated_at", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of institution + if self.institution: + _dict['institution'] = self.institution.to_dict() + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if data (nullable) is None + # and model_fields_set contains the field + if self.data is None and "data" in self.model_fields_set: + _dict['data'] = None + + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Program from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "institution": Institution.from_dict(obj["institution"]) if obj.get("institution") is not None else None, + "institution_id": obj.get("institution_id"), + "name": obj.get("name"), + "program_type": obj.get("program_type"), + "duration": obj.get("duration"), + "description": obj.get("description"), + "data": obj.get("data"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at") + }) + return _obj + + diff --git a/iblai/models/program_type_enum.py b/iblai/models/program_type_enum.py new file mode 100644 index 0000000..f694e8e --- /dev/null +++ b/iblai/models/program_type_enum.py @@ -0,0 +1,42 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ProgramTypeEnum(str, Enum): + """ + * `bachelors` - Bachelor's Degree * `masters` - Master's Degree * `phd` - PhD * `diploma` - Diploma * `certificate` - Certificate * `ungraded` - Ungraded * `other` - Other + """ + + """ + allowed enum values + """ + BACHELORS = 'bachelors' + MASTERS = 'masters' + PHD = 'phd' + DIPLOMA = 'diploma' + CERTIFICATE = 'certificate' + UNGRADED = 'ungraded' + OTHER = 'other' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ProgramTypeEnum from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/iblai/models/prompt.py b/iblai/models/prompt.py index 979325a..5db71b8 100644 --- a/iblai/models/prompt.py +++ b/iblai/models/prompt.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/prompt_category.py b/iblai/models/prompt_category.py index 0fcf8d4..2222dea 100644 --- a/iblai/models/prompt_category.py +++ b/iblai/models/prompt_category.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/prompt_visibility_enum.py b/iblai/models/prompt_visibility_enum.py index 4f463ed..bdb9c4e 100644 --- a/iblai/models/prompt_visibility_enum.py +++ b/iblai/models/prompt_visibility_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/provider63a_enum.py b/iblai/models/provider63a_enum.py index fe8face..81f46e3 100644 --- a/iblai/models/provider63a_enum.py +++ b/iblai/models/provider63a_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/provider_bd1_enum.py b/iblai/models/provider_bd1_enum.py index a0fcb58..dffe9fd 100644 --- a/iblai/models/provider_bd1_enum.py +++ b/iblai/models/provider_bd1_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/query_endpoint.py b/iblai/models/query_endpoint.py index fac08ac..a845fae 100644 --- a/iblai/models/query_endpoint.py +++ b/iblai/models/query_endpoint.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/rating_enum.py b/iblai/models/rating_enum.py index 8451b32..408a449 100644 --- a/iblai/models/rating_enum.py +++ b/iblai/models/rating_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/recommend_course_response.py b/iblai/models/recommend_course_response.py index b4da249..0df6375 100644 --- a/iblai/models/recommend_course_response.py +++ b/iblai/models/recommend_course_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/recommendation_search_api.py b/iblai/models/recommendation_search_api.py index 6f9109b..cfb4bd3 100644 --- a/iblai/models/recommendation_search_api.py +++ b/iblai/models/recommendation_search_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/redirect_token_request.py b/iblai/models/redirect_token_request.py new file mode 100644 index 0000000..862bc08 --- /dev/null +++ b/iblai/models/redirect_token_request.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class RedirectTokenRequest(BaseModel): + """ + RedirectTokenRequest + """ # noqa: E501 + url: StrictStr + __properties: ClassVar[List[str]] = ["url"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RedirectTokenRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RedirectTokenRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "url": obj.get("url") + }) + return _obj + + diff --git a/iblai/models/redirect_token_response.py b/iblai/models/redirect_token_response.py new file mode 100644 index 0000000..c740080 --- /dev/null +++ b/iblai/models/redirect_token_response.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class RedirectTokenResponse(BaseModel): + """ + RedirectTokenResponse + """ # noqa: E501 + platform_key: StrictStr + url: Annotated[str, Field(strict=True, max_length=200)] + token: StrictStr + __properties: ClassVar[List[str]] = ["platform_key", "url", "token"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of RedirectTokenResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "platform_key", + "token", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of RedirectTokenResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "platform_key": obj.get("platform_key"), + "url": obj.get("url"), + "token": obj.get("token") + }) + return _obj + + diff --git a/iblai/models/related_text.py b/iblai/models/related_text.py index 8d710e2..89bb79f 100644 --- a/iblai/models/related_text.py +++ b/iblai/models/related_text.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/report_create.py b/iblai/models/report_create.py index 637b241..68101c4 100644 --- a/iblai/models/report_create.py +++ b/iblai/models/report_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/report_data.py b/iblai/models/report_data.py index d252127..e5def35 100644 --- a/iblai/models/report_data.py +++ b/iblai/models/report_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/report_list.py b/iblai/models/report_list.py index 640e2ec..65af2ae 100644 --- a/iblai/models/report_list.py +++ b/iblai/models/report_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/report_request.py b/iblai/models/report_request.py index 96f0eaf..356383a 100644 --- a/iblai/models/report_request.py +++ b/iblai/models/report_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/report_status.py b/iblai/models/report_status.py index 16dd243..afa2157 100644 --- a/iblai/models/report_status.py +++ b/iblai/models/report_status.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/reported_skill.py b/iblai/models/reported_skill.py index 2372d92..435817f 100644 --- a/iblai/models/reported_skill.py +++ b/iblai/models/reported_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/request_data_variable.py b/iblai/models/request_data_variable.py index 4794783..222f1a1 100644 --- a/iblai/models/request_data_variable.py +++ b/iblai/models/request_data_variable.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/resource_point.py b/iblai/models/resource_point.py index e820c3f..73f1893 100644 --- a/iblai/models/resource_point.py +++ b/iblai/models/resource_point.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/resource_scrapped_data.py b/iblai/models/resource_scrapped_data.py new file mode 100644 index 0000000..571e875 --- /dev/null +++ b/iblai/models/resource_scrapped_data.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class ResourceScrappedData(BaseModel): + """ + ResourceScrappedData + """ # noqa: E501 + id: StrictInt + date_created: Optional[datetime] + last_modified: Optional[datetime] + resource: StrictInt + content: Optional[StrictStr] = None + content_type: Optional[Annotated[str, Field(strict=True, max_length=50)]] = None + extra_data: Optional[Any] = None + __properties: ClassVar[List[str]] = ["id", "date_created", "last_modified", "resource", "content", "content_type", "extra_data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ResourceScrappedData from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + "date_created", + "last_modified", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if date_created (nullable) is None + # and model_fields_set contains the field + if self.date_created is None and "date_created" in self.model_fields_set: + _dict['date_created'] = None + + # set to None if last_modified (nullable) is None + # and model_fields_set contains the field + if self.last_modified is None and "last_modified" in self.model_fields_set: + _dict['last_modified'] = None + + # set to None if content (nullable) is None + # and model_fields_set contains the field + if self.content is None and "content" in self.model_fields_set: + _dict['content'] = None + + # set to None if content_type (nullable) is None + # and model_fields_set contains the field + if self.content_type is None and "content_type" in self.model_fields_set: + _dict['content_type'] = None + + # set to None if extra_data (nullable) is None + # and model_fields_set contains the field + if self.extra_data is None and "extra_data" in self.model_fields_set: + _dict['extra_data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ResourceScrappedData from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "date_created": obj.get("date_created"), + "last_modified": obj.get("last_modified"), + "resource": obj.get("resource"), + "content": obj.get("content"), + "content_type": obj.get("content_type"), + "extra_data": obj.get("extra_data") + }) + return _obj + + diff --git a/iblai/models/response_data_variable.py b/iblai/models/response_data_variable.py index 3326a79..d282f36 100644 --- a/iblai/models/response_data_variable.py +++ b/iblai/models/response_data_variable.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retreiver_train_view_request.py b/iblai/models/retreiver_train_view_request.py index 7839726..60ec803 100644 --- a/iblai/models/retreiver_train_view_request.py +++ b/iblai/models/retreiver_train_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retreiver_train_view_response.py b/iblai/models/retreiver_train_view_response.py index 0bab201..f86edcf 100644 --- a/iblai/models/retreiver_train_view_response.py +++ b/iblai/models/retreiver_train_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retrieve_task.py b/iblai/models/retrieve_task.py index 666abc5..1d2552c 100644 --- a/iblai/models/retrieve_task.py +++ b/iblai/models/retrieve_task.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retriever_document_embedding.py b/iblai/models/retriever_document_embedding.py index 65db42e..363ec05 100644 --- a/iblai/models/retriever_document_embedding.py +++ b/iblai/models/retriever_document_embedding.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -19,6 +19,7 @@ from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from iblai.models.retriever_document_embedding_training_status import RetrieverDocumentEmbeddingTrainingStatus from typing import Optional, Set from typing_extensions import Self @@ -27,14 +28,16 @@ class RetrieverDocumentEmbedding(BaseModel): RetrieverDocumentEmbedding """ # noqa: E501 id: StrictInt + metadata: Optional[Any] = None document_name: Optional[StrictStr] = None document_type: Optional[StrictStr] = None + training_status: Optional[RetrieverDocumentEmbeddingTrainingStatus] = None pathway: StrictStr url: Optional[StrictStr] = None tokens: Optional[StrictInt] = None platform_key: StrictStr is_trained: Optional[StrictBool] = None - __properties: ClassVar[List[str]] = ["id", "document_name", "document_type", "pathway", "url", "tokens", "platform_key", "is_trained"] + __properties: ClassVar[List[str]] = ["id", "metadata", "document_name", "document_type", "training_status", "pathway", "url", "tokens", "platform_key", "is_trained"] model_config = ConfigDict( populate_by_name=True, @@ -77,6 +80,14 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of training_status + if self.training_status: + _dict['training_status'] = self.training_status.to_dict() + # set to None if metadata (nullable) is None + # and model_fields_set contains the field + if self.metadata is None and "metadata" in self.model_fields_set: + _dict['metadata'] = None + # set to None if document_name (nullable) is None # and model_fields_set contains the field if self.document_name is None and "document_name" in self.model_fields_set: @@ -87,6 +98,11 @@ def to_dict(self) -> Dict[str, Any]: if self.document_type is None and "document_type" in self.model_fields_set: _dict['document_type'] = None + # set to None if training_status (nullable) is None + # and model_fields_set contains the field + if self.training_status is None and "training_status" in self.model_fields_set: + _dict['training_status'] = None + # set to None if url (nullable) is None # and model_fields_set contains the field if self.url is None and "url" in self.model_fields_set: @@ -110,8 +126,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "id": obj.get("id"), + "metadata": obj.get("metadata"), "document_name": obj.get("document_name"), "document_type": obj.get("document_type"), + "training_status": RetrieverDocumentEmbeddingTrainingStatus.from_dict(obj["training_status"]) if obj.get("training_status") is not None else None, "pathway": obj.get("pathway"), "url": obj.get("url"), "tokens": obj.get("tokens"), diff --git a/iblai/models/retriever_document_embedding_request.py b/iblai/models/retriever_document_embedding_request.py index 14519f9..4a89d07 100644 --- a/iblai/models/retriever_document_embedding_request.py +++ b/iblai/models/retriever_document_embedding_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retriever_document_embedding_training_status.py b/iblai/models/retriever_document_embedding_training_status.py new file mode 100644 index 0000000..c8b0937 --- /dev/null +++ b/iblai/models/retriever_document_embedding_training_status.py @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from iblai.models.blank_enum import BlankEnum +from iblai.models.training_status_enum import TrainingStatusEnum +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +RETRIEVERDOCUMENTEMBEDDINGTRAININGSTATUS_ONE_OF_SCHEMAS = ["BlankEnum", "TrainingStatusEnum"] + +class RetrieverDocumentEmbeddingTrainingStatus(BaseModel): + """ + RetrieverDocumentEmbeddingTrainingStatus + """ + # data type: TrainingStatusEnum + oneof_schema_1_validator: Optional[TrainingStatusEnum] = None + # data type: BlankEnum + oneof_schema_2_validator: Optional[BlankEnum] = None + actual_instance: Optional[Union[BlankEnum, TrainingStatusEnum]] = None + one_of_schemas: Set[str] = { "BlankEnum", "TrainingStatusEnum" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + if v is None: + return v + + instance = RetrieverDocumentEmbeddingTrainingStatus.model_construct() + error_messages = [] + match = 0 + # validate data type: TrainingStatusEnum + if not isinstance(v, TrainingStatusEnum): + error_messages.append(f"Error! Input type `{type(v)}` is not `TrainingStatusEnum`") + else: + match += 1 + # validate data type: BlankEnum + if not isinstance(v, BlankEnum): + error_messages.append(f"Error! Input type `{type(v)}` is not `BlankEnum`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in RetrieverDocumentEmbeddingTrainingStatus with oneOf schemas: BlankEnum, TrainingStatusEnum. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in RetrieverDocumentEmbeddingTrainingStatus with oneOf schemas: BlankEnum, TrainingStatusEnum. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: Optional[str]) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + if json_str is None: + return instance + + error_messages = [] + match = 0 + + # deserialize data into TrainingStatusEnum + try: + instance.actual_instance = TrainingStatusEnum.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into BlankEnum + try: + instance.actual_instance = BlankEnum.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into RetrieverDocumentEmbeddingTrainingStatus with oneOf schemas: BlankEnum, TrainingStatusEnum. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into RetrieverDocumentEmbeddingTrainingStatus with oneOf schemas: BlankEnum, TrainingStatusEnum. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], BlankEnum, TrainingStatusEnum]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/iblai/models/retriever_request_search.py b/iblai/models/retriever_request_search.py index 16fda37..6cdacb0 100644 --- a/iblai/models/retriever_request_search.py +++ b/iblai/models/retriever_request_search.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retriever_request_search_document.py b/iblai/models/retriever_request_search_document.py index 9384626..f118e19 100644 --- a/iblai/models/retriever_request_search_document.py +++ b/iblai/models/retriever_request_search_document.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/retriever_response_search.py b/iblai/models/retriever_response_search.py index 12cb6b1..f703b15 100644 --- a/iblai/models/retriever_response_search.py +++ b/iblai/models/retriever_response_search.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/reuest_data_variable_list.py b/iblai/models/reuest_data_variable_list.py index 205d92d..748e48a 100644 --- a/iblai/models/reuest_data_variable_list.py +++ b/iblai/models/reuest_data_variable_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/revenue_by_product.py b/iblai/models/revenue_by_product.py index cfbf7fe..ebfa6a3 100644 --- a/iblai/models/revenue_by_product.py +++ b/iblai/models/revenue_by_product.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/scan_webhook_request.py b/iblai/models/scan_webhook_request.py new file mode 100644 index 0000000..3d8dd27 --- /dev/null +++ b/iblai/models/scan_webhook_request.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ScanWebhookRequest(BaseModel): + """ + ScanWebhookRequest + """ # noqa: E501 + file_id: StrictStr + filename: StrictStr + status: StrictStr + message: StrictStr + __properties: ClassVar[List[str]] = ["file_id", "filename", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanWebhookRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanWebhookRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "file_id": obj.get("file_id"), + "filename": obj.get("filename"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/iblai/models/scan_webhook_response.py b/iblai/models/scan_webhook_response.py new file mode 100644 index 0000000..918fe14 --- /dev/null +++ b/iblai/models/scan_webhook_response.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ScanWebhookResponse(BaseModel): + """ + ScanWebhookResponse + """ # noqa: E501 + message: StrictStr + __properties: ClassVar[List[str]] = ["message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ScanWebhookResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ScanWebhookResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message") + }) + return _obj + + diff --git a/iblai/models/score.py b/iblai/models/score.py index 5646ba6..8a670c3 100644 --- a/iblai/models/score.py +++ b/iblai/models/score.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/score_summary.py b/iblai/models/score_summary.py index e840dfd..323a01e 100644 --- a/iblai/models/score_summary.py +++ b/iblai/models/score_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/seed_mentors_view.py b/iblai/models/seed_mentors_view.py new file mode 100644 index 0000000..63fec09 --- /dev/null +++ b/iblai/models/seed_mentors_view.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SeedMentorsView(BaseModel): + """ + SeedMentorsView + """ # noqa: E501 + detail: StrictStr + __properties: ClassVar[List[str]] = ["detail"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SeedMentorsView from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SeedMentorsView from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "detail": obj.get("detail") + }) + return _obj + + diff --git a/iblai/models/session_browser_screenshot.py b/iblai/models/session_browser_screenshot.py index f0513e6..7632906 100644 --- a/iblai/models/session_browser_screenshot.py +++ b/iblai/models/session_browser_screenshot.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/session_detail.py b/iblai/models/session_detail.py index 6a8dfc8..32cbb81 100644 --- a/iblai/models/session_detail.py +++ b/iblai/models/session_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/shell_logs.py b/iblai/models/shell_logs.py index e6cfd66..f68ddf7 100644 --- a/iblai/models/shell_logs.py +++ b/iblai/models/shell_logs.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/skill.py b/iblai/models/skill.py index b03e05d..257ae9f 100644 --- a/iblai/models/skill.py +++ b/iblai/models/skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/skill_detail.py b/iblai/models/skill_detail.py index aa1bb23..0ce088f 100644 --- a/iblai/models/skill_detail.py +++ b/iblai/models/skill_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/skill_info.py b/iblai/models/skill_info.py index 01eb858..9ee7d94 100644 --- a/iblai/models/skill_info.py +++ b/iblai/models/skill_info.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/skill_threshold.py b/iblai/models/skill_threshold.py index 33d5ced..258c0eb 100644 --- a/iblai/models/skill_threshold.py +++ b/iblai/models/skill_threshold.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/slack_config.py b/iblai/models/slack_config.py index 8df2634..d6abbbc 100644 --- a/iblai/models/slack_config.py +++ b/iblai/models/slack_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/slack_webhook.py b/iblai/models/slack_webhook.py index 62902dc..9a88804 100644 --- a/iblai/models/slack_webhook.py +++ b/iblai/models/slack_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/state_enum.py b/iblai/models/state_enum.py index 387018f..67456e4 100644 --- a/iblai/models/state_enum.py +++ b/iblai/models/state_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/step.py b/iblai/models/step.py index b0dc1d3..db9b188 100644 --- a/iblai/models/step.py +++ b/iblai/models/step.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/step_status_enum.py b/iblai/models/step_status_enum.py index 7ff327f..b9408bf 100644 --- a/iblai/models/step_status_enum.py +++ b/iblai/models/step_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/styles_view.py b/iblai/models/styles_view.py index 65103d1..ef548f7 100644 --- a/iblai/models/styles_view.py +++ b/iblai/models/styles_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/sub_time_child.py b/iblai/models/sub_time_child.py index 3e434b9..f86bd82 100644 --- a/iblai/models/sub_time_child.py +++ b/iblai/models/sub_time_child.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/summary.py b/iblai/models/summary.py index 0301746..f76397e 100644 --- a/iblai/models/summary.py +++ b/iblai/models/summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/tags_view.py b/iblai/models/tags_view.py index 7b7cd92..2d88f71 100644 --- a/iblai/models/tags_view.py +++ b/iblai/models/tags_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/target_system_enum.py b/iblai/models/target_system_enum.py new file mode 100644 index 0000000..32c4249 --- /dev/null +++ b/iblai/models/target_system_enum.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class TargetSystemEnum(str, Enum): + """ + * `Safety System` - Safety System * `Moderation System` - Moderation System + """ + + """ + allowed enum values + """ + SAFETY_SYSTEM = 'Safety System' + MODERATION_SYSTEM = 'Moderation System' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of TargetSystemEnum from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/iblai/models/task_view.py b/iblai/models/task_view.py index c792368..900f1db 100644 --- a/iblai/models/task_view.py +++ b/iblai/models/task_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/template_mentor.py b/iblai/models/template_mentor.py new file mode 100644 index 0000000..54e7cf4 --- /dev/null +++ b/iblai/models/template_mentor.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class TemplateMentor(BaseModel): + """ + TemplateMentor + """ # noqa: E501 + id: StrictInt + name: Annotated[str, Field(strict=True, max_length=255)] + slug: Annotated[str, Field(strict=True, max_length=255)] + unique_id: Optional[StrictStr] = None + description: Optional[StrictStr] = None + system_prompt: Optional[StrictStr] = None + platform_key: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "name", "slug", "unique_id", "description", "system_prompt", "platform_key"] + + @field_validator('slug') + def slug_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[-a-zA-Z0-9_]+$", value): + raise ValueError(r"must validate the regular expression /^[-a-zA-Z0-9_]+$/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TemplateMentor from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + """ + excluded_fields: Set[str] = set([ + "id", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if description (nullable) is None + # and model_fields_set contains the field + if self.description is None and "description" in self.model_fields_set: + _dict['description'] = None + + # set to None if system_prompt (nullable) is None + # and model_fields_set contains the field + if self.system_prompt is None and "system_prompt" in self.model_fields_set: + _dict['system_prompt'] = None + + # set to None if platform_key (nullable) is None + # and model_fields_set contains the field + if self.platform_key is None and "platform_key" in self.model_fields_set: + _dict['platform_key'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TemplateMentor from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "slug": obj.get("slug"), + "unique_id": obj.get("unique_id"), + "description": obj.get("description"), + "system_prompt": obj.get("system_prompt"), + "platform_key": obj.get("platform_key") + }) + return _obj + + diff --git a/iblai/models/tenant_mentor_traces.py b/iblai/models/tenant_mentor_traces.py index c2e8ab5..06a458d 100644 --- a/iblai/models/tenant_mentor_traces.py +++ b/iblai/models/tenant_mentor_traces.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/theme_enum.py b/iblai/models/theme_enum.py index b7efec1..d22f8d5 100644 --- a/iblai/models/theme_enum.py +++ b/iblai/models/theme_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_child_data.py b/iblai/models/time_child_data.py index 1a7dd85..9f2cccd 100644 --- a/iblai/models/time_child_data.py +++ b/iblai/models/time_child_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_detail.py b/iblai/models/time_detail.py index c4b53c6..2df5394 100644 --- a/iblai/models/time_detail.py +++ b/iblai/models/time_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_detail_child.py b/iblai/models/time_detail_child.py index 1b4ee75..4167a3d 100644 --- a/iblai/models/time_detail_child.py +++ b/iblai/models/time_detail_child.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_detail_data.py b/iblai/models/time_detail_data.py index 29363b3..487594b 100644 --- a/iblai/models/time_detail_data.py +++ b/iblai/models/time_detail_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_by_users_in_course.py b/iblai/models/time_spent_by_users_in_course.py index b75572e..c8ab11b 100644 --- a/iblai/models/time_spent_by_users_in_course.py +++ b/iblai/models/time_spent_by_users_in_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_by_users_in_course_data.py b/iblai/models/time_spent_by_users_in_course_data.py index d46033c..b642281 100644 --- a/iblai/models/time_spent_by_users_in_course_data.py +++ b/iblai/models/time_spent_by_users_in_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_per_course.py b/iblai/models/time_spent_per_course.py index 92d2c95..389689f 100644 --- a/iblai/models/time_spent_per_course.py +++ b/iblai/models/time_spent_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_per_course_data.py b/iblai/models/time_spent_per_course_data.py index 79c1aba..c1f1f55 100644 --- a/iblai/models/time_spent_per_course_data.py +++ b/iblai/models/time_spent_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_update_request.py b/iblai/models/time_spent_update_request.py index 0aac14f..cb0a7c8 100644 --- a/iblai/models/time_spent_update_request.py +++ b/iblai/models/time_spent_update_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/time_spent_update_response.py b/iblai/models/time_spent_update_response.py index 4251e45..de16bb4 100644 --- a/iblai/models/time_spent_update_response.py +++ b/iblai/models/time_spent_update_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/tones_view.py b/iblai/models/tones_view.py index 6057a92..aa0149f 100644 --- a/iblai/models/tones_view.py +++ b/iblai/models/tones_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/tool_response.py b/iblai/models/tool_response.py index 5c64e99..714ec39 100644 --- a/iblai/models/tool_response.py +++ b/iblai/models/tool_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from typing import Optional, Set @@ -29,10 +29,12 @@ class ToolResponse(BaseModel): """ # noqa: E501 id: StrictInt name: Annotated[str, Field(strict=True, max_length=500)] + display_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None slug: Optional[Annotated[str, Field(strict=True, max_length=50)]] = None description: Optional[StrictStr] = None metadata: Optional[Any] = None - __properties: ClassVar[List[str]] = ["id", "name", "slug", "description", "metadata"] + allow_retriever_mentors: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = ["id", "name", "display_name", "slug", "description", "metadata", "allow_retriever_mentors"] @field_validator('slug') def slug_validate_regular_expression(cls, value): @@ -109,9 +111,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "id": obj.get("id"), "name": obj.get("name"), + "display_name": obj.get("display_name"), "slug": obj.get("slug"), "description": obj.get("description"), - "metadata": obj.get("metadata") + "metadata": obj.get("metadata"), + "allow_retriever_mentors": obj.get("allow_retriever_mentors") }) return _obj diff --git a/iblai/models/topic.py b/iblai/models/topic.py index 71e4e09..6fe8f65 100644 --- a/iblai/models/topic.py +++ b/iblai/models/topic.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/topic_conversation.py b/iblai/models/topic_conversation.py index 583751d..8a0d7cb 100644 --- a/iblai/models/topic_conversation.py +++ b/iblai/models/topic_conversation.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/topic_detail.py b/iblai/models/topic_detail.py index c4998df..9fb44bc 100644 --- a/iblai/models/topic_detail.py +++ b/iblai/models/topic_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/topic_model.py b/iblai/models/topic_model.py index 83e919c..3b17ab5 100644 --- a/iblai/models/topic_model.py +++ b/iblai/models/topic_model.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/topic_summary_view.py b/iblai/models/topic_summary_view.py index b8f32aa..60216a5 100644 --- a/iblai/models/topic_summary_view.py +++ b/iblai/models/topic_summary_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/trace.py b/iblai/models/trace.py index 32a3778..0ad65df 100644 --- a/iblai/models/trace.py +++ b/iblai/models/trace.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/train_chat_session_document_view.py b/iblai/models/train_chat_session_document_view.py index 442e8ed..16a0217 100644 --- a/iblai/models/train_chat_session_document_view.py +++ b/iblai/models/train_chat_session_document_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/train_chat_session_document_view_request.py b/iblai/models/train_chat_session_document_view_request.py index 35003fe..244bf35 100644 --- a/iblai/models/train_chat_session_document_view_request.py +++ b/iblai/models/train_chat_session_document_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/train_document_view_request.py b/iblai/models/train_document_view_request.py index e5c865a..dcf7a1b 100644 --- a/iblai/models/train_document_view_request.py +++ b/iblai/models/train_document_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -32,7 +32,10 @@ class TrainDocumentViewRequest(BaseModel): type: StrictStr = Field(description="Type of document e.g file") file: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="File to be trained") access: Optional[StrictStr] = Field(default='private', description="Accessibilityto the file") - __properties: ClassVar[List[str]] = ["pathway", "url", "text", "type", "file", "access"] + branch: Optional[StrictStr] = Field(default=None, description="Branch of the repository") + google_drive_auth_data: Optional[Any] = Field(default=None, description="Authentication and scoped details of google drive") + dropbox_auth_data: Optional[Any] = Field(default=None, description="Authentication and scoped details of dropbox") + __properties: ClassVar[List[str]] = ["pathway", "url", "text", "type", "file", "access", "branch", "google_drive_auth_data", "dropbox_auth_data"] model_config = ConfigDict( populate_by_name=True, @@ -73,6 +76,16 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # set to None if google_drive_auth_data (nullable) is None + # and model_fields_set contains the field + if self.google_drive_auth_data is None and "google_drive_auth_data" in self.model_fields_set: + _dict['google_drive_auth_data'] = None + + # set to None if dropbox_auth_data (nullable) is None + # and model_fields_set contains the field + if self.dropbox_auth_data is None and "dropbox_auth_data" in self.model_fields_set: + _dict['dropbox_auth_data'] = None + return _dict @classmethod @@ -90,7 +103,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "text": obj.get("text"), "type": obj.get("type"), "file": obj.get("file"), - "access": obj.get("access") if obj.get("access") is not None else 'private' + "access": obj.get("access") if obj.get("access") is not None else 'private', + "branch": obj.get("branch"), + "google_drive_auth_data": obj.get("google_drive_auth_data"), + "dropbox_auth_data": obj.get("dropbox_auth_data") }) return _obj diff --git a/iblai/models/train_document_view_response.py b/iblai/models/train_document_view_response.py index 9005dcf..a027f5c 100644 --- a/iblai/models/train_document_view_response.py +++ b/iblai/models/train_document_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/training.py b/iblai/models/training.py index 875b544..9e18eee 100644 --- a/iblai/models/training.py +++ b/iblai/models/training.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/training_create.py b/iblai/models/training_create.py index 6f8373c..19f6851 100644 --- a/iblai/models/training_create.py +++ b/iblai/models/training_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/training_status_enum.py b/iblai/models/training_status_enum.py index 16ce6db..9c048ec 100644 --- a/iblai/models/training_status_enum.py +++ b/iblai/models/training_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -20,17 +20,16 @@ class TrainingStatusEnum(str, Enum): """ - * `pending` - Pending * `processing` - Processing * `completed` - Completed * `cancelled` - Cancelled * `failed` - Failed + * `trained` - Trained * `failed` - Failed * `pending` - Pending * `untrained` - Untrained """ """ allowed enum values """ - PENDING = 'pending' - PROCESSING = 'processing' - COMPLETED = 'completed' - CANCELLED = 'cancelled' + TRAINED = 'trained' FAILED = 'failed' + PENDING = 'pending' + UNTRAINED = 'untrained' @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/iblai/models/usage.py b/iblai/models/usage.py index 00146fe..dd096cf 100644 --- a/iblai/models/usage.py +++ b/iblai/models/usage.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/use_main_creds.py b/iblai/models/use_main_creds.py index 33f1432..9a02846 100644 --- a/iblai/models/use_main_creds.py +++ b/iblai/models/use_main_creds.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_all_chat_memory_view.py b/iblai/models/user_all_chat_memory_view.py index 3ae9c08..551f0f8 100644 --- a/iblai/models/user_all_chat_memory_view.py +++ b/iblai/models/user_all_chat_memory_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_catalog_item_memory_view.py b/iblai/models/user_catalog_item_memory_view.py index 56fb658..3040d8a 100644 --- a/iblai/models/user_catalog_item_memory_view.py +++ b/iblai/models/user_catalog_item_memory_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_chat_feedback.py b/iblai/models/user_chat_feedback.py index af361ba..ba3d5d7 100644 --- a/iblai/models/user_chat_feedback.py +++ b/iblai/models/user_chat_feedback.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_chat_feedback_count.py b/iblai/models/user_chat_feedback_count.py index 22b8fb7..4e4f98c 100644 --- a/iblai/models/user_chat_feedback_count.py +++ b/iblai/models/user_chat_feedback_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_chat_memory_status_request_view.py b/iblai/models/user_chat_memory_status_request_view.py index 8836a02..c3af57c 100644 --- a/iblai/models/user_chat_memory_status_request_view.py +++ b/iblai/models/user_chat_memory_status_request_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_chat_memory_status_view.py b/iblai/models/user_chat_memory_status_view.py index 02e004d..485501f 100644 --- a/iblai/models/user_chat_memory_status_view.py +++ b/iblai/models/user_chat_memory_status_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_chat_memory_update_view.py b/iblai/models/user_chat_memory_update_view.py index 4e958a5..e699b99 100644 --- a/iblai/models/user_chat_memory_update_view.py +++ b/iblai/models/user_chat_memory_update_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_edx_memory.py b/iblai/models/user_edx_memory.py index 6f17685..c58f57a 100644 --- a/iblai/models/user_edx_memory.py +++ b/iblai/models/user_edx_memory.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_info.py b/iblai/models/user_info.py new file mode 100644 index 0000000..b4e7813 --- /dev/null +++ b/iblai/models/user_info.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class UserInfo(BaseModel): + """ + UserInfo + """ # noqa: E501 + id: StrictInt = Field(description="edX user ID") + username: Optional[Annotated[str, Field(strict=True, max_length=100)]] = Field(default=None, description="edX username") + name: StrictStr + email: StrictStr + active: StrictBool + edx_data: Optional[Any] + __properties: ClassVar[List[str]] = ["id", "username", "name", "email", "active", "edx_data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if username (nullable) is None + # and model_fields_set contains the field + if self.username is None and "username" in self.model_fields_set: + _dict['username'] = None + + # set to None if edx_data (nullable) is None + # and model_fields_set contains the field + if self.edx_data is None and "edx_data" in self.model_fields_set: + _dict['edx_data'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "username": obj.get("username"), + "name": obj.get("name"), + "email": obj.get("email"), + "active": obj.get("active"), + "edx_data": obj.get("edx_data") + }) + return _obj + + diff --git a/iblai/models/user_memory_context_request.py b/iblai/models/user_memory_context_request.py index ffa75d0..4d03f86 100644 --- a/iblai/models/user_memory_context_request.py +++ b/iblai/models/user_memory_context_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_memory_context_response.py b/iblai/models/user_memory_context_response.py index 5b8c931..adb2c25 100644 --- a/iblai/models/user_memory_context_response.py +++ b/iblai/models/user_memory_context_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_sentiment_count_view.py b/iblai/models/user_sentiment_count_view.py index ecec846..ae137dd 100644 --- a/iblai/models/user_sentiment_count_view.py +++ b/iblai/models/user_sentiment_count_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_skill.py b/iblai/models/user_skill.py index b89416e..19e8f68 100644 --- a/iblai/models/user_skill.py +++ b/iblai/models/user_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/user_skill_points_percentile.py b/iblai/models/user_skill_points_percentile.py index b280f6b..c64ff7c 100644 --- a/iblai/models/user_skill_points_percentile.py +++ b/iblai/models/user_skill_points_percentile.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/value.py b/iblai/models/value.py index 202902c..7258081 100644 --- a/iblai/models/value.py +++ b/iblai/models/value.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/value_data.py b/iblai/models/value_data.py index 4315386..11e9143 100644 --- a/iblai/models/value_data.py +++ b/iblai/models/value_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/video_block.py b/iblai/models/video_block.py index bce563f..d5eb0c1 100644 --- a/iblai/models/video_block.py +++ b/iblai/models/video_block.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/video_engagement_per_course.py b/iblai/models/video_engagement_per_course.py index a9974dc..cd179b8 100644 --- a/iblai/models/video_engagement_per_course.py +++ b/iblai/models/video_engagement_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/video_engagement_per_course_data.py b/iblai/models/video_engagement_per_course_data.py index fd93781..b4f8d0f 100644 --- a/iblai/models/video_engagement_per_course_data.py +++ b/iblai/models/video_engagement_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_count.py b/iblai/models/videos_count.py index deaf0ef..4deaad8 100644 --- a/iblai/models/videos_count.py +++ b/iblai/models/videos_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_count_data.py b/iblai/models/videos_count_data.py index cf184b3..26209fd 100644 --- a/iblai/models/videos_count_data.py +++ b/iblai/models/videos_count_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_in_course_summary.py b/iblai/models/videos_in_course_summary.py index 86c3a88..115f0b9 100644 --- a/iblai/models/videos_in_course_summary.py +++ b/iblai/models/videos_in_course_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_in_course_summary_data.py b/iblai/models/videos_in_course_summary_data.py index 0a73517..39ed5e9 100644 --- a/iblai/models/videos_in_course_summary_data.py +++ b/iblai/models/videos_in_course_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_specific_course.py b/iblai/models/videos_specific_course.py index c8c35b4..e3d4f9b 100644 --- a/iblai/models/videos_specific_course.py +++ b/iblai/models/videos_specific_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_specific_course_data.py b/iblai/models/videos_specific_course_data.py index 35b666e..6ca6e32 100644 --- a/iblai/models/videos_specific_course_data.py +++ b/iblai/models/videos_specific_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/videos_watched_sub_section.py b/iblai/models/videos_watched_sub_section.py index 8a26557..ff53783 100644 --- a/iblai/models/videos_watched_sub_section.py +++ b/iblai/models/videos_watched_sub_section.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/watched_videos_per_user.py b/iblai/models/watched_videos_per_user.py index a3bc21b..ea21267 100644 --- a/iblai/models/watched_videos_per_user.py +++ b/iblai/models/watched_videos_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/watched_videos_per_user_data.py b/iblai/models/watched_videos_per_user_data.py index 84d50c4..4757fa7 100644 --- a/iblai/models/watched_videos_per_user_data.py +++ b/iblai/models/watched_videos_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/webex_webhook.py b/iblai/models/webex_webhook.py index f3054a4..364ad55 100644 --- a/iblai/models/webex_webhook.py +++ b/iblai/models/webex_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/what_app_web_hook.py b/iblai/models/what_app_web_hook.py index 472fa10..82508e8 100644 --- a/iblai/models/what_app_web_hook.py +++ b/iblai/models/what_app_web_hook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/models/whatsapp_config.py b/iblai/models/whatsapp_config.py index 3459246..1383ef1 100644 --- a/iblai/models/whatsapp_config.py +++ b/iblai/models/whatsapp_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/iblai/rest.py b/iblai/rest.py index b36ee97..50e406d 100644 --- a/iblai/rest.py +++ b/iblai/rest.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/pyproject.toml b/pyproject.toml index 824f36f..7db2a7e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "iblai" -version = "2.4.1+ai.plus" +version = "3.6.0+ai.plus" description = "ibl-data-manager" authors = ["OpenAPI Generator Community "] license = "NoLicense" diff --git a/setup.py b/setup.py index 4031b05..62347b9 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -21,7 +21,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "iblai" -VERSION = "2.4.1+ai.plus" +VERSION = "3.6.0+ai.plus" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/test/test_acceptance_enum.py b/test/test_acceptance_enum.py index 08627ba..84ab7cb 100644 --- a/test/test_acceptance_enum.py +++ b/test/test_acceptance_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_active_users_data.py b/test/test_active_users_data.py index 2e76933..d9a821a 100644 --- a/test/test_active_users_data.py +++ b/test/test_active_users_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_active_users_list.py b/test/test_active_users_list.py index 1a9b5be..83b2cb4 100644 --- a/test/test_active_users_list.py +++ b/test/test_active_users_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_active_users_per_course.py b/test/test_active_users_per_course.py index 752edbe..bf42967 100644 --- a/test/test_active_users_per_course.py +++ b/test/test_active_users_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_active_users_per_course_data.py b/test/test_active_users_per_course_data.py index d726139..65fd6d5 100644 --- a/test/test_active_users_per_course_data.py +++ b/test/test_active_users_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_activity_api.py b/test/test_activity_api.py index 1af1125..dc52523 100644 --- a/test/test_activity_api.py +++ b/test/test_activity_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_activity_data.py b/test/test_activity_data.py index 34c85fd..db79e92 100644 --- a/test/test_activity_data.py +++ b/test/test_activity_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_ai_account_api.py b/test/test_ai_account_api.py index 0728182..e683cc3 100644 --- a/test/test_ai_account_api.py +++ b/test/test_ai_account_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_ai_analytics_api.py b/test/test_ai_analytics_api.py index 33fe4f4..05a1f82 100644 --- a/test/test_ai_analytics_api.py +++ b/test/test_ai_analytics_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -26,6 +26,24 @@ def setUp(self) -> None: def tearDown(self) -> None: pass + def test_ai_analytics_orgs_users_chat_history_filter_retrieve(self) -> None: + """Test case for ai_analytics_orgs_users_chat_history_filter_retrieve + + """ + pass + + def test_ai_analytics_orgs_users_chat_history_list(self) -> None: + """Test case for ai_analytics_orgs_users_chat_history_list + + """ + pass + + def test_ai_analytics_orgs_users_chat_history_retrieve(self) -> None: + """Test case for ai_analytics_orgs_users_chat_history_retrieve + + """ + pass + def test_ai_analytics_orgs_users_conversation_retrieve(self) -> None: """Test case for ai_analytics_orgs_users_conversation_retrieve diff --git a/test/test_ai_bot_api.py b/test/test_ai_bot_api.py index d6e2ad3..2d28fa6 100644 --- a/test/test_ai_bot_api.py +++ b/test/test_ai_bot_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_ai_finetuning_api.py b/test/test_ai_finetuning_api.py index f72dd7c..e555617 100644 --- a/test/test_ai_finetuning_api.py +++ b/test/test_ai_finetuning_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_ai_generated_image.py b/test/test_ai_generated_image.py new file mode 100644 index 0000000..5e8904a --- /dev/null +++ b/test/test_ai_generated_image.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.ai_generated_image import AIGeneratedImage + +class TestAIGeneratedImage(unittest.TestCase): + """AIGeneratedImage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AIGeneratedImage: + """Test AIGeneratedImage + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AIGeneratedImage` + """ + model = AIGeneratedImage() + if include_optional: + return AIGeneratedImage( + id = 56, + user = 56, + image = '', + platform = 56, + prompt = '', + model = '', + provider = '', + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return AIGeneratedImage( + id = 56, + user = 56, + image = '', + platform = 56, + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testAIGeneratedImage(self): + """Test AIGeneratedImage""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ai_index_api.py b/test/test_ai_index_api.py index 698d9b0..3e9ddf4 100644 --- a/test/test_ai_index_api.py +++ b/test/test_ai_index_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -32,6 +32,12 @@ def test_ai_index_orgs_users_documents_destroy(self) -> None: """ pass + def test_ai_index_orgs_users_documents_graph_train_create(self) -> None: + """Test case for ai_index_orgs_users_documents_graph_train_create + + """ + pass + def test_ai_index_orgs_users_documents_pathways_retrieve(self) -> None: """Test case for ai_index_orgs_users_documents_pathways_retrieve @@ -86,6 +92,24 @@ def test_ai_index_orgs_users_documents_update(self) -> None: """ pass + def test_ai_index_orgs_users_resource_data_scrapped_retrieve(self) -> None: + """Test case for ai_index_orgs_users_resource_data_scrapped_retrieve + + """ + pass + + def test_ai_index_orgs_users_resource_data_scrapped_retrieve2(self) -> None: + """Test case for ai_index_orgs_users_resource_data_scrapped_retrieve2 + + """ + pass + + def test_ai_index_webhook_scan_create(self) -> None: + """Test case for ai_index_webhook_scan_create + + """ + pass + if __name__ == '__main__': unittest.main() diff --git a/test/test_ai_mentor_api.py b/test/test_ai_mentor_api.py index 93fc13a..2cac2ce 100644 --- a/test/test_ai_mentor_api.py +++ b/test/test_ai_mentor_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -38,12 +38,36 @@ def test_ai_mentor_orgs_sessions_create(self) -> None: """ pass + def test_ai_mentor_orgs_users_ai_generated_images_destroy(self) -> None: + """Test case for ai_mentor_orgs_users_ai_generated_images_destroy + + """ + pass + + def test_ai_mentor_orgs_users_ai_generated_images_list(self) -> None: + """Test case for ai_mentor_orgs_users_ai_generated_images_list + + """ + pass + + def test_ai_mentor_orgs_users_ai_generated_images_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_ai_generated_images_retrieve + + """ + pass + def test_ai_mentor_orgs_users_audio_to_text_create(self) -> None: """Test case for ai_mentor_orgs_users_audio_to_text_create """ pass + def test_ai_mentor_orgs_users_available_template_mentors_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_available_template_mentors_retrieve + + """ + pass + def test_ai_mentor_orgs_users_clear_chathistory_destroy(self) -> None: """Test case for ai_mentor_orgs_users_clear_chathistory_destroy @@ -176,6 +200,12 @@ def test_ai_mentor_orgs_users_mentor_llms_retrieve(self) -> None: """ pass + def test_ai_mentor_orgs_users_mentor_seed_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_mentor_seed_retrieve + + """ + pass + def test_ai_mentor_orgs_users_mentor_tools_retrieve(self) -> None: """Test case for ai_mentor_orgs_users_mentor_tools_retrieve @@ -188,6 +218,24 @@ def test_ai_mentor_orgs_users_mentor_with_settings_create(self) -> None: """ pass + def test_ai_mentor_orgs_users_mentors_available_tools_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_mentors_available_tools_retrieve + + """ + pass + + def test_ai_mentor_orgs_users_mentors_memory_component_settings_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_mentors_memory_component_settings_retrieve + + """ + pass + + def test_ai_mentor_orgs_users_mentors_memory_component_settings_update(self) -> None: + """Test case for ai_mentor_orgs_users_mentors_memory_component_settings_update + + """ + pass + def test_ai_mentor_orgs_users_mentors_public_settings_retrieve(self) -> None: """Test case for ai_mentor_orgs_users_mentors_public_settings_retrieve @@ -200,6 +248,18 @@ def test_ai_mentor_orgs_users_mentors_retrieve(self) -> None: """ pass + def test_ai_mentor_orgs_users_mentors_scenarios_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_mentors_scenarios_retrieve + + """ + pass + + def test_ai_mentor_orgs_users_mentors_scenarios_update(self) -> None: + """Test case for ai_mentor_orgs_users_mentors_scenarios_update + + """ + pass + def test_ai_mentor_orgs_users_mentors_settings_retrieve(self) -> None: """Test case for ai_mentor_orgs_users_mentors_settings_retrieve @@ -218,6 +278,24 @@ def test_ai_mentor_orgs_users_metadata_retrieve(self) -> None: """ pass + def test_ai_mentor_orgs_users_moderation_logs_destroy(self) -> None: + """Test case for ai_mentor_orgs_users_moderation_logs_destroy + + """ + pass + + def test_ai_mentor_orgs_users_moderation_logs_list(self) -> None: + """Test case for ai_mentor_orgs_users_moderation_logs_list + + """ + pass + + def test_ai_mentor_orgs_users_moderation_logs_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_moderation_logs_retrieve + + """ + pass + def test_ai_mentor_orgs_users_partial_update(self) -> None: """Test case for ai_mentor_orgs_users_partial_update @@ -368,6 +446,24 @@ def test_ai_mentor_orgs_users_retrieve(self) -> None: """ pass + def test_ai_mentor_orgs_users_safety_logs_destroy(self) -> None: + """Test case for ai_mentor_orgs_users_safety_logs_destroy + + """ + pass + + def test_ai_mentor_orgs_users_safety_logs_list(self) -> None: + """Test case for ai_mentor_orgs_users_safety_logs_list + + """ + pass + + def test_ai_mentor_orgs_users_safety_logs_retrieve(self) -> None: + """Test case for ai_mentor_orgs_users_safety_logs_retrieve + + """ + pass + def test_ai_mentor_orgs_users_session_detail_mentors_retrieve(self) -> None: """Test case for ai_mentor_orgs_users_session_detail_mentors_retrieve diff --git a/test/test_ai_prompt_api.py b/test/test_ai_prompt_api.py index d1a151b..3b619e5 100644 --- a/test/test_ai_prompt_api.py +++ b/test/test_ai_prompt_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -116,6 +116,48 @@ def test_ai_prompt_orgs_users_memory_context_update(self) -> None: """ pass + def test_ai_prompt_orgs_users_memory_create(self) -> None: + """Test case for ai_prompt_orgs_users_memory_create + + """ + pass + + def test_ai_prompt_orgs_users_memory_destroy(self) -> None: + """Test case for ai_prompt_orgs_users_memory_destroy + + """ + pass + + def test_ai_prompt_orgs_users_memory_destroy2(self) -> None: + """Test case for ai_prompt_orgs_users_memory_destroy2 + + """ + pass + + def test_ai_prompt_orgs_users_memory_retrieve(self) -> None: + """Test case for ai_prompt_orgs_users_memory_retrieve + + """ + pass + + def test_ai_prompt_orgs_users_memory_status_retrieve(self) -> None: + """Test case for ai_prompt_orgs_users_memory_status_retrieve + + """ + pass + + def test_ai_prompt_orgs_users_memory_status_update(self) -> None: + """Test case for ai_prompt_orgs_users_memory_status_update + + """ + pass + + def test_ai_prompt_orgs_users_memory_update(self) -> None: + """Test case for ai_prompt_orgs_users_memory_update + + """ + pass + def test_ai_prompt_orgs_users_metadata_retrieve(self) -> None: """Test case for ai_prompt_orgs_users_metadata_retrieve @@ -254,36 +296,6 @@ def test_ai_prompt_orgs_users_tones_update(self) -> None: """ pass - def test_ai_prompt_orgs_users_user_catalog_item_memory_create(self) -> None: - """Test case for ai_prompt_orgs_users_user_catalog_item_memory_create - - """ - pass - - def test_ai_prompt_orgs_users_user_catalog_item_memory_destroy(self) -> None: - """Test case for ai_prompt_orgs_users_user_catalog_item_memory_destroy - - """ - pass - - def test_ai_prompt_orgs_users_user_catalog_item_memory_destroy2(self) -> None: - """Test case for ai_prompt_orgs_users_user_catalog_item_memory_destroy2 - - """ - pass - - def test_ai_prompt_orgs_users_user_catalog_item_memory_retrieve(self) -> None: - """Test case for ai_prompt_orgs_users_user_catalog_item_memory_retrieve - - """ - pass - - def test_ai_prompt_orgs_users_user_catalog_item_memory_update(self) -> None: - """Test case for ai_prompt_orgs_users_user_catalog_item_memory_update - - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/test/test_align_mentor_bubble_enum.py b/test/test_align_mentor_bubble_enum.py index 4fb5fd3..c0bade4 100644 --- a/test/test_align_mentor_bubble_enum.py +++ b/test/test_align_mentor_bubble_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_analytics_api.py b/test/test_analytics_api.py index 63e4c29..d57395d 100644 --- a/test/test_analytics_api.py +++ b/test/test_analytics_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_api_token_cost.py b/test/test_api_token_cost.py index 506f761..d9b14cf 100644 --- a/test/test_api_token_cost.py +++ b/test/test_api_token_cost.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_assertion.py b/test/test_assertion.py index b311cc0..113d883 100644 --- a/test/test_assertion.py +++ b/test/test_assertion.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_audience_api.py b/test/test_audience_api.py index 4250691..5df999a 100644 --- a/test/test_audience_api.py +++ b/test/test_audience_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_audio_to_text_request.py b/test/test_audio_to_text_request.py index f881687..a45f2b6 100644 --- a/test/test_audio_to_text_request.py +++ b/test/test_audio_to_text_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_audio_to_text_response.py b/test/test_audio_to_text_response.py index 6503144..28b7155 100644 --- a/test/test_audio_to_text_response.py +++ b/test/test_audio_to_text_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_average.py b/test/test_average.py index 2db3d2d..aa6a36b 100644 --- a/test/test_average.py +++ b/test/test_average.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_average_data.py b/test/test_average_data.py index bef7e41..a0d7bb3 100644 --- a/test/test_average_data.py +++ b/test/test_average_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_average_overtime.py b/test/test_average_overtime.py index 0f12d21..8ff0f98 100644 --- a/test/test_average_overtime.py +++ b/test/test_average_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_avg_course_grade_with_cutoff.py b/test/test_avg_course_grade_with_cutoff.py index a2d80f1..95c3dee 100644 --- a/test/test_avg_course_grade_with_cutoff.py +++ b/test/test_avg_course_grade_with_cutoff.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_avg_course_grade_with_cutoff_data.py b/test/test_avg_course_grade_with_cutoff_data.py index a66282a..76ce4f8 100644 --- a/test/test_avg_course_grade_with_cutoff_data.py +++ b/test/test_avg_course_grade_with_cutoff_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_blank_enum.py b/test/test_blank_enum.py index 9a6c4f8..fb36a43 100644 --- a/test/test_blank_enum.py +++ b/test/test_blank_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_bot.py b/test/test_bot.py index 4f74126..3fe28d2 100644 --- a/test/test_bot.py +++ b/test/test_bot.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_bot_command.py b/test/test_bot_command.py index 43bbd5f..7336eb3 100644 --- a/test/test_bot_command.py +++ b/test/test_bot_command.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_bot_create.py b/test/test_bot_create.py index 6731836..ccae457 100644 --- a/test/test_bot_create.py +++ b/test/test_bot_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_bulk_create_assertion.py b/test/test_bulk_create_assertion.py index 39cedba..91e6754 100644 --- a/test/test_bulk_create_assertion.py +++ b/test/test_bulk_create_assertion.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_career_api.py b/test/test_career_api.py index c4d4f7b..e6e3179 100644 --- a/test/test_career_api.py +++ b/test/test_career_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -26,6 +26,126 @@ def setUp(self) -> None: def tearDown(self) -> None: pass + def test_career_orgs_companies_users_create(self) -> None: + """Test case for career_orgs_companies_users_create + + """ + pass + + def test_career_orgs_companies_users_destroy(self) -> None: + """Test case for career_orgs_companies_users_destroy + + """ + pass + + def test_career_orgs_companies_users_retrieve(self) -> None: + """Test case for career_orgs_companies_users_retrieve + + """ + pass + + def test_career_orgs_companies_users_update(self) -> None: + """Test case for career_orgs_companies_users_update + + """ + pass + + def test_career_orgs_education_users_create(self) -> None: + """Test case for career_orgs_education_users_create + + """ + pass + + def test_career_orgs_education_users_destroy(self) -> None: + """Test case for career_orgs_education_users_destroy + + """ + pass + + def test_career_orgs_education_users_retrieve(self) -> None: + """Test case for career_orgs_education_users_retrieve + + """ + pass + + def test_career_orgs_education_users_update(self) -> None: + """Test case for career_orgs_education_users_update + + """ + pass + + def test_career_orgs_experience_users_create(self) -> None: + """Test case for career_orgs_experience_users_create + + """ + pass + + def test_career_orgs_experience_users_destroy(self) -> None: + """Test case for career_orgs_experience_users_destroy + + """ + pass + + def test_career_orgs_experience_users_retrieve(self) -> None: + """Test case for career_orgs_experience_users_retrieve + + """ + pass + + def test_career_orgs_experience_users_update(self) -> None: + """Test case for career_orgs_experience_users_update + + """ + pass + + def test_career_orgs_institutions_users_create(self) -> None: + """Test case for career_orgs_institutions_users_create + + """ + pass + + def test_career_orgs_institutions_users_destroy(self) -> None: + """Test case for career_orgs_institutions_users_destroy + + """ + pass + + def test_career_orgs_institutions_users_retrieve(self) -> None: + """Test case for career_orgs_institutions_users_retrieve + + """ + pass + + def test_career_orgs_institutions_users_update(self) -> None: + """Test case for career_orgs_institutions_users_update + + """ + pass + + def test_career_orgs_programs_users_create(self) -> None: + """Test case for career_orgs_programs_users_create + + """ + pass + + def test_career_orgs_programs_users_destroy(self) -> None: + """Test case for career_orgs_programs_users_destroy + + """ + pass + + def test_career_orgs_programs_users_retrieve(self) -> None: + """Test case for career_orgs_programs_users_retrieve + + """ + pass + + def test_career_orgs_programs_users_update(self) -> None: + """Test case for career_orgs_programs_users_update + + """ + pass + def test_career_resume_orgs_users_create(self) -> None: """Test case for career_resume_orgs_users_create @@ -38,6 +158,12 @@ def test_career_resume_orgs_users_retrieve(self) -> None: """ pass + def test_career_resume_orgs_users_update(self) -> None: + """Test case for career_resume_orgs_users_update + + """ + pass + if __name__ == '__main__': unittest.main() diff --git a/test/test_chartsession_mentor.py b/test/test_chartsession_mentor.py index a3769a6..aea7a6c 100644 --- a/test/test_chartsession_mentor.py +++ b/test/test_chartsession_mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_chat_history.py b/test/test_chat_history.py index 7da1ead..c878139 100644 --- a/test/test_chat_history.py +++ b/test/test_chat_history.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -39,14 +39,14 @@ def make_instance(self, include_optional) -> ChatHistory: message = None, inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), title = '', - feedback = '', + feedback = None, document_sources = None ) else: return ChatHistory( id = 56, inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - feedback = '', + feedback = None, ) """ diff --git a/test/test_chat_history_filter_data.py b/test/test_chat_history_filter_data.py new file mode 100644 index 0000000..5396a75 --- /dev/null +++ b/test/test_chat_history_filter_data.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.chat_history_filter_data import ChatHistoryFilterData + +class TestChatHistoryFilterData(unittest.TestCase): + """ChatHistoryFilterData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ChatHistoryFilterData: + """Test ChatHistoryFilterData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ChatHistoryFilterData` + """ + model = ChatHistoryFilterData() + if include_optional: + return ChatHistoryFilterData( + topics = [ + iblai.models.topic_model.TopicModel( + name = '', ) + ], + date_ranges = [ + iblai.models.date_range.DateRange( + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + end_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), ) + ], + sentiment = [ + '' + ] + ) + else: + return ChatHistoryFilterData( + topics = [ + iblai.models.topic_model.TopicModel( + name = '', ) + ], + ) + """ + + def testChatHistoryFilterData(self): + """Test ChatHistoryFilterData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_chat_history_item.py b/test/test_chat_history_item.py index 0d6376e..af8efa8 100644 --- a/test/test_chat_history_item.py +++ b/test/test_chat_history_item.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_chat_history_session_id.py b/test/test_chat_history_session_id.py index 576b64d..f813115 100644 --- a/test/test_chat_history_session_id.py +++ b/test/test_chat_history_session_id.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_chat_session_request.py b/test/test_chat_session_request.py index 9a2dbbf..4734a23 100644 --- a/test/test_chat_session_request.py +++ b/test/test_chat_session_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_chat_session_response.py b/test/test_chat_session_response.py index 3838b53..0f16ca6 100644 --- a/test/test_chat_session_response.py +++ b/test/test_chat_session_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_chat_session_with_message.py b/test/test_chat_session_with_message.py index 73364b4..15c7063 100644 --- a/test/test_chat_session_with_message.py +++ b/test/test_chat_session_with_message.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -51,7 +51,7 @@ def make_instance(self, include_optional) -> ChatSessionWithMessage: message = null, inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), title = '', - feedback = '', + feedback = null, document_sources = null, ) ] ) @@ -73,7 +73,7 @@ def make_instance(self, include_optional) -> ChatSessionWithMessage: message = null, inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), title = '', - feedback = '', + feedback = null, document_sources = null, ) ], ) diff --git a/test/test_check_document_training_status.py b/test/test_check_document_training_status.py index 03ff9c4..2306a73 100644 --- a/test/test_check_document_training_status.py +++ b/test/test_check_document_training_status.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_company.py b/test/test_company.py new file mode 100644 index 0000000..d80b657 --- /dev/null +++ b/test/test_company.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.company import Company + +class TestCompany(unittest.TestCase): + """Company unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Company: + """Test Company + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Company` + """ + model = Company() + if include_optional: + return Company( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + name = '', + industry = '', + website = '', + logo_url = '', + data = None, + metadata = None, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return Company( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + name = '', + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testCompany(self): + """Test Company""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_conversation_message.py b/test/test_conversation_message.py index 53a76f6..9e9dc50 100644 --- a/test/test_conversation_message.py +++ b/test/test_conversation_message.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -42,7 +42,7 @@ def make_instance(self, include_optional) -> ConversationMessage: ], id = '', user_id = '', - message_count = '', + message_count = 56, model = '', inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), user_sentiment = '' @@ -56,7 +56,7 @@ def make_instance(self, include_optional) -> ConversationMessage: ], id = '', user_id = '', - message_count = '', + message_count = 56, model = '', inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), user_sentiment = '', diff --git a/test/test_conversation_volume.py b/test/test_conversation_volume.py index 59584d5..10a06c5 100644 --- a/test/test_conversation_volume.py +++ b/test/test_conversation_volume.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_conversations.py b/test/test_conversations.py new file mode 100644 index 0000000..7aeab80 --- /dev/null +++ b/test/test_conversations.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.conversations import Conversations + +class TestConversations(unittest.TestCase): + """Conversations unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Conversations: + """Test Conversations + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Conversations` + """ + model = Conversations() + if include_optional: + return Conversations( + id = '', + messages = '', + topics = [ + iblai.models.topic_model.TopicModel( + name = '', ) + ], + sentiment = '', + mentor = '', + student = '', + model = '', + rating = '', + inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + has_document = True, + memory_tracked = True, + llm_name = '', + llm_provider = '', + metadata = None, + platform = 56 + ) + else: + return Conversations( + id = '', + messages = '', + topics = [ + iblai.models.topic_model.TopicModel( + name = '', ) + ], + sentiment = '', + mentor = '', + student = '', + model = '', + rating = '', + inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testConversations(self): + """Test Conversations""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_core_api.py b/test/test_core_api.py index 638e4f5..01307ab 100644 --- a/test/test_core_api.py +++ b/test/test_core_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -26,6 +26,66 @@ def setUp(self) -> None: def tearDown(self) -> None: pass + def test_core_lti1p3_provider_lti_keys_create(self) -> None: + """Test case for core_lti1p3_provider_lti_keys_create + + """ + pass + + def test_core_lti1p3_provider_lti_keys_destroy(self) -> None: + """Test case for core_lti1p3_provider_lti_keys_destroy + + """ + pass + + def test_core_lti1p3_provider_lti_keys_list(self) -> None: + """Test case for core_lti1p3_provider_lti_keys_list + + """ + pass + + def test_core_lti1p3_provider_lti_keys_retrieve(self) -> None: + """Test case for core_lti1p3_provider_lti_keys_retrieve + + """ + pass + + def test_core_lti1p3_provider_lti_keys_update(self) -> None: + """Test case for core_lti1p3_provider_lti_keys_update + + """ + pass + + def test_core_lti1p3_provider_lti_tools_create(self) -> None: + """Test case for core_lti1p3_provider_lti_tools_create + + """ + pass + + def test_core_lti1p3_provider_lti_tools_destroy(self) -> None: + """Test case for core_lti1p3_provider_lti_tools_destroy + + """ + pass + + def test_core_lti1p3_provider_lti_tools_list(self) -> None: + """Test case for core_lti1p3_provider_lti_tools_list + + """ + pass + + def test_core_lti1p3_provider_lti_tools_retrieve(self) -> None: + """Test case for core_lti1p3_provider_lti_tools_retrieve + + """ + pass + + def test_core_lti1p3_provider_lti_tools_update(self) -> None: + """Test case for core_lti1p3_provider_lti_tools_update + + """ + pass + def test_core_orgs_dark_mode_logo_create_create(self) -> None: """Test case for core_orgs_dark_mode_logo_create_create @@ -80,6 +140,24 @@ def test_core_orgs_metadata_update(self) -> None: """ pass + def test_core_orgs_redirect_tokens_create(self) -> None: + """Test case for core_orgs_redirect_tokens_create + + """ + pass + + def test_core_orgs_redirect_tokens_delete_destroy(self) -> None: + """Test case for core_orgs_redirect_tokens_delete_destroy + + """ + pass + + def test_core_orgs_redirect_tokens_retrieve(self) -> None: + """Test case for core_orgs_redirect_tokens_retrieve + + """ + pass + def test_core_orgs_thumbnail_create_create(self) -> None: """Test case for core_orgs_thumbnail_create_create diff --git a/test/test_count.py b/test/test_count.py index ecff5d7..c524e99 100644 --- a/test/test_count.py +++ b/test/test_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_count_data.py b/test/test_count_data.py index e2269c3..111d541 100644 --- a/test/test_count_data.py +++ b/test/test_count_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_completion_per_course.py b/test/test_course_completion_per_course.py index 38ee652..ba8afc1 100644 --- a/test/test_course_completion_per_course.py +++ b/test/test_course_completion_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_completion_per_course_data.py b/test/test_course_completion_per_course_data.py index d9dea9f..13abc13 100644 --- a/test/test_course_completion_per_course_data.py +++ b/test/test_course_completion_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_completion_summary_data_overtime.py b/test/test_course_completion_summary_data_overtime.py index 58c6a43..24f17f5 100644 --- a/test/test_course_completion_summary_data_overtime.py +++ b/test/test_course_completion_summary_data_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_completion_summary_overtime.py b/test/test_course_completion_summary_overtime.py index b055ae5..2f0b900 100644 --- a/test/test_course_completion_summary_overtime.py +++ b/test/test_course_completion_summary_overtime.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grade_detail_block.py b/test/test_course_grade_detail_block.py index f71c090..8550f10 100644 --- a/test/test_course_grade_detail_block.py +++ b/test/test_course_grade_detail_block.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grade_detail_sub_section.py b/test/test_course_grade_detail_sub_section.py index 947660b..5ae97b6 100644 --- a/test/test_course_grade_detail_sub_section.py +++ b/test/test_course_grade_detail_sub_section.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grade_summary.py b/test/test_course_grade_summary.py index 025c635..7827d3a 100644 --- a/test/test_course_grade_summary.py +++ b/test/test_course_grade_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grade_summary_data.py b/test/test_course_grade_summary_data.py index 0f57dde..f398768 100644 --- a/test/test_course_grade_summary_data.py +++ b/test/test_course_grade_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grading_detail.py b/test/test_course_grading_detail.py index a1ee6a1..d01138d 100644 --- a/test/test_course_grading_detail.py +++ b/test/test_course_grading_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_grading_detail_data.py b/test/test_course_grading_detail_data.py index 14aa381..b65ff3a 100644 --- a/test/test_course_grading_detail_data.py +++ b/test/test_course_grading_detail_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_point.py b/test/test_course_point.py index f93d8df..7e82f15 100644 --- a/test/test_course_point.py +++ b/test/test_course_point.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_course_skill.py b/test/test_course_skill.py index 78e228e..51e3c37 100644 --- a/test/test_course_skill.py +++ b/test/test_course_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_credential.py b/test/test_credential.py index b04560c..c7ed439 100644 --- a/test/test_credential.py +++ b/test/test_credential.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -35,14 +35,81 @@ def make_instance(self, include_optional) -> Credential: model = Credential() if include_optional: return Credential( + entity_id = '', name = '', - value = None, - platform = '' + name_override = '', + description = '', + criteria_url = '', + criteria_narrative = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + icon_image = '', + background_image = '', + thumbnail_image = '', + catalog_items = [ + '' + ], + courses = [ + { + 'key' : '' + } + ], + programs = [ + { + 'key' : '' + } + ], + issuer_details = { + 'key' : '' + }, + html_template = '', + css_template = '', + metadata = None, + credential_type = '', + expires = { + 'key' : 56 + }, + tags = None, + signatories = [ + { + 'key' : '' + } + ] ) else: return Credential( + entity_id = '', name = '', - platform = '', + criteria_url = '', + criteria_narrative = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + icon_image = '', + background_image = '', + thumbnail_image = '', + catalog_items = [ + '' + ], + courses = [ + { + 'key' : '' + } + ], + programs = [ + { + 'key' : '' + } + ], + issuer_details = { + 'key' : '' + }, + credential_type = '', + expires = { + 'key' : 56 + }, + signatories = [ + { + 'key' : '' + } + ], ) """ diff --git a/test/test_credential_request.py b/test/test_credential_request.py index 49d36f4..c6c8212 100644 --- a/test/test_credential_request.py +++ b/test/test_credential_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_credentials_api.py b/test/test_credentials_api.py index 3e72907..cb52664 100644 --- a/test/test_credentials_api.py +++ b/test/test_credentials_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_crontab_schedule.py b/test/test_crontab_schedule.py index 526e2ef..04c41be 100644 --- a/test/test_crontab_schedule.py +++ b/test/test_crontab_schedule.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_custom_instruction_response.py b/test/test_custom_instruction_response.py index de51db0..6d4ca7f 100644 --- a/test/test_custom_instruction_response.py +++ b/test/test_custom_instruction_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_data_set.py b/test/test_data_set.py index a5d34b0..c61b110 100644 --- a/test/test_data_set.py +++ b/test/test_data_set.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_data_set_create.py b/test/test_data_set_create.py index 4af84e6..34b8cac 100644 --- a/test/test_data_set_create.py +++ b/test/test_data_set_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_data_set_platform_value.py b/test/test_data_set_platform_value.py index dcdd297..eb69d8a 100644 --- a/test/test_data_set_platform_value.py +++ b/test/test_data_set_platform_value.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_data_set_status_enum.py b/test/test_data_set_status_enum.py index 1480ae1..c3537ce 100644 --- a/test/test_data_set_status_enum.py +++ b/test/test_data_set_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_date_range.py b/test/test_date_range.py new file mode 100644 index 0000000..995376a --- /dev/null +++ b/test/test_date_range.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.date_range import DateRange + +class TestDateRange(unittest.TestCase): + """DateRange unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DateRange: + """Test DateRange + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DateRange` + """ + model = DateRange() + if include_optional: + return DateRange( + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + end_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date() + ) + else: + return DateRange( + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + end_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + ) + """ + + def testDateRange(self): + """Test DateRange""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_desired_skill.py b/test/test_desired_skill.py index e2a64bc..d2d766d 100644 --- a/test/test_desired_skill.py +++ b/test/test_desired_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_detailed_grade_subsection.py b/test/test_detailed_grade_subsection.py index b7ffb61..ea015ca 100644 --- a/test/test_detailed_grade_subsection.py +++ b/test/test_detailed_grade_subsection.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_detailed_grade_view.py b/test/test_detailed_grade_view.py index f55cdab..8af70a0 100644 --- a/test/test_detailed_grade_view.py +++ b/test/test_detailed_grade_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_detailed_grade_view_data.py b/test/test_detailed_grade_view_data.py index a6790bd..632f446 100644 --- a/test/test_detailed_grade_view_data.py +++ b/test/test_detailed_grade_view_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_discord_config.py b/test/test_discord_config.py index 732d6cd..d849d92 100644 --- a/test/test_discord_config.py +++ b/test/test_discord_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_discord_webhook.py b/test/test_discord_webhook.py index 0cf168c..c8d8768 100644 --- a/test/test_discord_webhook.py +++ b/test/test_discord_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_education.py b/test/test_education.py new file mode 100644 index 0000000..b7937ef --- /dev/null +++ b/test/test_education.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.education import Education + +class TestEducation(unittest.TestCase): + """Education unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Education: + """Test Education + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Education` + """ + model = Education() + if include_optional: + return Education( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + institution = iblai.models.institution.Institution( + id = 56, + name = '', + institution_type = 'university', + location = '', + website = '', + accreditation = '', + established_year = 56, + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + institution_id = 56, + degree = '', + field_of_study = '', + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + end_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + grade = '-8', + activities = '', + description = '', + data = None, + metadata = None, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + is_current = True + ) + else: + return Education( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + institution = iblai.models.institution.Institution( + id = 56, + name = '', + institution_type = 'university', + location = '', + website = '', + accreditation = '', + established_year = 56, + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + institution_id = 56, + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testEducation(self): + """Test Education""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_engagement_api.py b/test/test_engagement_api.py index cfcb7b3..46dc2ff 100644 --- a/test/test_engagement_api.py +++ b/test/test_engagement_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_engagement_per_course.py b/test/test_engagement_per_course.py index fd7f3a2..616d269 100644 --- a/test/test_engagement_per_course.py +++ b/test/test_engagement_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_engagement_per_course_data.py b/test/test_engagement_per_course_data.py index b70b5eb..5403392 100644 --- a/test/test_engagement_per_course_data.py +++ b/test/test_engagement_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_enrollments.py b/test/test_enrollments.py index 8a44fb7..14a7b51 100644 --- a/test/test_enrollments.py +++ b/test/test_enrollments.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_enrollments_data.py b/test/test_enrollments_data.py index 0134cb1..73b1af2 100644 --- a/test/test_enrollments_data.py +++ b/test/test_enrollments_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_enrollments_per_user.py b/test/test_enrollments_per_user.py index 2a5219e..915562f 100644 --- a/test/test_enrollments_per_user.py +++ b/test/test_enrollments_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_enrollments_per_user_data.py b/test/test_enrollments_per_user_data.py index 1f9807e..587525b 100644 --- a/test/test_enrollments_per_user_data.py +++ b/test/test_enrollments_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_experience.py b/test/test_experience.py new file mode 100644 index 0000000..61ac0fb --- /dev/null +++ b/test/test_experience.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.experience import Experience + +class TestExperience(unittest.TestCase): + """Experience unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Experience: + """Test Experience + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Experience` + """ + model = Experience() + if include_optional: + return Experience( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + company = iblai.models.company.Company( + id = 56, + user = 56, + user_info = null, + name = '', + industry = '', + website = '', + logo_url = '', + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + company_id = 56, + title = '', + employment_type = '', + location = '', + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + end_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + is_current = True, + description = '', + data = None, + metadata = None, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return Experience( + id = 56, + user = 56, + user_info = iblai.models.user_info.UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = null, ), + company = iblai.models.company.Company( + id = 56, + user = 56, + user_info = null, + name = '', + industry = '', + website = '', + logo_url = '', + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + company_id = 56, + title = '', + start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testExperience(self): + """Test Experience""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_finance_api.py b/test/test_finance_api.py index 89dc30f..3ff919d 100644 --- a/test/test_finance_api.py +++ b/test/test_finance_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_float_over_time.py b/test/test_float_over_time.py index 7167a2e..cb47f95 100644 --- a/test/test_float_over_time.py +++ b/test/test_float_over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_free_usage_count.py b/test/test_free_usage_count.py index 7fdc32b..6ae43a4 100644 --- a/test/test_free_usage_count.py +++ b/test/test_free_usage_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_grading_per_user.py b/test/test_grading_per_user.py index 4b5b370..2b1204c 100644 --- a/test/test_grading_per_user.py +++ b/test/test_grading_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_grading_per_user_data.py b/test/test_grading_per_user_data.py index 76d0128..9d03fbe 100644 --- a/test/test_grading_per_user_data.py +++ b/test/test_grading_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_guided_prompts_response.py b/test/test_guided_prompts_response.py index 7e216ba..0874a46 100644 --- a/test/test_guided_prompts_response.py +++ b/test/test_guided_prompts_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_iblai_platform_meta.py b/test/test_iblai_platform_meta.py index b216cf8..3cb0db9 100644 --- a/test/test_iblai_platform_meta.py +++ b/test/test_iblai_platform_meta.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_iblai_platform_meta_request.py b/test/test_iblai_platform_meta_request.py index 74214cc..0ea3990 100644 --- a/test/test_iblai_platform_meta_request.py +++ b/test/test_iblai_platform_meta_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_iblai_platform_meta_update_request.py b/test/test_iblai_platform_meta_update_request.py index 4910447..e9a8fbc 100644 --- a/test/test_iblai_platform_meta_update_request.py +++ b/test/test_iblai_platform_meta_update_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_image_upload.py b/test/test_image_upload.py index 12b8fb9..da65a06 100644 --- a/test/test_image_upload.py +++ b/test/test_image_upload.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_institution.py b/test/test_institution.py new file mode 100644 index 0000000..dadf79c --- /dev/null +++ b/test/test_institution.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.institution import Institution + +class TestInstitution(unittest.TestCase): + """Institution unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Institution: + """Test Institution + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Institution` + """ + model = Institution() + if include_optional: + return Institution( + id = 56, + name = '', + institution_type = 'university', + location = '', + website = '', + accreditation = '', + established_year = 56, + data = None, + metadata = None, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return Institution( + id = 56, + name = '', + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testInstitution(self): + """Test Institution""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_institution_type_enum.py b/test/test_institution_type_enum.py new file mode 100644 index 0000000..4cd1f4e --- /dev/null +++ b/test/test_institution_type_enum.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.institution_type_enum import InstitutionTypeEnum + +class TestInstitutionTypeEnum(unittest.TestCase): + """InstitutionTypeEnum unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInstitutionTypeEnum(self): + """Test InstitutionTypeEnum""" + # inst = InstitutionTypeEnum() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_integration_credential.py b/test/test_integration_credential.py index d550ce4..c8923b4 100644 --- a/test/test_integration_credential.py +++ b/test/test_integration_credential.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_issuer.py b/test/test_issuer.py index d1433fc..e83d306 100644 --- a/test/test_issuer.py +++ b/test/test_issuer.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_issuer_authority.py b/test/test_issuer_authority.py index 4a0ed54..fb37830 100644 --- a/test/test_issuer_authority.py +++ b/test/test_issuer_authority.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_job_run.py b/test/test_job_run.py index 7e8b009..c09986e 100644 --- a/test/test_job_run.py +++ b/test/test_job_run.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_languages_view.py b/test/test_languages_view.py index c89de9e..7cc767d 100644 --- a/test/test_languages_view.py +++ b/test/test_languages_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_learner_information_api.py b/test/test_learner_information_api.py index c104fbd..cda0cb1 100644 --- a/test/test_learner_information_api.py +++ b/test/test_learner_information_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_learner_information_api_data.py b/test/test_learner_information_api_data.py index f8a04c6..e6ee822 100644 --- a/test/test_learner_information_api_data.py +++ b/test/test_learner_information_api_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_credential_response.py b/test/test_llm_credential_response.py new file mode 100644 index 0000000..77ee3bb --- /dev/null +++ b/test/test_llm_credential_response.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.llm_credential_response import LLMCredentialResponse + +class TestLLMCredentialResponse(unittest.TestCase): + """LLMCredentialResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LLMCredentialResponse: + """Test LLMCredentialResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LLMCredentialResponse` + """ + model = LLMCredentialResponse() + if include_optional: + return LLMCredentialResponse( + name = '', + value = None, + platform = '' + ) + else: + return LLMCredentialResponse( + name = '', + platform = '', + ) + """ + + def testLLMCredentialResponse(self): + """Test LLMCredentialResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_llm_model_for_tenant.py b/test/test_llm_model_for_tenant.py index eedafd2..d1b3a72 100644 --- a/test/test_llm_model_for_tenant.py +++ b/test/test_llm_model_for_tenant.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_response.py b/test/test_llm_response.py index a7da443..9541664 100644 --- a/test/test_llm_response.py +++ b/test/test_llm_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_scores_view.py b/test/test_llm_scores_view.py index 1c10ffa..cccefca 100644 --- a/test/test_llm_scores_view.py +++ b/test/test_llm_scores_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_scores_view_request.py b/test/test_llm_scores_view_request.py index 6ade65b..0f47118 100644 --- a/test/test_llm_scores_view_request.py +++ b/test/test_llm_scores_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_scores_view_response.py b/test/test_llm_scores_view_response.py index 2b0e1b7..1553883 100644 --- a/test/test_llm_scores_view_response.py +++ b/test/test_llm_scores_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_trace_detail.py b/test/test_llm_trace_detail.py index 20ab926..0e79445 100644 --- a/test/test_llm_trace_detail.py +++ b/test/test_llm_trace_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_llm_traces_list_response.py b/test/test_llm_traces_list_response.py index 239bec5..7521817 100644 --- a/test/test_llm_traces_list_response.py +++ b/test/test_llm_traces_list_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_lti_key.py b/test/test_lti_key.py new file mode 100644 index 0000000..163f0d3 --- /dev/null +++ b/test/test_lti_key.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.lti_key import LtiKey + +class TestLtiKey(unittest.TestCase): + """LtiKey unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LtiKey: + """Test LtiKey + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LtiKey` + """ + model = LtiKey() + if include_optional: + return LtiKey( + id = 56, + name = '', + public_key = '', + public_jwk = None, + platform_key = '' + ) + else: + return LtiKey( + id = 56, + name = '', + public_key = '', + public_jwk = None, + platform_key = '', + ) + """ + + def testLtiKey(self): + """Test LtiKey""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_lti_launch_gate.py b/test/test_lti_launch_gate.py new file mode 100644 index 0000000..e168836 --- /dev/null +++ b/test/test_lti_launch_gate.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.lti_launch_gate import LtiLaunchGate + +class TestLtiLaunchGate(unittest.TestCase): + """LtiLaunchGate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LtiLaunchGate: + """Test LtiLaunchGate + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LtiLaunchGate` + """ + model = LtiLaunchGate() + if include_optional: + return LtiLaunchGate( + allowed_keys = [ + '' + ], + allowed_courses = [ + '' + ], + allow_all_within_org = True + ) + else: + return LtiLaunchGate( + ) + """ + + def testLtiLaunchGate(self): + """Test LtiLaunchGate""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_lti_tool.py b/test/test_lti_tool.py new file mode 100644 index 0000000..e55ffa2 --- /dev/null +++ b/test/test_lti_tool.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.lti_tool import LtiTool + +class TestLtiTool(unittest.TestCase): + """LtiTool unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LtiTool: + """Test LtiTool + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LtiTool` + """ + model = LtiTool() + if include_optional: + return LtiTool( + id = 56, + title = '', + issuer = '', + client_id = '', + auth_login_url = '', + auth_token_url = '', + auth_audience = '', + key_set_url = '', + key_set = None, + tool_key = 56, + deployment_ids = [ + '' + ], + platform_key = '', + launch_gate = iblai.models.lti_launch_gate.LtiLaunchGate( + allowed_keys = [ + '' + ], + allowed_courses = [ + '' + ], + allow_all_within_org = True, ) + ) + else: + return LtiTool( + id = 56, + title = '', + issuer = '', + client_id = '', + auth_login_url = '', + auth_token_url = '', + tool_key = 56, + deployment_ids = [ + '' + ], + platform_key = '', + launch_gate = iblai.models.lti_launch_gate.LtiLaunchGate( + allowed_keys = [ + '' + ], + allowed_courses = [ + '' + ], + allow_all_within_org = True, ), + ) + """ + + def testLtiTool(self): + """Test LtiTool""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_main_creds.py b/test/test_main_creds.py index 15fc182..18c1368 100644 --- a/test/test_main_creds.py +++ b/test/test_main_creds.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_memory_status_request_view.py b/test/test_memory_status_request_view.py new file mode 100644 index 0000000..4947db4 --- /dev/null +++ b/test/test_memory_status_request_view.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.memory_status_request_view import MemoryStatusRequestView + +class TestMemoryStatusRequestView(unittest.TestCase): + """MemoryStatusRequestView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MemoryStatusRequestView: + """Test MemoryStatusRequestView + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MemoryStatusRequestView` + """ + model = MemoryStatusRequestView() + if include_optional: + return MemoryStatusRequestView( + enabled = True + ) + else: + return MemoryStatusRequestView( + enabled = True, + ) + """ + + def testMemoryStatusRequestView(self): + """Test MemoryStatusRequestView""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_memory_status_view.py b/test/test_memory_status_view.py new file mode 100644 index 0000000..81b6019 --- /dev/null +++ b/test/test_memory_status_view.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.memory_status_view import MemoryStatusView + +class TestMemoryStatusView(unittest.TestCase): + """MemoryStatusView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MemoryStatusView: + """Test MemoryStatusView + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MemoryStatusView` + """ + model = MemoryStatusView() + if include_optional: + return MemoryStatusView( + id = 56, + username = '', + platform_key = '', + enabled = True + ) + else: + return MemoryStatusView( + id = 56, + username = '', + platform_key = '', + ) + """ + + def testMemoryStatusView(self): + """Test MemoryStatusView""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_mentor.py b/test/test_mentor.py index 3197d67..80fddb5 100644 --- a/test/test_mentor.py +++ b/test/test_mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -47,6 +47,9 @@ def make_instance(self, include_optional) -> Mentor: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_mentor_category.py b/test/test_mentor_category.py index 284ba6f..82df137 100644 --- a/test/test_mentor_category.py +++ b/test/test_mentor_category.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_data.py b/test/test_mentor_data.py index 3413306..8688263 100644 --- a/test/test_mentor_data.py +++ b/test/test_mentor_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_detail_analytics.py b/test/test_mentor_detail_analytics.py index 68e11db..69d8c39 100644 --- a/test/test_mentor_detail_analytics.py +++ b/test/test_mentor_detail_analytics.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_from_template_request.py b/test/test_mentor_from_template_request.py index 933208a..16f13a3 100644 --- a/test/test_mentor_from_template_request.py +++ b/test/test_mentor_from_template_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_from_template_with_setting_request.py b/test/test_mentor_from_template_with_setting_request.py index 4d1b6e4..3bca9d8 100644 --- a/test/test_mentor_from_template_with_setting_request.py +++ b/test/test_mentor_from_template_with_setting_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -63,7 +63,10 @@ def make_instance(self, include_optional) -> MentorFromTemplateWithSettingReques llm_temperature = 0.0, seo_tags = None, marketing_conversations = None, - proactive_prompt = '' + proactive_prompt = '', + moderation_system_prompt = '', + moderation_response = '', + enable_moderation = True ) else: return MentorFromTemplateWithSettingRequest( diff --git a/test/test_mentor_metadata.py b/test/test_mentor_metadata.py new file mode 100644 index 0000000..f9540d4 --- /dev/null +++ b/test/test_mentor_metadata.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.mentor_metadata import MentorMetadata + +class TestMentorMetadata(unittest.TestCase): + """MentorMetadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MentorMetadata: + """Test MentorMetadata + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MentorMetadata` + """ + model = MentorMetadata() + if include_optional: + return MentorMetadata( + metadata = None, + mentor = '', + mentor_id = 56 + ) + else: + return MentorMetadata( + metadata = None, + ) + """ + + def testMentorMetadata(self): + """Test MentorMetadata""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_mentor_settings.py b/test/test_mentor_settings.py index 3de1191..f4fcace 100644 --- a/test/test_mentor_settings.py +++ b/test/test_mentor_settings.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -47,19 +47,19 @@ def make_instance(self, include_optional) -> MentorSettings: mentor = '', mentor_slug = '', mentor_unique_id = '', - metadata = '', + metadata = None, mentor_visibility = None, enable_image_generation = True, enable_web_browsing = True, enable_code_interpreter = True, custom_css = '', - allow_anonymous = '', + allow_anonymous = True, mentor_description = '', - suggested_prompts = '', + suggested_prompts = None, proactive_message = '', - mentor_tools = '', - can_use_tools = '', - llm_temperature = '', + mentor_tools = None, + can_use_tools = True, + llm_temperature = 1.337, llm_provider = '', llm_name = '', proactive_prompt = '' @@ -70,14 +70,14 @@ def make_instance(self, include_optional) -> MentorSettings: mentor = '', mentor_slug = '', mentor_unique_id = '', - metadata = '', - allow_anonymous = '', + metadata = None, + allow_anonymous = True, mentor_description = '', - suggested_prompts = '', + suggested_prompts = None, proactive_message = '', - mentor_tools = '', - can_use_tools = '', - llm_temperature = '', + mentor_tools = None, + can_use_tools = True, + llm_temperature = 1.337, llm_provider = '', llm_name = '', proactive_prompt = '', diff --git a/test/test_mentor_settings_mentor_visibility.py b/test/test_mentor_settings_mentor_visibility.py index 09355b4..4b6c8c3 100644 --- a/test/test_mentor_settings_mentor_visibility.py +++ b/test/test_mentor_settings_mentor_visibility.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_settings_request.py b/test/test_mentor_settings_request.py index 50bb869..d667e6a 100644 --- a/test/test_mentor_settings_request.py +++ b/test/test_mentor_settings_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -35,6 +35,7 @@ def make_instance(self, include_optional) -> MentorSettingsRequest: model = MentorSettingsRequest() if include_optional: return MentorSettingsRequest( + mentor_name = '', display_name = '', profile_image = '', initial_message = '', @@ -46,21 +47,29 @@ def make_instance(self, include_optional) -> MentorSettingsRequest: system_prompt = '', llm_provider = '', llm_name = '', - featured = '', + featured = True, metadata = None, custom_css = '', mentor_visibility = '', - enable_image_generation = '', - enable_web_browsing = '', - enable_code_interpreter = '', - allow_anonymous = '', + enable_image_generation = True, + enable_web_browsing = True, + enable_code_interpreter = True, + allow_anonymous = True, mentor_description = '', uploaded_profile_image = '', proactive_message = '', + can_use_tools = True, tool_slugs = [ '' ], - llm_temperature = 0.0 + llm_temperature = 0.0, + proactive_prompt = '', + moderation_system_prompt = '', + moderation_response = '', + enable_moderation = True, + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True ) else: return MentorSettingsRequest( diff --git a/test/test_mentor_trace.py b/test/test_mentor_trace.py index f8e43eb..a0de629 100644 --- a/test/test_mentor_trace.py +++ b/test/test_mentor_trace.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_visibility_enum.py b/test/test_mentor_visibility_enum.py index b583ce1..7729999 100644 --- a/test/test_mentor_visibility_enum.py +++ b/test/test_mentor_visibility_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_mentor_wizard.py b/test/test_mentor_wizard.py index f0182b5..71f5c1e 100644 --- a/test/test_mentor_wizard.py +++ b/test/test_mentor_wizard.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_message_status.py b/test/test_message_status.py new file mode 100644 index 0000000..83094b7 --- /dev/null +++ b/test/test_message_status.py @@ -0,0 +1,50 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.message_status import MessageStatus + +class TestMessageStatus(unittest.TestCase): + """MessageStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MessageStatus: + """Test MessageStatus + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MessageStatus` + """ + model = MessageStatus() + if include_optional: + return MessageStatus( + ) + else: + return MessageStatus( + ) + """ + + def testMessageStatus(self): + """Test MessageStatus""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_message_view.py b/test/test_message_view.py index 7d0838a..515a266 100644 --- a/test/test_message_view.py +++ b/test/test_message_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_message_view_request.py b/test/test_message_view_request.py index 892f423..2f11abb 100644 --- a/test/test_message_view_request.py +++ b/test/test_message_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_message_view_updat_response.py b/test/test_message_view_updat_response.py index 77fa939..e7ee259 100644 --- a/test/test_message_view_updat_response.py +++ b/test/test_message_view_updat_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_metadata.py b/test/test_metadata.py new file mode 100644 index 0000000..c065d9f --- /dev/null +++ b/test/test_metadata.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.metadata import Metadata + +class TestMetadata(unittest.TestCase): + """Metadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Metadata: + """Test Metadata + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Metadata` + """ + model = Metadata() + if include_optional: + return Metadata( + metadata = None, + prompt = '', + prompt_id = 56 + ) + else: + return Metadata( + metadata = None, + ) + """ + + def testMetadata(self): + """Test Metadata""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_model_cost.py b/test/test_model_cost.py index e8076a5..6c806d3 100644 --- a/test/test_model_cost.py +++ b/test/test_model_cost.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_model_usage.py b/test/test_model_usage.py index daef261..7af8a97 100644 --- a/test/test_model_usage.py +++ b/test/test_model_usage.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_moderation_log.py b/test/test_moderation_log.py new file mode 100644 index 0000000..3d396d2 --- /dev/null +++ b/test/test_moderation_log.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.moderation_log import ModerationLog + +class TestModerationLog(unittest.TestCase): + """ModerationLog unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ModerationLog: + """Test ModerationLog + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ModerationLog` + """ + model = ModerationLog() + if include_optional: + return ModerationLog( + id = 56, + username = '', + platform_key = '', + mentor = 56, + prompt = '', + reason = '', + target_system = 'Safety System', + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return ModerationLog( + id = 56, + platform_key = '', + mentor = 56, + prompt = '', + reason = '', + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testModerationLog(self): + """Test ModerationLog""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_monitoring_api.py b/test/test_monitoring_api.py deleted file mode 100644 index 3256831..0000000 --- a/test/test_monitoring_api.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 - -""" - ibl-data-manager - - API for iblai - - The version of the OpenAPI document: 2.4.1-ai-plus - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -import unittest - -from iblai.api.monitoring_api import MonitoringApi - - -class TestMonitoringApi(unittest.TestCase): - """MonitoringApi unit test stubs""" - - def setUp(self) -> None: - self.api = MonitoringApi() - - def tearDown(self) -> None: - pass - - def test_monitoring_connectors_retrieve(self) -> None: - """Test case for monitoring_connectors_retrieve - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_net_revenue_over_time.py b/test/test_net_revenue_over_time.py index 95c4b3f..ad1e345 100644 --- a/test/test_net_revenue_over_time.py +++ b/test/test_net_revenue_over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_notification.py b/test/test_notification.py new file mode 100644 index 0000000..57d92d4 --- /dev/null +++ b/test/test_notification.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.notification import Notification + +class TestNotification(unittest.TestCase): + """Notification unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Notification: + """Test Notification + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Notification` + """ + model = Notification() + if include_optional: + return Notification( + id = '', + username = '', + title = '', + body = '', + status = None, + channel = 56, + context = None, + short_message = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return Notification( + id = '', + username = '', + title = '', + body = '', + short_message = '', + ) + """ + + def testNotification(self): + """Test Notification""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notification_api.py b/test/test_notification_api.py new file mode 100644 index 0000000..c4342fb --- /dev/null +++ b/test/test_notification_api.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.api.notification_api import NotificationApi + + +class TestNotificationApi(unittest.TestCase): + """NotificationApi unit test stubs""" + + def setUp(self) -> None: + self.api = NotificationApi() + + def tearDown(self) -> None: + pass + + def test_notification_v1_orgs_notifications_bulk_update_partial_update(self) -> None: + """Test case for notification_v1_orgs_notifications_bulk_update_partial_update + + """ + pass + + def test_notification_v1_orgs_notifications_retrieve(self) -> None: + """Test case for notification_v1_orgs_notifications_retrieve + + """ + pass + + def test_notification_v1_orgs_notifications_update(self) -> None: + """Test case for notification_v1_orgs_notifications_update + + """ + pass + + def test_notification_v1_orgs_users_notifications_bulk_update_partial_update(self) -> None: + """Test case for notification_v1_orgs_users_notifications_bulk_update_partial_update + + """ + pass + + def test_notification_v1_orgs_users_notifications_count_retrieve(self) -> None: + """Test case for notification_v1_orgs_users_notifications_count_retrieve + + """ + pass + + def test_notification_v1_orgs_users_notifications_destroy(self) -> None: + """Test case for notification_v1_orgs_users_notifications_destroy + + """ + pass + + def test_notification_v1_orgs_users_notifications_retrieve(self) -> None: + """Test case for notification_v1_orgs_users_notifications_retrieve + + """ + pass + + def test_notification_v1_orgs_users_notifications_update(self) -> None: + """Test case for notification_v1_orgs_users_notifications_update + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notification_count.py b/test/test_notification_count.py new file mode 100644 index 0000000..38e9174 --- /dev/null +++ b/test/test_notification_count.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.notification_count import NotificationCount + +class TestNotificationCount(unittest.TestCase): + """NotificationCount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> NotificationCount: + """Test NotificationCount + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `NotificationCount` + """ + model = NotificationCount() + if include_optional: + return NotificationCount( + status = '', + channel = '' + ) + else: + return NotificationCount( + ) + """ + + def testNotificationCount(self): + """Test NotificationCount""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notification_status_enum.py b/test/test_notification_status_enum.py new file mode 100644 index 0000000..e061939 --- /dev/null +++ b/test/test_notification_status_enum.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.notification_status_enum import NotificationStatusEnum + +class TestNotificationStatusEnum(unittest.TestCase): + """NotificationStatusEnum unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotificationStatusEnum(self): + """Test NotificationStatusEnum""" + # inst = NotificationStatusEnum() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_null_enum.py b/test/test_null_enum.py index a2ba36b..556d794 100644 --- a/test/test_null_enum.py +++ b/test/test_null_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_observation.py b/test/test_observation.py index 1646f29..0b35116 100644 --- a/test/test_observation.py +++ b/test/test_observation.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_order.py b/test/test_order.py index 1bc2dee..f0e21de 100644 --- a/test/test_order.py +++ b/test/test_order.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_over_time.py b/test/test_over_time.py index 143ade9..51aad9c 100644 --- a/test/test_over_time.py +++ b/test/test_over_time.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_overtime.py b/test/test_over_time_with_total.py similarity index 59% rename from test/test_overtime.py rename to test/test_over_time_with_total.py index 4b7bdd4..438193c 100644 --- a/test/test_overtime.py +++ b/test/test_over_time_with_total.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -14,10 +14,10 @@ import unittest -from iblai.models.overtime import Overtime +from iblai.models.over_time_with_total import OverTimeWithTotal -class TestOvertime(unittest.TestCase): - """Overtime unit test stubs""" +class TestOverTimeWithTotal(unittest.TestCase): + """OverTimeWithTotal unit test stubs""" def setUp(self): pass @@ -25,28 +25,28 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> Overtime: - """Test Overtime + def make_instance(self, include_optional) -> OverTimeWithTotal: + """Test OverTimeWithTotal include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `Overtime` + # uncomment below to create an instance of `OverTimeWithTotal` """ - model = Overtime() + model = OverTimeWithTotal() if include_optional: - return Overtime( + return OverTimeWithTotal( data = { 'key' : null }, total = 56 ) else: - return Overtime( + return OverTimeWithTotal( ) """ - def testOvertime(self): - """Test Overtime""" + def testOverTimeWithTotal(self): + """Test OverTimeWithTotal""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_overtime_meta.py b/test/test_overtime_meta.py index 8500614..0fe1714 100644 --- a/test/test_overtime_meta.py +++ b/test/test_overtime_meta.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_overtime_with_change_info.py b/test/test_overtime_with_change_info.py index d5e78f4..e3a8063 100644 --- a/test/test_overtime_with_change_info.py +++ b/test/test_overtime_with_change_info.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_overview_api.py b/test/test_overview_api.py index 8d43204..3f317e9 100644 --- a/test/test_overview_api.py +++ b/test/test_overview_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_page_content.py b/test/test_page_content.py index f647f1e..a5a7aab 100644 --- a/test/test_page_content.py +++ b/test/test_page_content.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_paginated_ai_generated_image_list.py b/test/test_paginated_ai_generated_image_list.py new file mode 100644 index 0000000..88279bd --- /dev/null +++ b/test/test_paginated_ai_generated_image_list.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.paginated_ai_generated_image_list import PaginatedAIGeneratedImageList + +class TestPaginatedAIGeneratedImageList(unittest.TestCase): + """PaginatedAIGeneratedImageList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaginatedAIGeneratedImageList: + """Test PaginatedAIGeneratedImageList + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaginatedAIGeneratedImageList` + """ + model = PaginatedAIGeneratedImageList() + if include_optional: + return PaginatedAIGeneratedImageList( + count = 123, + next = 'http://api.example.org/accounts/?page=4', + previous = 'http://api.example.org/accounts/?page=2', + results = [ + iblai.models.ai_generated_image.AIGeneratedImage( + id = 56, + user = 56, + image = '', + platform = 56, + prompt = '', + model = '', + provider = '', + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ] + ) + else: + return PaginatedAIGeneratedImageList( + ) + """ + + def testPaginatedAIGeneratedImageList(self): + """Test PaginatedAIGeneratedImageList""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paginated_conversations_list.py b/test/test_paginated_conversations_list.py new file mode 100644 index 0000000..48da66e --- /dev/null +++ b/test/test_paginated_conversations_list.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.paginated_conversations_list import PaginatedConversationsList + +class TestPaginatedConversationsList(unittest.TestCase): + """PaginatedConversationsList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaginatedConversationsList: + """Test PaginatedConversationsList + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaginatedConversationsList` + """ + model = PaginatedConversationsList() + if include_optional: + return PaginatedConversationsList( + count = 123, + next = 'http://api.example.org/accounts/?page=4', + previous = 'http://api.example.org/accounts/?page=2', + results = [ + iblai.models.conversations.Conversations( + id = '', + messages = '', + topics = [ + iblai.models.topic_model.TopicModel( + name = '', ) + ], + sentiment = '', + mentor = '', + student = '', + model = '', + rating = '', + inserted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + has_document = True, + memory_tracked = True, + llm_name = '', + llm_provider = '', + metadata = null, + platform = 56, ) + ] + ) + else: + return PaginatedConversationsList( + ) + """ + + def testPaginatedConversationsList(self): + """Test PaginatedConversationsList""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paginated_data_set_list.py b/test/test_paginated_data_set_list.py index 86d3821..29efaa9 100644 --- a/test/test_paginated_data_set_list.py +++ b/test/test_paginated_data_set_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_paginated_job_run_list.py b/test/test_paginated_job_run_list.py index 72c11f9..24c9cde 100644 --- a/test/test_paginated_job_run_list.py +++ b/test/test_paginated_job_run_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_paginated_mentor_list.py b/test/test_paginated_mentor_list.py index 0cd9553..6c7f6b5 100644 --- a/test/test_paginated_mentor_list.py +++ b/test/test_paginated_mentor_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -52,6 +52,9 @@ def make_instance(self, include_optional) -> PaginatedMentorList: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_paginated_moderation_log_list.py b/test/test_paginated_moderation_log_list.py new file mode 100644 index 0000000..d1a9464 --- /dev/null +++ b/test/test_paginated_moderation_log_list.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.paginated_moderation_log_list import PaginatedModerationLogList + +class TestPaginatedModerationLogList(unittest.TestCase): + """PaginatedModerationLogList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaginatedModerationLogList: + """Test PaginatedModerationLogList + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaginatedModerationLogList` + """ + model = PaginatedModerationLogList() + if include_optional: + return PaginatedModerationLogList( + count = 123, + next = 'http://api.example.org/accounts/?page=4', + previous = 'http://api.example.org/accounts/?page=2', + results = [ + iblai.models.moderation_log.ModerationLog( + id = 56, + username = '', + platform_key = '', + mentor = 56, + prompt = '', + reason = '', + target_system = 'Safety System', + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + ] + ) + else: + return PaginatedModerationLogList( + ) + """ + + def testPaginatedModerationLogList(self): + """Test PaginatedModerationLogList""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paginated_periodic_agent_list.py b/test/test_paginated_periodic_agent_list.py index 6fb9494..70351c9 100644 --- a/test/test_paginated_periodic_agent_list.py +++ b/test/test_paginated_periodic_agent_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -54,6 +54,9 @@ def make_instance(self, include_optional) -> PaginatedPeriodicAgentList: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), @@ -80,6 +83,8 @@ def make_instance(self, include_optional) -> PaginatedPeriodicAgentList: one_off = '', platform_key = '', pathway = '', + callback_url = '', + callback_secret = '', parent_session_id = '', parent_mentor_id = 56, previous_agent = 56, diff --git a/test/test_paginated_periodic_agent_log_list.py b/test/test_paginated_periodic_agent_log_list.py index 1228bf0..e61e905 100644 --- a/test/test_paginated_periodic_agent_log_list.py +++ b/test/test_paginated_periodic_agent_log_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_paginated_play_wright_script_list.py b/test/test_paginated_play_wright_script_list.py index eb36b79..b066b17 100644 --- a/test/test_paginated_play_wright_script_list.py +++ b/test/test_paginated_play_wright_script_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_paginated_training_list.py b/test/test_paginated_training_list.py index d4ac622..d3982ef 100644 --- a/test/test_paginated_training_list.py +++ b/test/test_paginated_training_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -61,7 +61,7 @@ def make_instance(self, include_optional) -> PaginatedTrainingList: last_modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), project_name = '', metadata = null, - status = 'pending', + status = 'trained', retry_attempts = 56, fine_tuned_model = '', provider = 'openai', diff --git a/test/test_paginated_user_edx_memory_list.py b/test/test_paginated_user_edx_memory_list.py index c19c9ff..1d4c7b6 100644 --- a/test/test_paginated_user_edx_memory_list.py +++ b/test/test_paginated_user_edx_memory_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_pagination.py b/test/test_pagination.py index 5f619e3..66b5927 100644 --- a/test/test_pagination.py +++ b/test/test_pagination.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_bot_command.py b/test/test_patched_bot_command.py index 4153fa5..2fffe2c 100644 --- a/test/test_patched_bot_command.py +++ b/test/test_patched_bot_command.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_bot_create.py b/test/test_patched_bot_create.py index 53bebe1..cbae08b 100644 --- a/test/test_patched_bot_create.py +++ b/test/test_patched_bot_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_credential_request.py b/test/test_patched_credential_request.py index 507cd8d..6164fb0 100644 --- a/test/test_patched_credential_request.py +++ b/test/test_patched_credential_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_data_set.py b/test/test_patched_data_set.py index cbd5074..d645797 100644 --- a/test/test_patched_data_set.py +++ b/test/test_patched_data_set.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_discord_config.py b/test/test_patched_discord_config.py index c4c14f1..59deff7 100644 --- a/test/test_patched_discord_config.py +++ b/test/test_patched_discord_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_mentor.py b/test/test_patched_mentor.py index 2bd79ad..444f615 100644 --- a/test/test_patched_mentor.py +++ b/test/test_patched_mentor.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -47,6 +47,9 @@ def make_instance(self, include_optional) -> PatchedMentor: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_patched_notification.py b/test/test_patched_notification.py new file mode 100644 index 0000000..18cb160 --- /dev/null +++ b/test/test_patched_notification.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.patched_notification import PatchedNotification + +class TestPatchedNotification(unittest.TestCase): + """PatchedNotification unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PatchedNotification: + """Test PatchedNotification + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PatchedNotification` + """ + model = PatchedNotification() + if include_optional: + return PatchedNotification( + id = '', + username = '', + title = '', + body = '', + status = None, + channel = 56, + context = None, + short_message = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return PatchedNotification( + ) + """ + + def testPatchedNotification(self): + """Test PatchedNotification""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_patched_periodic_agent_create.py b/test/test_patched_periodic_agent_create.py index 3d9977d..4226775 100644 --- a/test/test_patched_periodic_agent_create.py +++ b/test/test_patched_periodic_agent_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -59,6 +59,8 @@ def make_instance(self, include_optional) -> PatchedPeriodicAgentCreate: one_off = '', platform_key = '', pathway = '', + callback_url = '', + callback_secret = '', parent_session_id = '', parent_mentor_id = 56, previous_agent = 56, diff --git a/test/test_patched_platform_public_metadata.py b/test/test_patched_platform_public_metadata.py index fc3372e..5f927a0 100644 --- a/test/test_patched_platform_public_metadata.py +++ b/test/test_patched_platform_public_metadata.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -37,9 +37,7 @@ def make_instance(self, include_optional) -> PatchedPlatformPublicMetadata: return PatchedPlatformPublicMetadata( platform_key = '', platform_name = '', - metadata = None, - created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - last_updated = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + metadata = None ) else: return PatchedPlatformPublicMetadata( diff --git a/test/test_patched_play_wright_script.py b/test/test_patched_play_wright_script.py index 8603658..b36cfb6 100644 --- a/test/test_patched_play_wright_script.py +++ b/test/test_patched_play_wright_script.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_prompt.py b/test/test_patched_prompt.py index 95b6efb..04c9510 100644 --- a/test/test_patched_prompt.py +++ b/test/test_patched_prompt.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_prompt_prompt_visibility.py b/test/test_patched_prompt_prompt_visibility.py index d1f3386..bacd865 100644 --- a/test/test_patched_prompt_prompt_visibility.py +++ b/test/test_patched_prompt_prompt_visibility.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_skill_threshold.py b/test/test_patched_skill_threshold.py index e23f734..8dc1fa5 100644 --- a/test/test_patched_skill_threshold.py +++ b/test/test_patched_skill_threshold.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_slack_config.py b/test/test_patched_slack_config.py index 50cbb5d..ca23cb9 100644 --- a/test/test_patched_slack_config.py +++ b/test/test_patched_slack_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_training_create.py b/test/test_patched_training_create.py index 258836b..44d047e 100644 --- a/test/test_patched_training_create.py +++ b/test/test_patched_training_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_patched_whatsapp_config.py b/test/test_patched_whatsapp_config.py index 8649324..8c233d7 100644 --- a/test/test_patched_whatsapp_config.py +++ b/test/test_patched_whatsapp_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_course_last_access_data.py b/test/test_per_learner_course_last_access_data.py index dde54b6..ad76324 100644 --- a/test/test_per_learner_course_last_access_data.py +++ b/test/test_per_learner_course_last_access_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_course_videos_watched.py b/test/test_per_learner_course_videos_watched.py index 4dd5629..957e57b 100644 --- a/test/test_per_learner_course_videos_watched.py +++ b/test/test_per_learner_course_videos_watched.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_course_videos_watched_data.py b/test/test_per_learner_course_videos_watched_data.py index 864f5e6..23ec1bb 100644 --- a/test/test_per_learner_course_videos_watched_data.py +++ b/test/test_per_learner_course_videos_watched_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_last_access.py b/test/test_per_learner_last_access.py index 7ab23bb..6258b94 100644 --- a/test/test_per_learner_last_access.py +++ b/test/test_per_learner_last_access.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_last_access_data.py b/test/test_per_learner_last_access_data.py index c04a547..8549209 100644 --- a/test/test_per_learner_last_access_data.py +++ b/test/test_per_learner_last_access_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_per_learner_time_spent_in_course_tree.py b/test/test_per_learner_time_spent_in_course_tree.py index 245e9b5..746c611 100644 --- a/test/test_per_learner_time_spent_in_course_tree.py +++ b/test/test_per_learner_time_spent_in_course_tree.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_performance_api.py b/test/test_performance_api.py index f07a08e..0dbf847 100644 --- a/test/test_performance_api.py +++ b/test/test_performance_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_performance_grades_per_course.py b/test/test_performance_grades_per_course.py index 420d799..b2fbf19 100644 --- a/test/test_performance_grades_per_course.py +++ b/test/test_performance_grades_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_performance_grades_per_course_data.py b/test/test_performance_grades_per_course_data.py index 6e99b68..c6e374a 100644 --- a/test/test_performance_grades_per_course_data.py +++ b/test/test_performance_grades_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_periodic_agent.py b/test/test_periodic_agent.py index 2d59b1d..767a2af 100644 --- a/test/test_periodic_agent.py +++ b/test/test_periodic_agent.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -49,6 +49,9 @@ def make_instance(self, include_optional) -> PeriodicAgent: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), @@ -75,6 +78,8 @@ def make_instance(self, include_optional) -> PeriodicAgent: one_off = '', platform_key = '', pathway = '', + callback_url = '', + callback_secret = '', parent_session_id = '', parent_mentor_id = 56, previous_agent = 56, @@ -97,6 +102,9 @@ def make_instance(self, include_optional) -> PeriodicAgent: proactive_prompt = '', moderation_system_prompt = '', moderation_response = '', + safety_system_prompt = '', + safety_response = '', + enable_safety_system = True, proactive_message = '', created_by = '', created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_periodic_agent_create.py b/test/test_periodic_agent_create.py index 524022c..6d462e8 100644 --- a/test/test_periodic_agent_create.py +++ b/test/test_periodic_agent_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -59,6 +59,8 @@ def make_instance(self, include_optional) -> PeriodicAgentCreate: one_off = '', platform_key = '', pathway = '', + callback_url = '', + callback_secret = '', parent_session_id = '', parent_mentor_id = 56, previous_agent = 56, diff --git a/test/test_periodic_agent_log.py b/test/test_periodic_agent_log.py index d3bd6c5..7a7057f 100644 --- a/test/test_periodic_agent_log.py +++ b/test/test_periodic_agent_log.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_periodic_agent_log_status_enum.py b/test/test_periodic_agent_log_status_enum.py index 93e7f8c..c0efe64 100644 --- a/test/test_periodic_agent_log_status_enum.py +++ b/test/test_periodic_agent_log_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_periodic_task.py b/test/test_periodic_task.py index 60f0963..228131a 100644 --- a/test/test_periodic_task.py +++ b/test/test_periodic_task.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_api.py b/test/test_perlearner_api.py index e9070f5..8fc9484 100644 --- a/test/test_perlearner_api.py +++ b/test/test_perlearner_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_course_progress.py b/test/test_perlearner_course_progress.py index d50200f..621e127 100644 --- a/test/test_perlearner_course_progress.py +++ b/test/test_perlearner_course_progress.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_course_progress_data.py b/test/test_perlearner_course_progress_data.py index 39e949a..c862a88 100644 --- a/test/test_perlearner_course_progress_data.py +++ b/test/test_perlearner_course_progress_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_engagement_videos_data.py b/test/test_perlearner_engagement_videos_data.py index 6e170ac..8f4435b 100644 --- a/test/test_perlearner_engagement_videos_data.py +++ b/test/test_perlearner_engagement_videos_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_engagement_videos_watched_per_course.py b/test/test_perlearner_engagement_videos_watched_per_course.py index 09cd3c7..ef4c1b7 100644 --- a/test/test_perlearner_engagement_videos_watched_per_course.py +++ b/test/test_perlearner_engagement_videos_watched_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grade_summary.py b/test/test_perlearner_grade_summary.py index 6ebde0f..f22e32d 100644 --- a/test/test_perlearner_grade_summary.py +++ b/test/test_perlearner_grade_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grade_summary_data.py b/test/test_perlearner_grade_summary_data.py index 9e3e390..61a1fc7 100644 --- a/test/test_perlearner_grade_summary_data.py +++ b/test/test_perlearner_grade_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grade_with_cut_off.py b/test/test_perlearner_grade_with_cut_off.py index dda31ac..9728df8 100644 --- a/test/test_perlearner_grade_with_cut_off.py +++ b/test/test_perlearner_grade_with_cut_off.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grade_with_cut_off_data.py b/test/test_perlearner_grade_with_cut_off_data.py index 419d5e3..d40f1dc 100644 --- a/test/test_perlearner_grade_with_cut_off_data.py +++ b/test/test_perlearner_grade_with_cut_off_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grading_per_course_api.py b/test/test_perlearner_grading_per_course_api.py index 472ec37..a0248fe 100644 --- a/test/test_perlearner_grading_per_course_api.py +++ b/test/test_perlearner_grading_per_course_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_grading_per_course_api_data.py b/test/test_perlearner_grading_per_course_api_data.py index a27e41a..5f26615 100644 --- a/test/test_perlearner_grading_per_course_api_data.py +++ b/test/test_perlearner_grading_per_course_api_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_user_list.py b/test/test_perlearner_user_list.py index 27745fb..c134dd6 100644 --- a/test/test_perlearner_user_list.py +++ b/test/test_perlearner_user_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_perlearner_user_list_data.py b/test/test_perlearner_user_list_data.py index caaeaa1..4b44626 100644 --- a/test/test_perlearner_user_list_data.py +++ b/test/test_perlearner_user_list_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_pinned_message_create.py b/test/test_pinned_message_create.py index 44c3a07..cdc8c7d 100644 --- a/test/test_pinned_message_create.py +++ b/test/test_pinned_message_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_pinned_message_request.py b/test/test_pinned_message_request.py index 7b1296f..b5a3109 100644 --- a/test/test_pinned_message_request.py +++ b/test/test_pinned_message_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_platform_api.py b/test/test_platform_api.py index 8fa8f56..34d600a 100644 --- a/test/test_platform_api.py +++ b/test/test_platform_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_platform_public_metadata.py b/test/test_platform_public_metadata.py index ff5e96c..f820d78 100644 --- a/test/test_platform_public_metadata.py +++ b/test/test_platform_public_metadata.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -37,16 +37,12 @@ def make_instance(self, include_optional) -> PlatformPublicMetadata: return PlatformPublicMetadata( platform_key = '', platform_name = '', - metadata = None, - created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - last_updated = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + metadata = None ) else: return PlatformPublicMetadata( platform_key = '', platform_name = '', - created_on = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - last_updated = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) """ diff --git a/test/test_play_wright_script.py b/test/test_play_wright_script.py index aaea44c..36014fb 100644 --- a/test/test_play_wright_script.py +++ b/test/test_play_wright_script.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_points_percentile.py b/test/test_points_percentile.py index dadfd92..68fb83c 100644 --- a/test/test_points_percentile.py +++ b/test/test_points_percentile.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_predictive_analytics_request.py b/test/test_predictive_analytics_request.py index 61eed0d..c81cd32 100644 --- a/test/test_predictive_analytics_request.py +++ b/test/test_predictive_analytics_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_predictive_analytics_response.py b/test/test_predictive_analytics_response.py index 04152d6..c1995de 100644 --- a/test/test_predictive_analytics_response.py +++ b/test/test_predictive_analytics_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_previous_agent_status_enum.py b/test/test_previous_agent_status_enum.py index 0eadee4..b666691 100644 --- a/test/test_previous_agent_status_enum.py +++ b/test/test_previous_agent_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_product.py b/test/test_product.py index c4ac59e..8048533 100644 --- a/test/test_product.py +++ b/test/test_product.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_product_table.py b/test/test_product_table.py index a3a1d07..be08b8c 100644 --- a/test/test_product_table.py +++ b/test/test_product_table.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_program.py b/test/test_program.py new file mode 100644 index 0000000..bcf31b9 --- /dev/null +++ b/test/test_program.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.program import Program + +class TestProgram(unittest.TestCase): + """Program unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Program: + """Test Program + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Program` + """ + model = Program() + if include_optional: + return Program( + id = 56, + institution = iblai.models.institution.Institution( + id = 56, + name = '', + institution_type = 'university', + location = '', + website = '', + accreditation = '', + established_year = 56, + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + institution_id = 56, + name = '', + program_type = 'bachelors', + duration = 56, + description = '', + data = None, + metadata = None, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return Program( + id = 56, + institution = iblai.models.institution.Institution( + id = 56, + name = '', + institution_type = 'university', + location = '', + website = '', + accreditation = '', + established_year = 56, + data = null, + metadata = null, + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + institution_id = 56, + name = '', + program_type = 'bachelors', + duration = 56, + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + ) + """ + + def testProgram(self): + """Test Program""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_program_type_enum.py b/test/test_program_type_enum.py new file mode 100644 index 0000000..021a14a --- /dev/null +++ b/test/test_program_type_enum.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.program_type_enum import ProgramTypeEnum + +class TestProgramTypeEnum(unittest.TestCase): + """ProgramTypeEnum unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProgramTypeEnum(self): + """Test ProgramTypeEnum""" + # inst = ProgramTypeEnum() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_prompt.py b/test/test_prompt.py index cef133e..ca6ef90 100644 --- a/test/test_prompt.py +++ b/test/test_prompt.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_prompt_category.py b/test/test_prompt_category.py index 87c4b1c..a61278a 100644 --- a/test/test_prompt_category.py +++ b/test/test_prompt_category.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_prompt_visibility_enum.py b/test/test_prompt_visibility_enum.py index 080648e..45c3c19 100644 --- a/test/test_prompt_visibility_enum.py +++ b/test/test_prompt_visibility_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_provider63a_enum.py b/test/test_provider63a_enum.py index ce1e283..dd95283 100644 --- a/test/test_provider63a_enum.py +++ b/test/test_provider63a_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_provider_bd1_enum.py b/test/test_provider_bd1_enum.py index 825e370..61c9cb3 100644 --- a/test/test_provider_bd1_enum.py +++ b/test/test_provider_bd1_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_query_endpoint.py b/test/test_query_endpoint.py index 70681e9..2f9aac4 100644 --- a/test/test_query_endpoint.py +++ b/test/test_query_endpoint.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_rating_enum.py b/test/test_rating_enum.py index 584865d..3c0fbf7 100644 --- a/test/test_rating_enum.py +++ b/test/test_rating_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_recommend_course_response.py b/test/test_recommend_course_response.py index 8417bdf..f6b0b87 100644 --- a/test/test_recommend_course_response.py +++ b/test/test_recommend_course_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_recommendation_search_api.py b/test/test_recommendation_search_api.py index 747ca24..5c5542e 100644 --- a/test/test_recommendation_search_api.py +++ b/test/test_recommendation_search_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_recommendations_api.py b/test/test_recommendations_api.py index 2ae1f02..14aef0a 100644 --- a/test/test_recommendations_api.py +++ b/test/test_recommendations_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_redirect_token_request.py b/test/test_redirect_token_request.py new file mode 100644 index 0000000..4d413a6 --- /dev/null +++ b/test/test_redirect_token_request.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.redirect_token_request import RedirectTokenRequest + +class TestRedirectTokenRequest(unittest.TestCase): + """RedirectTokenRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RedirectTokenRequest: + """Test RedirectTokenRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RedirectTokenRequest` + """ + model = RedirectTokenRequest() + if include_optional: + return RedirectTokenRequest( + url = '' + ) + else: + return RedirectTokenRequest( + url = '', + ) + """ + + def testRedirectTokenRequest(self): + """Test RedirectTokenRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_redirect_token_response.py b/test/test_redirect_token_response.py new file mode 100644 index 0000000..9ef1e62 --- /dev/null +++ b/test/test_redirect_token_response.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.redirect_token_response import RedirectTokenResponse + +class TestRedirectTokenResponse(unittest.TestCase): + """RedirectTokenResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RedirectTokenResponse: + """Test RedirectTokenResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RedirectTokenResponse` + """ + model = RedirectTokenResponse() + if include_optional: + return RedirectTokenResponse( + platform_key = '', + url = '', + token = '' + ) + else: + return RedirectTokenResponse( + platform_key = '', + url = '', + token = '', + ) + """ + + def testRedirectTokenResponse(self): + """Test RedirectTokenResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_related_text.py b/test/test_related_text.py index 7e94802..bf9d102 100644 --- a/test/test_related_text.py +++ b/test/test_related_text.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_report_create.py b/test/test_report_create.py index 35784da..802e11a 100644 --- a/test/test_report_create.py +++ b/test/test_report_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_report_data.py b/test/test_report_data.py index 39e33e2..021267e 100644 --- a/test/test_report_data.py +++ b/test/test_report_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_report_list.py b/test/test_report_list.py index 2ee79ca..1c7951d 100644 --- a/test/test_report_list.py +++ b/test/test_report_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_report_request.py b/test/test_report_request.py index 5d5a9b5..cdcd828 100644 --- a/test/test_report_request.py +++ b/test/test_report_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_report_status.py b/test/test_report_status.py index 0ec9be5..cbdc026 100644 --- a/test/test_report_status.py +++ b/test/test_report_status.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_reported_skill.py b/test/test_reported_skill.py index 1c67666..266ed1a 100644 --- a/test/test_reported_skill.py +++ b/test/test_reported_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_reports_api.py b/test/test_reports_api.py index 68ee027..34f8555 100644 --- a/test/test_reports_api.py +++ b/test/test_reports_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_request_data_variable.py b/test/test_request_data_variable.py index 101058f..82ba6f8 100644 --- a/test/test_request_data_variable.py +++ b/test/test_request_data_variable.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_resource_point.py b/test/test_resource_point.py index bf76384..d693ce8 100644 --- a/test/test_resource_point.py +++ b/test/test_resource_point.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_resource_scrapped_data.py b/test/test_resource_scrapped_data.py new file mode 100644 index 0000000..d66d354 --- /dev/null +++ b/test/test_resource_scrapped_data.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.resource_scrapped_data import ResourceScrappedData + +class TestResourceScrappedData(unittest.TestCase): + """ResourceScrappedData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ResourceScrappedData: + """Test ResourceScrappedData + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ResourceScrappedData` + """ + model = ResourceScrappedData() + if include_optional: + return ResourceScrappedData( + id = 56, + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + last_modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + resource = 56, + content = '', + content_type = '', + extra_data = None + ) + else: + return ResourceScrappedData( + id = 56, + date_created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + last_modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + resource = 56, + ) + """ + + def testResourceScrappedData(self): + """Test ResourceScrappedData""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_response_data_variable.py b/test/test_response_data_variable.py index 34a03c8..b90f06c 100644 --- a/test/test_response_data_variable.py +++ b/test/test_response_data_variable.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retreiver_train_view_request.py b/test/test_retreiver_train_view_request.py index d7acdb6..c0ed84b 100644 --- a/test/test_retreiver_train_view_request.py +++ b/test/test_retreiver_train_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retreiver_train_view_response.py b/test/test_retreiver_train_view_response.py index 1d31ac3..a543b73 100644 --- a/test/test_retreiver_train_view_response.py +++ b/test/test_retreiver_train_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retrieve_task.py b/test/test_retrieve_task.py index 7d4b64e..2f9042c 100644 --- a/test/test_retrieve_task.py +++ b/test/test_retrieve_task.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retriever_document_embedding.py b/test/test_retriever_document_embedding.py index 0843c6c..f3621f7 100644 --- a/test/test_retriever_document_embedding.py +++ b/test/test_retriever_document_embedding.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -36,8 +36,10 @@ def make_instance(self, include_optional) -> RetrieverDocumentEmbedding: if include_optional: return RetrieverDocumentEmbedding( id = 56, + metadata = None, document_name = '', document_type = '', + training_status = None, pathway = '', url = '', tokens = 56, diff --git a/test/test_retriever_document_embedding_request.py b/test/test_retriever_document_embedding_request.py index a3bc351..6ba0396 100644 --- a/test/test_retriever_document_embedding_request.py +++ b/test/test_retriever_document_embedding_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retriever_document_embedding_training_status.py b/test/test_retriever_document_embedding_training_status.py new file mode 100644 index 0000000..777f425 --- /dev/null +++ b/test/test_retriever_document_embedding_training_status.py @@ -0,0 +1,50 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.retriever_document_embedding_training_status import RetrieverDocumentEmbeddingTrainingStatus + +class TestRetrieverDocumentEmbeddingTrainingStatus(unittest.TestCase): + """RetrieverDocumentEmbeddingTrainingStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> RetrieverDocumentEmbeddingTrainingStatus: + """Test RetrieverDocumentEmbeddingTrainingStatus + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `RetrieverDocumentEmbeddingTrainingStatus` + """ + model = RetrieverDocumentEmbeddingTrainingStatus() + if include_optional: + return RetrieverDocumentEmbeddingTrainingStatus( + ) + else: + return RetrieverDocumentEmbeddingTrainingStatus( + ) + """ + + def testRetrieverDocumentEmbeddingTrainingStatus(self): + """Test RetrieverDocumentEmbeddingTrainingStatus""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_retriever_request_search.py b/test/test_retriever_request_search.py index 4cad0d2..536c118 100644 --- a/test/test_retriever_request_search.py +++ b/test/test_retriever_request_search.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retriever_request_search_document.py b/test/test_retriever_request_search_document.py index 47ca75b..f8224cf 100644 --- a/test/test_retriever_request_search_document.py +++ b/test/test_retriever_request_search_document.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_retriever_response_search.py b/test/test_retriever_response_search.py index 33ed927..32bbd2a 100644 --- a/test/test_retriever_response_search.py +++ b/test/test_retriever_response_search.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_reuest_data_variable_list.py b/test/test_reuest_data_variable_list.py index 52fa54f..7b95732 100644 --- a/test/test_reuest_data_variable_list.py +++ b/test/test_reuest_data_variable_list.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_revenue_by_product.py b/test/test_revenue_by_product.py index 0ecce3d..e095bfe 100644 --- a/test/test_revenue_by_product.py +++ b/test/test_revenue_by_product.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_scan_webhook_request.py b/test/test_scan_webhook_request.py new file mode 100644 index 0000000..c502c5e --- /dev/null +++ b/test/test_scan_webhook_request.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.scan_webhook_request import ScanWebhookRequest + +class TestScanWebhookRequest(unittest.TestCase): + """ScanWebhookRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ScanWebhookRequest: + """Test ScanWebhookRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ScanWebhookRequest` + """ + model = ScanWebhookRequest() + if include_optional: + return ScanWebhookRequest( + file_id = '', + filename = '', + status = '', + message = '' + ) + else: + return ScanWebhookRequest( + file_id = '', + filename = '', + status = '', + message = '', + ) + """ + + def testScanWebhookRequest(self): + """Test ScanWebhookRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scan_webhook_response.py b/test/test_scan_webhook_response.py new file mode 100644 index 0000000..4e47f74 --- /dev/null +++ b/test/test_scan_webhook_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.scan_webhook_response import ScanWebhookResponse + +class TestScanWebhookResponse(unittest.TestCase): + """ScanWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ScanWebhookResponse: + """Test ScanWebhookResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ScanWebhookResponse` + """ + model = ScanWebhookResponse() + if include_optional: + return ScanWebhookResponse( + message = '' + ) + else: + return ScanWebhookResponse( + message = '', + ) + """ + + def testScanWebhookResponse(self): + """Test ScanWebhookResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_score.py b/test/test_score.py index 9194dac..d2f7f04 100644 --- a/test/test_score.py +++ b/test/test_score.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_score_summary.py b/test/test_score_summary.py index e442024..d8cfcde 100644 --- a/test/test_score_summary.py +++ b/test/test_score_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_search_api.py b/test/test_search_api.py index 31849a7..9f2e69a 100644 --- a/test/test_search_api.py +++ b/test/test_search_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -38,6 +38,12 @@ def test_search_ai_search_retrieve(self) -> None: """ pass + def test_search_catalog_retrieve(self) -> None: + """Test case for search_catalog_retrieve + + """ + pass + def test_search_documentsearch_retrieve(self) -> None: """Test case for search_documentsearch_retrieve @@ -50,12 +56,24 @@ def test_search_es_health_retrieve(self) -> None: """ pass + def test_search_personalized_catalog_retrieve(self) -> None: + """Test case for search_personalized_catalog_retrieve + + """ + pass + def test_search_search_retrieve(self) -> None: """Test case for search_search_retrieve """ pass + def test_search_users_orgs_users_retrieve(self) -> None: + """Test case for search_users_orgs_users_retrieve + + """ + pass + if __name__ == '__main__': unittest.main() diff --git a/test/test_seed_mentors_view.py b/test/test_seed_mentors_view.py new file mode 100644 index 0000000..6041afa --- /dev/null +++ b/test/test_seed_mentors_view.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.seed_mentors_view import SeedMentorsView + +class TestSeedMentorsView(unittest.TestCase): + """SeedMentorsView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SeedMentorsView: + """Test SeedMentorsView + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SeedMentorsView` + """ + model = SeedMentorsView() + if include_optional: + return SeedMentorsView( + detail = '' + ) + else: + return SeedMentorsView( + detail = '', + ) + """ + + def testSeedMentorsView(self): + """Test SeedMentorsView""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_session_browser_screenshot.py b/test/test_session_browser_screenshot.py index 2e882c9..c133c40 100644 --- a/test/test_session_browser_screenshot.py +++ b/test/test_session_browser_screenshot.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_session_detail.py b/test/test_session_detail.py index 5c73d95..1f81080 100644 --- a/test/test_session_detail.py +++ b/test/test_session_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_shell_logs.py b/test/test_shell_logs.py index d672103..f51ea86 100644 --- a/test/test_shell_logs.py +++ b/test/test_shell_logs.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_skill.py b/test/test_skill.py index bd3a432..dd745b0 100644 --- a/test/test_skill.py +++ b/test/test_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_skill_detail.py b/test/test_skill_detail.py index 248c99b..8cdfb94 100644 --- a/test/test_skill_detail.py +++ b/test/test_skill_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_skill_info.py b/test/test_skill_info.py index 2341338..6277ed3 100644 --- a/test/test_skill_info.py +++ b/test/test_skill_info.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_skill_threshold.py b/test/test_skill_threshold.py index 083032b..7a5d504 100644 --- a/test/test_skill_threshold.py +++ b/test/test_skill_threshold.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_skills_api.py b/test/test_skills_api.py index 226f258..df16bd6 100644 --- a/test/test_skills_api.py +++ b/test/test_skills_api.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_slack_config.py b/test/test_slack_config.py index 694e40b..e9b744d 100644 --- a/test/test_slack_config.py +++ b/test/test_slack_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_slack_webhook.py b/test/test_slack_webhook.py index 978f333..a8f15ee 100644 --- a/test/test_slack_webhook.py +++ b/test/test_slack_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_state_enum.py b/test/test_state_enum.py index 0660b3a..9b6b2ae 100644 --- a/test/test_state_enum.py +++ b/test/test_state_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_step.py b/test/test_step.py index 8c031df..f33cc15 100644 --- a/test/test_step.py +++ b/test/test_step.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_step_status_enum.py b/test/test_step_status_enum.py index 84522bf..9345c8c 100644 --- a/test/test_step_status_enum.py +++ b/test/test_step_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_styles_view.py b/test/test_styles_view.py index 971e018..c75e68d 100644 --- a/test/test_styles_view.py +++ b/test/test_styles_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_sub_time_child.py b/test/test_sub_time_child.py index 0757b51..adb1d38 100644 --- a/test/test_sub_time_child.py +++ b/test/test_sub_time_child.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_summary.py b/test/test_summary.py index 52d1727..7cb4374 100644 --- a/test/test_summary.py +++ b/test/test_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_tags_view.py b/test/test_tags_view.py index f0b2e63..2efb65a 100644 --- a/test/test_tags_view.py +++ b/test/test_tags_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_target_system_enum.py b/test/test_target_system_enum.py new file mode 100644 index 0000000..a14ed51 --- /dev/null +++ b/test/test_target_system_enum.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.target_system_enum import TargetSystemEnum + +class TestTargetSystemEnum(unittest.TestCase): + """TargetSystemEnum unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTargetSystemEnum(self): + """Test TargetSystemEnum""" + # inst = TargetSystemEnum() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_task_view.py b/test/test_task_view.py index 8152d50..8a54085 100644 --- a/test/test_task_view.py +++ b/test/test_task_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_template_mentor.py b/test/test_template_mentor.py new file mode 100644 index 0000000..920046c --- /dev/null +++ b/test/test_template_mentor.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.template_mentor import TemplateMentor + +class TestTemplateMentor(unittest.TestCase): + """TemplateMentor unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TemplateMentor: + """Test TemplateMentor + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TemplateMentor` + """ + model = TemplateMentor() + if include_optional: + return TemplateMentor( + id = 56, + name = '', + slug = 'z', + unique_id = '', + description = '', + system_prompt = '', + platform_key = '' + ) + else: + return TemplateMentor( + id = 56, + name = '', + slug = 'z', + ) + """ + + def testTemplateMentor(self): + """Test TemplateMentor""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tenant_mentor_traces.py b/test/test_tenant_mentor_traces.py index ef1cabb..de0ffa4 100644 --- a/test/test_tenant_mentor_traces.py +++ b/test/test_tenant_mentor_traces.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_theme_enum.py b/test/test_theme_enum.py index 884d1ac..102c7ee 100644 --- a/test/test_theme_enum.py +++ b/test/test_theme_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_child_data.py b/test/test_time_child_data.py index 2eaba5a..6965499 100644 --- a/test/test_time_child_data.py +++ b/test/test_time_child_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_detail.py b/test/test_time_detail.py index 8427f80..c3ecbcc 100644 --- a/test/test_time_detail.py +++ b/test/test_time_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_detail_child.py b/test/test_time_detail_child.py index d20ee0a..8faa45a 100644 --- a/test/test_time_detail_child.py +++ b/test/test_time_detail_child.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_detail_data.py b/test/test_time_detail_data.py index 9459f20..7140696 100644 --- a/test/test_time_detail_data.py +++ b/test/test_time_detail_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_by_users_in_course.py b/test/test_time_spent_by_users_in_course.py index c12ec5e..f5d8afb 100644 --- a/test/test_time_spent_by_users_in_course.py +++ b/test/test_time_spent_by_users_in_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_by_users_in_course_data.py b/test/test_time_spent_by_users_in_course_data.py index 6ff6c81..70d9dd8 100644 --- a/test/test_time_spent_by_users_in_course_data.py +++ b/test/test_time_spent_by_users_in_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_per_course.py b/test/test_time_spent_per_course.py index d74defb..7890cdd 100644 --- a/test/test_time_spent_per_course.py +++ b/test/test_time_spent_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_per_course_data.py b/test/test_time_spent_per_course_data.py index 1a4b16d..335d86c 100644 --- a/test/test_time_spent_per_course_data.py +++ b/test/test_time_spent_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_update_request.py b/test/test_time_spent_update_request.py index e508d58..731450e 100644 --- a/test/test_time_spent_update_request.py +++ b/test/test_time_spent_update_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_time_spent_update_response.py b/test/test_time_spent_update_response.py index 672ec8d..b5cfb44 100644 --- a/test/test_time_spent_update_response.py +++ b/test/test_time_spent_update_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_tones_view.py b/test/test_tones_view.py index 121e807..2287115 100644 --- a/test/test_tones_view.py +++ b/test/test_tones_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_tool_response.py b/test/test_tool_response.py index 1bb538c..2a401fa 100644 --- a/test/test_tool_response.py +++ b/test/test_tool_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -37,9 +37,11 @@ def make_instance(self, include_optional) -> ToolResponse: return ToolResponse( id = 56, name = '', + display_name = '', slug = 'z', description = '', - metadata = None + metadata = None, + allow_retriever_mentors = True ) else: return ToolResponse( diff --git a/test/test_topic.py b/test/test_topic.py index e57034b..b453380 100644 --- a/test/test_topic.py +++ b/test/test_topic.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_topic_conversation.py b/test/test_topic_conversation.py index e585070..f98fd93 100644 --- a/test/test_topic_conversation.py +++ b/test/test_topic_conversation.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_topic_detail.py b/test/test_topic_detail.py index 8260540..47b4e06 100644 --- a/test/test_topic_detail.py +++ b/test/test_topic_detail.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_topic_model.py b/test/test_topic_model.py index 16b3674..2b65a8f 100644 --- a/test/test_topic_model.py +++ b/test/test_topic_model.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_topic_summary_view.py b/test/test_topic_summary_view.py index baa7a9f..64dfa99 100644 --- a/test/test_topic_summary_view.py +++ b/test/test_topic_summary_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_trace.py b/test/test_trace.py index 802ab6e..aad6e67 100644 --- a/test/test_trace.py +++ b/test/test_trace.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_train_chat_session_document_view.py b/test/test_train_chat_session_document_view.py index 09d2a72..e45dc87 100644 --- a/test/test_train_chat_session_document_view.py +++ b/test/test_train_chat_session_document_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_train_chat_session_document_view_request.py b/test/test_train_chat_session_document_view_request.py index b1a4707..a84c649 100644 --- a/test/test_train_chat_session_document_view_request.py +++ b/test/test_train_chat_session_document_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_train_document_view_request.py b/test/test_train_document_view_request.py index c6bfbc2..712b3f3 100644 --- a/test/test_train_document_view_request.py +++ b/test/test_train_document_view_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -40,7 +40,10 @@ def make_instance(self, include_optional) -> TrainDocumentViewRequest: text = '', type = '', file = bytes(b'blah'), - access = 'private' + access = 'private', + branch = '', + google_drive_auth_data = None, + dropbox_auth_data = None ) else: return TrainDocumentViewRequest( diff --git a/test/test_train_document_view_response.py b/test/test_train_document_view_response.py index 7c87811..67d3b89 100644 --- a/test/test_train_document_view_response.py +++ b/test/test_train_document_view_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_training.py b/test/test_training.py index 1caf62f..7d5fcc8 100644 --- a/test/test_training.py +++ b/test/test_training.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -56,7 +56,7 @@ def make_instance(self, include_optional) -> Training: last_modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), project_name = '', metadata = None, - status = 'pending', + status = 'trained', retry_attempts = 56, fine_tuned_model = '', provider = 'openai', diff --git a/test/test_training_create.py b/test/test_training_create.py index 57bc568..9d8acee 100644 --- a/test/test_training_create.py +++ b/test/test_training_create.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_training_status_enum.py b/test/test_training_status_enum.py index 0ad2493..3aad83e 100644 --- a/test/test_training_status_enum.py +++ b/test/test_training_status_enum.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_usage.py b/test/test_usage.py index aaf1668..4ef88a1 100644 --- a/test/test_usage.py +++ b/test/test_usage.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_use_main_creds.py b/test/test_use_main_creds.py index ba09800..fc5283a 100644 --- a/test/test_use_main_creds.py +++ b/test/test_use_main_creds.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_all_chat_memory_view.py b/test/test_user_all_chat_memory_view.py index 443d97b..e948872 100644 --- a/test/test_user_all_chat_memory_view.py +++ b/test/test_user_all_chat_memory_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_catalog_item_memory_view.py b/test/test_user_catalog_item_memory_view.py index 5371663..c8abaa2 100644 --- a/test/test_user_catalog_item_memory_view.py +++ b/test/test_user_catalog_item_memory_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_chat_feedback.py b/test/test_user_chat_feedback.py index 662a066..a4e8cf5 100644 --- a/test/test_user_chat_feedback.py +++ b/test/test_user_chat_feedback.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_chat_feedback_count.py b/test/test_user_chat_feedback_count.py index dbc2d66..9237da1 100644 --- a/test/test_user_chat_feedback_count.py +++ b/test/test_user_chat_feedback_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_chat_memory_status_request_view.py b/test/test_user_chat_memory_status_request_view.py index 96caf65..68bc642 100644 --- a/test/test_user_chat_memory_status_request_view.py +++ b/test/test_user_chat_memory_status_request_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_chat_memory_status_view.py b/test/test_user_chat_memory_status_view.py index bb75bac..0395b91 100644 --- a/test/test_user_chat_memory_status_view.py +++ b/test/test_user_chat_memory_status_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_chat_memory_update_view.py b/test/test_user_chat_memory_update_view.py index ef46839..2bed767 100644 --- a/test/test_user_chat_memory_update_view.py +++ b/test/test_user_chat_memory_update_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_edx_memory.py b/test/test_user_edx_memory.py index d533d19..44251ab 100644 --- a/test/test_user_edx_memory.py +++ b/test/test_user_edx_memory.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_info.py b/test/test_user_info.py new file mode 100644 index 0000000..67047f3 --- /dev/null +++ b/test/test_user_info.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + ibl-data-manager + + API for iblai + + The version of the OpenAPI document: 3.6.0-ai-plus + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from iblai.models.user_info import UserInfo + +class TestUserInfo(unittest.TestCase): + """UserInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UserInfo: + """Test UserInfo + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UserInfo` + """ + model = UserInfo() + if include_optional: + return UserInfo( + id = 56, + username = '', + name = '', + email = '', + active = True, + edx_data = None + ) + else: + return UserInfo( + id = 56, + name = '', + email = '', + active = True, + edx_data = None, + ) + """ + + def testUserInfo(self): + """Test UserInfo""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_memory_context_request.py b/test/test_user_memory_context_request.py index dee4554..7d29297 100644 --- a/test/test_user_memory_context_request.py +++ b/test/test_user_memory_context_request.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_memory_context_response.py b/test/test_user_memory_context_response.py index 61cb737..041e782 100644 --- a/test/test_user_memory_context_response.py +++ b/test/test_user_memory_context_response.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_sentiment_count_view.py b/test/test_user_sentiment_count_view.py index 4438aec..fe6b350 100644 --- a/test/test_user_sentiment_count_view.py +++ b/test/test_user_sentiment_count_view.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_skill.py b/test/test_user_skill.py index b171e85..272be11 100644 --- a/test/test_user_skill.py +++ b/test/test_user_skill.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_user_skill_points_percentile.py b/test/test_user_skill_points_percentile.py index c1dde6b..a854be7 100644 --- a/test/test_user_skill_points_percentile.py +++ b/test/test_user_skill_points_percentile.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_value.py b/test/test_value.py index d04eb39..88fbb40 100644 --- a/test/test_value.py +++ b/test/test_value.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_value_data.py b/test/test_value_data.py index 8dc5ea5..26fb94a 100644 --- a/test/test_value_data.py +++ b/test/test_value_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_video_block.py b/test/test_video_block.py index 42d7afa..c73364c 100644 --- a/test/test_video_block.py +++ b/test/test_video_block.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_video_engagement_per_course.py b/test/test_video_engagement_per_course.py index d0e7502..2111bd4 100644 --- a/test/test_video_engagement_per_course.py +++ b/test/test_video_engagement_per_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_video_engagement_per_course_data.py b/test/test_video_engagement_per_course_data.py index c7e83a7..405cebe 100644 --- a/test/test_video_engagement_per_course_data.py +++ b/test/test_video_engagement_per_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_count.py b/test/test_videos_count.py index ecad6f6..abfd3b1 100644 --- a/test/test_videos_count.py +++ b/test/test_videos_count.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_count_data.py b/test/test_videos_count_data.py index fb004d2..06762cf 100644 --- a/test/test_videos_count_data.py +++ b/test/test_videos_count_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_in_course_summary.py b/test/test_videos_in_course_summary.py index b72469a..2c04afe 100644 --- a/test/test_videos_in_course_summary.py +++ b/test/test_videos_in_course_summary.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_in_course_summary_data.py b/test/test_videos_in_course_summary_data.py index bf06aae..0b250a7 100644 --- a/test/test_videos_in_course_summary_data.py +++ b/test/test_videos_in_course_summary_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_specific_course.py b/test/test_videos_specific_course.py index cd2173a..d42105b 100644 --- a/test/test_videos_specific_course.py +++ b/test/test_videos_specific_course.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_specific_course_data.py b/test/test_videos_specific_course_data.py index 9aceaae..d627993 100644 --- a/test/test_videos_specific_course_data.py +++ b/test/test_videos_specific_course_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_videos_watched_sub_section.py b/test/test_videos_watched_sub_section.py index f38ce81..4fb1c3f 100644 --- a/test/test_videos_watched_sub_section.py +++ b/test/test_videos_watched_sub_section.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_watched_videos_per_user.py b/test/test_watched_videos_per_user.py index 88b6a97..fc87b6b 100644 --- a/test/test_watched_videos_per_user.py +++ b/test/test_watched_videos_per_user.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_watched_videos_per_user_data.py b/test/test_watched_videos_per_user_data.py index 9daee74..0174703 100644 --- a/test/test_watched_videos_per_user_data.py +++ b/test/test_watched_videos_per_user_data.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_webex_webhook.py b/test/test_webex_webhook.py index fbc594a..2cb4e7d 100644 --- a/test/test_webex_webhook.py +++ b/test/test_webex_webhook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_what_app_web_hook.py b/test/test_what_app_web_hook.py index b16887e..79422af 100644 --- a/test/test_what_app_web_hook.py +++ b/test/test_what_app_web_hook.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/test/test_whatsapp_config.py b/test/test_whatsapp_config.py index 404c88c..fa292a3 100644 --- a/test/test_whatsapp_config.py +++ b/test/test_whatsapp_config.py @@ -5,7 +5,7 @@ API for iblai - The version of the OpenAPI document: 2.4.1-ai-plus + The version of the OpenAPI document: 3.6.0-ai-plus Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually.