BusinessData#

pydantic model mobu.models.business.base.BusinessData#

Status of a running business.

Each type of business with additional data should create a new type inheriting from this type and adding that information.

Parameters:

data (Any)

Show JSON schema
{
   "title": "BusinessData",
   "description": "Status of a running business.\n\nEach type of business with additional data should create a new type\ninheriting from this type and adding that information.",
   "type": "object",
   "properties": {
      "name": {
         "examples": [
            "Business"
         ],
         "title": "Type of business",
         "type": "string"
      },
      "failure_count": {
         "examples": [
            0
         ],
         "title": "Number of failures",
         "type": "integer"
      },
      "success_count": {
         "examples": [
            25
         ],
         "title": "Number of successes",
         "type": "integer"
      },
      "refreshing": {
         "title": "If the business is currently in the process of refreshing",
         "type": "boolean"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "failure_count",
      "success_count",
      "refreshing"
   ]
}

Config:
  • extra: str = forbid

Fields:
field failure_count: int [Required]#
field name: str [Required]#
field refreshing: bool [Required]#
field success_count: int [Required]#