shipany.bot.actions.message_action

shipany.bot.actions.message_action package

Submodules

shipany.bot.actions.message_action.v1 module

class shipany.bot.actions.message_action.v1.SupportedMessageActionTypes

Bases: StrEnum

Supported message action types.

• answer: Send a message to the user.
• reply: Reply to a message.

answer = ‘answer’

reply = ‘reply’

__new__(value)

pydantic model shipany.bot.actions.message_action.v1.MessageAction

Bases: BaseModel

Action to send a message to the user.

Payload samples

Send a message to the user:

{
  "name": "MessageAction@1",
  "type": "answer",
  "content": "Hello, world!"
}

Reply to a message:

{
  "name": "MessageAction@1",
  "type": "reply",
  "content": "Hello, world!"
}

Pydantic model parameters

• Config:
  • extra: str = ignore
  • frozen: bool = True
• Fields:
  • action_type (shipany.bot.actions.message_action.v1.SupportedMessageActionTypes)
  • content (str)
  • name (Literal['MessageAction@1'])

field name : Literal['MessageAction@1'] [Required]

Action name.

field action_type : SupportedMessageActionTypes [Required] (alias ‘type’)

Action type.

field content : str [Required]

Message content. Jinja2 templating is supported.

Module contents