app.views_private

Private views and routes for authenticated users.

This module defines the routes that require authentication, including the user dashboard, billing, account settings, API key management, admin pages, and webhook endpoints.

Attributes

private_bp

Functions

`download_results`(jobuid)	The view function that serves the batch validation result files.
`webhook`(path)	The view function for the webhook endpoint.
`api_keys`(path)	The view function for the page for managing API keys.
`billing`(path)	The view function for the billing pages' routing.
`account`(path)	The view function for the account pages routing.
`admin`(path)	The view function for the admin privileged pages' routing.
`private_index`(path)	The view function for the private pages routing.

Module Contents

app.views_private.private_bp[source]

app.views_private.download_results(jobuid)[source]

The view function that serves the batch validation result files.

Parameters:: jobuid (str) – The part of the requested endpoint after /download-results/.

app.views_private.webhook(path)[source]

The view function for the webhook endpoint.

Parameters:: path (str) – The part of the requested endpoint after /webhook/.
Returns:: A JSON response indicating success or failure.
Return type:: Response

Note

Webhook endpoints for external services to give us updates. Currently, this endpoint is used to receive webhook events from Stripe.

app.views_private.api_keys(path)[source]

The view function for the page for managing API keys.

Parameters:: path – The sub-path for API key actions (‘create’, ‘revoke’, or ‘api-keys’).
Returns:: The rendered template or JSON response for the action.
Return type:: Response

app.views_private.billing(path)[source]

The view function for the billing pages’ routing.

Parameters:: path (str) – The part of the requested endpoint after /billing/.
Returns:: The rendered template for the requested billing page.
Return type:: Response

app.views_private.account(path)[source]

The view function for the account pages routing.

Parameters:: path (str) – The part of the requested endpoint after /account/.
Returns:: The rendered template for the requested account page.
Return type:: Response

app.views_private.admin(path)[source]

The view function for the admin privileged pages’ routing.

path:path is used to catch all paths, including those with multiple slashes (/)

Parameters:: path (str) – The part of the requested endpoint after /admin/.
Returns:: The rendered template for the requested admin page.
Return type:: Response

app.views_private.private_index(path)[source]

The view function for the private pages routing.

This is the fallback view function for all private pages at /app/.

Parameters:: path (str) – The part of the requested endpoint after /app/.
Returns:: The rendered template for the requested private page.
Return type:: Response