org.path

Contains the paths to the different models served by onegov.org.

Functions

`get_org`(→ onegov.org.models.Organisation)
`get_auth`(→ onegov.user.Auth)
`get_mtan_auth`(→ onegov.org.auth.MTANAuth)
`get_user`(→ onegov.user.User \| None)
`get_users`(→ onegov.user.UserCollection)
`get_user_group`(→ onegov.user.UserGroup \| None)
`get_user_groups`(...)
`get_topic`(→ onegov.org.models.Topic \| None)
`get_news`(→ onegov.org.models.News \| None)
`get_files`(→ onegov.org.models.GeneralFileCollection)
`get_images`(→ onegov.org.models.ImageFileCollection)
`get_exports`(→ onegov.org.models.ExportCollection)
`get_export`(→ onegov.org.models.Export \| None)
`get_forms`(→ onegov.form.FormCollection)
`get_form`(→ onegov.form.FormDefinition \| None)
`get_surveys`(...)
`get_survey`(...)
`get_pending_survey_submission`(...)
`get_pending_form_submission`(...)
`get_complete_form_submission`(...)
`get_form_registration_window`(...)
`get_survey_submission_window`(...)
`get_file_for_org`(→ onegov.file.File \| None)	Some files are kept private and out of any caches.
`get_editor`(→ onegov.org.models.Editor \| None)
`get_people`(→ onegov.people.PersonCollection)
`get_person`(→ onegov.people.Person \| None)
`get_chats`(→ onegov.chat.collections.ChatCollection)
`get_chat`(→ onegov.chat.models.Chat \| None)
`get_ticket`(→ onegov.ticket.Ticket \| None)
`get_tickets`(→ onegov.ticket.TicketCollection)
`get_archived_tickets`(...)
`get_ticket_note`(→ onegov.org.models.TicketNote \| None)
`get_resources`(→ onegov.reservation.ResourceCollection)
`get_find_my_spot`(...)
`get_resource`(→ onegov.reservation.Resource \| None)
`get_allocation`(→ onegov.reservation.Allocation \| None)
`get_reservation`(→ onegov.reservation.Reservation \| None)
`get_clipboard`(→ onegov.org.models.Clipboard \| None)
`get_sitecollection`(→ onegov.org.models.SiteCollection)
`get_page_move`(→ onegov.org.models.PageMove \| None)
`get_person_move`(→ onegov.org.models.PagePersonMove \| None)
`get_form_move`(→ onegov.org.models.FormPersonMove \| None)
`get_resource_move`(...)
`get_occurrences`(→ onegov.event.OccurrenceCollection)
`get_occurrence`(→ onegov.event.Occurrence \| None)
`get_event`(→ onegov.event.Event \| None)
`get_search`(→ onegov.org.models.Search[Any])
`get_a_to_z`(→ onegov.org.models.AtoZPages)
`get_newsletters`(→ onegov.newsletter.NewsletterCollection)
`get_newsletter`(→ onegov.newsletter.Newsletter \| None)
`get_newsletter_recipients`(...)
`get_subscription`(→ onegov.newsletter.Subscription \| None)
`get_entry_subscription`(...)
`get_legacy_file`(→ onegov.org.models.LegacyFile \| None)
`get_image`(→ onegov.org.models.LegacyImage \| None)
`get_image_sets`(→ onegov.org.models.ImageSetCollection)
`get_image_set`(→ onegov.org.models.ImageSet \| None)
`get_resource_recipient_collection`(...)
`get_resource_recipient`(...)
`get_payment_provider_collection`(...)
`get_payment_provider`(...)
`get_payment`(→ onegov.pay.Payment \| None)
`get_payments`(→ onegov.pay.PaymentCollection)
`get_messages`(→ onegov.chat.MessageCollection[Any])
`get_text_modules`(→ onegov.chat.TextModuleCollection)
`get_text_module`(→ onegov.chat.TextModule \| None)
`get_directories`(...)
`get_directory`(→ onegov.directory.Directory \| None)
`get_directory_entries`(...)
`get_directory_entry`(...)
`get_directory_submission_action`(...)
`get_publication_collection`(...)
`get_dashboard`(→ onegov.org.models.Dashboard \| None)
`get_external_link_collection`(...)
`get_external_link`(...)
`get_qr_code`(→ onegov.qrcode.QrCode)
`get_api_key_for_delete`(→ onegov.api.models.ApiKey \| None)

Module Contents

org.path.get_org(app: onegov.org.app.OrgApp) → onegov.org.models.Organisation[source]

org.path.get_auth(app: onegov.org.app.OrgApp, to: str = '/', skip: bool = False, signup_token: str | None = None) → onegov.user.Auth[source]

org.path.get_mtan_auth(app: onegov.org.app.OrgApp, to: str = '/') → onegov.org.auth.MTANAuth[source]

org.path.get_user(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.user.User | None[source]

org.path.get_users(app: onegov.org.app.OrgApp, active: list[bool] | None = None, role: list[str] | None = None, tag: list[str] | None = None, provider: list[str] | None = None, source: list[str] | None = None) → onegov.user.UserCollection[source]

org.path.get_user_group(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.user.UserGroup | None[source]

org.path.get_user_groups(app: onegov.org.app.OrgApp) → onegov.user.UserGroupCollection[onegov.user.UserGroup][source]

org.path.get_topic(app: onegov.org.app.OrgApp, absorb: str) → onegov.org.models.Topic | None[source]

org.path.get_news(app: onegov.org.app.OrgApp, absorb: str, filter_years: list[int], filter_tags: list[str]) → onegov.org.models.News | None[source]

org.path.get_files(request: onegov.org.request.OrgRequest, order_by: str = 'name') → onegov.org.models.GeneralFileCollection[source]

org.path.get_images(app: onegov.org.app.OrgApp) → onegov.org.models.ImageFileCollection[source]

org.path.get_exports(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp) → onegov.org.models.ExportCollection[source]

org.path.get_export(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) → onegov.org.models.Export | None[source]

org.path.get_forms(app: onegov.org.app.OrgApp) → onegov.form.FormCollection[source]

org.path.get_form(app: onegov.org.app.OrgApp, name: str) → onegov.form.FormDefinition | None[source]

org.path.get_surveys(app: onegov.org.app.OrgApp) → onegov.form.collection.SurveyCollection | None[source]

org.path.get_survey(app: onegov.org.app.OrgApp, name: str) → onegov.form.models.definition.SurveyDefinition | None[source]

org.path.get_pending_survey_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.models.submission.SurveySubmission | None[source]

org.path.get_pending_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.PendingFormSubmission | None[source]

org.path.get_complete_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.CompleteFormSubmission | None[source]

org.path.get_form_registration_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.form.FormRegistrationWindow | None[source]

org.path.get_survey_submission_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.form.models.survey_window.SurveySubmissionWindow | None[source]

org.path.get_file_for_org(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) → onegov.file.File | None[source]

Some files are kept private and out of any caches.

This approach is not all that morepath-y, as we could override the views instead to change the required permissions, but this approach has the advantage that we don’t need to overwrite multiple views and we do not have to care for additional views added in the future.

org.path.get_editor(app: onegov.org.app.OrgApp, action: str, trait: str, page_id: int = 0) → onegov.org.models.Editor | None[source]

org.path.get_people(app: onegov.org.app.OrgApp) → onegov.people.PersonCollection[source]

org.path.get_person(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.people.Person | None[source]

org.path.get_chats(app: onegov.org.app.OrgApp, page: int = 0, state: str = 'active') → onegov.chat.collections.ChatCollection[source]

org.path.get_chat(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.chat.models.Chat | None[source]

org.path.get_ticket(app: onegov.org.app.OrgApp, handler_code: str, id: uuid.UUID) → onegov.ticket.Ticket | None[source]

org.path.get_tickets(app: onegov.org.app.OrgApp, handler: str = 'ALL', state: onegov.ticket.collection.ExtendedTicketState = 'open', page: int = 0, group: str | None = None, owner: str | None = None, extra_parameters: dict[str, str] | None = None) → onegov.ticket.TicketCollection[source]

org.path.get_archived_tickets(app: onegov.org.app.OrgApp, handler: str = 'ALL', page: int = 0, group: str | None = None, owner: str | None = None, extra_parameters: dict[str, str] | None = None) → onegov.ticket.collection.ArchivedTicketCollection[source]

org.path.get_ticket_note(app: onegov.org.app.OrgApp, id: str) → onegov.org.models.TicketNote | None[source]

org.path.get_resources(app: onegov.org.app.OrgApp) → onegov.reservation.ResourceCollection[source]

org.path.get_find_my_spot(app: onegov.org.app.OrgApp, group: str | None = None) → onegov.org.models.resource.FindYourSpotCollection[source]

org.path.get_resource(app: onegov.org.app.OrgApp, name: str, date: get_resource.date | None = None, view: str | None = None, highlights_min: int | None = None, highlights_max: int | None = None) → onegov.reservation.Resource | None[source]

org.path.get_allocation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) → onegov.reservation.Allocation | None[source]

org.path.get_reservation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) → onegov.reservation.Reservation | None[source]

org.path.get_clipboard(request: onegov.org.request.OrgRequest, token: str) → onegov.org.models.Clipboard | None[source]

org.path.get_sitecollection(app: onegov.org.app.OrgApp) → onegov.org.models.SiteCollection[source]

org.path.get_page_move(app: onegov.org.app.OrgApp, subject_id: int, direction: onegov.core.orm.abstract.MoveDirection, target_id: int) → onegov.org.models.PageMove | None[source]

org.path.get_person_move(app: onegov.org.app.OrgApp, key: int, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.PagePersonMove | None[source]

org.path.get_form_move(app: onegov.org.app.OrgApp, key: str, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.FormPersonMove | None[source]

org.path.get_resource_move(app: onegov.org.app.OrgApp, key: uuid.UUID, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.ResourcePersonMove | None[source]

org.path.get_occurrences(app: onegov.org.app.OrgApp, request: onegov.org.request.OrgRequest, page: int = 0, range: onegov.event.collections.occurrences.DateRange | None = None, start: datetime.date | None = None, end: datetime.date | None = None, tags: list[str] | None = None, filter_keywords: dict[str, list[str]] | None = None, locations: list[str] | None = None, search: str | None = None, search_query: dict[str, Any] | None = None) → onegov.event.OccurrenceCollection[source]

org.path.get_occurrence(app: onegov.org.app.OrgApp, name: str) → onegov.event.Occurrence | None[source]

org.path.get_event(app: onegov.org.app.OrgApp, name: str) → onegov.event.Event | None[source]

org.path.get_search(request: onegov.org.request.OrgRequest, q: str = '', page: int = 0) → onegov.org.models.Search[Any][source]

org.path.get_a_to_z(request: onegov.org.request.OrgRequest) → onegov.org.models.AtoZPages[source]

org.path.get_newsletters(app: onegov.org.app.OrgApp) → onegov.newsletter.NewsletterCollection[source]

org.path.get_newsletter(app: onegov.org.app.OrgApp, name: str) → onegov.newsletter.Newsletter | None[source]

org.path.get_newsletter_recipients(app: onegov.org.app.OrgApp) → onegov.newsletter.RecipientCollection[source]

org.path.get_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) → onegov.newsletter.Subscription | None[source]

org.path.get_entry_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) → onegov.directory.models.directory.EntrySubscription | None[source]

org.path.get_legacy_file(app: onegov.org.app.OrgApp, filename: str) → onegov.org.models.LegacyFile | None[source]

org.path.get_image(app: onegov.org.app.OrgApp, filename: str) → onegov.org.models.LegacyImage | None[source]

org.path.get_image_sets(app: onegov.org.app.OrgApp) → onegov.org.models.ImageSetCollection[source]

org.path.get_image_set(app: onegov.org.app.OrgApp, id: str) → onegov.org.models.ImageSet | None[source]

org.path.get_resource_recipient_collection(app: onegov.org.app.OrgApp) → onegov.org.models.ResourceRecipientCollection[source]

org.path.get_resource_recipient(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.ResourceRecipient | None[source]

org.path.get_payment_provider_collection(app: onegov.org.app.OrgApp) → onegov.pay.PaymentProviderCollection | None[source]

org.path.get_payment_provider(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.pay.PaymentProvider[onegov.pay.Payment] | None[source]

org.path.get_payment(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.pay.Payment | None[source]

org.path.get_payments(app: onegov.org.app.OrgApp, source: str = '*', page: int = 0) → onegov.pay.PaymentCollection[source]

org.path.get_messages(app: onegov.org.app.OrgApp, channel_id: str = '*', type: str = '*', newer_than: str | None = None, older_than: str | None = None, limit: int = 25, load: str = 'older-first') → onegov.chat.MessageCollection[Any][source]

org.path.get_text_modules(app: onegov.org.app.OrgApp) → onegov.chat.TextModuleCollection[source]

org.path.get_text_module(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.chat.TextModule | None[source]

org.path.get_directories(app: onegov.org.app.OrgApp) → onegov.directory.DirectoryCollection[onegov.org.models.ExtendedDirectory][source]

org.path.get_directory(app: onegov.org.app.OrgApp, name: str) → onegov.directory.Directory | None[source]

org.path.get_directory_entries(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, directory_name: str, keywords: dict[str, list[str]], page: int = 0, search: str | None = None, search_query: dict[str, Any] | None = None, published_only: bool = False, past_only: bool = False, upcoming_only: bool = False) → onegov.org.models.directory.ExtendedDirectoryEntryCollection | None[source]

org.path.get_directory_entry(app: onegov.org.app.OrgApp, directory_name: str, name: str) → onegov.directory.DirectoryEntry | None[source]

org.path.get_directory_submission_action(app: onegov.org.app.OrgApp, directory_id: uuid.UUID, submission_id: uuid.UUID, action: str) → onegov.org.models.DirectorySubmissionAction | None[source]

org.path.get_publication_collection(request: onegov.org.request.OrgRequest, year: int | None = None) → onegov.org.models.PublicationCollection[source]

org.path.get_dashboard(request: onegov.org.request.OrgRequest) → onegov.org.models.Dashboard | None[source]

org.path.get_external_link_collection(request: onegov.org.request.OrgRequest, type: str | None = None) → onegov.org.models.external_link.ExternalLinkCollection[source]

org.path.get_external_link(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.org.models.external_link.ExternalLink | None[source]

org.path.get_qr_code(app: onegov.org.app.OrgApp, payload: str, border: int | None = None, box_size: int | None = None, fill_color: str | None = None, back_color: str | None = None, img_format: str | None = None, encoding: Literal['base64'] | None = None) → onegov.qrcode.QrCode[source]

org.path.get_api_key_for_delete(request: onegov.org.request.OrgRequest, key: uuid.UUID) → onegov.api.models.ApiKey | None[source]