ticket.model

Attributes

TicketState

Classes

Ticket	Defines a ticket.
TicketPermission	Defines a custom ticket permission.

Module Contents

ticket.model.TicketState

class ticket.model.Ticket

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin, onegov.search.ORMSearchable

Defines a ticket.

__tablename__ = 'tickets'

id: Column[uuid.UUID]

number: Column[str]

title: Column[str]

subtitle: Column[str | None]

group: Column[str]

handler_code: Column[str]

handler_id: Column[str]

handler_data: Column[dict[str, Any]]

snapshot: Column[dict[str, Any]]

last_state_change: Column[datetime | None]

reaction_time: Column[int | None]

process_time: Column[int | None]

muted: Column[bool]

created: sqlalchemy.Column[datetime.datetime]

state: Column[TicketState]

user_id: Column[uuid.UUID | None]

user: relationship[User | None]

__mapper_args__

es_public = False

Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

es_properties

Returns the type mapping of this model. Each property in the mapping will be read from the model instance.

The returned object needs to be a dict or an object that provides a to_dict method.

Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language.

Note that objects with multiple languages are not supported (each object is supposed to have exactly one language).

Onegov.search will automatically insert the right analyzer for types like these.

There’s currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though.

property extra_localized_text: str | None

Maybe used by child-classes to return localized extra data that should be indexed as well.

property es_suggestion: list[str]

Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere.

If a single string is returned, the completion input equals the completion output. (My Title -> My Title)

If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title)

property ticket_email: str | None

property ticket_data: Sequence[str] | None

redact_data() → None

Redact sensitive information from the ticket to protect personal data.

In scenarios where complete deletion is not feasible, this method serves as an alternative by masking sensitive information, like addresses, phone numbers in the form submission.

property handler: onegov.ticket.handler.Handler

Returns an instance of the handler associated with this ticket.

property current_process_time: int | None

accept_ticket(user: onegov.user.User) → None

close_ticket() → None

reopen_ticket(user: onegov.user.User) → None

archive_ticket() → None

unarchive_ticket(user: onegov.user.User) → None

create_snapshot(request: onegov.core.request.CoreRequest) → None

Takes the current handler and stores the output of the summary as a snapshot.

TODO: This doesn’t support multiple langauges at this point. The language of the user creating the snapshot will be what’s stored.

In the future we might change this by iterating over all supported languages and creating the summary for each language.

class ticket.model.TicketPermission

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin

Defines a custom ticket permission.

If a ticket permission is defined for ticket handler (and optionally a group), a user has to be in the given user group to access these tickets.

__tablename__ = 'ticket_permissions'

id: Column[uuid.UUID]

user_group_id: Column[uuid.UUID]

user_group: relationship[UserGroup]

handler_code: Column[str]

group: Column[str | None]