ClientCommunicationMessageDTO

stonepy.models.ClientCommunicationMessageDTO.ClientCommunicationMessageDTO

Bases: ResponseModel

Client communication messages for display to the client.

id class-attribute instance-attribute

id: int | None = Field(default=None, alias='Id')

The identifier for the client communication message

priority class-attribute instance-attribute

priority: int | None = Field(default=None, alias="Priority")

The display priority of the client communication message

headline class-attribute instance-attribute

headline: str | None = Field(default=None, alias="Headline")

The headline for display to the client

message class-attribute instance-attribute

message: str | None = Field(default=None, alias='Message')

The actual message for display to the client

image_uri class-attribute instance-attribute

image_uri: str | None = Field(
    default=None, alias="ImageUri"
)

Location of image for display to the client

is_mandatory class-attribute instance-attribute

is_mandatory: bool | None = Field(
    default=None, alias="IsMandatory"
)

Flag indicating whether it is mandatory to display the message