Common

Common module contains common models and functions to support different automations and handlers.

Model

pydantic model fair_wizard.automation.common.model.AuthorizedUserResponse

Show JSON schema

{
   "title": "AuthorizedUserResponse",
   "type": "object",
   "properties": {
      "type": {
         "default": "AuthorizedUserResponse",
         "title": "Type",
         "type": "string"
      },
      "firstName": {
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "title": "Lastname",
         "type": "string"
      },
      "email": {
         "title": "Email",
         "type": "string"
      },
      "imageUrl": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Imageurl"
      },
      "affiliation": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Affiliation"
      },
      "userGroupUuids": {
         "items": {
            "format": "uuid",
            "type": "string"
         },
         "title": "Usergroupuuids",
         "type": "array"
      }
   },
   "required": [
      "firstName",
      "lastName",
      "email",
      "imageUrl",
      "affiliation",
      "userGroupUuids"
   ]
}

Config:

• populate_by_name: bool = True

Fields:

• affiliation (str | None)

• email (str)

• first_name (str)

• image_url (str | None)

• last_name (str)

• type (str)

• user_group_uuids (list[uuid.UUID])

field affiliation: str | None [Required]

field email: str [Required]

field first_name: str [Required] (alias 'firstName')

field image_url: str | None [Required] (alias 'imageUrl')

field last_name: str [Required] (alias 'lastName')

field type: str = 'AuthorizedUserResponse'

field user_group_uuids: list[UUID] [Required] (alias 'userGroupUuids')

serialize()

pydantic model fair_wizard.automation.common.model.ErrorResponse

Show JSON schema

{
   "title": "ErrorResponse",
   "type": "object",
   "properties": {
      "type": {
         "default": "ErrorResponse",
         "title": "Type",
         "type": "string"
      },
      "message": {
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "message"
   ]
}

Config:

• populate_by_name: bool = True

Fields:

• message (str)

• type (str)

field message: str [Required]

field type: str = 'ErrorResponse'

serialize()

pydantic model fair_wizard.automation.common.model.ForbiddenResponse

Show JSON schema

{
   "title": "ForbiddenResponse",
   "type": "object",
   "properties": {
      "type": {
         "default": "ForbiddenResponse",
         "title": "Type",
         "type": "string"
      },
      "message": {
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "message"
   ]
}

Config:

• populate_by_name: bool = True

Fields:

• message (str)

• type (str)

field message: str [Required]

field type: str = 'ForbiddenResponse'

serialize()