mindroot 9.10.0__py3-none-any.whl → 9.12.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of mindroot might be problematic. Click here for more details.
- mindroot/__init__.py +1 -0
- mindroot/coreplugins/__init__.py +2 -0
- mindroot/coreplugins/home/templates/home.jinja2 +1 -0
- mindroot/docs/Makefile +20 -0
- mindroot/docs/_build/doctrees/chat_with_assistant.doctree +0 -0
- mindroot/docs/_build/doctrees/developer_documentation.doctree +0 -0
- mindroot/docs/_build/doctrees/environment.pickle +0 -0
- mindroot/docs/_build/doctrees/getting_started.doctree +0 -0
- mindroot/docs/_build/doctrees/index.doctree +0 -0
- mindroot/docs/_build/doctrees/install_plugins_with_tools.doctree +0 -0
- mindroot/docs/_build/doctrees/installation.doctree +0 -0
- mindroot/docs/_build/doctrees/llm_api_key.doctree +0 -0
- mindroot/docs/_build/doctrees/llm_plugin_installation.doctree +0 -0
- mindroot/docs/_build/doctrees/programming_task.doctree +0 -0
- mindroot/docs/_build/doctrees/source/ahp.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.admin.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.api_keys.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.chat.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.chat_avatar.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.check_list.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.credits.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.email.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.env_manager.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.events.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.index.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.index.handlers.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.jwt_auth.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.l8n.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.mcp_.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.persona.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.startup.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.subscriptions.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.usage.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.coreplugins.user_service.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.auth.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.json_str_block.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.plugins.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.providers.backup.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.lib.providers.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mindroot.registry.doctree +0 -0
- mindroot/docs/_build/doctrees/source/modules.doctree +0 -0
- mindroot/docs/_build/doctrees/source/mr_agent_expert_instr.doctree +0 -0
- mindroot/docs/_build/doctrees/starting_mindroot.doctree +0 -0
- mindroot/docs/_build/doctrees/user_documentation.doctree +0 -0
- mindroot/docs/_build/html/.buildinfo +4 -0
- mindroot/docs/_build/html/.buildinfo.bak +4 -0
- mindroot/docs/_build/html/_images/envvar.png +0 -0
- mindroot/docs/_build/html/_images/files.png +0 -0
- mindroot/docs/_build/html/_images/installopenrouter.png +0 -0
- mindroot/docs/_build/html/_images/mood.png +0 -0
- mindroot/docs/_build/html/_images/moon.png +0 -0
- mindroot/docs/_build/html/_images/openrouter.png +0 -0
- mindroot/docs/_build/html/_images/restart.png +0 -0
- mindroot/docs/_build/html/_modules/index.html +425 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/agent_importer.html +292 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/agent_router.html +620 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/asset_manager.html +289 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/command_router.html +518 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/mcp_catalog_routes.html +275 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/mcp_publish_routes.html +581 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/mcp_registry_routes.html +623 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/mcp_routes.html +347 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/mod.html +163 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/oauth_callback_router.html +188 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/persona_handler.html +195 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/persona_router.html +428 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/plugin_manager.html +610 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/plugin_router.html +146 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/plugin_routes.html +230 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/registry_settings_routes.html +253 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/router.html +267 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/server_router.html +271 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/service_models.html +195 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/admin/settings_router.html +403 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/api_keys/api_key_manager.html +215 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/api_keys/mod.html +127 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/api_keys/router.html +170 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/commands.html +565 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/mod.html +118 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/models.html +130 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/router.html +571 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/services.html +645 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/widget_manager.html +258 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/chat/widget_routes.html +409 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/check_list/mod.html +460 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/conversion.html +232 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/ledger.html +283 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/mod.html +355 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/models.html +269 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/router.html +306 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/storage.html +257 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/email_provider.html +159 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/imap_handler.html +343 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/mod.html +210 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/services.html +172 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/smtp_handler.html +188 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/email/test_email_service.html +179 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/env_manager/mod.html +409 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/env_manager/router.html +147 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/events/router.html +201 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/handlers/agent_ops.html +195 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/handlers/index_ops.html +214 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/handlers/plugin_ops.html +263 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/handlers/publish.html +225 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/mod.html +120 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/models.html +148 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/router.html +184 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/index/utils.html +166 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/jwt_auth/middleware.html +400 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/jwt_auth/mod.html +153 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/jwt_auth/router.html +134 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/language_detection.html +296 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/middleware.html +258 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/mod.html +393 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/test_enhanced.html +408 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/test_l8n_standalone.html +379 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/test_middleware.html +394 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/l8n/utils.html +348 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/catalog_commands.html +456 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/catalog_manager.html +409 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/dynamic_commands.html +267 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/mcp_manager.html +1186 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/mod.html +510 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/oauth_storage.html +260 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/server_installer.html +195 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/mcp_/testmcpclient.html +217 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/persona/init_persona.html +117 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/persona/mod.html +276 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/startup/mod.html +122 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/credit_integration.html +163 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/mod.html +1089 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/models.html +261 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/router.html +502 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/storage.html +413 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/stripe_integration.html +178 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/subscription_manager.html +289 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/subscriptions/webhook_handler.html +327 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/handlers.html +157 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/mod.html +253 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/models.html +141 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/reporting.html +226 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/router.html +228 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/usage/storage.html +264 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/admin_init.html +234 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/email_service.html +204 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/mod.html +260 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/models.html +148 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/password_reset_service.html +336 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/role_service.html +183 -0
- mindroot/docs/_build/html/_modules/mindroot/coreplugins/user_service/router.html +202 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/auth/api_key.html +129 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/auth/auth.html +203 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/buchatlog.html +259 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/buchatlog2.html +500 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/butemplates.html +415 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/chatcontext.html +401 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/chatlog.html +619 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/chatlog_optimized.html +655 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/json_escape.html +138 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/json_str_block/json_str_block.html +213 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/parent_templates.html +181 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/installation.html +481 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/l8n_static_handler.html +347 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/loader.html +403 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/loader_with_l8n.html +391 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/manifest.html +450 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/mapping.html +127 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins/paths.html +215 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/plugins_install.html +171 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers/commands.html +125 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers/hooks.html +117 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers/missing.html +169 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers/model_preferences_v2.html +291 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers/services.html +122 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/providers.html +465 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/route_decorators.html +175 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/session_files.html +142 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/streamcmd.html +246 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/templates.html +677 -0
- mindroot/docs/_build/html/_modules/mindroot/lib/token_counter.html +326 -0
- mindroot/docs/_build/html/_modules/mindroot/migrate.html +153 -0
- mindroot/docs/_build/html/_modules/mindroot/registry/component_manager.html +140 -0
- mindroot/docs/_build/html/_modules/mindroot/registry/data_access.html +302 -0
- mindroot/docs/_build/html/_modules/mindroot/server.html +317 -0
- mindroot/docs/_build/html/_modules/mindroot/server_missing_normal_args.html +322 -0
- mindroot/docs/_build/html/_modules/mindroot/server_prev.html +298 -0
- mindroot/docs/_build/html/_sources/chat_with_assistant.rst.txt +14 -0
- mindroot/docs/_build/html/_sources/developer_documentation.rst.txt +26 -0
- mindroot/docs/_build/html/_sources/getting_started.rst.txt +139 -0
- mindroot/docs/_build/html/_sources/index.rst.txt +38 -0
- mindroot/docs/_build/html/_sources/install_plugins_with_tools.rst.txt +25 -0
- mindroot/docs/_build/html/_sources/installation.rst.txt +21 -0
- mindroot/docs/_build/html/_sources/llm_api_key.rst.txt +22 -0
- mindroot/docs/_build/html/_sources/llm_plugin_installation.rst.txt +27 -0
- mindroot/docs/_build/html/_sources/programming_task.rst.txt +10 -0
- mindroot/docs/_build/html/_sources/source/ahp.rst.txt +7 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.admin.rst.txt +189 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.api_keys.rst.txt +45 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.chat.rst.txt +93 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.chat_avatar.rst.txt +10 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.check_list.rst.txt +21 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.credits.rst.txt +61 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.email.rst.txt +77 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.env_manager.rst.txt +29 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.events.rst.txt +29 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.index.handlers.rst.txt +45 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.index.rst.txt +53 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.jwt_auth.rst.txt +45 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.l8n.rst.txt +109 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.mcp_.rst.txt +93 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.persona.rst.txt +29 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.rst.txt +35 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.startup.rst.txt +21 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.subscriptions.rst.txt +85 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.usage.rst.txt +61 -0
- mindroot/docs/_build/html/_sources/source/mindroot.coreplugins.user_service.rst.txt +69 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.auth.rst.txt +29 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.json_str_block.rst.txt +21 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.plugins.rst.txt +69 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.providers.backup.rst.txt +10 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.providers.rst.txt +61 -0
- mindroot/docs/_build/html/_sources/source/mindroot.lib.rst.txt +152 -0
- mindroot/docs/_build/html/_sources/source/mindroot.registry.rst.txt +29 -0
- mindroot/docs/_build/html/_sources/source/mindroot.rst.txt +54 -0
- mindroot/docs/_build/html/_sources/source/modules.rst.txt +7 -0
- mindroot/docs/_build/html/_sources/source/mr_agent_expert_instr.rst.txt +7 -0
- mindroot/docs/_build/html/_sources/starting_mindroot.rst.txt +12 -0
- mindroot/docs/_build/html/_sources/user_documentation.rst.txt +16 -0
- mindroot/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js +123 -0
- mindroot/docs/_build/html/_static/basic.css +906 -0
- mindroot/docs/_build/html/_static/css/badge_only.css +1 -0
- mindroot/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot +0 -0
- mindroot/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg +2671 -0
- mindroot/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf +0 -0
- mindroot/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-bold-italic.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-bold.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-bold.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-normal-italic.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-normal.woff +0 -0
- mindroot/docs/_build/html/_static/css/fonts/lato-normal.woff2 +0 -0
- mindroot/docs/_build/html/_static/css/theme.css +4 -0
- mindroot/docs/_build/html/_static/custom.css +19 -0
- mindroot/docs/_build/html/_static/debug.css +69 -0
- mindroot/docs/_build/html/_static/doctools.js +149 -0
- mindroot/docs/_build/html/_static/documentation_options.js +13 -0
- mindroot/docs/_build/html/_static/file.png +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bold.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bold.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bold.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bold.woff2 +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bolditalic.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bolditalic.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff2 +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-italic.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-italic.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-italic.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-italic.woff2 +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-regular.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-regular.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-regular.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/Lato/lato-regular.woff2 +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff +0 -0
- mindroot/docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 +0 -0
- mindroot/docs/_build/html/_static/jquery.js +2 -0
- mindroot/docs/_build/html/_static/js/badge_only.js +1 -0
- mindroot/docs/_build/html/_static/js/theme.js +1 -0
- mindroot/docs/_build/html/_static/js/versions.js +228 -0
- mindroot/docs/_build/html/_static/language_data.js +192 -0
- mindroot/docs/_build/html/_static/minus.png +0 -0
- mindroot/docs/_build/html/_static/plus.png +0 -0
- mindroot/docs/_build/html/_static/pygments.css +232 -0
- mindroot/docs/_build/html/_static/scripts/furo-extensions.js +0 -0
- mindroot/docs/_build/html/_static/scripts/furo.js +3 -0
- mindroot/docs/_build/html/_static/scripts/furo.js.LICENSE.txt +7 -0
- mindroot/docs/_build/html/_static/scripts/furo.js.map +1 -0
- mindroot/docs/_build/html/_static/searchtools.js +635 -0
- mindroot/docs/_build/html/_static/skeleton.css +296 -0
- mindroot/docs/_build/html/_static/sphinx_highlight.js +154 -0
- mindroot/docs/_build/html/_static/styles/furo-extensions.css +2 -0
- mindroot/docs/_build/html/_static/styles/furo-extensions.css.map +1 -0
- mindroot/docs/_build/html/_static/styles/furo.css +2 -0
- mindroot/docs/_build/html/_static/styles/furo.css.map +1 -0
- mindroot/docs/_build/html/chat_with_assistant.html +329 -0
- mindroot/docs/_build/html/developer_documentation.html +338 -0
- mindroot/docs/_build/html/genindex.html +4690 -0
- mindroot/docs/_build/html/getting_started.html +423 -0
- mindroot/docs/_build/html/index.html +357 -0
- mindroot/docs/_build/html/install_plugins_with_tools.html +336 -0
- mindroot/docs/_build/html/installation.html +330 -0
- mindroot/docs/_build/html/llm_api_key.html +337 -0
- mindroot/docs/_build/html/llm_plugin_installation.html +338 -0
- mindroot/docs/_build/html/objects.inv +0 -0
- mindroot/docs/_build/html/programming_task.html +326 -0
- mindroot/docs/_build/html/py-modindex.html +1307 -0
- mindroot/docs/_build/html/search.html +307 -0
- mindroot/docs/_build/html/searchindex.js +1 -0
- mindroot/docs/_build/html/source/ahp.html +302 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.admin.html +2212 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.api_keys.html +532 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.chat.html +1185 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.chat_avatar.html +311 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.check_list.html +441 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.credits.html +879 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.email.html +554 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.env_manager.html +447 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.events.html +338 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.html +1785 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.index.handlers.html +481 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.index.html +696 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.jwt_auth.html +432 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.l8n.html +933 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.mcp_.html +1271 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.persona.html +386 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.startup.html +327 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.subscriptions.html +1631 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.usage.html +677 -0
- mindroot/docs/_build/html/source/mindroot.coreplugins.user_service.html +681 -0
- mindroot/docs/_build/html/source/mindroot.html +811 -0
- mindroot/docs/_build/html/source/mindroot.lib.auth.html +407 -0
- mindroot/docs/_build/html/source/mindroot.lib.html +2027 -0
- mindroot/docs/_build/html/source/mindroot.lib.json_str_block.html +344 -0
- mindroot/docs/_build/html/source/mindroot.lib.plugins.html +1050 -0
- mindroot/docs/_build/html/source/mindroot.lib.providers.backup.html +324 -0
- mindroot/docs/_build/html/source/mindroot.lib.providers.html +572 -0
- mindroot/docs/_build/html/source/mindroot.registry.html +501 -0
- mindroot/docs/_build/html/source/modules.html +377 -0
- mindroot/docs/_build/html/source/mr_agent_expert_instr.html +302 -0
- mindroot/docs/_build/html/starting_mindroot.html +325 -0
- mindroot/docs/_build/html/user_documentation.html +333 -0
- mindroot/docs/_static/custom.css +19 -0
- mindroot/docs/chat_with_assistant.rst +14 -0
- mindroot/docs/conf.py +54 -0
- mindroot/docs/data/agents/local/Assistant/agent.json +27 -0
- mindroot/docs/data/agents/local/SysAdmin/agent.json +33 -0
- mindroot/docs/data/equivalent_flags.json +1 -0
- mindroot/docs/data/mcp/servers.json +9 -0
- mindroot/docs/data/models.json +57 -0
- mindroot/docs/data/plugin_manifest.json +95 -0
- mindroot/docs/data/preferred_models.json +12 -0
- mindroot/docs/data/providers.json +62 -0
- mindroot/docs/developer_documentation.rst +26 -0
- mindroot/docs/envvar.png +0 -0
- mindroot/docs/files.png +0 -0
- mindroot/docs/getting_started.rst +139 -0
- mindroot/docs/index.rst +38 -0
- mindroot/docs/install_plugins_with_tools.rst +25 -0
- mindroot/docs/installation.rst +21 -0
- mindroot/docs/installopenrouter.png +0 -0
- mindroot/docs/llm_api_key.rst +22 -0
- mindroot/docs/llm_plugin_installation.rst +27 -0
- mindroot/docs/make.bat +35 -0
- mindroot/docs/mood.png +0 -0
- mindroot/docs/moon.png +0 -0
- mindroot/docs/openrouter.png +0 -0
- mindroot/docs/personas/local/Assistant/avatar.png +0 -0
- mindroot/docs/personas/local/Assistant/faceref.png +0 -0
- mindroot/docs/personas/local/Assistant/persona.json +7 -0
- mindroot/docs/programming_task.rst +10 -0
- mindroot/docs/restart.png +0 -0
- mindroot/docs/source/ahp.rst +7 -0
- mindroot/docs/source/mindroot.coreplugins.admin.rst +189 -0
- mindroot/docs/source/mindroot.coreplugins.api_keys.rst +45 -0
- mindroot/docs/source/mindroot.coreplugins.chat.rst +93 -0
- mindroot/docs/source/mindroot.coreplugins.chat_avatar.rst +10 -0
- mindroot/docs/source/mindroot.coreplugins.check_list.rst +21 -0
- mindroot/docs/source/mindroot.coreplugins.credits.rst +61 -0
- mindroot/docs/source/mindroot.coreplugins.email.rst +77 -0
- mindroot/docs/source/mindroot.coreplugins.env_manager.rst +29 -0
- mindroot/docs/source/mindroot.coreplugins.events.rst +29 -0
- mindroot/docs/source/mindroot.coreplugins.index.handlers.rst +45 -0
- mindroot/docs/source/mindroot.coreplugins.index.rst +53 -0
- mindroot/docs/source/mindroot.coreplugins.jwt_auth.rst +45 -0
- mindroot/docs/source/mindroot.coreplugins.l8n.rst +109 -0
- mindroot/docs/source/mindroot.coreplugins.mcp_.rst +93 -0
- mindroot/docs/source/mindroot.coreplugins.persona.rst +29 -0
- mindroot/docs/source/mindroot.coreplugins.rst +35 -0
- mindroot/docs/source/mindroot.coreplugins.startup.rst +21 -0
- mindroot/docs/source/mindroot.coreplugins.subscriptions.rst +85 -0
- mindroot/docs/source/mindroot.coreplugins.usage.rst +61 -0
- mindroot/docs/source/mindroot.coreplugins.user_service.rst +69 -0
- mindroot/docs/source/mindroot.lib.auth.rst +29 -0
- mindroot/docs/source/mindroot.lib.json_str_block.rst +21 -0
- mindroot/docs/source/mindroot.lib.plugins.rst +69 -0
- mindroot/docs/source/mindroot.lib.providers.backup.rst +10 -0
- mindroot/docs/source/mindroot.lib.providers.rst +61 -0
- mindroot/docs/source/mindroot.lib.rst +152 -0
- mindroot/docs/source/mindroot.registry.rst +29 -0
- mindroot/docs/source/mindroot.rst +54 -0
- mindroot/docs/source/modules.rst +7 -0
- mindroot/docs/source/mr_agent_expert_instr.rst +7 -0
- mindroot/docs/starting_mindroot.rst +12 -0
- mindroot/docs/user_documentation.rst +16 -0
- mindroot/lib/plugins/default_plugin_manifest.json +1 -1
- mindroot/server.py +10 -1
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/METADATA +1 -1
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/RECORD +418 -10
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/WHEEL +0 -0
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/entry_points.txt +0 -0
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/licenses/LICENSE +0 -0
- {mindroot-9.10.0.dist-info → mindroot-9.12.0.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,1631 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="no-js" lang="en" data-content_root="../">
|
|
3
|
+
<head><meta charset="utf-8"/>
|
|
4
|
+
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
5
|
+
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
6
|
+
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
|
|
7
|
+
|
|
8
|
+
<!-- Generated with Sphinx 8.2.3 and Furo 2025.07.19 -->
|
|
9
|
+
<title>mindroot.coreplugins.subscriptions package - MindRoot 9.10.0 documentation</title>
|
|
10
|
+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
|
11
|
+
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=25af2a20" />
|
|
12
|
+
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
|
13
|
+
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=f4b9d74b" />
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<style>
|
|
19
|
+
body {
|
|
20
|
+
--color-code-background: #f2f2f2;
|
|
21
|
+
--color-code-foreground: #1e1e1e;
|
|
22
|
+
--color-brand-primary: #007acc;
|
|
23
|
+
--color-brand-content: #007acc;
|
|
24
|
+
|
|
25
|
+
}
|
|
26
|
+
@media not print {
|
|
27
|
+
body[data-theme="dark"] {
|
|
28
|
+
--color-code-background: #2b2b2b;
|
|
29
|
+
--color-code-foreground: #f8f8f2;
|
|
30
|
+
--color-brand-primary: #ff7b72;
|
|
31
|
+
--color-brand-content: #ff7b72;
|
|
32
|
+
|
|
33
|
+
}
|
|
34
|
+
@media (prefers-color-scheme: dark) {
|
|
35
|
+
body:not([data-theme="light"]) {
|
|
36
|
+
--color-code-background: #2b2b2b;
|
|
37
|
+
--color-code-foreground: #f8f8f2;
|
|
38
|
+
--color-brand-primary: #ff7b72;
|
|
39
|
+
--color-brand-content: #ff7b72;
|
|
40
|
+
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
</style></head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
<script>
|
|
48
|
+
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
49
|
+
</script>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
53
|
+
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
54
|
+
<title>Contents</title>
|
|
55
|
+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
56
|
+
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
57
|
+
</svg>
|
|
58
|
+
</symbol>
|
|
59
|
+
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
60
|
+
<title>Menu</title>
|
|
61
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
62
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
63
|
+
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
64
|
+
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
65
|
+
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
66
|
+
</svg>
|
|
67
|
+
</symbol>
|
|
68
|
+
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
69
|
+
<title>Expand</title>
|
|
70
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
71
|
+
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
72
|
+
<polyline points="9 18 15 12 9 6"></polyline>
|
|
73
|
+
</svg>
|
|
74
|
+
</symbol>
|
|
75
|
+
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
76
|
+
<title>Light mode</title>
|
|
77
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
78
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
79
|
+
<circle cx="12" cy="12" r="5"></circle>
|
|
80
|
+
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
81
|
+
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
82
|
+
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
83
|
+
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
84
|
+
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
85
|
+
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
86
|
+
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
87
|
+
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
88
|
+
</svg>
|
|
89
|
+
</symbol>
|
|
90
|
+
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
91
|
+
<title>Dark mode</title>
|
|
92
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
93
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
94
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
95
|
+
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
96
|
+
</svg>
|
|
97
|
+
</symbol>
|
|
98
|
+
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
|
99
|
+
<title>Auto light/dark, in light mode</title>
|
|
100
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
101
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
102
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
103
|
+
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
|
104
|
+
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
|
105
|
+
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
|
106
|
+
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
|
107
|
+
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
|
108
|
+
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
|
109
|
+
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
|
110
|
+
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
|
111
|
+
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
|
112
|
+
<circle cx="14.5" cy="9.55" r="3.6"/>
|
|
113
|
+
</svg>
|
|
114
|
+
</symbol>
|
|
115
|
+
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
|
116
|
+
<title>Auto light/dark, in dark mode</title>
|
|
117
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
118
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
|
119
|
+
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
|
120
|
+
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
|
121
|
+
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
|
122
|
+
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
|
123
|
+
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
|
124
|
+
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
|
125
|
+
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
|
126
|
+
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
|
127
|
+
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
|
128
|
+
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
|
129
|
+
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
|
130
|
+
</svg>
|
|
131
|
+
</symbol>
|
|
132
|
+
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
|
133
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
134
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
|
135
|
+
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
|
136
|
+
<path d="M13.5 6.5l4 4" />
|
|
137
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
138
|
+
<path d="M17 17l-2 2l2 2" />
|
|
139
|
+
</svg>
|
|
140
|
+
</symbol>
|
|
141
|
+
<symbol id="svg-eye" viewBox="0 0 24 24">
|
|
142
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
143
|
+
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
|
144
|
+
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
145
|
+
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
|
146
|
+
<path
|
|
147
|
+
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
|
148
|
+
<path d="M20 21l2 -2l-2 -2" />
|
|
149
|
+
<path d="M17 17l-2 2l2 2" />
|
|
150
|
+
</svg>
|
|
151
|
+
</symbol>
|
|
152
|
+
</svg>
|
|
153
|
+
|
|
154
|
+
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
155
|
+
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
156
|
+
<label class="overlay sidebar-overlay" for="__navigation">
|
|
157
|
+
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
158
|
+
</label>
|
|
159
|
+
<label class="overlay toc-overlay" for="__toc">
|
|
160
|
+
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
161
|
+
</label>
|
|
162
|
+
|
|
163
|
+
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<div class="page">
|
|
168
|
+
<header class="mobile-header">
|
|
169
|
+
<div class="header-left">
|
|
170
|
+
<label class="nav-overlay-icon" for="__navigation">
|
|
171
|
+
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
172
|
+
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
173
|
+
</label>
|
|
174
|
+
</div>
|
|
175
|
+
<div class="header-center">
|
|
176
|
+
<a href="../index.html"><div class="brand">MindRoot 9.10.0 documentation</div></a>
|
|
177
|
+
</div>
|
|
178
|
+
<div class="header-right">
|
|
179
|
+
<div class="theme-toggle-container theme-toggle-header">
|
|
180
|
+
<button class="theme-toggle">
|
|
181
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
182
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
183
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
184
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
185
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
186
|
+
</button>
|
|
187
|
+
</div>
|
|
188
|
+
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
189
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
190
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
191
|
+
</label>
|
|
192
|
+
</div>
|
|
193
|
+
</header>
|
|
194
|
+
<aside class="sidebar-drawer">
|
|
195
|
+
<div class="sidebar-container">
|
|
196
|
+
|
|
197
|
+
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
|
201
|
+
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
202
|
+
<input type="hidden" name="check_keywords" value="yes">
|
|
203
|
+
<input type="hidden" name="area" value="default">
|
|
204
|
+
</form>
|
|
205
|
+
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
206
|
+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
207
|
+
<ul>
|
|
208
|
+
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
|
|
209
|
+
</ul>
|
|
210
|
+
|
|
211
|
+
</div>
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
</div>
|
|
217
|
+
</aside>
|
|
218
|
+
<div class="main">
|
|
219
|
+
<div class="content">
|
|
220
|
+
<div class="article-container">
|
|
221
|
+
<a href="#" class="back-to-top muted-link">
|
|
222
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
223
|
+
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
224
|
+
</svg>
|
|
225
|
+
<span>Back to top</span>
|
|
226
|
+
</a>
|
|
227
|
+
<div class="content-icon-container">
|
|
228
|
+
<div class="view-this-page">
|
|
229
|
+
<a class="muted-link" href="../_sources/source/mindroot.coreplugins.subscriptions.rst.txt" title="View this page">
|
|
230
|
+
<svg><use href="#svg-eye"></use></svg>
|
|
231
|
+
<span class="visually-hidden">View this page</span>
|
|
232
|
+
</a>
|
|
233
|
+
</div>
|
|
234
|
+
<div class="theme-toggle-container theme-toggle-content">
|
|
235
|
+
<button class="theme-toggle">
|
|
236
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
237
|
+
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
|
238
|
+
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
|
239
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
240
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
241
|
+
</button>
|
|
242
|
+
</div>
|
|
243
|
+
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
244
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
245
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
246
|
+
</label>
|
|
247
|
+
</div>
|
|
248
|
+
<article role="main" id="furo-main-content">
|
|
249
|
+
<section id="mindroot-coreplugins-subscriptions-package">
|
|
250
|
+
<h1>mindroot.coreplugins.subscriptions package<a class="headerlink" href="#mindroot-coreplugins-subscriptions-package" title="Link to this heading">¶</a></h1>
|
|
251
|
+
<section id="submodules">
|
|
252
|
+
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
|
|
253
|
+
</section>
|
|
254
|
+
<section id="module-mindroot.coreplugins.subscriptions.credit_integration">
|
|
255
|
+
<span id="mindroot-coreplugins-subscriptions-credit-integration-module"></span><h2>mindroot.coreplugins.subscriptions.credit_integration module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.credit_integration" title="Link to this heading">¶</a></h2>
|
|
256
|
+
<dl class="py class">
|
|
257
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration">
|
|
258
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.credit_integration.</span></span><span class="sig-name descname"><span class="pre">CreditIntegration</span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/credit_integration.html#CreditIntegration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration" title="Link to this definition">¶</a></dt>
|
|
259
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
260
|
+
<p>Handles integration with the credits plugin for subscription-related credit operations</p>
|
|
261
|
+
<dl class="py method">
|
|
262
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.allocate_subscription_credits">
|
|
263
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allocate_subscription_credits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">amount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/credit_integration.html#CreditIntegration.allocate_subscription_credits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.allocate_subscription_credits" title="Link to this definition">¶</a></dt>
|
|
264
|
+
<dd><p>Allocate credits to a user based on their subscription</p>
|
|
265
|
+
<dl class="field-list simple">
|
|
266
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
267
|
+
<dd class="field-odd"><ul class="simple">
|
|
268
|
+
<li><p><strong>username</strong> – User to allocate credits to</p></li>
|
|
269
|
+
<li><p><strong>amount</strong> – Amount of credits to allocate</p></li>
|
|
270
|
+
<li><p><strong>subscription_id</strong> – Subscription ID for reference</p></li>
|
|
271
|
+
<li><p><strong>metadata</strong> – Additional information about the allocation</p></li>
|
|
272
|
+
</ul>
|
|
273
|
+
</dd>
|
|
274
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
275
|
+
<dd class="field-even"><p>New credit balance</p>
|
|
276
|
+
</dd>
|
|
277
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
278
|
+
<dd class="field-odd"><p>float</p>
|
|
279
|
+
</dd>
|
|
280
|
+
</dl>
|
|
281
|
+
</dd></dl>
|
|
282
|
+
|
|
283
|
+
<dl class="py method">
|
|
284
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.check_credit_balance">
|
|
285
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_credit_balance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/credit_integration.html#CreditIntegration.check_credit_balance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.check_credit_balance" title="Link to this definition">¶</a></dt>
|
|
286
|
+
<dd><p>Get current credit balance for a user</p>
|
|
287
|
+
</dd></dl>
|
|
288
|
+
|
|
289
|
+
</dd></dl>
|
|
290
|
+
|
|
291
|
+
</section>
|
|
292
|
+
<section id="module-mindroot.coreplugins.subscriptions.default_templates">
|
|
293
|
+
<span id="mindroot-coreplugins-subscriptions-default-templates-module"></span><h2>mindroot.coreplugins.subscriptions.default_templates module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.default_templates" title="Link to this heading">¶</a></h2>
|
|
294
|
+
</section>
|
|
295
|
+
<section id="module-mindroot.coreplugins.subscriptions.mod">
|
|
296
|
+
<span id="mindroot-coreplugins-subscriptions-mod-module"></span><h2>mindroot.coreplugins.subscriptions.mod module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.mod" title="Link to this heading">¶</a></h2>
|
|
297
|
+
<dl class="py class">
|
|
298
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin">
|
|
299
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">SubscriptionsPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#SubscriptionsPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin" title="Link to this definition">¶</a></dt>
|
|
300
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
301
|
+
<dl class="py method">
|
|
302
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin.create_components">
|
|
303
|
+
<span class="sig-name descname"><span class="pre">create_components</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#SubscriptionsPlugin.create_components"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin.create_components" title="Link to this definition">¶</a></dt>
|
|
304
|
+
<dd><p>Create fresh instances of all subscription system components</p>
|
|
305
|
+
</dd></dl>
|
|
306
|
+
|
|
307
|
+
</dd></dl>
|
|
308
|
+
|
|
309
|
+
<dl class="py function">
|
|
310
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.activate_plan_feature">
|
|
311
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">activate_plan_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#activate_plan_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.activate_plan_feature" title="Link to this definition">¶</a></dt>
|
|
312
|
+
<dd><p>Activate a plan feature</p>
|
|
313
|
+
<dl class="field-list simple">
|
|
314
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
315
|
+
<dd class="field-odd"><ul class="simple">
|
|
316
|
+
<li><p><strong>feature_id</strong> – ID of the feature to activate</p></li>
|
|
317
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
318
|
+
</ul>
|
|
319
|
+
</dd>
|
|
320
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
321
|
+
<dd class="field-even"><p>Status result</p>
|
|
322
|
+
</dd>
|
|
323
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
324
|
+
<dd class="field-odd"><p>Dict</p>
|
|
325
|
+
</dd>
|
|
326
|
+
</dl>
|
|
327
|
+
</dd></dl>
|
|
328
|
+
|
|
329
|
+
<dl class="py function">
|
|
330
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.activate_subscription_plan">
|
|
331
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">activate_subscription_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#activate_subscription_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.activate_subscription_plan" title="Link to this definition">¶</a></dt>
|
|
332
|
+
<dd><p>Activate a subscription plan</p>
|
|
333
|
+
<dl class="field-list simple">
|
|
334
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
335
|
+
<dd class="field-odd"><ul class="simple">
|
|
336
|
+
<li><p><strong>plan_id</strong> – ID of the plan to activate</p></li>
|
|
337
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
338
|
+
</ul>
|
|
339
|
+
</dd>
|
|
340
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
341
|
+
<dd class="field-even"><p>Status result</p>
|
|
342
|
+
</dd>
|
|
343
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
344
|
+
<dd class="field-odd"><p>Dict</p>
|
|
345
|
+
</dd>
|
|
346
|
+
</dl>
|
|
347
|
+
</dd></dl>
|
|
348
|
+
|
|
349
|
+
<dl class="py function">
|
|
350
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.cancel_subscription">
|
|
351
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">cancel_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">at_period_end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#cancel_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.cancel_subscription" title="Link to this definition">¶</a></dt>
|
|
352
|
+
<dd><p>Cancel a user subscription</p>
|
|
353
|
+
<dl class="field-list simple">
|
|
354
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
355
|
+
<dd class="field-odd"><ul class="simple">
|
|
356
|
+
<li><p><strong>subscription_id</strong> – ID of the subscription to cancel</p></li>
|
|
357
|
+
<li><p><strong>at_period_end</strong> – Whether to cancel at period end or immediately</p></li>
|
|
358
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
359
|
+
</ul>
|
|
360
|
+
</dd>
|
|
361
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
362
|
+
<dd class="field-even"><p>Updated subscription details</p>
|
|
363
|
+
</dd>
|
|
364
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
365
|
+
<dd class="field-odd"><p>Dict</p>
|
|
366
|
+
</dd>
|
|
367
|
+
</dl>
|
|
368
|
+
</dd></dl>
|
|
369
|
+
|
|
370
|
+
<dl class="py function">
|
|
371
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.create_page_template">
|
|
372
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">create_page_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#create_page_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.create_page_template" title="Link to this definition">¶</a></dt>
|
|
373
|
+
<dd><p>Create a new page template</p>
|
|
374
|
+
<dl class="field-list simple">
|
|
375
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
376
|
+
<dd class="field-odd"><ul class="simple">
|
|
377
|
+
<li><p><strong>template_data</strong> – Template details</p></li>
|
|
378
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
379
|
+
</ul>
|
|
380
|
+
</dd>
|
|
381
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
382
|
+
<dd class="field-even"><p>Created template details</p>
|
|
383
|
+
</dd>
|
|
384
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
385
|
+
<dd class="field-odd"><p>Dict</p>
|
|
386
|
+
</dd>
|
|
387
|
+
</dl>
|
|
388
|
+
</dd></dl>
|
|
389
|
+
|
|
390
|
+
<dl class="py function">
|
|
391
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.create_plan_feature">
|
|
392
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">create_plan_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#create_plan_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.create_plan_feature" title="Link to this definition">¶</a></dt>
|
|
393
|
+
<dd><p>Create a new plan feature</p>
|
|
394
|
+
<dl class="field-list simple">
|
|
395
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
396
|
+
<dd class="field-odd"><ul class="simple">
|
|
397
|
+
<li><p><strong>feature_data</strong> – Feature details</p></li>
|
|
398
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
399
|
+
</ul>
|
|
400
|
+
</dd>
|
|
401
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
402
|
+
<dd class="field-even"><p>Created feature details</p>
|
|
403
|
+
</dd>
|
|
404
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
405
|
+
<dd class="field-odd"><p>Dict</p>
|
|
406
|
+
</dd>
|
|
407
|
+
</dl>
|
|
408
|
+
</dd></dl>
|
|
409
|
+
|
|
410
|
+
<dl class="py function">
|
|
411
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.create_subscription_plan">
|
|
412
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">create_subscription_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#create_subscription_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.create_subscription_plan" title="Link to this definition">¶</a></dt>
|
|
413
|
+
<dd><p>Create a new subscription plan</p>
|
|
414
|
+
<dl class="field-list simple">
|
|
415
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
416
|
+
<dd class="field-odd"><ul class="simple">
|
|
417
|
+
<li><p><strong>plan_data</strong> – Plan details including name, description, price, etc.</p></li>
|
|
418
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
419
|
+
</ul>
|
|
420
|
+
</dd>
|
|
421
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
422
|
+
<dd class="field-even"><p>Created plan details</p>
|
|
423
|
+
</dd>
|
|
424
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
425
|
+
<dd class="field-odd"><p>Dict</p>
|
|
426
|
+
</dd>
|
|
427
|
+
</dl>
|
|
428
|
+
</dd></dl>
|
|
429
|
+
|
|
430
|
+
<dl class="py function">
|
|
431
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.deactivate_plan_feature">
|
|
432
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">deactivate_plan_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#deactivate_plan_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.deactivate_plan_feature" title="Link to this definition">¶</a></dt>
|
|
433
|
+
<dd><p>Deactivate a plan feature</p>
|
|
434
|
+
<dl class="field-list simple">
|
|
435
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
436
|
+
<dd class="field-odd"><ul class="simple">
|
|
437
|
+
<li><p><strong>feature_id</strong> – ID of the feature to deactivate</p></li>
|
|
438
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
439
|
+
</ul>
|
|
440
|
+
</dd>
|
|
441
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
442
|
+
<dd class="field-even"><p>Status result</p>
|
|
443
|
+
</dd>
|
|
444
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
445
|
+
<dd class="field-odd"><p>Dict</p>
|
|
446
|
+
</dd>
|
|
447
|
+
</dl>
|
|
448
|
+
</dd></dl>
|
|
449
|
+
|
|
450
|
+
<dl class="py function">
|
|
451
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.deactivate_subscription_plan">
|
|
452
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">deactivate_subscription_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#deactivate_subscription_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.deactivate_subscription_plan" title="Link to this definition">¶</a></dt>
|
|
453
|
+
<dd><p>Deactivate a subscription plan</p>
|
|
454
|
+
<dl class="field-list simple">
|
|
455
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
456
|
+
<dd class="field-odd"><ul class="simple">
|
|
457
|
+
<li><p><strong>plan_id</strong> – ID of the plan to deactivate</p></li>
|
|
458
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
459
|
+
</ul>
|
|
460
|
+
</dd>
|
|
461
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
462
|
+
<dd class="field-even"><p>Status result</p>
|
|
463
|
+
</dd>
|
|
464
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
465
|
+
<dd class="field-odd"><p>Dict</p>
|
|
466
|
+
</dd>
|
|
467
|
+
</dl>
|
|
468
|
+
</dd></dl>
|
|
469
|
+
|
|
470
|
+
<dl class="py function">
|
|
471
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_available_features">
|
|
472
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_available_features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_available_features"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_available_features" title="Link to this definition">¶</a></dt>
|
|
473
|
+
<dd><p>Get all available plan features</p>
|
|
474
|
+
<dl class="field-list simple">
|
|
475
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
476
|
+
<dd class="field-odd"><ul class="simple">
|
|
477
|
+
<li><p><strong>active_only</strong> – Whether to return only active features</p></li>
|
|
478
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
479
|
+
</ul>
|
|
480
|
+
</dd>
|
|
481
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
482
|
+
<dd class="field-even"><p>List of feature details</p>
|
|
483
|
+
</dd>
|
|
484
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
485
|
+
<dd class="field-odd"><p>List[Dict]</p>
|
|
486
|
+
</dd>
|
|
487
|
+
</dl>
|
|
488
|
+
</dd></dl>
|
|
489
|
+
|
|
490
|
+
<dl class="py function">
|
|
491
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_base_path">
|
|
492
|
+
<span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_base_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_base_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_base_path" title="Link to this definition">¶</a></dt>
|
|
493
|
+
<dd><p>Get the base path for subscription data storage</p>
|
|
494
|
+
</dd></dl>
|
|
495
|
+
|
|
496
|
+
<dl class="py function">
|
|
497
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_my_subscriptions">
|
|
498
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_my_subscriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_my_subscriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_my_subscriptions" title="Link to this definition">¶</a></dt>
|
|
499
|
+
<dd><p>Get current user’s subscriptions</p>
|
|
500
|
+
<p class="rubric">Example</p>
|
|
501
|
+
<p>{ “get_my_subscriptions”: {} }</p>
|
|
502
|
+
</dd></dl>
|
|
503
|
+
|
|
504
|
+
<dl class="py function">
|
|
505
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_page_templates">
|
|
506
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_page_templates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_page_templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_page_templates" title="Link to this definition">¶</a></dt>
|
|
507
|
+
<dd><p>Get all page templates</p>
|
|
508
|
+
<dl class="field-list simple">
|
|
509
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
510
|
+
<dd class="field-odd"><p><strong>context</strong> – Request context</p>
|
|
511
|
+
</dd>
|
|
512
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
513
|
+
<dd class="field-even"><p>List of template details</p>
|
|
514
|
+
</dd>
|
|
515
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
516
|
+
<dd class="field-odd"><p>List[Dict]</p>
|
|
517
|
+
</dd>
|
|
518
|
+
</dl>
|
|
519
|
+
</dd></dl>
|
|
520
|
+
|
|
521
|
+
<dl class="py function">
|
|
522
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_subscription_by_provider_id">
|
|
523
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_subscription_by_provider_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_subscription_by_provider_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_by_provider_id" title="Link to this definition">¶</a></dt>
|
|
524
|
+
<dd><p>Get subscription by provider subscription ID (e.g., Stripe subscription ID)</p>
|
|
525
|
+
<dl class="field-list simple">
|
|
526
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
527
|
+
<dd class="field-odd"><ul class="simple">
|
|
528
|
+
<li><p><strong>provider_subscription_id</strong> – Provider’s subscription ID</p></li>
|
|
529
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
530
|
+
</ul>
|
|
531
|
+
</dd>
|
|
532
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
533
|
+
<dd class="field-even"><p>Subscription details or None if not found</p>
|
|
534
|
+
</dd>
|
|
535
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
536
|
+
<dd class="field-odd"><p>Optional[Dict]</p>
|
|
537
|
+
</dd>
|
|
538
|
+
</dl>
|
|
539
|
+
</dd></dl>
|
|
540
|
+
|
|
541
|
+
<dl class="py function">
|
|
542
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_subscription_plan">
|
|
543
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_subscription_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_subscription_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_plan" title="Link to this definition">¶</a></dt>
|
|
544
|
+
<dd><p>Get a subscription plan by ID</p>
|
|
545
|
+
<dl class="field-list simple">
|
|
546
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
547
|
+
<dd class="field-odd"><ul class="simple">
|
|
548
|
+
<li><p><strong>plan_id</strong> – ID of the plan to retrieve</p></li>
|
|
549
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
550
|
+
</ul>
|
|
551
|
+
</dd>
|
|
552
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
553
|
+
<dd class="field-even"><p>Plan details or None if not found</p>
|
|
554
|
+
</dd>
|
|
555
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
556
|
+
<dd class="field-odd"><p>Optional[Dict]</p>
|
|
557
|
+
</dd>
|
|
558
|
+
</dl>
|
|
559
|
+
</dd></dl>
|
|
560
|
+
|
|
561
|
+
<dl class="py function">
|
|
562
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_subscription_plans">
|
|
563
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_subscription_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_subscription_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_plans" title="Link to this definition">¶</a></dt>
|
|
564
|
+
<dd><p>Get all subscription plans</p>
|
|
565
|
+
<dl class="field-list simple">
|
|
566
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
567
|
+
<dd class="field-odd"><ul class="simple">
|
|
568
|
+
<li><p><strong>active_only</strong> – Whether to return only active plans</p></li>
|
|
569
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
570
|
+
</ul>
|
|
571
|
+
</dd>
|
|
572
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
573
|
+
<dd class="field-even"><p>List of plan details</p>
|
|
574
|
+
</dd>
|
|
575
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
576
|
+
<dd class="field-odd"><p>List[Dict]</p>
|
|
577
|
+
</dd>
|
|
578
|
+
</dl>
|
|
579
|
+
</dd></dl>
|
|
580
|
+
|
|
581
|
+
<dl class="py function">
|
|
582
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.get_user_subscriptions">
|
|
583
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">get_user_subscriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#get_user_subscriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.get_user_subscriptions" title="Link to this definition">¶</a></dt>
|
|
584
|
+
<dd><p>Get all subscriptions for a user</p>
|
|
585
|
+
<dl class="field-list simple">
|
|
586
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
587
|
+
<dd class="field-odd"><ul class="simple">
|
|
588
|
+
<li><p><strong>username</strong> – User to get subscriptions for</p></li>
|
|
589
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
590
|
+
</ul>
|
|
591
|
+
</dd>
|
|
592
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
593
|
+
<dd class="field-even"><p>List of subscription details</p>
|
|
594
|
+
</dd>
|
|
595
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
596
|
+
<dd class="field-odd"><p>List[Dict]</p>
|
|
597
|
+
</dd>
|
|
598
|
+
</dl>
|
|
599
|
+
</dd></dl>
|
|
600
|
+
|
|
601
|
+
<dl class="py function">
|
|
602
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.initialize_default_features">
|
|
603
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">initialize_default_features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#initialize_default_features"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.initialize_default_features" title="Link to this definition">¶</a></dt>
|
|
604
|
+
<dd><p>Initialize default plan features</p>
|
|
605
|
+
</dd></dl>
|
|
606
|
+
|
|
607
|
+
<dl class="py function">
|
|
608
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.initialize_default_template">
|
|
609
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">initialize_default_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#initialize_default_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.initialize_default_template" title="Link to this definition">¶</a></dt>
|
|
610
|
+
<dd><p>Initialize default page template</p>
|
|
611
|
+
</dd></dl>
|
|
612
|
+
|
|
613
|
+
<dl class="py function">
|
|
614
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.list_subscription_plans">
|
|
615
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">list_subscription_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#list_subscription_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.list_subscription_plans" title="Link to this definition">¶</a></dt>
|
|
616
|
+
<dd><p>List available subscription plans</p>
|
|
617
|
+
<p class="rubric">Example</p>
|
|
618
|
+
<p>{ “list_subscription_plans”: {} }</p>
|
|
619
|
+
</dd></dl>
|
|
620
|
+
|
|
621
|
+
<dl class="py function">
|
|
622
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.process_subscription_event">
|
|
623
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">process_subscription_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#process_subscription_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.process_subscription_event" title="Link to this definition">¶</a></dt>
|
|
624
|
+
<dd><p>Process normalized subscription events from any payment provider</p>
|
|
625
|
+
<dl class="field-list simple">
|
|
626
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
627
|
+
<dd class="field-odd"><ul class="simple">
|
|
628
|
+
<li><p><strong>event_data</strong> – Normalized event data with provider, event type, etc.</p></li>
|
|
629
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
630
|
+
</ul>
|
|
631
|
+
</dd>
|
|
632
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
633
|
+
<dd class="field-even"><p>Processing result</p>
|
|
634
|
+
</dd>
|
|
635
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
636
|
+
<dd class="field-odd"><p>Dict</p>
|
|
637
|
+
</dd>
|
|
638
|
+
</dl>
|
|
639
|
+
</dd></dl>
|
|
640
|
+
|
|
641
|
+
<dl class="py function">
|
|
642
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.set_default_template">
|
|
643
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">set_default_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#set_default_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.set_default_template" title="Link to this definition">¶</a></dt>
|
|
644
|
+
<dd><p>Set a template as the default</p>
|
|
645
|
+
<dl class="field-list simple">
|
|
646
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
647
|
+
<dd class="field-odd"><ul class="simple">
|
|
648
|
+
<li><p><strong>template_id</strong> – ID of the template to set as default</p></li>
|
|
649
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
650
|
+
</ul>
|
|
651
|
+
</dd>
|
|
652
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
653
|
+
<dd class="field-even"><p>Status result</p>
|
|
654
|
+
</dd>
|
|
655
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
656
|
+
<dd class="field-odd"><p>Dict</p>
|
|
657
|
+
</dd>
|
|
658
|
+
</dl>
|
|
659
|
+
</dd></dl>
|
|
660
|
+
|
|
661
|
+
<dl class="py function">
|
|
662
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.startup">
|
|
663
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#startup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.startup" title="Link to this definition">¶</a></dt>
|
|
664
|
+
<dd><p>Startup tasks</p>
|
|
665
|
+
</dd></dl>
|
|
666
|
+
|
|
667
|
+
<dl class="py function">
|
|
668
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.update_page_template">
|
|
669
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">update_page_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#update_page_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.update_page_template" title="Link to this definition">¶</a></dt>
|
|
670
|
+
<dd><p>Update an existing page template</p>
|
|
671
|
+
<dl class="field-list simple">
|
|
672
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
673
|
+
<dd class="field-odd"><ul class="simple">
|
|
674
|
+
<li><p><strong>template_id</strong> – ID of the template to update</p></li>
|
|
675
|
+
<li><p><strong>template_data</strong> – Updated template details</p></li>
|
|
676
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
677
|
+
</ul>
|
|
678
|
+
</dd>
|
|
679
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
680
|
+
<dd class="field-even"><p>Updated template details</p>
|
|
681
|
+
</dd>
|
|
682
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
683
|
+
<dd class="field-odd"><p>Dict</p>
|
|
684
|
+
</dd>
|
|
685
|
+
</dl>
|
|
686
|
+
</dd></dl>
|
|
687
|
+
|
|
688
|
+
<dl class="py function">
|
|
689
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.update_plan_feature">
|
|
690
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">update_plan_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feature_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#update_plan_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.update_plan_feature" title="Link to this definition">¶</a></dt>
|
|
691
|
+
<dd><p>Update an existing plan feature</p>
|
|
692
|
+
<dl class="field-list simple">
|
|
693
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
694
|
+
<dd class="field-odd"><ul class="simple">
|
|
695
|
+
<li><p><strong>feature_id</strong> – ID of the feature to update</p></li>
|
|
696
|
+
<li><p><strong>feature_data</strong> – Updated feature details</p></li>
|
|
697
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
698
|
+
</ul>
|
|
699
|
+
</dd>
|
|
700
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
701
|
+
<dd class="field-even"><p>Updated feature details</p>
|
|
702
|
+
</dd>
|
|
703
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
704
|
+
<dd class="field-odd"><p>Dict</p>
|
|
705
|
+
</dd>
|
|
706
|
+
</dl>
|
|
707
|
+
</dd></dl>
|
|
708
|
+
|
|
709
|
+
<dl class="py function">
|
|
710
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.update_subscription_plan">
|
|
711
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">update_subscription_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plan_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#update_subscription_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.update_subscription_plan" title="Link to this definition">¶</a></dt>
|
|
712
|
+
<dd><p>Update an existing subscription plan</p>
|
|
713
|
+
<dl class="field-list simple">
|
|
714
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
715
|
+
<dd class="field-odd"><ul class="simple">
|
|
716
|
+
<li><p><strong>plan_id</strong> – ID of the plan to update</p></li>
|
|
717
|
+
<li><p><strong>plan_data</strong> – Updated plan details</p></li>
|
|
718
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
719
|
+
</ul>
|
|
720
|
+
</dd>
|
|
721
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
722
|
+
<dd class="field-even"><p>Updated plan details</p>
|
|
723
|
+
</dd>
|
|
724
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
725
|
+
<dd class="field-odd"><p>Dict</p>
|
|
726
|
+
</dd>
|
|
727
|
+
</dl>
|
|
728
|
+
</dd></dl>
|
|
729
|
+
|
|
730
|
+
<dl class="py function">
|
|
731
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.mod.update_subscription_status">
|
|
732
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.mod.</span></span><span class="sig-name descname"><span class="pre">update_subscription_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/mod.html#update_subscription_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.mod.update_subscription_status" title="Link to this definition">¶</a></dt>
|
|
733
|
+
<dd><p>Update a subscription’s status</p>
|
|
734
|
+
<dl class="field-list simple">
|
|
735
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
736
|
+
<dd class="field-odd"><ul class="simple">
|
|
737
|
+
<li><p><strong>subscription_id</strong> – Internal subscription ID</p></li>
|
|
738
|
+
<li><p><strong>status</strong> – New status (active, canceled, etc.)</p></li>
|
|
739
|
+
<li><p><strong>context</strong> – Request context</p></li>
|
|
740
|
+
</ul>
|
|
741
|
+
</dd>
|
|
742
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
743
|
+
<dd class="field-even"><p>Updated subscription details or None if not found</p>
|
|
744
|
+
</dd>
|
|
745
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
746
|
+
<dd class="field-odd"><p>Optional[Dict]</p>
|
|
747
|
+
</dd>
|
|
748
|
+
</dl>
|
|
749
|
+
</dd></dl>
|
|
750
|
+
|
|
751
|
+
</section>
|
|
752
|
+
<section id="module-mindroot.coreplugins.subscriptions.models">
|
|
753
|
+
<span id="mindroot-coreplugins-subscriptions-models-module"></span><h2>mindroot.coreplugins.subscriptions.models module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.models" title="Link to this heading">¶</a></h2>
|
|
754
|
+
<dl class="py class">
|
|
755
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate">
|
|
756
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.models.</span></span><span class="sig-name descname"><span class="pre">PageTemplate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">html_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">css_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">js_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PageTemplate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="Link to this definition">¶</a></dt>
|
|
757
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
758
|
+
<dl class="py attribute">
|
|
759
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.css_template">
|
|
760
|
+
<span class="sig-name descname"><span class="pre">css_template</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.css_template" title="Link to this definition">¶</a></dt>
|
|
761
|
+
<dd></dd></dl>
|
|
762
|
+
|
|
763
|
+
<dl class="py attribute">
|
|
764
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.description">
|
|
765
|
+
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.description" title="Link to this definition">¶</a></dt>
|
|
766
|
+
<dd></dd></dl>
|
|
767
|
+
|
|
768
|
+
<dl class="py method">
|
|
769
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.from_dict">
|
|
770
|
+
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="mindroot.coreplugins.subscriptions.models.PageTemplate"><span class="pre">PageTemplate</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PageTemplate.from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.from_dict" title="Link to this definition">¶</a></dt>
|
|
771
|
+
<dd></dd></dl>
|
|
772
|
+
|
|
773
|
+
<dl class="py attribute">
|
|
774
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.html_template">
|
|
775
|
+
<span class="sig-name descname"><span class="pre">html_template</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.html_template" title="Link to this definition">¶</a></dt>
|
|
776
|
+
<dd></dd></dl>
|
|
777
|
+
|
|
778
|
+
<dl class="py attribute">
|
|
779
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.is_default">
|
|
780
|
+
<span class="sig-name descname"><span class="pre">is_default</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.is_default" title="Link to this definition">¶</a></dt>
|
|
781
|
+
<dd></dd></dl>
|
|
782
|
+
|
|
783
|
+
<dl class="py attribute">
|
|
784
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.js_template">
|
|
785
|
+
<span class="sig-name descname"><span class="pre">js_template</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.js_template" title="Link to this definition">¶</a></dt>
|
|
786
|
+
<dd></dd></dl>
|
|
787
|
+
|
|
788
|
+
<dl class="py attribute">
|
|
789
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.name">
|
|
790
|
+
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.name" title="Link to this definition">¶</a></dt>
|
|
791
|
+
<dd></dd></dl>
|
|
792
|
+
|
|
793
|
+
<dl class="py attribute">
|
|
794
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.template_id">
|
|
795
|
+
<span class="sig-name descname"><span class="pre">template_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.template_id" title="Link to this definition">¶</a></dt>
|
|
796
|
+
<dd></dd></dl>
|
|
797
|
+
|
|
798
|
+
<dl class="py method">
|
|
799
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PageTemplate.to_dict">
|
|
800
|
+
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PageTemplate.to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.to_dict" title="Link to this definition">¶</a></dt>
|
|
801
|
+
<dd></dd></dl>
|
|
802
|
+
|
|
803
|
+
</dd></dl>
|
|
804
|
+
|
|
805
|
+
<dl class="py class">
|
|
806
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature">
|
|
807
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.models.</span></span><span class="sig-name descname"><span class="pre">PlanFeature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_order:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options:</span> <span class="pre">List[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_value:</span> <span class="pre">Any</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PlanFeature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="Link to this definition">¶</a></dt>
|
|
808
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
809
|
+
<dl class="py attribute">
|
|
810
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.active">
|
|
811
|
+
<span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.active" title="Link to this definition">¶</a></dt>
|
|
812
|
+
<dd></dd></dl>
|
|
813
|
+
|
|
814
|
+
<dl class="py attribute">
|
|
815
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.default_value">
|
|
816
|
+
<span class="sig-name descname"><span class="pre">default_value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Any</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.default_value" title="Link to this definition">¶</a></dt>
|
|
817
|
+
<dd></dd></dl>
|
|
818
|
+
|
|
819
|
+
<dl class="py attribute">
|
|
820
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.description">
|
|
821
|
+
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.description" title="Link to this definition">¶</a></dt>
|
|
822
|
+
<dd></dd></dl>
|
|
823
|
+
|
|
824
|
+
<dl class="py attribute">
|
|
825
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.display_order">
|
|
826
|
+
<span class="sig-name descname"><span class="pre">display_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.display_order" title="Link to this definition">¶</a></dt>
|
|
827
|
+
<dd></dd></dl>
|
|
828
|
+
|
|
829
|
+
<dl class="py attribute">
|
|
830
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.feature_id">
|
|
831
|
+
<span class="sig-name descname"><span class="pre">feature_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.feature_id" title="Link to this definition">¶</a></dt>
|
|
832
|
+
<dd></dd></dl>
|
|
833
|
+
|
|
834
|
+
<dl class="py method">
|
|
835
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.from_dict">
|
|
836
|
+
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="mindroot.coreplugins.subscriptions.models.PlanFeature"><span class="pre">PlanFeature</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PlanFeature.from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.from_dict" title="Link to this definition">¶</a></dt>
|
|
837
|
+
<dd></dd></dl>
|
|
838
|
+
|
|
839
|
+
<dl class="py attribute">
|
|
840
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.name">
|
|
841
|
+
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.name" title="Link to this definition">¶</a></dt>
|
|
842
|
+
<dd></dd></dl>
|
|
843
|
+
|
|
844
|
+
<dl class="py attribute">
|
|
845
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.options">
|
|
846
|
+
<span class="sig-name descname"><span class="pre">options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.options" title="Link to this definition">¶</a></dt>
|
|
847
|
+
<dd></dd></dl>
|
|
848
|
+
|
|
849
|
+
<dl class="py method">
|
|
850
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.to_dict">
|
|
851
|
+
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#PlanFeature.to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.to_dict" title="Link to this definition">¶</a></dt>
|
|
852
|
+
<dd></dd></dl>
|
|
853
|
+
|
|
854
|
+
<dl class="py attribute">
|
|
855
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.PlanFeature.type">
|
|
856
|
+
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.type" title="Link to this definition">¶</a></dt>
|
|
857
|
+
<dd></dd></dl>
|
|
858
|
+
|
|
859
|
+
</dd></dl>
|
|
860
|
+
|
|
861
|
+
<dl class="py class">
|
|
862
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan">
|
|
863
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.models.</span></span><span class="sig-name descname"><span class="pre">SubscriptionPlan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">price:</span> <span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credits_per_cycle:</span> <span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">currency:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'USD'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interval:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'month'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">features:</span> <span class="pre">Dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata:</span> <span class="pre">Dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#SubscriptionPlan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="Link to this definition">¶</a></dt>
|
|
864
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
865
|
+
<dl class="py attribute">
|
|
866
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.active">
|
|
867
|
+
<span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.active" title="Link to this definition">¶</a></dt>
|
|
868
|
+
<dd></dd></dl>
|
|
869
|
+
|
|
870
|
+
<dl class="py attribute">
|
|
871
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.credits_per_cycle">
|
|
872
|
+
<span class="sig-name descname"><span class="pre">credits_per_cycle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.credits_per_cycle" title="Link to this definition">¶</a></dt>
|
|
873
|
+
<dd></dd></dl>
|
|
874
|
+
|
|
875
|
+
<dl class="py attribute">
|
|
876
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.currency">
|
|
877
|
+
<span class="sig-name descname"><span class="pre">currency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'USD'</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.currency" title="Link to this definition">¶</a></dt>
|
|
878
|
+
<dd></dd></dl>
|
|
879
|
+
|
|
880
|
+
<dl class="py attribute">
|
|
881
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.description">
|
|
882
|
+
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.description" title="Link to this definition">¶</a></dt>
|
|
883
|
+
<dd></dd></dl>
|
|
884
|
+
|
|
885
|
+
<dl class="py attribute">
|
|
886
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.features">
|
|
887
|
+
<span class="sig-name descname"><span class="pre">features</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.features" title="Link to this definition">¶</a></dt>
|
|
888
|
+
<dd></dd></dl>
|
|
889
|
+
|
|
890
|
+
<dl class="py method">
|
|
891
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.from_dict">
|
|
892
|
+
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#SubscriptionPlan.from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.from_dict" title="Link to this definition">¶</a></dt>
|
|
893
|
+
<dd></dd></dl>
|
|
894
|
+
|
|
895
|
+
<dl class="py attribute">
|
|
896
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.interval">
|
|
897
|
+
<span class="sig-name descname"><span class="pre">interval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'month'</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.interval" title="Link to this definition">¶</a></dt>
|
|
898
|
+
<dd></dd></dl>
|
|
899
|
+
|
|
900
|
+
<dl class="py attribute">
|
|
901
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.metadata">
|
|
902
|
+
<span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.metadata" title="Link to this definition">¶</a></dt>
|
|
903
|
+
<dd></dd></dl>
|
|
904
|
+
|
|
905
|
+
<dl class="py attribute">
|
|
906
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.name">
|
|
907
|
+
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.name" title="Link to this definition">¶</a></dt>
|
|
908
|
+
<dd></dd></dl>
|
|
909
|
+
|
|
910
|
+
<dl class="py attribute">
|
|
911
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.plan_id">
|
|
912
|
+
<span class="sig-name descname"><span class="pre">plan_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.plan_id" title="Link to this definition">¶</a></dt>
|
|
913
|
+
<dd></dd></dl>
|
|
914
|
+
|
|
915
|
+
<dl class="py attribute">
|
|
916
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.price">
|
|
917
|
+
<span class="sig-name descname"><span class="pre">price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.price" title="Link to this definition">¶</a></dt>
|
|
918
|
+
<dd></dd></dl>
|
|
919
|
+
|
|
920
|
+
<dl class="py method">
|
|
921
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.SubscriptionPlan.to_dict">
|
|
922
|
+
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#SubscriptionPlan.to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.to_dict" title="Link to this definition">¶</a></dt>
|
|
923
|
+
<dd></dd></dl>
|
|
924
|
+
|
|
925
|
+
</dd></dl>
|
|
926
|
+
|
|
927
|
+
<dl class="py class">
|
|
928
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription">
|
|
929
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.models.</span></span><span class="sig-name descname"><span class="pre">UserSubscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plan_id:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current_period_start:</span> <span class="pre">datetime.datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current_period_end:</span> <span class="pre">datetime.datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel_at_period_end:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payment_provider:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'stripe'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_subscription_id:</span> <span class="pre">Optional[str]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata:</span> <span class="pre">Dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_at:</span> <span class="pre">datetime.datetime</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_at:</span> <span class="pre">datetime.datetime</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#UserSubscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="Link to this definition">¶</a></dt>
|
|
930
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
931
|
+
<dl class="py attribute">
|
|
932
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.cancel_at_period_end">
|
|
933
|
+
<span class="sig-name descname"><span class="pre">cancel_at_period_end</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.cancel_at_period_end" title="Link to this definition">¶</a></dt>
|
|
934
|
+
<dd></dd></dl>
|
|
935
|
+
|
|
936
|
+
<dl class="py attribute">
|
|
937
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.created_at">
|
|
938
|
+
<span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.created_at" title="Link to this definition">¶</a></dt>
|
|
939
|
+
<dd></dd></dl>
|
|
940
|
+
|
|
941
|
+
<dl class="py attribute">
|
|
942
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_end">
|
|
943
|
+
<span class="sig-name descname"><span class="pre">current_period_end</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_end" title="Link to this definition">¶</a></dt>
|
|
944
|
+
<dd></dd></dl>
|
|
945
|
+
|
|
946
|
+
<dl class="py attribute">
|
|
947
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_start">
|
|
948
|
+
<span class="sig-name descname"><span class="pre">current_period_start</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_start" title="Link to this definition">¶</a></dt>
|
|
949
|
+
<dd></dd></dl>
|
|
950
|
+
|
|
951
|
+
<dl class="py method">
|
|
952
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.from_dict">
|
|
953
|
+
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#UserSubscription.from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.from_dict" title="Link to this definition">¶</a></dt>
|
|
954
|
+
<dd></dd></dl>
|
|
955
|
+
|
|
956
|
+
<dl class="py attribute">
|
|
957
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.metadata">
|
|
958
|
+
<span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.metadata" title="Link to this definition">¶</a></dt>
|
|
959
|
+
<dd></dd></dl>
|
|
960
|
+
|
|
961
|
+
<dl class="py attribute">
|
|
962
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.payment_provider">
|
|
963
|
+
<span class="sig-name descname"><span class="pre">payment_provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stripe'</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.payment_provider" title="Link to this definition">¶</a></dt>
|
|
964
|
+
<dd></dd></dl>
|
|
965
|
+
|
|
966
|
+
<dl class="py attribute">
|
|
967
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.plan_id">
|
|
968
|
+
<span class="sig-name descname"><span class="pre">plan_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.plan_id" title="Link to this definition">¶</a></dt>
|
|
969
|
+
<dd></dd></dl>
|
|
970
|
+
|
|
971
|
+
<dl class="py attribute">
|
|
972
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.provider_subscription_id">
|
|
973
|
+
<span class="sig-name descname"><span class="pre">provider_subscription_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.provider_subscription_id" title="Link to this definition">¶</a></dt>
|
|
974
|
+
<dd></dd></dl>
|
|
975
|
+
|
|
976
|
+
<dl class="py attribute">
|
|
977
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.status">
|
|
978
|
+
<span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.status" title="Link to this definition">¶</a></dt>
|
|
979
|
+
<dd></dd></dl>
|
|
980
|
+
|
|
981
|
+
<dl class="py attribute">
|
|
982
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.subscription_id">
|
|
983
|
+
<span class="sig-name descname"><span class="pre">subscription_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.subscription_id" title="Link to this definition">¶</a></dt>
|
|
984
|
+
<dd></dd></dl>
|
|
985
|
+
|
|
986
|
+
<dl class="py method">
|
|
987
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.to_dict">
|
|
988
|
+
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/models.html#UserSubscription.to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.to_dict" title="Link to this definition">¶</a></dt>
|
|
989
|
+
<dd></dd></dl>
|
|
990
|
+
|
|
991
|
+
<dl class="py attribute">
|
|
992
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.updated_at">
|
|
993
|
+
<span class="sig-name descname"><span class="pre">updated_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.updated_at" title="Link to this definition">¶</a></dt>
|
|
994
|
+
<dd></dd></dl>
|
|
995
|
+
|
|
996
|
+
<dl class="py attribute">
|
|
997
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.models.UserSubscription.username">
|
|
998
|
+
<span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.username" title="Link to this definition">¶</a></dt>
|
|
999
|
+
<dd></dd></dl>
|
|
1000
|
+
|
|
1001
|
+
</dd></dl>
|
|
1002
|
+
|
|
1003
|
+
</section>
|
|
1004
|
+
<section id="module-mindroot.coreplugins.subscriptions.router">
|
|
1005
|
+
<span id="mindroot-coreplugins-subscriptions-router-module"></span><h2>mindroot.coreplugins.subscriptions.router module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.router" title="Link to this heading">¶</a></h2>
|
|
1006
|
+
<dl class="py function">
|
|
1007
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_activate_feature">
|
|
1008
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_activate_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_activate_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_activate_feature" title="Link to this definition">¶</a></dt>
|
|
1009
|
+
<dd><p>Activate a plan feature</p>
|
|
1010
|
+
</dd></dl>
|
|
1011
|
+
|
|
1012
|
+
<dl class="py function">
|
|
1013
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_activate_plan">
|
|
1014
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_activate_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_activate_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_activate_plan" title="Link to this definition">¶</a></dt>
|
|
1015
|
+
<dd><p>Activate a subscription plan</p>
|
|
1016
|
+
</dd></dl>
|
|
1017
|
+
|
|
1018
|
+
<dl class="py function">
|
|
1019
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_cancel_subscription">
|
|
1020
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_cancel_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">at_period_end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_cancel_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_cancel_subscription" title="Link to this definition">¶</a></dt>
|
|
1021
|
+
<dd><p>Cancel a subscription</p>
|
|
1022
|
+
</dd></dl>
|
|
1023
|
+
|
|
1024
|
+
<dl class="py function">
|
|
1025
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_create_checkout">
|
|
1026
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_create_checkout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Query(stripe)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_create_checkout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_create_checkout" title="Link to this definition">¶</a></dt>
|
|
1027
|
+
<dd><p>Create checkout session for subscription</p>
|
|
1028
|
+
</dd></dl>
|
|
1029
|
+
|
|
1030
|
+
<dl class="py function">
|
|
1031
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_create_feature">
|
|
1032
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_create_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_create_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_create_feature" title="Link to this definition">¶</a></dt>
|
|
1033
|
+
<dd><p>Create a new plan feature</p>
|
|
1034
|
+
</dd></dl>
|
|
1035
|
+
|
|
1036
|
+
<dl class="py function">
|
|
1037
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_create_plan">
|
|
1038
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_create_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_create_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_create_plan" title="Link to this definition">¶</a></dt>
|
|
1039
|
+
<dd><p>Create a new subscription plan</p>
|
|
1040
|
+
</dd></dl>
|
|
1041
|
+
|
|
1042
|
+
<dl class="py function">
|
|
1043
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_create_template">
|
|
1044
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_create_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_create_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_create_template" title="Link to this definition">¶</a></dt>
|
|
1045
|
+
<dd><p>Create a new page template</p>
|
|
1046
|
+
</dd></dl>
|
|
1047
|
+
|
|
1048
|
+
<dl class="py function">
|
|
1049
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_deactivate_feature">
|
|
1050
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_deactivate_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_deactivate_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_deactivate_feature" title="Link to this definition">¶</a></dt>
|
|
1051
|
+
<dd><p>Deactivate a plan feature</p>
|
|
1052
|
+
</dd></dl>
|
|
1053
|
+
|
|
1054
|
+
<dl class="py function">
|
|
1055
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_deactivate_plan">
|
|
1056
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_deactivate_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_deactivate_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_deactivate_plan" title="Link to this definition">¶</a></dt>
|
|
1057
|
+
<dd><p>Deactivate a subscription plan</p>
|
|
1058
|
+
</dd></dl>
|
|
1059
|
+
|
|
1060
|
+
<dl class="py function">
|
|
1061
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_get_all_plans">
|
|
1062
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_get_all_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_get_all_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_get_all_plans" title="Link to this definition">¶</a></dt>
|
|
1063
|
+
<dd><p>Get all subscription plans</p>
|
|
1064
|
+
</dd></dl>
|
|
1065
|
+
|
|
1066
|
+
<dl class="py function">
|
|
1067
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_get_features">
|
|
1068
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_get_features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_get_features"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_get_features" title="Link to this definition">¶</a></dt>
|
|
1069
|
+
<dd><p>Get all plan features</p>
|
|
1070
|
+
</dd></dl>
|
|
1071
|
+
|
|
1072
|
+
<dl class="py function">
|
|
1073
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_get_my_subscriptions">
|
|
1074
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_get_my_subscriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_get_my_subscriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_get_my_subscriptions" title="Link to this definition">¶</a></dt>
|
|
1075
|
+
<dd><p>Get current user’s subscriptions</p>
|
|
1076
|
+
</dd></dl>
|
|
1077
|
+
|
|
1078
|
+
<dl class="py function">
|
|
1079
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_get_plans">
|
|
1080
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_get_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_get_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_get_plans" title="Link to this definition">¶</a></dt>
|
|
1081
|
+
<dd><p>Get available subscription plans</p>
|
|
1082
|
+
</dd></dl>
|
|
1083
|
+
|
|
1084
|
+
<dl class="py function">
|
|
1085
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_get_templates">
|
|
1086
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_get_templates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_get_templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_get_templates" title="Link to this definition">¶</a></dt>
|
|
1087
|
+
<dd><p>Get all page templates</p>
|
|
1088
|
+
</dd></dl>
|
|
1089
|
+
|
|
1090
|
+
<dl class="py function">
|
|
1091
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_set_default_template">
|
|
1092
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_set_default_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_set_default_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_set_default_template" title="Link to this definition">¶</a></dt>
|
|
1093
|
+
<dd><p>Set a template as the default</p>
|
|
1094
|
+
</dd></dl>
|
|
1095
|
+
|
|
1096
|
+
<dl class="py function">
|
|
1097
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_update_feature">
|
|
1098
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_update_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_update_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_update_feature" title="Link to this definition">¶</a></dt>
|
|
1099
|
+
<dd><p>Update an existing plan feature</p>
|
|
1100
|
+
</dd></dl>
|
|
1101
|
+
|
|
1102
|
+
<dl class="py function">
|
|
1103
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_update_plan">
|
|
1104
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_update_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_update_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_update_plan" title="Link to this definition">¶</a></dt>
|
|
1105
|
+
<dd><p>Update an existing subscription plan</p>
|
|
1106
|
+
</dd></dl>
|
|
1107
|
+
|
|
1108
|
+
<dl class="py function">
|
|
1109
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.api_update_template">
|
|
1110
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">api_update_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#api_update_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.api_update_template" title="Link to this definition">¶</a></dt>
|
|
1111
|
+
<dd><p>Update an existing page template</p>
|
|
1112
|
+
</dd></dl>
|
|
1113
|
+
|
|
1114
|
+
<dl class="py function">
|
|
1115
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.router.subscription_page">
|
|
1116
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.router.</span></span><span class="sig-name descname"><span class="pre">subscription_page</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/router.html#subscription_page"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.router.subscription_page" title="Link to this definition">¶</a></dt>
|
|
1117
|
+
<dd><p>Public subscription page</p>
|
|
1118
|
+
</dd></dl>
|
|
1119
|
+
|
|
1120
|
+
</section>
|
|
1121
|
+
<section id="module-mindroot.coreplugins.subscriptions.storage">
|
|
1122
|
+
<span id="mindroot-coreplugins-subscriptions-storage-module"></span><h2>mindroot.coreplugins.subscriptions.storage module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.storage" title="Link to this heading">¶</a></h2>
|
|
1123
|
+
<dl class="py class">
|
|
1124
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage">
|
|
1125
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.storage.</span></span><span class="sig-name descname"><span class="pre">SubscriptionStorage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage" title="Link to this definition">¶</a></dt>
|
|
1126
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1127
|
+
<dl class="py method">
|
|
1128
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_features">
|
|
1129
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="mindroot.coreplugins.subscriptions.models.PlanFeature"><span class="pre">PlanFeature</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_all_features"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_features" title="Link to this definition">¶</a></dt>
|
|
1130
|
+
<dd><p>Get all plan features</p>
|
|
1131
|
+
</dd></dl>
|
|
1132
|
+
|
|
1133
|
+
<dl class="py method">
|
|
1134
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_plans">
|
|
1135
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_all_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_plans" title="Link to this definition">¶</a></dt>
|
|
1136
|
+
<dd><p>Get all subscription plans</p>
|
|
1137
|
+
</dd></dl>
|
|
1138
|
+
|
|
1139
|
+
<dl class="py method">
|
|
1140
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_templates">
|
|
1141
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_templates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="mindroot.coreplugins.subscriptions.models.PageTemplate"><span class="pre">PageTemplate</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_all_templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_templates" title="Link to this definition">¶</a></dt>
|
|
1142
|
+
<dd><p>Get all page templates</p>
|
|
1143
|
+
</dd></dl>
|
|
1144
|
+
|
|
1145
|
+
<dl class="py method">
|
|
1146
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_default_template">
|
|
1147
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_default_template</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="mindroot.coreplugins.subscriptions.models.PageTemplate"><span class="pre">PageTemplate</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_default_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_default_template" title="Link to this definition">¶</a></dt>
|
|
1148
|
+
<dd><p>Get the default page template</p>
|
|
1149
|
+
</dd></dl>
|
|
1150
|
+
|
|
1151
|
+
<dl class="py method">
|
|
1152
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_feature">
|
|
1153
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="mindroot.coreplugins.subscriptions.models.PlanFeature"><span class="pre">PlanFeature</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_feature" title="Link to this definition">¶</a></dt>
|
|
1154
|
+
<dd><p>Get a plan feature by ID</p>
|
|
1155
|
+
</dd></dl>
|
|
1156
|
+
|
|
1157
|
+
<dl class="py method">
|
|
1158
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_plan">
|
|
1159
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_plan" title="Link to this definition">¶</a></dt>
|
|
1160
|
+
<dd><p>Get a subscription plan by ID</p>
|
|
1161
|
+
</dd></dl>
|
|
1162
|
+
|
|
1163
|
+
<dl class="py method">
|
|
1164
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscription">
|
|
1165
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscription" title="Link to this definition">¶</a></dt>
|
|
1166
|
+
<dd><p>Get a subscription by ID</p>
|
|
1167
|
+
</dd></dl>
|
|
1168
|
+
|
|
1169
|
+
<dl class="py method">
|
|
1170
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscriptions_by_provider_id">
|
|
1171
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_subscriptions_by_provider_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_subscriptions_by_provider_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscriptions_by_provider_id" title="Link to this definition">¶</a></dt>
|
|
1172
|
+
<dd><p>Get subscriptions by provider subscription ID</p>
|
|
1173
|
+
</dd></dl>
|
|
1174
|
+
|
|
1175
|
+
<dl class="py method">
|
|
1176
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_template">
|
|
1177
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="mindroot.coreplugins.subscriptions.models.PageTemplate"><span class="pre">PageTemplate</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_template" title="Link to this definition">¶</a></dt>
|
|
1178
|
+
<dd><p>Get a page template by ID</p>
|
|
1179
|
+
</dd></dl>
|
|
1180
|
+
|
|
1181
|
+
<dl class="py method">
|
|
1182
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_user_subscriptions">
|
|
1183
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_user_subscriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.get_user_subscriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_user_subscriptions" title="Link to this definition">¶</a></dt>
|
|
1184
|
+
<dd><p>Get all subscriptions for a user</p>
|
|
1185
|
+
</dd></dl>
|
|
1186
|
+
|
|
1187
|
+
<dl class="py method">
|
|
1188
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.set_default_template">
|
|
1189
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_default_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.set_default_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.set_default_template" title="Link to this definition">¶</a></dt>
|
|
1190
|
+
<dd><p>Set a template as the default</p>
|
|
1191
|
+
</dd></dl>
|
|
1192
|
+
|
|
1193
|
+
<dl class="py method">
|
|
1194
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_feature">
|
|
1195
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">store_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="mindroot.coreplugins.subscriptions.models.PlanFeature"><span class="pre">PlanFeature</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.store_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_feature" title="Link to this definition">¶</a></dt>
|
|
1196
|
+
<dd><p>Store a plan feature</p>
|
|
1197
|
+
</dd></dl>
|
|
1198
|
+
|
|
1199
|
+
<dl class="py method">
|
|
1200
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_plan">
|
|
1201
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">store_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.store_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_plan" title="Link to this definition">¶</a></dt>
|
|
1202
|
+
<dd><p>Store a subscription plan</p>
|
|
1203
|
+
</dd></dl>
|
|
1204
|
+
|
|
1205
|
+
<dl class="py method">
|
|
1206
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_subscription">
|
|
1207
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">store_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.store_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_subscription" title="Link to this definition">¶</a></dt>
|
|
1208
|
+
<dd><p>Store a user subscription</p>
|
|
1209
|
+
</dd></dl>
|
|
1210
|
+
|
|
1211
|
+
<dl class="py method">
|
|
1212
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_template">
|
|
1213
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">store_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate" title="mindroot.coreplugins.subscriptions.models.PageTemplate"><span class="pre">PageTemplate</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.store_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_template" title="Link to this definition">¶</a></dt>
|
|
1214
|
+
<dd><p>Store a page template</p>
|
|
1215
|
+
</dd></dl>
|
|
1216
|
+
|
|
1217
|
+
<dl class="py method">
|
|
1218
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_feature">
|
|
1219
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature" title="mindroot.coreplugins.subscriptions.models.PlanFeature"><span class="pre">PlanFeature</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.update_feature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_feature" title="Link to this definition">¶</a></dt>
|
|
1220
|
+
<dd><p>Update a plan feature</p>
|
|
1221
|
+
</dd></dl>
|
|
1222
|
+
|
|
1223
|
+
<dl class="py method">
|
|
1224
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_plan">
|
|
1225
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.update_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_plan" title="Link to this definition">¶</a></dt>
|
|
1226
|
+
<dd><p>Update a subscription plan</p>
|
|
1227
|
+
</dd></dl>
|
|
1228
|
+
|
|
1229
|
+
<dl class="py method">
|
|
1230
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_subscription">
|
|
1231
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/storage.html#SubscriptionStorage.update_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_subscription" title="Link to this definition">¶</a></dt>
|
|
1232
|
+
<dd><p>Update a user subscription</p>
|
|
1233
|
+
</dd></dl>
|
|
1234
|
+
|
|
1235
|
+
</dd></dl>
|
|
1236
|
+
|
|
1237
|
+
</section>
|
|
1238
|
+
<section id="module-mindroot.coreplugins.subscriptions.stripe_integration">
|
|
1239
|
+
<span id="mindroot-coreplugins-subscriptions-stripe-integration-module"></span><h2>mindroot.coreplugins.subscriptions.stripe_integration module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.stripe_integration" title="Link to this heading">¶</a></h2>
|
|
1240
|
+
<dl class="py class">
|
|
1241
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration">
|
|
1242
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.stripe_integration.</span></span><span class="sig-name descname"><span class="pre">StripeIntegration</span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/stripe_integration.html#StripeIntegration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration" title="Link to this definition">¶</a></dt>
|
|
1243
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1244
|
+
<p>Handles integration with the Stripe payment plugin for subscription operations</p>
|
|
1245
|
+
<dl class="py method">
|
|
1246
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.cancel_subscription">
|
|
1247
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancel_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">at_period_end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/stripe_integration.html#StripeIntegration.cancel_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.cancel_subscription" title="Link to this definition">¶</a></dt>
|
|
1248
|
+
<dd><p>Cancel a Stripe subscription</p>
|
|
1249
|
+
<dl class="field-list simple">
|
|
1250
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1251
|
+
<dd class="field-odd"><ul class="simple">
|
|
1252
|
+
<li><p><strong>provider_subscription_id</strong> – Stripe subscription ID</p></li>
|
|
1253
|
+
<li><p><strong>at_period_end</strong> – Whether to cancel at period end or immediately</p></li>
|
|
1254
|
+
</ul>
|
|
1255
|
+
</dd>
|
|
1256
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1257
|
+
<dd class="field-even"><p>Success status</p>
|
|
1258
|
+
</dd>
|
|
1259
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1260
|
+
<dd class="field-odd"><p>bool</p>
|
|
1261
|
+
</dd>
|
|
1262
|
+
</dl>
|
|
1263
|
+
</dd></dl>
|
|
1264
|
+
|
|
1265
|
+
<dl class="py method">
|
|
1266
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.create_checkout_session">
|
|
1267
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_checkout_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/stripe_integration.html#StripeIntegration.create_checkout_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.create_checkout_session" title="Link to this definition">¶</a></dt>
|
|
1268
|
+
<dd><p>Create a Stripe checkout session for subscription</p>
|
|
1269
|
+
<dl class="field-list simple">
|
|
1270
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1271
|
+
<dd class="field-odd"><ul class="simple">
|
|
1272
|
+
<li><p><strong>username</strong> – User to create checkout for</p></li>
|
|
1273
|
+
<li><p><strong>plan</strong> – Subscription plan details</p></li>
|
|
1274
|
+
</ul>
|
|
1275
|
+
</dd>
|
|
1276
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1277
|
+
<dd class="field-even"><p>Checkout URL</p>
|
|
1278
|
+
</dd>
|
|
1279
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1280
|
+
<dd class="field-odd"><p>str</p>
|
|
1281
|
+
</dd>
|
|
1282
|
+
</dl>
|
|
1283
|
+
</dd></dl>
|
|
1284
|
+
|
|
1285
|
+
</dd></dl>
|
|
1286
|
+
|
|
1287
|
+
</section>
|
|
1288
|
+
<section id="module-mindroot.coreplugins.subscriptions.subscription_manager">
|
|
1289
|
+
<span id="mindroot-coreplugins-subscriptions-subscription-manager-module"></span><h2>mindroot.coreplugins.subscriptions.subscription_manager module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.subscription_manager" title="Link to this heading">¶</a></h2>
|
|
1290
|
+
<dl class="py class">
|
|
1291
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager">
|
|
1292
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.subscription_manager.</span></span><span class="sig-name descname"><span class="pre">SubscriptionManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage" title="mindroot.coreplugins.subscriptions.storage.SubscriptionStorage"><span class="pre">SubscriptionStorage</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager" title="Link to this definition">¶</a></dt>
|
|
1293
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1294
|
+
<dl class="py method">
|
|
1295
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.cancel_subscription">
|
|
1296
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancel_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">at_period_end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.cancel_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.cancel_subscription" title="Link to this definition">¶</a></dt>
|
|
1297
|
+
<dd><p>Cancel a user subscription</p>
|
|
1298
|
+
</dd></dl>
|
|
1299
|
+
|
|
1300
|
+
<dl class="py method">
|
|
1301
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_plan">
|
|
1302
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.create_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_plan" title="Link to this definition">¶</a></dt>
|
|
1303
|
+
<dd><p>Create a new subscription plan</p>
|
|
1304
|
+
</dd></dl>
|
|
1305
|
+
|
|
1306
|
+
<dl class="py method">
|
|
1307
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_subscription">
|
|
1308
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_subscription</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.create_subscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_subscription" title="Link to this definition">¶</a></dt>
|
|
1309
|
+
<dd><p>Create a new user subscription</p>
|
|
1310
|
+
</dd></dl>
|
|
1311
|
+
|
|
1312
|
+
<dl class="py method">
|
|
1313
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.deactivate_plan">
|
|
1314
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deactivate_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.deactivate_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.deactivate_plan" title="Link to this definition">¶</a></dt>
|
|
1315
|
+
<dd><p>Deactivate a subscription plan</p>
|
|
1316
|
+
</dd></dl>
|
|
1317
|
+
|
|
1318
|
+
<dl class="py method">
|
|
1319
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_plan">
|
|
1320
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.get_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_plan" title="Link to this definition">¶</a></dt>
|
|
1321
|
+
<dd><p>Get a subscription plan by ID</p>
|
|
1322
|
+
</dd></dl>
|
|
1323
|
+
|
|
1324
|
+
<dl class="py method">
|
|
1325
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_subscriptions_by_provider_id">
|
|
1326
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_subscriptions_by_provider_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.get_subscriptions_by_provider_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_subscriptions_by_provider_id" title="Link to this definition">¶</a></dt>
|
|
1327
|
+
<dd><p>Get subscriptions by provider subscription ID</p>
|
|
1328
|
+
</dd></dl>
|
|
1329
|
+
|
|
1330
|
+
<dl class="py method">
|
|
1331
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_user_subscriptions">
|
|
1332
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_user_subscriptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.get_user_subscriptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_user_subscriptions" title="Link to this definition">¶</a></dt>
|
|
1333
|
+
<dd><p>Get all subscriptions for a user</p>
|
|
1334
|
+
</dd></dl>
|
|
1335
|
+
|
|
1336
|
+
<dl class="py method">
|
|
1337
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.list_plans">
|
|
1338
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">list_plans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.list_plans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.list_plans" title="Link to this definition">¶</a></dt>
|
|
1339
|
+
<dd><p>List all subscription plans</p>
|
|
1340
|
+
</dd></dl>
|
|
1341
|
+
|
|
1342
|
+
<dl class="py method">
|
|
1343
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_plan">
|
|
1344
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_plan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plan_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan" title="mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><span class="pre">SubscriptionPlan</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.update_plan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_plan" title="Link to this definition">¶</a></dt>
|
|
1345
|
+
<dd><p>Update an existing subscription plan</p>
|
|
1346
|
+
</dd></dl>
|
|
1347
|
+
|
|
1348
|
+
<dl class="py method">
|
|
1349
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_period">
|
|
1350
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_subscription_period</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">period_start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">period_end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.update_subscription_period"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_period" title="Link to this definition">¶</a></dt>
|
|
1351
|
+
<dd><p>Update a subscription’s billing period</p>
|
|
1352
|
+
</dd></dl>
|
|
1353
|
+
|
|
1354
|
+
<dl class="py method">
|
|
1355
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_status">
|
|
1356
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_subscription_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription" title="mindroot.coreplugins.subscriptions.models.UserSubscription"><span class="pre">UserSubscription</span></a></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/subscription_manager.html#SubscriptionManager.update_subscription_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_status" title="Link to this definition">¶</a></dt>
|
|
1357
|
+
<dd><p>Update a subscription’s status</p>
|
|
1358
|
+
</dd></dl>
|
|
1359
|
+
|
|
1360
|
+
</dd></dl>
|
|
1361
|
+
|
|
1362
|
+
</section>
|
|
1363
|
+
<section id="module-mindroot.coreplugins.subscriptions.webhook_handler">
|
|
1364
|
+
<span id="mindroot-coreplugins-subscriptions-webhook-handler-module"></span><h2>mindroot.coreplugins.subscriptions.webhook_handler module<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions.webhook_handler" title="Link to this heading">¶</a></h2>
|
|
1365
|
+
<dl class="py class">
|
|
1366
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler">
|
|
1367
|
+
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mindroot.coreplugins.subscriptions.webhook_handler.</span></span><span class="sig-name descname"><span class="pre">WebhookHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subscription_manager</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager" title="mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager"><span class="pre">SubscriptionManager</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">credit_integration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration" title="mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration"><span class="pre">CreditIntegration</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/webhook_handler.html#WebhookHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler" title="Link to this definition">¶</a></dt>
|
|
1368
|
+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
1369
|
+
<p>Handles webhook events from payment providers for subscription events</p>
|
|
1370
|
+
<dl class="py method">
|
|
1371
|
+
<dt class="sig sig-object py" id="mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler.handle_stripe_event">
|
|
1372
|
+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_stripe_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/mindroot/coreplugins/subscriptions/webhook_handler.html#WebhookHandler.handle_stripe_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler.handle_stripe_event" title="Link to this definition">¶</a></dt>
|
|
1373
|
+
<dd><p>Process Stripe webhook events related to subscriptions</p>
|
|
1374
|
+
<dl class="field-list simple">
|
|
1375
|
+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
1376
|
+
<dd class="field-odd"><p><strong>event</strong> – Stripe event object</p>
|
|
1377
|
+
</dd>
|
|
1378
|
+
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
1379
|
+
<dd class="field-even"><p>Processing result</p>
|
|
1380
|
+
</dd>
|
|
1381
|
+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
1382
|
+
<dd class="field-odd"><p>Optional[Dict]</p>
|
|
1383
|
+
</dd>
|
|
1384
|
+
</dl>
|
|
1385
|
+
</dd></dl>
|
|
1386
|
+
|
|
1387
|
+
</dd></dl>
|
|
1388
|
+
|
|
1389
|
+
</section>
|
|
1390
|
+
<section id="module-mindroot.coreplugins.subscriptions">
|
|
1391
|
+
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-mindroot.coreplugins.subscriptions" title="Link to this heading">¶</a></h2>
|
|
1392
|
+
</section>
|
|
1393
|
+
</section>
|
|
1394
|
+
|
|
1395
|
+
</article>
|
|
1396
|
+
</div>
|
|
1397
|
+
<footer>
|
|
1398
|
+
|
|
1399
|
+
<div class="related-pages">
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
</div>
|
|
1403
|
+
<div class="bottom-of-page">
|
|
1404
|
+
<div class="left-details">
|
|
1405
|
+
<div class="copyright">
|
|
1406
|
+
Copyright © 2025, Jason Livesay
|
|
1407
|
+
</div>
|
|
1408
|
+
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
1409
|
+
|
|
1410
|
+
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
1411
|
+
|
|
1412
|
+
</div>
|
|
1413
|
+
<div class="right-details">
|
|
1414
|
+
|
|
1415
|
+
</div>
|
|
1416
|
+
</div>
|
|
1417
|
+
|
|
1418
|
+
</footer>
|
|
1419
|
+
</div>
|
|
1420
|
+
<aside class="toc-drawer">
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<div class="toc-sticky toc-scroll">
|
|
1424
|
+
<div class="toc-title-container">
|
|
1425
|
+
<span class="toc-title">
|
|
1426
|
+
On this page
|
|
1427
|
+
</span>
|
|
1428
|
+
</div>
|
|
1429
|
+
<div class="toc-tree-container">
|
|
1430
|
+
<div class="toc-tree">
|
|
1431
|
+
<ul>
|
|
1432
|
+
<li><a class="reference internal" href="#">mindroot.coreplugins.subscriptions package</a><ul>
|
|
1433
|
+
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
|
1434
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.credit_integration">mindroot.coreplugins.subscriptions.credit_integration module</a><ul>
|
|
1435
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration"><code class="docutils literal notranslate"><span class="pre">CreditIntegration</span></code></a><ul>
|
|
1436
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.allocate_subscription_credits"><code class="docutils literal notranslate"><span class="pre">CreditIntegration.allocate_subscription_credits()</span></code></a></li>
|
|
1437
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.credit_integration.CreditIntegration.check_credit_balance"><code class="docutils literal notranslate"><span class="pre">CreditIntegration.check_credit_balance()</span></code></a></li>
|
|
1438
|
+
</ul>
|
|
1439
|
+
</li>
|
|
1440
|
+
</ul>
|
|
1441
|
+
</li>
|
|
1442
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.default_templates">mindroot.coreplugins.subscriptions.default_templates module</a></li>
|
|
1443
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.mod">mindroot.coreplugins.subscriptions.mod module</a><ul>
|
|
1444
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin"><code class="docutils literal notranslate"><span class="pre">SubscriptionsPlugin</span></code></a><ul>
|
|
1445
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.SubscriptionsPlugin.create_components"><code class="docutils literal notranslate"><span class="pre">SubscriptionsPlugin.create_components()</span></code></a></li>
|
|
1446
|
+
</ul>
|
|
1447
|
+
</li>
|
|
1448
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.activate_plan_feature"><code class="docutils literal notranslate"><span class="pre">activate_plan_feature()</span></code></a></li>
|
|
1449
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.activate_subscription_plan"><code class="docutils literal notranslate"><span class="pre">activate_subscription_plan()</span></code></a></li>
|
|
1450
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.cancel_subscription"><code class="docutils literal notranslate"><span class="pre">cancel_subscription()</span></code></a></li>
|
|
1451
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.create_page_template"><code class="docutils literal notranslate"><span class="pre">create_page_template()</span></code></a></li>
|
|
1452
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.create_plan_feature"><code class="docutils literal notranslate"><span class="pre">create_plan_feature()</span></code></a></li>
|
|
1453
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.create_subscription_plan"><code class="docutils literal notranslate"><span class="pre">create_subscription_plan()</span></code></a></li>
|
|
1454
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.deactivate_plan_feature"><code class="docutils literal notranslate"><span class="pre">deactivate_plan_feature()</span></code></a></li>
|
|
1455
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.deactivate_subscription_plan"><code class="docutils literal notranslate"><span class="pre">deactivate_subscription_plan()</span></code></a></li>
|
|
1456
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_available_features"><code class="docutils literal notranslate"><span class="pre">get_available_features()</span></code></a></li>
|
|
1457
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_base_path"><code class="docutils literal notranslate"><span class="pre">get_base_path()</span></code></a></li>
|
|
1458
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_my_subscriptions"><code class="docutils literal notranslate"><span class="pre">get_my_subscriptions()</span></code></a></li>
|
|
1459
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_page_templates"><code class="docutils literal notranslate"><span class="pre">get_page_templates()</span></code></a></li>
|
|
1460
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_by_provider_id"><code class="docutils literal notranslate"><span class="pre">get_subscription_by_provider_id()</span></code></a></li>
|
|
1461
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_plan"><code class="docutils literal notranslate"><span class="pre">get_subscription_plan()</span></code></a></li>
|
|
1462
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_subscription_plans"><code class="docutils literal notranslate"><span class="pre">get_subscription_plans()</span></code></a></li>
|
|
1463
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.get_user_subscriptions"><code class="docutils literal notranslate"><span class="pre">get_user_subscriptions()</span></code></a></li>
|
|
1464
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.initialize_default_features"><code class="docutils literal notranslate"><span class="pre">initialize_default_features()</span></code></a></li>
|
|
1465
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.initialize_default_template"><code class="docutils literal notranslate"><span class="pre">initialize_default_template()</span></code></a></li>
|
|
1466
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.list_subscription_plans"><code class="docutils literal notranslate"><span class="pre">list_subscription_plans()</span></code></a></li>
|
|
1467
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.process_subscription_event"><code class="docutils literal notranslate"><span class="pre">process_subscription_event()</span></code></a></li>
|
|
1468
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.set_default_template"><code class="docutils literal notranslate"><span class="pre">set_default_template()</span></code></a></li>
|
|
1469
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.startup"><code class="docutils literal notranslate"><span class="pre">startup()</span></code></a></li>
|
|
1470
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.update_page_template"><code class="docutils literal notranslate"><span class="pre">update_page_template()</span></code></a></li>
|
|
1471
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.update_plan_feature"><code class="docutils literal notranslate"><span class="pre">update_plan_feature()</span></code></a></li>
|
|
1472
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.update_subscription_plan"><code class="docutils literal notranslate"><span class="pre">update_subscription_plan()</span></code></a></li>
|
|
1473
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.mod.update_subscription_status"><code class="docutils literal notranslate"><span class="pre">update_subscription_status()</span></code></a></li>
|
|
1474
|
+
</ul>
|
|
1475
|
+
</li>
|
|
1476
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.models">mindroot.coreplugins.subscriptions.models module</a><ul>
|
|
1477
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate"><code class="docutils literal notranslate"><span class="pre">PageTemplate</span></code></a><ul>
|
|
1478
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.css_template"><code class="docutils literal notranslate"><span class="pre">PageTemplate.css_template</span></code></a></li>
|
|
1479
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.description"><code class="docutils literal notranslate"><span class="pre">PageTemplate.description</span></code></a></li>
|
|
1480
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.from_dict"><code class="docutils literal notranslate"><span class="pre">PageTemplate.from_dict()</span></code></a></li>
|
|
1481
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.html_template"><code class="docutils literal notranslate"><span class="pre">PageTemplate.html_template</span></code></a></li>
|
|
1482
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.is_default"><code class="docutils literal notranslate"><span class="pre">PageTemplate.is_default</span></code></a></li>
|
|
1483
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.js_template"><code class="docutils literal notranslate"><span class="pre">PageTemplate.js_template</span></code></a></li>
|
|
1484
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.name"><code class="docutils literal notranslate"><span class="pre">PageTemplate.name</span></code></a></li>
|
|
1485
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.template_id"><code class="docutils literal notranslate"><span class="pre">PageTemplate.template_id</span></code></a></li>
|
|
1486
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PageTemplate.to_dict"><code class="docutils literal notranslate"><span class="pre">PageTemplate.to_dict()</span></code></a></li>
|
|
1487
|
+
</ul>
|
|
1488
|
+
</li>
|
|
1489
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature"><code class="docutils literal notranslate"><span class="pre">PlanFeature</span></code></a><ul>
|
|
1490
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.active"><code class="docutils literal notranslate"><span class="pre">PlanFeature.active</span></code></a></li>
|
|
1491
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.default_value"><code class="docutils literal notranslate"><span class="pre">PlanFeature.default_value</span></code></a></li>
|
|
1492
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.description"><code class="docutils literal notranslate"><span class="pre">PlanFeature.description</span></code></a></li>
|
|
1493
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.display_order"><code class="docutils literal notranslate"><span class="pre">PlanFeature.display_order</span></code></a></li>
|
|
1494
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.feature_id"><code class="docutils literal notranslate"><span class="pre">PlanFeature.feature_id</span></code></a></li>
|
|
1495
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.from_dict"><code class="docutils literal notranslate"><span class="pre">PlanFeature.from_dict()</span></code></a></li>
|
|
1496
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.name"><code class="docutils literal notranslate"><span class="pre">PlanFeature.name</span></code></a></li>
|
|
1497
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.options"><code class="docutils literal notranslate"><span class="pre">PlanFeature.options</span></code></a></li>
|
|
1498
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.to_dict"><code class="docutils literal notranslate"><span class="pre">PlanFeature.to_dict()</span></code></a></li>
|
|
1499
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.PlanFeature.type"><code class="docutils literal notranslate"><span class="pre">PlanFeature.type</span></code></a></li>
|
|
1500
|
+
</ul>
|
|
1501
|
+
</li>
|
|
1502
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan</span></code></a><ul>
|
|
1503
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.active"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.active</span></code></a></li>
|
|
1504
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.credits_per_cycle"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.credits_per_cycle</span></code></a></li>
|
|
1505
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.currency"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.currency</span></code></a></li>
|
|
1506
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.description"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.description</span></code></a></li>
|
|
1507
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.features"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.features</span></code></a></li>
|
|
1508
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.from_dict"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.from_dict()</span></code></a></li>
|
|
1509
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.interval"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.interval</span></code></a></li>
|
|
1510
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.metadata"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.metadata</span></code></a></li>
|
|
1511
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.name"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.name</span></code></a></li>
|
|
1512
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.plan_id"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.plan_id</span></code></a></li>
|
|
1513
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.price"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.price</span></code></a></li>
|
|
1514
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.SubscriptionPlan.to_dict"><code class="docutils literal notranslate"><span class="pre">SubscriptionPlan.to_dict()</span></code></a></li>
|
|
1515
|
+
</ul>
|
|
1516
|
+
</li>
|
|
1517
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription"><code class="docutils literal notranslate"><span class="pre">UserSubscription</span></code></a><ul>
|
|
1518
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.cancel_at_period_end"><code class="docutils literal notranslate"><span class="pre">UserSubscription.cancel_at_period_end</span></code></a></li>
|
|
1519
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.created_at"><code class="docutils literal notranslate"><span class="pre">UserSubscription.created_at</span></code></a></li>
|
|
1520
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_end"><code class="docutils literal notranslate"><span class="pre">UserSubscription.current_period_end</span></code></a></li>
|
|
1521
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.current_period_start"><code class="docutils literal notranslate"><span class="pre">UserSubscription.current_period_start</span></code></a></li>
|
|
1522
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.from_dict"><code class="docutils literal notranslate"><span class="pre">UserSubscription.from_dict()</span></code></a></li>
|
|
1523
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.metadata"><code class="docutils literal notranslate"><span class="pre">UserSubscription.metadata</span></code></a></li>
|
|
1524
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.payment_provider"><code class="docutils literal notranslate"><span class="pre">UserSubscription.payment_provider</span></code></a></li>
|
|
1525
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.plan_id"><code class="docutils literal notranslate"><span class="pre">UserSubscription.plan_id</span></code></a></li>
|
|
1526
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.provider_subscription_id"><code class="docutils literal notranslate"><span class="pre">UserSubscription.provider_subscription_id</span></code></a></li>
|
|
1527
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.status"><code class="docutils literal notranslate"><span class="pre">UserSubscription.status</span></code></a></li>
|
|
1528
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.subscription_id"><code class="docutils literal notranslate"><span class="pre">UserSubscription.subscription_id</span></code></a></li>
|
|
1529
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.to_dict"><code class="docutils literal notranslate"><span class="pre">UserSubscription.to_dict()</span></code></a></li>
|
|
1530
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.updated_at"><code class="docutils literal notranslate"><span class="pre">UserSubscription.updated_at</span></code></a></li>
|
|
1531
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.models.UserSubscription.username"><code class="docutils literal notranslate"><span class="pre">UserSubscription.username</span></code></a></li>
|
|
1532
|
+
</ul>
|
|
1533
|
+
</li>
|
|
1534
|
+
</ul>
|
|
1535
|
+
</li>
|
|
1536
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.router">mindroot.coreplugins.subscriptions.router module</a><ul>
|
|
1537
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_activate_feature"><code class="docutils literal notranslate"><span class="pre">api_activate_feature()</span></code></a></li>
|
|
1538
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_activate_plan"><code class="docutils literal notranslate"><span class="pre">api_activate_plan()</span></code></a></li>
|
|
1539
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_cancel_subscription"><code class="docutils literal notranslate"><span class="pre">api_cancel_subscription()</span></code></a></li>
|
|
1540
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_create_checkout"><code class="docutils literal notranslate"><span class="pre">api_create_checkout()</span></code></a></li>
|
|
1541
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_create_feature"><code class="docutils literal notranslate"><span class="pre">api_create_feature()</span></code></a></li>
|
|
1542
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_create_plan"><code class="docutils literal notranslate"><span class="pre">api_create_plan()</span></code></a></li>
|
|
1543
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_create_template"><code class="docutils literal notranslate"><span class="pre">api_create_template()</span></code></a></li>
|
|
1544
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_deactivate_feature"><code class="docutils literal notranslate"><span class="pre">api_deactivate_feature()</span></code></a></li>
|
|
1545
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_deactivate_plan"><code class="docutils literal notranslate"><span class="pre">api_deactivate_plan()</span></code></a></li>
|
|
1546
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_get_all_plans"><code class="docutils literal notranslate"><span class="pre">api_get_all_plans()</span></code></a></li>
|
|
1547
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_get_features"><code class="docutils literal notranslate"><span class="pre">api_get_features()</span></code></a></li>
|
|
1548
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_get_my_subscriptions"><code class="docutils literal notranslate"><span class="pre">api_get_my_subscriptions()</span></code></a></li>
|
|
1549
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_get_plans"><code class="docutils literal notranslate"><span class="pre">api_get_plans()</span></code></a></li>
|
|
1550
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_get_templates"><code class="docutils literal notranslate"><span class="pre">api_get_templates()</span></code></a></li>
|
|
1551
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_set_default_template"><code class="docutils literal notranslate"><span class="pre">api_set_default_template()</span></code></a></li>
|
|
1552
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_update_feature"><code class="docutils literal notranslate"><span class="pre">api_update_feature()</span></code></a></li>
|
|
1553
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_update_plan"><code class="docutils literal notranslate"><span class="pre">api_update_plan()</span></code></a></li>
|
|
1554
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.api_update_template"><code class="docutils literal notranslate"><span class="pre">api_update_template()</span></code></a></li>
|
|
1555
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.router.subscription_page"><code class="docutils literal notranslate"><span class="pre">subscription_page()</span></code></a></li>
|
|
1556
|
+
</ul>
|
|
1557
|
+
</li>
|
|
1558
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.storage">mindroot.coreplugins.subscriptions.storage module</a><ul>
|
|
1559
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage</span></code></a><ul>
|
|
1560
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_features"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_all_features()</span></code></a></li>
|
|
1561
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_plans"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_all_plans()</span></code></a></li>
|
|
1562
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_all_templates"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_all_templates()</span></code></a></li>
|
|
1563
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_default_template"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_default_template()</span></code></a></li>
|
|
1564
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_feature"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_feature()</span></code></a></li>
|
|
1565
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_plan()</span></code></a></li>
|
|
1566
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscription"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_subscription()</span></code></a></li>
|
|
1567
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_subscriptions_by_provider_id"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_subscriptions_by_provider_id()</span></code></a></li>
|
|
1568
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_template"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_template()</span></code></a></li>
|
|
1569
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.get_user_subscriptions"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.get_user_subscriptions()</span></code></a></li>
|
|
1570
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.set_default_template"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.set_default_template()</span></code></a></li>
|
|
1571
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_feature"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.store_feature()</span></code></a></li>
|
|
1572
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.store_plan()</span></code></a></li>
|
|
1573
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_subscription"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.store_subscription()</span></code></a></li>
|
|
1574
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.store_template"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.store_template()</span></code></a></li>
|
|
1575
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_feature"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.update_feature()</span></code></a></li>
|
|
1576
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.update_plan()</span></code></a></li>
|
|
1577
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.storage.SubscriptionStorage.update_subscription"><code class="docutils literal notranslate"><span class="pre">SubscriptionStorage.update_subscription()</span></code></a></li>
|
|
1578
|
+
</ul>
|
|
1579
|
+
</li>
|
|
1580
|
+
</ul>
|
|
1581
|
+
</li>
|
|
1582
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.stripe_integration">mindroot.coreplugins.subscriptions.stripe_integration module</a><ul>
|
|
1583
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration"><code class="docutils literal notranslate"><span class="pre">StripeIntegration</span></code></a><ul>
|
|
1584
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.cancel_subscription"><code class="docutils literal notranslate"><span class="pre">StripeIntegration.cancel_subscription()</span></code></a></li>
|
|
1585
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.stripe_integration.StripeIntegration.create_checkout_session"><code class="docutils literal notranslate"><span class="pre">StripeIntegration.create_checkout_session()</span></code></a></li>
|
|
1586
|
+
</ul>
|
|
1587
|
+
</li>
|
|
1588
|
+
</ul>
|
|
1589
|
+
</li>
|
|
1590
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.subscription_manager">mindroot.coreplugins.subscriptions.subscription_manager module</a><ul>
|
|
1591
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager</span></code></a><ul>
|
|
1592
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.cancel_subscription"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.cancel_subscription()</span></code></a></li>
|
|
1593
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.create_plan()</span></code></a></li>
|
|
1594
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.create_subscription"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.create_subscription()</span></code></a></li>
|
|
1595
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.deactivate_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.deactivate_plan()</span></code></a></li>
|
|
1596
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.get_plan()</span></code></a></li>
|
|
1597
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_subscriptions_by_provider_id"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.get_subscriptions_by_provider_id()</span></code></a></li>
|
|
1598
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.get_user_subscriptions"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.get_user_subscriptions()</span></code></a></li>
|
|
1599
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.list_plans"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.list_plans()</span></code></a></li>
|
|
1600
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_plan"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.update_plan()</span></code></a></li>
|
|
1601
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_period"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.update_subscription_period()</span></code></a></li>
|
|
1602
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.subscription_manager.SubscriptionManager.update_subscription_status"><code class="docutils literal notranslate"><span class="pre">SubscriptionManager.update_subscription_status()</span></code></a></li>
|
|
1603
|
+
</ul>
|
|
1604
|
+
</li>
|
|
1605
|
+
</ul>
|
|
1606
|
+
</li>
|
|
1607
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions.webhook_handler">mindroot.coreplugins.subscriptions.webhook_handler module</a><ul>
|
|
1608
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler"><code class="docutils literal notranslate"><span class="pre">WebhookHandler</span></code></a><ul>
|
|
1609
|
+
<li><a class="reference internal" href="#mindroot.coreplugins.subscriptions.webhook_handler.WebhookHandler.handle_stripe_event"><code class="docutils literal notranslate"><span class="pre">WebhookHandler.handle_stripe_event()</span></code></a></li>
|
|
1610
|
+
</ul>
|
|
1611
|
+
</li>
|
|
1612
|
+
</ul>
|
|
1613
|
+
</li>
|
|
1614
|
+
<li><a class="reference internal" href="#module-mindroot.coreplugins.subscriptions">Module contents</a></li>
|
|
1615
|
+
</ul>
|
|
1616
|
+
</li>
|
|
1617
|
+
</ul>
|
|
1618
|
+
|
|
1619
|
+
</div>
|
|
1620
|
+
</div>
|
|
1621
|
+
</div>
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
</aside>
|
|
1625
|
+
</div>
|
|
1626
|
+
</div><script src="../_static/documentation_options.js?v=3c16008f"></script>
|
|
1627
|
+
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
1628
|
+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
1629
|
+
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
|
1630
|
+
</body>
|
|
1631
|
+
</html>
|