org.path ======== .. py:module:: org.path .. autoapi-nested-parse:: Contains the paths to the different models served by onegov.org. Functions --------- .. autoapisummary:: org.path.get_org org.path.get_auth org.path.get_mtan_auth org.path.get_user org.path.get_users org.path.get_user_group org.path.get_user_groups org.path.get_topic org.path.get_news org.path.get_files org.path.get_images org.path.get_exports org.path.get_export org.path.get_forms org.path.get_form org.path.get_surveys org.path.get_survey org.path.get_pending_survey_submission org.path.get_pending_form_submission org.path.get_complete_form_submission org.path.get_form_registration_window org.path.get_survey_submission_window org.path.get_file_for_org org.path.get_editor org.path.get_people org.path.get_person org.path.get_chats org.path.get_chat org.path.get_ticket org.path.get_tickets org.path.get_archived_tickets org.path.get_ticket_note org.path.get_resources org.path.get_find_my_spot org.path.get_resource org.path.get_allocation org.path.get_reservation org.path.get_clipboard org.path.get_sitecollection org.path.get_page_move org.path.get_person_move org.path.get_form_move org.path.get_resource_move org.path.get_occurrences org.path.get_occurrence org.path.get_event org.path.get_search org.path.get_a_to_z org.path.get_newsletters org.path.get_newsletter org.path.get_newsletter_recipients org.path.get_subscription org.path.get_entry_subscription org.path.get_legacy_file org.path.get_image org.path.get_image_sets org.path.get_image_set org.path.get_resource_recipient_collection org.path.get_resource_recipient org.path.get_payment_provider_collection org.path.get_payment_provider org.path.get_payment org.path.get_payments org.path.get_messages org.path.get_text_modules org.path.get_text_module org.path.get_directories org.path.get_directory org.path.get_directory_entries org.path.get_directory_entry org.path.get_directory_submission_action org.path.get_publication_collection org.path.get_dashboard org.path.get_external_link_collection org.path.get_external_link org.path.get_document_form_collection org.path.get_document_form_page org.path.get_qr_code org.path.get_api_key_for_delete org.path.get_sent_notification_collection Module Contents --------------- .. py:function:: get_org(app: onegov.org.app.OrgApp) -> onegov.org.models.Organisation .. py:function:: get_auth(app: onegov.org.app.OrgApp, to: str = '/', skip: bool = False, signup_token: str | None = None) -> onegov.user.Auth .. py:function:: get_mtan_auth(app: onegov.org.app.OrgApp, to: str = '/') -> onegov.org.auth.MTANAuth .. py:function:: get_user(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.user.User | None .. py:function:: 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 .. py:function:: get_user_group(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.user.UserGroup | None .. py:function:: get_user_groups(app: onegov.org.app.OrgApp) -> onegov.user.UserGroupCollection[onegov.user.UserGroup] .. py:function:: get_topic(app: onegov.org.app.OrgApp, absorb: str) -> onegov.org.models.Topic | None .. py:function:: get_news(request: onegov.org.request.OrgRequest, absorb: str, filter_years: list[int], filter_tags: list[str], page: int = 0) -> onegov.org.models.News | onegov.org.models.NewsCollection | None .. py:function:: get_files(request: onegov.org.request.OrgRequest, order_by: str = 'name') -> onegov.org.models.GeneralFileCollection .. py:function:: get_images(app: onegov.org.app.OrgApp) -> onegov.org.models.ImageFileCollection .. py:function:: get_exports(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp) -> onegov.org.models.ExportCollection .. py:function:: get_export(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) -> onegov.org.models.Export | None .. py:function:: get_forms(app: onegov.org.app.OrgApp) -> onegov.form.FormCollection .. py:function:: get_form(app: onegov.org.app.OrgApp, name: str) -> onegov.form.FormDefinition | None .. py:function:: get_surveys(app: onegov.org.app.OrgApp) -> onegov.form.collection.SurveyCollection | None .. py:function:: get_survey(app: onegov.org.app.OrgApp, name: str) -> onegov.form.models.definition.SurveyDefinition | None .. py:function:: get_pending_survey_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.form.models.submission.SurveySubmission | None .. py:function:: get_pending_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.form.PendingFormSubmission | None .. py:function:: get_complete_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.form.CompleteFormSubmission | None .. py:function:: get_form_registration_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) -> onegov.form.FormRegistrationWindow | None .. py:function:: get_survey_submission_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) -> onegov.form.models.survey_window.SurveySubmissionWindow | None .. py:function:: get_file_for_org(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) -> onegov.file.File | None 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. .. py:function:: get_editor(app: onegov.org.app.OrgApp, action: str, trait: str, page_id: int = 0) -> onegov.org.models.Editor | None .. py:function:: get_people(app: onegov.org.app.OrgApp) -> onegov.people.PersonCollection .. py:function:: get_person(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.people.Person | None .. py:function:: get_chats(app: onegov.org.app.OrgApp, page: int = 0, state: str = 'active') -> onegov.chat.collections.ChatCollection .. py:function:: get_chat(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.chat.models.Chat | None .. py:function:: get_ticket(app: onegov.org.app.OrgApp, handler_code: str, id: uuid.UUID) -> onegov.ticket.Ticket | None .. py:function:: 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 .. py:function:: 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 .. py:function:: get_ticket_note(app: onegov.org.app.OrgApp, id: str) -> onegov.org.models.TicketNote | None .. py:function:: get_resources(app: onegov.org.app.OrgApp) -> onegov.reservation.ResourceCollection .. py:function:: get_find_my_spot(app: onegov.org.app.OrgApp, group: str | None = None) -> onegov.org.models.resource.FindYourSpotCollection .. py:function:: 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 .. py:function:: get_allocation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) -> onegov.reservation.Allocation | None .. py:function:: get_reservation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) -> onegov.reservation.Reservation | None .. py:function:: get_clipboard(request: onegov.org.request.OrgRequest, token: str) -> onegov.org.models.Clipboard | None .. py:function:: get_sitecollection(app: onegov.org.app.OrgApp) -> onegov.org.models.SiteCollection .. py:function:: 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 .. py:function:: 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 .. py:function:: 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 .. py:function:: 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 .. py:function:: 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 .. py:function:: get_occurrence(app: onegov.org.app.OrgApp, name: str) -> onegov.event.Occurrence | None .. py:function:: get_event(app: onegov.org.app.OrgApp, name: str) -> onegov.event.Event | None .. py:function:: get_search(request: onegov.org.request.OrgRequest, q: str = '', page: int = 0) -> onegov.org.models.Search[Any] .. py:function:: get_a_to_z(request: onegov.org.request.OrgRequest) -> onegov.org.models.AtoZPages .. py:function:: get_newsletters(app: onegov.org.app.OrgApp) -> onegov.newsletter.NewsletterCollection .. py:function:: get_newsletter(app: onegov.org.app.OrgApp, name: str) -> onegov.newsletter.Newsletter | None .. py:function:: get_newsletter_recipients(app: onegov.org.app.OrgApp) -> onegov.newsletter.RecipientCollection .. py:function:: get_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) -> onegov.newsletter.Subscription | None .. py:function:: get_entry_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) -> onegov.directory.models.directory.EntrySubscription | None .. py:function:: get_legacy_file(app: onegov.org.app.OrgApp, filename: str) -> onegov.org.models.LegacyFile | None .. py:function:: get_image(app: onegov.org.app.OrgApp, filename: str) -> onegov.org.models.LegacyImage | None .. py:function:: get_image_sets(app: onegov.org.app.OrgApp) -> onegov.org.models.ImageSetCollection .. py:function:: get_image_set(app: onegov.org.app.OrgApp, id: str) -> onegov.org.models.ImageSet | None .. py:function:: get_resource_recipient_collection(app: onegov.org.app.OrgApp) -> onegov.org.models.ResourceRecipientCollection .. py:function:: get_resource_recipient(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.org.models.ResourceRecipient | None .. py:function:: get_payment_provider_collection(app: onegov.org.app.OrgApp) -> onegov.pay.PaymentProviderCollection | None .. py:function:: get_payment_provider(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.pay.PaymentProvider[onegov.pay.Payment] | None .. py:function:: get_payment(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.pay.Payment | None .. py:function:: get_payments(app: onegov.org.app.OrgApp, source: str = '*', page: int = 0) -> onegov.pay.PaymentCollection .. py:function:: 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] .. py:function:: get_text_modules(app: onegov.org.app.OrgApp) -> onegov.chat.TextModuleCollection .. py:function:: get_text_module(app: onegov.org.app.OrgApp, id: uuid.UUID) -> onegov.chat.TextModule | None .. py:function:: get_directories(app: onegov.org.app.OrgApp) -> onegov.directory.DirectoryCollection[onegov.org.models.ExtendedDirectory] .. py:function:: get_directory(app: onegov.org.app.OrgApp, name: str) -> onegov.directory.Directory | None .. py:function:: 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 .. py:function:: get_directory_entry(app: onegov.org.app.OrgApp, directory_name: str, name: str) -> onegov.directory.DirectoryEntry | None .. py:function:: get_directory_submission_action(app: onegov.org.app.OrgApp, directory_id: uuid.UUID, submission_id: uuid.UUID, action: str) -> onegov.org.models.DirectorySubmissionAction | None .. py:function:: get_publication_collection(request: onegov.org.request.OrgRequest, year: int | None = None) -> onegov.org.models.PublicationCollection .. py:function:: get_dashboard(request: onegov.org.request.OrgRequest) -> onegov.org.models.Dashboard | None .. py:function:: get_external_link_collection(request: onegov.org.request.OrgRequest, type: str | None = None) -> onegov.org.models.external_link.ExternalLinkCollection .. py:function:: get_external_link(request: onegov.org.request.OrgRequest, id: uuid.UUID) -> onegov.org.models.external_link.ExternalLink | None .. py:function:: get_document_form_collection(request: onegov.org.request.OrgRequest, type: str | None = None) -> onegov.org.models.document_form.FormDocumentCollection .. py:function:: get_document_form_page(app: onegov.org.app.OrgApp, name: str) -> onegov.org.models.document_form.FormDocument | None .. py:function:: 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 .. py:function:: get_api_key_for_delete(request: onegov.org.request.OrgRequest, key: uuid.UUID) -> onegov.api.models.ApiKey | None .. py:function:: get_sent_notification_collection(request: onegov.org.request.OrgRequest) -> onegov.org.models.PushNotificationCollection