app.models

Database models for the Mail List Shield application.

This module defines the SQLAlchemy ORM models for the application’s database, including user accounts, API keys, batch validation jobs, and subscription tiers.

Classes

`APIKeys`	Table for storing API keys associated with user accounts.
`BatchJobs`	Table for batch email validation jobs.
`Tiers`	Table for subscription tiers.
`Users`	Table for user accounts.

Module Contents

class app.models.APIKeys(user, key_hash, label=None, expires_at=None)[source]

Bases: app.db.Model

Table for storing API keys associated with user accounts.

API keys are hashed before storage for security. Each key belongs to a single user and can be active or revoked.

id[source]: Primary key.

user_id[source]: Foreign key to the Users table.

key_hash[source]: Bcrypt hash of the API key.

label[source]: Optional user-provided label for the key.

created_at[source]: Timestamp when the key was created.

expires_at[source]: Optional expiration timestamp.

last_used[source]: Timestamp of the last API call using this key.

is_active[source]: Whether the key is currently active.

id[source]

user_id[source]

key_hash[source]

label[source]

created_at[source]

expires_at[source]

last_used[source]

is_active[source]

check_key(key_plain)[source]

Verify if a plaintext key matches this key’s hash.

Parameters:: key_plain – The plaintext API key to verify.
Returns:: True if the key matches, False otherwise.
Return type:: bool

delete_key()[source]

Delete this API key from the database.

Returns:: True if deletion was successful.
Return type:: bool

update_last_used()[source]: Update the last_used timestamp to the current time.

save()[source]

Save the current state of this API key to the database.

Returns:: The saved API key instance.
Return type:: APIKeys

class app.models.BatchJobs(*args, **kwargs)[source]

Bases: app.db.Model

Table for batch email validation jobs.

Tracks the status and metadata of batch validation jobs, including uploaded files, processing status, and results.

id[source]: Primary key.

uid[source]: Unique 6-character identifier for the job.

user_id[source]: Foreign key to the Users table.

user[source]: Relationship to the user who created the job.

status[source]: Current status of the job.

original_file_name[source]: Original name of the uploaded file.

uploaded_file[source]: Path to the uploaded file in object storage.

accepted_file[source]: Path to the accepted/processed file.

results_file[source]: Path to the results file in object storage.

row_count[source]: Number of rows in the uploaded file.

last_pick_row[source]: Last row processed by the worker.

last_pick_time[source]: Timestamp of the last worker pick.

source[source]: Source of the job (e.g., ‘web’, ‘api’).

header_row[source]: Row number containing headers (0 or 1).

email_column[source]: Name of the column containing email addresses.

uploaded[source]: Timestamp when the file was uploaded.

started[source]: Timestamp when processing started.

finished[source]: Timestamp when processing finished.

result[source]: Final result summary.

id[source]

uid[source]

user_id[source]

user[source]

status[source]

original_file_name[source]

uploaded_file[source]

accepted_file[source]

results_file[source]

row_count[source]

last_pick_row[source]

last_pick_time[source]

source[source]

header_row[source]

email_column[source]

uploaded[source]

started[source]

finished[source]

result[source]

generate_job_uid()[source]

Generate a unique 6-character identifier for this job.

Ensures uniqueness by checking against existing jobs in the database.

generate_results_download_link()[source]

Generate a pre-signed download URL for the results file.

Returns:

A pre-signed URL for downloading the results file,: or None if no results file exists.

Return type:

str

class app.models.Tiers[source]

Bases: app.db.Model

Table for subscription tiers.

Defines the available subscription tiers and their associated Stripe price IDs.

id[source]: Primary key.

name[source]: Internal name of the tier.

label[source]: Display label for the tier.

stripe_price_id[source]: Associated Stripe price ID for subscriptions.

users[source]: Relationship to users on this tier.

id[source]

name[source]

label[source]

stripe_price_id[source]

users[source]

class app.models.Users(email, password, tier_id, firstName, lastName, newsletter, member_since, last_login, email_confirmation_code)[source]