mysticat-data-service-types 1.0.0__py3-none-any.whl

mysticat_data_service_types/__init__.py

@@ -0,0 +1,18 @@
+"""
+mysticat-data-service-types
+
+Pydantic models for Mysticat Data Service API.
+Auto-generated from PostgreSQL/PostgREST schema.
+
+Example:
+    from mysticat_data_service_types import Organizations, Sites, Audits
+
+    # Use for validation
+    org = Organizations(id="...", name="My Org", ...)
+
+    # Use for type hints
+    def process_site(site: Sites) -> None:
+        print(site.base_url)
+"""
+
+from .models import *  # noqa: F401, F403

mysticat_data_service_types/models.py

@@ -0,0 +1,1118 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.json
+#   timestamp: 2026-02-04T11:38:55+00:00
+
+from __future__ import annotations
+
+from datetime import date
+from enum import Enum
+from typing import Any
+from uuid import UUID
+
+from pydantic import AwareDatetime, BaseModel, Field, constr
+
+
+class Origin(Enum):
+    ESS_OPS = 'ESS_OPS'
+    AI = 'AI'
+    AUTOMATION = 'AUTOMATION'
+
+
+class Status(Enum):
+    NEW = 'NEW'
+    IN_PROGRESS = 'IN_PROGRESS'
+    IGNORED = 'IGNORED'
+    RESOLVED = 'RESOLVED'
+
+
+class Opportunities(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the site this opportunity belongs to\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    audit_id: UUID | None = Field(
+        None,
+        description="Reference to the audit that discovered this opportunity (if applicable)\n\nNote:\nThis is a Foreign Key to `audits.id`.<fk table='audits' column='id'/>",
+    )
+    runbook: str | None = Field(
+        None,
+        description='URL to the runbook/documentation for resolving this opportunity',
+    )
+    type: str = Field(
+        ...,
+        description='Category of opportunity (e.g., broken-backlinks, high-bounce-rate)',
+    )
+    data: Any | None = Field(None, description='Opportunity-specific data as JSON')
+    origin: Origin = Field(..., description='How this opportunity was discovered')
+    title: str = Field(
+        ..., description='Human-readable title describing the opportunity'
+    )
+    description: str | None = Field(
+        None, description='Detailed description of the opportunity'
+    )
+    status: Status = Field(
+        ..., description='Current workflow status of the opportunity'
+    )
+    guidance: Any | None = Field(
+        None, description='AI-generated guidance for resolving the opportunity'
+    )
+    tags: list[str] | None = Field(
+        None, description='Classification tags for filtering and grouping'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the opportunity was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Status1(Enum):
+    IN_PROGRESS = 'IN_PROGRESS'
+    COMPLETED = 'COMPLETED'
+    FAILED = 'FAILED'
+    CANCELLED = 'CANCELLED'
+
+
+class ResultType(Enum):
+    S3 = 'S3'
+    INLINE = 'INLINE'
+    URL = 'URL'
+
+
+class AsyncJobs(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable) - use this as the job ticket\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    status: Status1 = Field(..., description='Current execution status')
+    result_location: str | None = Field(
+        None, description='Where to find the result (S3 path, URL, etc.)'
+    )
+    result_type: ResultType | None = Field(
+        None, description='How the result is stored/accessed'
+    )
+    result: Any | None = Field(
+        None, description='Inline result data for small payloads as JSON'
+    )
+    error: Any | None = Field(
+        None, description='Error details if the job failed as JSON'
+    )
+    metadata: Any | None = Field(None, description='Job-specific metadata as JSON')
+    started_at: AwareDatetime = Field(..., description='When job execution began')
+    ended_at: AwareDatetime | None = Field(
+        None, description='When job execution completed'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the job was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Status2(Enum):
+    ACTIVE = 'ACTIVE'
+    INACTIVE = 'INACTIVE'
+
+
+class Experiments(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the site running the experiment\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    exp_id: str = Field(
+        ..., description='External experiment identifier (unique per site)'
+    )
+    name: str | None = Field(None, description='Human-readable experiment name')
+    url: str = Field(..., description='URL where the experiment is running')
+    type: str | None = Field(None, description='Experiment type classification')
+    status: Status2 = Field(
+        ..., description='Whether the experiment is currently active'
+    )
+    start_date: AwareDatetime | None = Field(
+        None, description='When the experiment started'
+    )
+    end_date: AwareDatetime | None = Field(
+        None, description='When the experiment ended or is scheduled to end'
+    )
+    conversion_event_name: str | None = Field(
+        None, description='Name of the conversion event being tracked'
+    )
+    conversion_event_value: str | None = Field(
+        None, description='Target value for the conversion event'
+    )
+    variants: Any = Field(
+        ..., description='Experiment variants and their configurations as JSON'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str = Field(
+        ..., description='Identifier of the user or system that made the last update'
+    )
+
+
+class Status3(Enum):
+    RUNNING = 'RUNNING'
+    COMPLETE = 'COMPLETE'
+    FAILED = 'FAILED'
+    STOPPED = 'STOPPED'
+
+
+class ScrapeJobs(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    base_url: str = Field(..., description='Base URL being scraped')
+    processing_type: str = Field(
+        ..., description='Type of processing to apply to scraped content'
+    )
+    duration: float = Field(..., description='Total job duration in seconds')
+    ended_at: AwareDatetime | None = Field(None, description='When the job completed')
+    failed_count: int = Field(..., description='Number of URLs that failed to scrape')
+    scrape_queue_id: str | None = Field(None, description='External queue identifier')
+    options: Any | None = Field(
+        None, description='Scraping configuration options as JSON'
+    )
+    custom_headers: Any | None = Field(
+        None, description='Custom HTTP headers for requests as JSON'
+    )
+    redirect_count: int = Field(..., description='Number of redirects encountered')
+    status: Status3 = Field(..., description='Current job status')
+    started_at: AwareDatetime = Field(..., description='When the job started')
+    success_count: int = Field(..., description='Number of URLs successfully scraped')
+    url_count: int = Field(..., description='Total number of URLs to process')
+    results: Any | None = Field(None, description='Aggregated scraping results as JSON')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the job was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class SiteEnrollments(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the enrolled site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    entitlement_id: UUID = Field(
+        ...,
+        description="Reference to the entitlement\n\nNote:\nThis is a Foreign Key to `entitlements.id`.<fk table='entitlements' column='id'/>",
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the enrollment was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class ProductCode(Enum):
+    LLMO = 'LLMO'
+    ASO = 'ASO'
+    ACO = 'ACO'
+
+
+class Tier(Enum):
+    FREE_TRIAL = 'FREE_TRIAL'
+    PAID = 'PAID'
+
+
+class Entitlements(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    organization_id: UUID = Field(
+        ...,
+        description="Reference to the organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>",
+    )
+    product_code: ProductCode = Field(..., description='Product being entitled')
+    tier: Tier = Field(..., description='Subscription tier level')
+    quotas: Any | None = Field(None, description='Usage limits and quotas as JSON')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the entitlement was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class AuditUrls(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the parent site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    url: str = Field(..., description='URL to be audited (unique per site)')
+    by_customer: bool = Field(
+        ...,
+        description='Whether this URL was added by the customer (vs auto-discovered)',
+    )
+    audits: list[str] = Field(..., description='List of audit types to run on this URL')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the URL was registered'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    created_by: str = Field(..., description='User or system that added this URL')
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class SiteTopForms(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the parent site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    url: str = Field(..., description='URL of the page containing the form')
+    form_source: str = Field(
+        ..., description='Identifier for the specific form on the page'
+    )
+    traffic: int = Field(..., description='Traffic volume to this form')
+    source: str = Field(..., description='Analytics source for the traffic data')
+    imported_at: AwareDatetime = Field(
+        ..., description='When this data was imported from the source'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Type(Enum):
+    SIGN_UP = 'SIGN_UP'
+    SIGN_IN = 'SIGN_IN'
+    CREATE_SITE = 'CREATE_SITE'
+    RUN_AUDIT = 'RUN_AUDIT'
+    PROMPT_RUN = 'PROMPT_RUN'
+    DOWNLOAD = 'DOWNLOAD'
+
+
+class TrialUserActivities(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    trial_user_id: UUID = Field(
+        ...,
+        description="Reference to the trial user\n\nNote:\nThis is a Foreign Key to `trial_users.id`.<fk table='trial_users' column='id'/>",
+    )
+    entitlement_id: UUID = Field(
+        ...,
+        description="Reference to the entitlement used\n\nNote:\nThis is a Foreign Key to `entitlements.id`.<fk table='entitlements' column='id'/>",
+    )
+    site_id: UUID | None = Field(
+        None,
+        description="Reference to the site involved (if applicable)\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    type: Type = Field(..., description='Type of activity performed')
+    details: Any | None = Field(None, description='Activity-specific details as JSON')
+    product_code: ProductCode = Field(..., description='Product code for the activity')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the activity occurred'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class PageIntent(Enum):
+    INFORMATIONAL = 'INFORMATIONAL'
+    NAVIGATIONAL = 'NAVIGATIONAL'
+    TRANSACTIONAL = 'TRANSACTIONAL'
+    COMMERCIAL = 'COMMERCIAL'
+
+
+class PageIntents(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the parent site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    url: str = Field(..., description='Full URL of the page (unique across all sites)')
+    page_intent: PageIntent = Field(..., description='Classified search intent type')
+    topic: str = Field(..., description='Primary topic or subject of the page')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'spacecat',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Audits(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the audited site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    audit_type: str = Field(
+        ..., description='Type of audit performed (e.g., cwv, lhs, broken-backlinks)'
+    )
+    audit_result: Any = Field(..., description='Full audit results as JSON')
+    full_audit_ref: str = Field(
+        ..., description='Reference to the complete audit data in external storage'
+    )
+    is_live: bool = Field(
+        ..., description='Whether this audit was performed on a live site'
+    )
+    is_error: bool = Field(..., description='Whether the audit encountered an error')
+    invocation_id: str | None = Field(
+        None, description='Correlation ID for the audit invocation'
+    )
+    audited_at: AwareDatetime = Field(
+        ..., description='Timestamp when the audit was performed'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class ImportJobs(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    base_url: str = Field(..., description='Base URL being imported from')
+    duration: float = Field(..., description='Total job duration in seconds')
+    ended_at: AwareDatetime | None = Field(None, description='When the job completed')
+    failed_count: int = Field(..., description='Number of URLs that failed to import')
+    has_custom_headers: bool = Field(
+        ..., description='Whether custom HTTP headers were used'
+    )
+    has_custom_import_js: bool = Field(
+        ..., description='Whether custom import JavaScript was used'
+    )
+    hashed_api_key: str = Field(
+        ..., description='Hash of the API key that initiated the import'
+    )
+    import_queue_id: str | None = Field(None, description='External queue identifier')
+    initiated_by: Any | None = Field(
+        None, description='User or system that started the import'
+    )
+    options: Any | None = Field(
+        None, description='Import configuration options as JSON'
+    )
+    redirect_count: int = Field(..., description='Number of redirects encountered')
+    status: Status3 = Field(..., description='Current job status')
+    started_at: AwareDatetime = Field(..., description='When the job started')
+    success_count: int = Field(..., description='Number of URLs successfully imported')
+    url_count: int = Field(..., description='Total number of URLs to process')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the job was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Status5(Enum):
+    processing = 'processing'
+    success = 'success'
+    failed = 'failed'
+
+
+class Reports(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the site this report is for\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    report_type: str = Field(
+        ..., description='Type of report (e.g., monthly-summary, performance)'
+    )
+    report_period: Any = Field(
+        ..., description='Time period covered by the report as JSON'
+    )
+    comparison_period: Any = Field(
+        ..., description='Comparison period for trend analysis as JSON'
+    )
+    storage_path: str = Field(..., description='Path to the generated report file')
+    status: Status5 = Field(..., description='Report generation status')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the report was requested'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Status6(Enum):
+    PENDING = 'PENDING'
+    REDIRECT = 'REDIRECT'
+    RUNNING = 'RUNNING'
+    COMPLETE = 'COMPLETE'
+    FAILED = 'FAILED'
+    STOPPED = 'STOPPED'
+
+
+class ImportUrls(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    import_job_id: UUID = Field(
+        ...,
+        description="Reference to the parent import job\n\nNote:\nThis is a Foreign Key to `import_jobs.id`.<fk table='import_jobs' column='id'/>",
+    )
+    file: str | None = Field(
+        None, description='Output file path for the imported content'
+    )
+    path: str | None = Field(
+        None, description='Relative path within the import destination'
+    )
+    reason: str | None = Field(
+        None, description='Failure or redirect reason (if applicable)'
+    )
+    status: Status6 = Field(..., description='Current processing status')
+    url: str = Field(..., description='URL being imported')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Projects(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    organization_id: UUID = Field(
+        ...,
+        description="Reference to the owning organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>",
+    )
+    project_name: str = Field(..., description='Name of the project')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the project was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class DeliveryType(Enum):
+    aem_cs = 'aem_cs'
+    aem_edge = 'aem_edge'
+    aem_ams = 'aem_ams'
+    aem_headless = 'aem_headless'
+    other = 'other'
+
+
+class AuthoringType(Enum):
+    cs_crosswalk = 'cs/crosswalk'
+    cs = 'cs'
+    ams = 'ams'
+    sharepoint = 'sharepoint'
+    googledocs = 'googledocs'
+    documentauthoring = 'documentauthoring'
+
+
+class Sites(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    organization_id: UUID = Field(
+        ...,
+        description="Reference to the owning organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>",
+    )
+    base_url: str = Field(
+        ..., description='Primary URL of the website (must be unique)'
+    )
+    name: str | None = Field(
+        None, description='Human-friendly display name for the site'
+    )
+    is_primary_locale: bool | None = Field(
+        None, description='Whether this is the primary locale for a multi-locale site'
+    )
+    language: constr(max_length=2) | None = Field(
+        None, description='ISO 639-1 two-letter language code (e.g., en, de, fr)'
+    )
+    region: constr(max_length=2) | None = Field(
+        None, description='ISO 3166-1 alpha-2 country code (e.g., US, DE, FR)'
+    )
+    config: Any = Field(..., description='Site-level configuration settings as JSON')
+    code: Any | None = Field(
+        None, description='Code-related configuration (e.g., repository settings)'
+    )
+    delivery_type: DeliveryType = Field(
+        ..., description='Content delivery platform type'
+    )
+    authoring_type: AuthoringType | None = Field(
+        None, description='Content authoring platform type'
+    )
+    github_url: str | None = Field(
+        None, description='URL to the GitHub repository for this site'
+    )
+    delivery_config: Any | None = Field(
+        None, description='Delivery-specific configuration settings'
+    )
+    hlx_config: Any | None = Field(
+        None, description='Helix (Edge Delivery) specific configuration'
+    )
+    is_sandbox: bool = Field(..., description='Whether this is a sandbox/test site')
+    is_live: bool = Field(..., description='Whether the site is actively monitored')
+    is_live_toggled_at: AwareDatetime | None = Field(
+        None, description='Timestamp when is_live status was last changed'
+    )
+    external_owner_id: str | None = Field(
+        None, description='External system owner identifier'
+    )
+    external_site_id: str | None = Field(
+        None, description='External system site identifier'
+    )
+    page_types: Any | None = Field(
+        None, description='Configured page type classifications'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the site was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+    project_id: UUID | None = Field(
+        None,
+        description="Reference to the project this site belongs to (optional)\n\nNote:\nThis is a Foreign Key to `projects.id`.<fk table='projects' column='id'/>",
+    )
+
+
+class Status7(Enum):
+    INVITED = 'INVITED'
+    REGISTERED = 'REGISTERED'
+    BLOCKED = 'BLOCKED'
+    DELETED = 'DELETED'
+
+
+class TrialUsers(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    organization_id: UUID = Field(
+        ...,
+        description="Reference to the organization\n\nNote:\nThis is a Foreign Key to `organizations.id`.<fk table='organizations' column='id'/>",
+    )
+    external_user_id: str | None = Field(
+        None, description='User ID from external identity system'
+    )
+    status: Status7 = Field(..., description='Current status in the trial lifecycle')
+    last_seen_at: AwareDatetime | None = Field(
+        None, description='Last activity timestamp'
+    )
+    email_id: str = Field(..., description='Email address (unique per organization)')
+    first_name: str | None = Field(None, description='User first name')
+    last_name: str | None = Field(None, description='User last name')
+    metadata: Any | None = Field(None, description='Additional user metadata as JSON')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the user was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Type1(Enum):
+    CODE_CHANGE = 'CODE_CHANGE'
+    CONTENT_UPDATE = 'CONTENT_UPDATE'
+    REDIRECT_UPDATE = 'REDIRECT_UPDATE'
+    METADATA_UPDATE = 'METADATA_UPDATE'
+    AI_INSIGHTS = 'AI_INSIGHTS'
+    CONFIG_UPDATE = 'CONFIG_UPDATE'
+
+
+class Status8(Enum):
+    PENDING = 'PENDING'
+    DEPLOYED = 'DEPLOYED'
+    PUBLISHED = 'PUBLISHED'
+    FAILED = 'FAILED'
+    ROLLED_BACK = 'ROLLED_BACK'
+
+
+class Origin1(Enum):
+    spacecat = 'spacecat'
+    aso = 'aso'
+    reporting = 'reporting'
+
+
+class FixEntities(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    opportunity_id: UUID = Field(
+        ...,
+        description="Reference to the opportunity being fixed\n\nNote:\nThis is a Foreign Key to `opportunities.id`.<fk table='opportunities' column='id'/>",
+    )
+    type: Type1 = Field(
+        ..., description='Type of fix applied (reuses suggestion_type enum)'
+    )
+    executed_by: str | None = Field(
+        None, description='User or system that executed the fix'
+    )
+    executed_at: AwareDatetime | None = Field(
+        None, description='Timestamp when the fix was executed'
+    )
+    published_at: AwareDatetime | None = Field(
+        None, description='Timestamp when the fix was published/deployed'
+    )
+    change_details: Any = Field(..., description='Details of the changes made as JSON')
+    status: Status8 = Field(..., description='Current deployment status of the fix')
+    origin: Origin1 | None = Field(
+        'spacecat', description='System that originated the fix'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Organizations(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    name: str = Field(..., description='Display name of the organization')
+    ims_org_id: str | None = Field(
+        None, description='Adobe IMS organization identifier'
+    )
+    config: Any = Field(
+        ..., description='Organization-level configuration settings as JSON'
+    )
+    fulfillable_items: Any | None = Field(
+        None, description='Fulfillment tracking data for provisioned services'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the organization was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class SiteTopPages(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the parent site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    url: str = Field(..., description='Full URL of the page')
+    traffic: int = Field(..., description='Traffic volume (page views or visits)')
+    source: str = Field(..., description='Analytics source (e.g., rum, ahrefs, google)')
+    top_keyword: str | None = Field(
+        None, description='Primary keyword driving traffic to this page'
+    )
+    geo: str = Field(
+        ..., description='Geographic region for the traffic data (default: global)'
+    )
+    imported_at: AwareDatetime = Field(
+        ..., description='When this data was imported from the source'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Source(Enum):
+    SPACECAT_SLACK_BOT = 'SPACECAT_SLACK_BOT'
+    RUM = 'RUM'
+    CDN = 'CDN'
+
+
+class Status9(Enum):
+    PENDING = 'PENDING'
+    IGNORED = 'IGNORED'
+    APPROVED = 'APPROVED'
+    ERROR = 'ERROR'
+
+
+class SiteCandidates(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID | None = Field(
+        None,
+        description="Reference to the site (once approved and created)\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    base_url: str = Field(..., description='URL of the candidate site (must be unique)')
+    hlx_config: Any = Field(
+        ..., description='Helix configuration discovered for this candidate'
+    )
+    source: Source = Field(..., description='How this candidate was discovered')
+    status: Status9 = Field(..., description='Current approval workflow status')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the candidate was discovered'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'spacecat',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class ApiKeys(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    hashed_api_key: str = Field(
+        ..., description='SHA-256 hash of the API key (never store plain text)'
+    )
+    ims_user_id: str = Field(..., description='Adobe IMS user ID who owns this key')
+    ims_org_id: str = Field(
+        ..., description='Adobe IMS organization ID this key belongs to'
+    )
+    name: str = Field(..., description='Human-readable name for the API key')
+    deleted_at: AwareDatetime | None = Field(None, description='Soft delete timestamp')
+    expires_at: AwareDatetime | None = Field(
+        None, description='When the key expires (null = never)'
+    )
+    revoked_at: AwareDatetime | None = Field(
+        None, description='When the key was revoked (null = active)'
+    )
+    scopes: Any = Field(..., description='Permissions granted to this key as JSON')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the key was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Status10(Enum):
+    PENDING = 'PENDING'
+    REDIRECT = 'REDIRECT'
+    RUNNING = 'RUNNING'
+    COMPLETE = 'COMPLETE'
+    FAILED = 'FAILED'
+    STOPPED = 'STOPPED'
+
+
+class ScrapeUrls(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    scrape_job_id: UUID = Field(
+        ...,
+        description="Reference to the parent scrape job\n\nNote:\nThis is a Foreign Key to `scrape_jobs.id`.<fk table='scrape_jobs' column='id'/>",
+    )
+    file: str | None = Field(
+        None, description='Output file path for the scraped content'
+    )
+    path: str | None = Field(
+        None, description='Relative path within the output destination'
+    )
+    reason: str | None = Field(
+        None, description='Failure or redirect reason (if applicable)'
+    )
+    status: Status10 = Field(..., description='Current processing status')
+    url: str = Field(..., description='URL being scraped')
+    processing_type: str = Field(
+        ..., description='Type of processing applied to this URL'
+    )
+    options: Any | None = Field(None, description='URL-specific options as JSON')
+    is_original: bool = Field(
+        ...,
+        description='Whether this is an original URL (not discovered during scraping)',
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class PageCitabilities(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the parent site\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    url: str = Field(..., description='Full URL of the page (unique across all sites)')
+    citability_score: float | None = Field(
+        None, description='Overall citability score (0-100)'
+    )
+    content_ratio: float | None = Field(
+        None, description='Ratio of useful content to total content'
+    )
+    word_difference: int | None = Field(
+        None, description='Difference in word count between bot and normal views'
+    )
+    bot_words: int | None = Field(
+        None, description='Word count as seen by bots/crawlers'
+    )
+    normal_words: int | None = Field(
+        None, description='Word count as seen by normal users'
+    )
+    is_deployed_at_edge: bool | None = Field(
+        None, description='Whether the page is served from edge CDN'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'spacecat',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class FixEntitySuggestions(BaseModel):
+    suggestion_id: UUID = Field(
+        ...,
+        description="Reference to the suggestion\n\nNote:\nThis is a Primary Key.<pk/>\nThis is a Foreign Key to `suggestions.id`.<fk table='suggestions' column='id'/>",
+    )
+    fix_entity_id: UUID = Field(
+        ...,
+        description="Reference to the fix entity\n\nNote:\nThis is a Primary Key.<pk/>\nThis is a Foreign Key to `fix_entities.id`.<fk table='fix_entities' column='id'/>",
+    )
+    opportunity_id: UUID = Field(
+        ...,
+        description="Reference to the parent opportunity (denormalized for queries)\n\nNote:\nThis is a Foreign Key to `opportunities.id`.<fk table='opportunities' column='id'/>",
+    )
+    fix_entity_created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the fix entity was created'
+    )
+    fix_entity_created_date: date | None = Field(
+        None,
+        description='Date portion of fix_entity_created_at (generated, for date-based queries)',
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the link was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+
+
+class Type2(Enum):
+    PERFORMANCE = 'PERFORMANCE'
+    SEO = 'SEO'
+    CONTENT = 'CONTENT'
+    CODE = 'CODE'
+    THIRD_PARTY = 'THIRD PARTY'
+    EXPERIMENTATION = 'EXPERIMENTATION'
+    NETWORK = 'NETWORK'
+    STATUS_CHANGE = 'STATUS CHANGE'
+
+
+class KeyEvents(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    site_id: UUID = Field(
+        ...,
+        description="Reference to the site this event belongs to\n\nNote:\nThis is a Foreign Key to `sites.id`.<fk table='sites' column='id'/>",
+    )
+    name: str = Field(..., description='Description of the event')
+    type: Type2 = Field(..., description='Category of the event')
+    time: AwareDatetime = Field(..., description='When the event occurred')
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the record was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )
+
+
+class Type3(Enum):
+    CODE_CHANGE = 'CODE_CHANGE'
+    CONTENT_UPDATE = 'CONTENT_UPDATE'
+    REDIRECT_UPDATE = 'REDIRECT_UPDATE'
+    METADATA_UPDATE = 'METADATA_UPDATE'
+    AI_INSIGHTS = 'AI_INSIGHTS'
+    CONFIG_UPDATE = 'CONFIG_UPDATE'
+
+
+class Status11(Enum):
+    NEW = 'NEW'
+    APPROVED = 'APPROVED'
+    IN_PROGRESS = 'IN_PROGRESS'
+    SKIPPED = 'SKIPPED'
+    FIXED = 'FIXED'
+    ERROR = 'ERROR'
+    OUTDATED = 'OUTDATED'
+    PENDING_VALIDATION = 'PENDING_VALIDATION'
+    REJECTED = 'REJECTED'
+
+
+class Suggestions(BaseModel):
+    id: UUID = Field(
+        ...,
+        description='Unique identifier (UUID v7, time-sortable)\n\nNote:\nThis is a Primary Key.<pk/>',
+    )
+    opportunity_id: UUID = Field(
+        ...,
+        description="Reference to the parent opportunity\n\nNote:\nThis is a Foreign Key to `opportunities.id`.<fk table='opportunities' column='id'/>",
+    )
+    type: Type3 = Field(..., description='Category of change being suggested')
+    rank: int = Field(
+        ...,
+        description='Priority ranking among suggestions for the same opportunity (lower is higher priority)',
+    )
+    data: Any = Field(
+        ..., description='Suggestion-specific data including the proposed changes'
+    )
+    kpi_deltas: Any | None = Field(
+        None, description='Projected impact on KPIs if this suggestion is implemented'
+    )
+    status: Status11 = Field(
+        ..., description='Current workflow status of the suggestion'
+    )
+    created_at: AwareDatetime = Field(
+        ..., description='Timestamp when the suggestion was created'
+    )
+    updated_at: AwareDatetime = Field(
+        ..., description='Timestamp of the last update (auto-managed)'
+    )
+    updated_by: str | None = Field(
+        'system',
+        description='Identifier of the user or system that made the last update',
+    )

mysticat_data_service_types-1.0.0.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: mysticat-data-service-types
+Version: 1.0.0
+Summary: Pydantic models for Mysticat Data Service API (PostgREST)
+Project-URL: Homepage, https://github.com/adobe/mysticat-data-service
+Project-URL: Repository, https://github.com/adobe/mysticat-data-service
+Project-URL: Documentation, https://github.com/adobe/mysticat-data-service#readme
+Author-email: Adobe <noreply@adobe.com>
+License-Expression: Apache-2.0
+Keywords: models,mysticat,postgrest,pydantic,types
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0.0
+Description-Content-Type: text/markdown
+
+# mysticat-data-service-types
+
+Pydantic models for Mysticat Data Service API (PostgREST).
+
+## Installation
+
+```bash
+pip install mysticat-data-service-types
+```
+
+## Usage
+
+```python
+from mysticat_data_service_types import Organizations, Sites, Audits
+
+# Type hints for API responses
+def process_organization(org: Organizations) -> None:
+    print(org.name)
+
+# Validation
+org = Organizations(
+    id="01234567-89ab-cdef-0123-456789abcdef",
+    name="My Organization",
+    ims_org_id="ABC123@AdobeOrg",
+    # ...
+)
+```
+
+## License
+
+Apache-2.0

mysticat_data_service_types-1.0.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+mysticat_data_service_types/__init__.py,sha256=57T0ap1G3Va3BagQ0U8dkDt8hx1d0LBvNzF67opzcZA,437
+mysticat_data_service_types/models.py,sha256=k9p9ZOLg96RG3qxyBk5xll84Yf-IdkdiIz26KoGH4Ck,40916
+mysticat_data_service_types-1.0.0.dist-info/METADATA,sha256=N4WzQVWH1p9TLmjVeRXkkb2xNLfFyjd5UNRl91bLq7w,1499
+mysticat_data_service_types-1.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mysticat_data_service_types-1.0.0.dist-info/RECORD,,

mysticat_data_service_types-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any