org.models.organisation ======================= .. py:module:: org.models.organisation .. autoapi-nested-parse:: Contains the model describing the organisation proper. Classes ------- .. autoapisummary:: org.models.organisation.Organisation Functions --------- .. autoapisummary:: org.models.organisation.flatten_event_filter_fields_from_definition Module Contents --------------- .. py:class:: Organisation Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin` Defines the basic information associated with an organisation. It is assumed that there's only one organisation record in the schema! .. py:attribute:: __tablename__ :value: 'organisations' .. py:attribute:: id :type: sqlalchemy.Column[uuid.UUID] .. py:attribute:: name :type: sqlalchemy.Column[str] .. py:attribute:: logo_url :type: sqlalchemy.Column[str | None] .. py:attribute:: theme_options :type: sqlalchemy.Column[dict[str, Any] | None] .. py:attribute:: meta :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: custom_css :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: contact :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: contact_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: opening_hours :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: opening_hours_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: about_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: reply_to :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: analytics_code .. py:attribute:: online_counter_label :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: hide_online_counter :type: onegov.core.orm.mixins.dict_property[bool | None] .. py:attribute:: reservations_label :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: hide_reservations :type: onegov.core.orm.mixins.dict_property[bool | None] .. py:attribute:: publications_label :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: hide_publications :type: onegov.core.orm.mixins.dict_property[bool | None] .. py:attribute:: event_limit_homepage :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: news_limit_homepage :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: focus_widget_image :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: daypass_label :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: e_move_label :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: e_move_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: default_map_view :type: onegov.core.orm.mixins.dict_property[dict[str, Any] | None] .. py:attribute:: homepage_structure :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: homepage_cover .. py:attribute:: square_logo_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: locales :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: redirect_homepage_to :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: redirect_path :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: hidden_people_fields :type: onegov.core.orm.mixins.dict_property[list[str]] .. py:attribute:: event_locations :type: onegov.core.orm.mixins.dict_property[list[str]] .. py:attribute:: geo_provider :type: onegov.core.orm.mixins.dict_property[str] .. py:attribute:: holiday_settings :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: hide_onegov_footer :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: standard_image :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: submit_events_visible :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: delete_past_events :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: event_filter_type :type: onegov.core.orm.mixins.dict_property[str] .. py:attribute:: event_filter_definition :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: event_filter_configuration :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: event_files :value: None .. py:attribute:: facebook_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: twitter_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: youtube_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: instagram_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: linkedin_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: tiktok_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: og_logo_default :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_1_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_1_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_2_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_2_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_3_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: custom_link_3_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_1_img :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_1_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_1_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_2_img :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_2_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_2_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_3_img :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_3_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_3_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_4_img :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_4_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: partner_4_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: always_show_partners :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: hide_personal_email :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: general_email :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: email_for_new_tickets :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: ticket_auto_accept_style :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: ticket_auto_accepts :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: ticket_auto_accept_roles :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: tickets_skip_opening_email :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: tickets_skip_closing_email :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: mute_all_tickets :type: onegov.core.orm.mixins.dict_property[bool | None] .. py:attribute:: ticket_always_notify :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: auto_closing_user :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: report_changes :type: onegov.core.orm.mixins.dict_property[bool | None] .. py:attribute:: pdf_layout :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: pdf_link_color :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: pdf_underline_links :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: page_break_on_level_root_pdf :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: page_break_on_level_org_pdf :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: agency_display_levels :type: onegov.core.orm.mixins.dict_property[list[int] | None] .. py:attribute:: header_options :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: agency_path_display_on_people :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: agency_phone_internal_digits :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: agency_phone_internal_field :type: onegov.core.orm.mixins.dict_property[str] .. py:attribute:: favicon_win_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: favicon_mac_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: favicon_apple_touch_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: favicon_pinned_tab_safari_url :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: open_files_target_blank :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: disable_page_refs :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: footer_left_width :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: footer_center_width :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: footer_right_width :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: show_newsletter :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: secret_content_allowed :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: newsletter_categories :type: onegov.core.orm.mixins.dict_property[list[dict[str, list[str]] | str]] .. py:attribute:: notify_on_unsubscription :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: chat_staff :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: enable_chat :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: specific_opening_hours :type: onegov.core.orm.mixins.dict_property[bool] .. py:attribute:: opening_hours_chat :type: onegov.core.orm.mixins.dict_property[list[list[str]] | None] .. py:attribute:: chat_topics :type: onegov.core.orm.mixins.dict_property[list[str] | None] .. py:attribute:: organisation_hierarchy :type: onegov.core.orm.mixins.dict_property[list[dict[str, list[str]] | str]] .. py:attribute:: gever_username :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: gever_password :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: gever_endpoint :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: auto_archive_timespan :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: auto_delete_timespan :type: onegov.core.orm.mixins.dict_property[int] .. py:attribute:: vat_rate :type: onegov.core.orm.mixins.dict_property[float | None] .. py:attribute:: mtan_access_window_seconds :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: mtan_access_window_requests :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: mtan_session_duration_seconds :type: onegov.core.orm.mixins.dict_property[int | None] .. py:attribute:: ogd_publisher_mail :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: ogd_publisher_id :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: ogd_publisher_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: hourly_maintenance_tasks_last_run :type: onegov.core.orm.mixins.dict_property[onegov.core.orm.types.UTCDateTime | None] .. py:attribute:: firebase_adminsdk_credential :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: selectable_push_notification_options :type: onegov.core.orm.mixins.dict_property[list[list[str]]] .. py:property:: mtan_access_window :type: datetime.timedelta .. py:property:: mtan_session_duration :type: datetime.timedelta .. py:property:: public_identity :type: str The public identity is a globally unique SHA 256 hash of the current organisation. Basically, this is the database record of the database, but mangled for security and because it is cooler 😎. This value can be accessed through /identity. .. py:property:: holidays :type: onegov.org.models.swiss_holidays.SwissHolidays Returns a SwissHolidays instance, as configured by the holiday_settings on the UI. .. py:property:: has_school_holidays :type: bool Returns whether any school holidays have been configured .. py:property:: school_holidays :type: collections.abc.Iterator[tuple[datetime.date, datetime.date]] Returns an iterable that yields date pairs of start and end dates of school holidays .. py:property:: contact_html :type: markupsafe.Markup .. py:property:: opening_hours_html :type: markupsafe.Markup .. py:property:: title :type: str .. py:property:: title_lines :type: tuple[str, str] .. py:method:: excluded_person_fields(request: onegov.org.request.OrgRequest) -> list[str] .. py:property:: event_filter_fields :type: tuple[onegov.form.parser.core.ParsedField, Ellipsis] .. py:function:: flatten_event_filter_fields_from_definition(definition: str) -> tuple[onegov.form.parser.core.ParsedField, Ellipsis]