index

• shipany.bot package
  • Subpackages
    • Supported actions / shipany.bot.actions
      • Subpackages
        • shipany.bot.actions.broken_action package
          • Submodules
          • shipany.bot.actions.broken_action.v1 module
            • BrokenAction
          • shipany.bot.actions.broken_action.v2 module
          • shipany.bot.actions.broken_action.v3 module
            • BrokenAction
              • BrokenAction.name
          • shipany.bot.actions.broken_action.v4 module
            • BrokenAction
              • BrokenAction.name
          • Module contents
        • shipany.bot.actions.http_request package
          • Submodules
          • shipany.bot.actions.http_request.v1 module
            • HttpMethods
              • HttpMethods.GET
              • HttpMethods.POST
              • HttpMethods.PUT
              • HttpMethods.PATCH
              • HttpMethods.DELETE
              • HttpMethods.__new__()
            • HttpRequest
              • HttpRequest.name
              • HttpRequest.method
              • HttpRequest.url
              • HttpRequest.headers
              • HttpRequest.query_string_parameters
              • HttpRequest.basic_auth
              • HttpRequest.timeout
              • HttpRequest.body
              • HttpRequest.captures
          • Module contents
        • shipany.bot.actions.json_path_action package
          • Submodules
          • shipany.bot.actions.json_path_action.v1 module
            • JsonPathAction
              • JsonPathAction.name
              • JsonPathAction.expression
              • JsonPathAction.captures
              • JsonPathAction.input_
          • Module contents
        • shipany.bot.actions.message_action package
          • Submodules
          • shipany.bot.actions.message_action.v1 module
            • SupportedMessageActionTypes
              • SupportedMessageActionTypes.answer
              • SupportedMessageActionTypes.reply
              • SupportedMessageActionTypes.__new__()
            • MessageAction
              • MessageAction.name
              • MessageAction.action_type
              • MessageAction.content
          • Module contents
        • shipany.bot.actions.state_action package
          • Submodules
          • shipany.bot.actions.state_action.v1 module
            • SupportedStateActionTypes
              • SupportedStateActionTypes.remove
              • SupportedStateActionTypes.store
              • SupportedStateActionTypes.load
              • SupportedStateActionTypes.__new__()
            • StateAction
              • StateAction.name
              • StateAction.action_type
              • StateAction.key
              • StateAction.value
              • StateAction.scope
              • StateAction.ttl
              • StateAction.validate_value
          • Module contents
        • shipany.bot.actions.timeout_action package
          • Submodules
          • shipany.bot.actions.timeout_action.v1 module
            • TimeoutAction
              • TimeoutAction.duration
              • TimeoutAction.emit_event
              • TimeoutAction.scope
              • TimeoutAction.delta
          • Module contents
        • shipany.bot.actions.transition_action package
          • Submodules
          • shipany.bot.actions.transition_action.v1 module
            • TransitionAction
              • TransitionAction.name
              • TransitionAction.next_step
              • TransitionAction.condition
          • Module contents
      • Module contents
    • Command line interface / shipany.bot.cli
      • Submodules
      • shipany.bot.cli.main module
        • logger
        • app
        • run()
        • schema()
        • version()
    • Contrib modules
      • Subpackages
        • Aiogram
          • Subpackages
            • shipany.bot.contrib.aiogram.factories package
              • Submodules
              • shipany.bot.contrib.aiogram.factories.send_message module
                • construct_from()
              • shipany.bot.contrib.aiogram.factories.telegram_objects module
                • bot_from_config()
                • bot()
                • dispatcher()
              • Module contents
            • shipany.bot.contrib.aiogram.persistency package
              • Submodules
              • shipany.bot.contrib.aiogram.persistency.bindings module
                • default_bindings()
              • shipany.bot.contrib.aiogram.persistency.handles module
                • EventInspector
                  • EventInspector.__init__()
                  • EventInspector.user_id()
                  • EventInspector.chat_id()
                • AiogramHandleGenerator
                  • AiogramHandleGenerator.__init__()
                  • AiogramHandleGenerator.generate()
                • HandleGeneratorFactory
                  • HandleGeneratorFactory.create()
              • Module contents
            • shipany.bot.contrib.aiogram.process package
              • Subpackages
                • shipany.bot.contrib.aiogram.process.broken_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.broken_action.v1 module
                  • Module contents
                • shipany.bot.contrib.aiogram.process.http_request package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.http_request.bindings module
                    • default_bindings()
                  • shipany.bot.contrib.aiogram.process.http_request.namespaces module
                    • response_namespace()
                  • shipany.bot.contrib.aiogram.process.http_request.v1 module
                    • process()
                  • Module contents
                • shipany.bot.contrib.aiogram.process.json_path_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.json_path_action.v1 module
                    • process()
                  • Module contents
                • shipany.bot.contrib.aiogram.process.message_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.message_action.v1 module
                    • process()
                  • Module contents
                • shipany.bot.contrib.aiogram.process.state_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.state_action.v1 module
                    • process()
                  • Module contents
                • shipany.bot.contrib.aiogram.process.timeout_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.timeout_action.v1 module
                    • process()
                  • Module contents
                • shipany.bot.contrib.aiogram.process.transition_action package
                  • Submodules
                  • shipany.bot.contrib.aiogram.process.transition_action.v1 module
                    • process()
                  • Module contents
              • Submodules
              • shipany.bot.contrib.aiogram.process.bindings module
                • default_bindings()
              • Module contents
            • shipany.bot.contrib.aiogram.renders package
              • Submodules
              • shipany.bot.contrib.aiogram.renders.bindings module
                • default_bindings()
              • shipany.bot.contrib.aiogram.renders.namespaces module
                • message_namespace()
                • user_namespace()
                • reaction_namespace()
              • Module contents
            • shipany.bot.contrib.aiogram.webhook package
              • Submodules
              • shipany.bot.contrib.aiogram.webhook.bindings module
                • default_bindings()
              • shipany.bot.contrib.aiogram.webhook.events module
                • OnStartupDispatcher
                • OnUpdatesDispatcher
                • OnShutdownDispatcher
              • Module contents
          • Submodules
          • shipany.bot.contrib.aiogram.backend module
            • serve()
          • shipany.bot.contrib.aiogram.bindings module
            • default_bindings()
          • shipany.bot.contrib.aiogram.router module
            • handler()
            • activate_entry_points()
            • create_handlers()
            • create()
          • Module contents
        • FastAPI
          • Submodules
          • shipany.bot.contrib.fastapi.app module
            • app
            • root()
            • header_checks()
            • query_param_checks()
            • add_webhooks()
          • shipany.bot.contrib.fastapi.bindings module
            • default_bindings()
          • shipany.bot.contrib.fastapi.server module
            • FastApiWebServer
              • FastApiWebServer.serve()
          • Module contents
        • Apschedulers
          • Submodules
          • shipany.bot.contrib.apschedulers.bindings module
            • default_bindings()
          • shipany.bot.contrib.apschedulers.server module
            • ApschedulerScheduleServer
              • ApschedulerScheduleServer.__init__()
              • ApschedulerScheduleServer.serve()
              • ApschedulerScheduleServer.add_job()
          • Module contents
        • shipany.bot.contrib.semver package
          • Submodules
          • shipany.bot.contrib.semver.model module
            • ManifestVersion
          • Module contents
      • Module contents
    • shipany.bot.conversation package
      • Subpackages
        • shipany.bot.conversation.handlers package
          • Submodules
          • shipany.bot.conversation.handlers.actions module
            • Terminate
            • AwaitObjectAndContinue
              • AwaitObjectAndContinue.value
            • Continue
            • GoToStep
              • GoToStep.step_id
            • handle()
          • shipany.bot.conversation.handlers.activations module
            • ActivationHandler
              • ActivationHandler.__init__()
              • ActivationHandler.traverse_actions()
          • Module contents
        • shipany.bot.conversation.models package
          • Subpackages
            • shipany.bot.conversation.models.activations package
              • Submodules
              • shipany.bot.conversation.models.activations.base module
                • BaseActivation
                  • BaseActivation.next_step
                  • BaseActivation.condition
              • shipany.bot.conversation.models.activations.command module
                • CommandActivation
                  • CommandActivation.command
                  • CommandActivation.prefix
                  • CommandActivation.check_command_prefix
              • shipany.bot.conversation.models.activations.event module
                • EventActivation
                  • EventActivation.event
                  • EventActivation.validate_event
              • shipany.bot.conversation.models.activations.timeout module
                • TimeoutActivation
                  • TimeoutActivation.timeout_id
              • shipany.bot.conversation.models.activations.webhook module
                • WebhookActivation
                  • WebhookActivation.webhook
              • Module contents
          • Submodules
          • shipany.bot.conversation.models.action module
            • BaseAction
              • BaseAction.name
          • shipany.bot.conversation.models.conversation module
            • Conversation
              • Conversation.conversation_id
              • Conversation.activations
              • Conversation.steps
          • shipany.bot.conversation.models.flow module
            • Flow
              • Flow.self_schema
              • Flow.name
              • Flow.description
              • Flow.version
              • Flow.conversations
              • Flow.webhooks
          • shipany.bot.conversation.models.steps module
            • Step
              • Step.step_id
              • Step.actions
          • shipany.bot.conversation.models.validators module
            • check_for_orphaned_conversations()
            • check_missed_start_state()
          • shipany.bot.conversation.models.webhooks module
            • WebhookMethod
              • WebhookMethod.POST
              • WebhookMethod.__new__()
            • Expectation
              • Expectation.headers
              • Expectation.query_params
            • WebhookParameters
              • WebhookParameters.webhook_id
              • WebhookParameters.path
              • WebhookParameters.status_code_ok
              • WebhookParameters.status_code_error
              • WebhookParameters.method
              • WebhookParameters.expect
          • Module contents
        • shipany.bot.conversation.renders package
          • Submodules
          • shipany.bot.conversation.renders.attributes_mapping module
            • VariablesGetter
              • VariablesGetter.__init__()
          • shipany.bot.conversation.renders.jinja_env module
            • template_from_context()
            • value_from_context()
          • Module contents
      • Submodules
      • shipany.bot.conversation.context module
        • conversation_context()
        • ConversationContext
          • ConversationContext.runtime
          • ConversationContext.captures
          • ConversationContext.event
      • shipany.bot.conversation.errors module
        • ConversationRuntimeError
        • NoStepFoundError
          • NoStepFoundError.__init__()
        • ActionNotImplementedError
          • ActionNotImplementedError.__init__()
        • ActivationPreconditionNotMeetError
          • ActivationPreconditionNotMeetError.__init__()
      • shipany.bot.conversation.loader module
        • load()
      • Module contents
    • shipany.bot.errors package
      • Module contents
        • ShipAnyError
        • FlowValidationError
        • EventProcessingNotImplementedError
    • Scheduler jobs / shipany.bot.jobs
      • Submodules
      • shipany.bot.jobs.timeout module
        • triggered()
      • shipany.bot.jobs.webhook module
        • triggered()
        • process_telegram_update()
        • process_webhook()
      • Module contents
    • JSONLogic implementation / shipany.bot.jsonlogic
      • Submodules
      • shipany.bot.jsonlogic.apply module
        • apply()
      • shipany.bot.jsonlogic.model module
        • EqualsOperation
          • EqualsOperation.args
          • EqualsOperation.check_args_length
        • InOperation
          • InOperation.args
          • InOperation.check_args_length
        • AndOperation
          • AndOperation.args
          • AndOperation.check_args_length
        • OrOperation
          • OrOperation.args
          • OrOperation.check_args_length
        • NotOperation
          • NotOperation.args
          • NotOperation.check_args_length
        • VarOperation
          • VarOperation.var
          • VarOperation.scope
      • Module contents
    • Persistency / shipany.bot.persistency
      • Submodules
      • shipany.bot.persistency.handles module
        • HandleGenerator
          • HandleGenerator.generate()
        • NoScopeHandleGenerator
          • NoScopeHandleGenerator.generate()
        • HandleGeneratorFactory
          • HandleGeneratorFactory.create()
      • shipany.bot.persistency.scopes module
        • Scope
          • Scope.chat
          • Scope.user
          • Scope.__new__()
      • Module contents
    • shipany.bot.providers package
      • Submodules
      • shipany.bot.providers.bindings module
        • default_bindings()
      • shipany.bot.providers.captures module
        • CapturesProvider
          • CapturesProvider.snapshot()
        • CapturesModifier
          • CapturesModifier.__init__()
          • CapturesModifier.set()
          • CapturesModifier.get()
          • CapturesModifier.remove()
        • InMemoryCapturesProvider
          • InMemoryCapturesProvider.__init__()
          • InMemoryCapturesProvider.snapshot()
      • shipany.bot.providers.secrets module
        • SecretsProvider
          • SecretsProvider.snapshot()
        • StubSecretsProvider
          • StubSecretsProvider.__init__()
          • StubSecretsProvider.snapshot()
      • Module contents
    • Runtime / shipany.bot.runtime
      • Submodules
      • shipany.bot.runtime.context module
        • RuntimeContext
          • RuntimeContext.secrets
        • runtime_context()
      • shipany.bot.runtime.events_handler module
        • handle()
      • shipany.bot.runtime.preconditions module
        • check_preconditions()
      • Module contents
    • Servers / shipany.bot.servers
      • Submodules
      • shipany.bot.servers.bot module
        • BotServer
          • BotServer.serve()
      • shipany.bot.servers.schedule module
        • ScheduleServer
          • ScheduleServer.serve()
          • ScheduleServer.add_job()
      • shipany.bot.servers.web module
        • WebServer
          • WebServer.serve()
        • OnStartupDispatcher
        • OnUpdatesDispatcher
        • OnShutdownDispatcher
      • Module contents
  • Submodules
  • shipany.bot.config module
    • ApplicationConfig
      • ApplicationConfig.bot_token
      • ApplicationConfig.telegram_api_url
      • ApplicationConfig.telegram_webhook_url
      • ApplicationConfig.telegram_webhook_secret
      • ApplicationConfig.web_server_host
      • ApplicationConfig.web_server_port