blitz-api-py 0.1.0__py3-none-any.whl

blitz_api/types/__init__.py

@@ -0,0 +1,108 @@
+"""Public type surface for the Blitz API SDK.
+
+Import response models and request filters from here, e.g.::
+
+    from blitz_api.types import Person, CompanyFilter, Industry
+"""
+
+from __future__ import annotations
+
+from .account import ActivePlan, KeyInfo
+from .enrichment import (
+    CompanyEnrichmentResponse,
+    DomainToLinkedinResponse,
+    EmailEnrichmentResponse,
+    EmailMatch,
+    EmailToPersonResponse,
+    LinkedinToDomainResponse,
+    PhoneEnrichmentResponse,
+    PhoneToPersonResponse,
+)
+from .enums import (
+    CompanyType,
+    Continent,
+    EmployeeRange,
+    Industry,
+    JobFunction,
+    JobLevel,
+    SalesRegion,
+)
+from .filters import (
+    CascadeTier,
+    CompanyFilter,
+    CompanyHQFilter,
+    CompanyTypeFilter,
+    IndustryFilter,
+    KeywordFilter,
+    PeopleFilter,
+    PeopleJobTitleFilter,
+    PeopleLocationFilter,
+    RangeFilter,
+)
+from .search import (
+    WaterfallIcpMatch,
+    WaterfallIcpResponse,
+)
+from .shared import (
+    HQ,
+    Certification,
+    Company,
+    Education,
+    Experience,
+    Location,
+    Person,
+)
+from .utils import (
+    CompanyEmploymentDistributionResponse,
+    CurrentDateResponse,
+    EmploymentDistributionItem,
+)
+
+__all__ = [
+    # shared
+    "Person",
+    "Experience",
+    "Education",
+    "Certification",
+    "Location",
+    "Company",
+    "HQ",
+    # enums
+    "Industry",
+    "CompanyType",
+    "EmployeeRange",
+    "Continent",
+    "SalesRegion",
+    "JobFunction",
+    "JobLevel",
+    # filters
+    "KeywordFilter",
+    "IndustryFilter",
+    "CompanyTypeFilter",
+    "RangeFilter",
+    "CompanyHQFilter",
+    "CompanyFilter",
+    "PeopleJobTitleFilter",
+    "PeopleLocationFilter",
+    "PeopleFilter",
+    "CascadeTier",
+    # account
+    "KeyInfo",
+    "ActivePlan",
+    # search (paginated results return the page classes exported from `blitz_api`)
+    "WaterfallIcpMatch",
+    "WaterfallIcpResponse",
+    # enrichment
+    "EmailMatch",
+    "EmailEnrichmentResponse",
+    "PhoneEnrichmentResponse",
+    "EmailToPersonResponse",
+    "PhoneToPersonResponse",
+    "CompanyEnrichmentResponse",
+    "DomainToLinkedinResponse",
+    "LinkedinToDomainResponse",
+    # utils
+    "CurrentDateResponse",
+    "EmploymentDistributionItem",
+    "CompanyEmploymentDistributionResponse",
+]

blitz_api/types/_models.py

@@ -0,0 +1,23 @@
+"""Base Pydantic model for every Blitz API response type."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+
+class BlitzModel(BaseModel):
+    """Base for all response models.
+
+    Configured to be forward-compatible: unknown fields returned by the API are
+    preserved (reachable via :attr:`model_extra`) instead of raising, so a new
+    server-side field never breaks deserialization. Known fields stay precisely
+    typed.
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+        # The API exposes fields like ``max_requests_per_seconds``; silence the
+        # ``model_`` protected-namespace warnings without affecting behaviour.
+        protected_namespaces=(),
+    )

blitz_api/types/account.py

@@ -0,0 +1,27 @@
+"""Response models for the Account resource."""
+
+from __future__ import annotations
+
+from ._models import BlitzModel
+
+__all__ = ["ActivePlan", "KeyInfo"]
+
+
+class ActivePlan(BlitzModel):
+    """A subscription plan attached to the API key."""
+
+    name: str | None = None
+    status: str | None = None
+    started_at: str | None = None
+
+
+class KeyInfo(BlitzModel):
+    """The result of ``client.account.key_info()`` — key health and limits."""
+
+    valid: bool | None = None
+    id: str | None = None
+    remaining_credits: float | None = None
+    next_reset_at: str | None = None
+    max_requests_per_seconds: int | None = None
+    allowed_apis: list[str] = []
+    active_plans: list[ActivePlan] = []

blitz_api/types/enrichment.py

@@ -0,0 +1,76 @@
+"""Response models for the Enrichment resource."""
+
+from __future__ import annotations
+
+from ._models import BlitzModel
+from .shared import Company, Person
+
+__all__ = [
+    "EmailMatch",
+    "EmailEnrichmentResponse",
+    "PhoneEnrichmentResponse",
+    "EmailToPersonResponse",
+    "PhoneToPersonResponse",
+    "CompanyEnrichmentResponse",
+    "DomainToLinkedinResponse",
+    "LinkedinToDomainResponse",
+]
+
+
+class EmailMatch(BlitzModel):
+    """A single candidate email returned by ``enrichment.email``."""
+
+    email: str | None = None
+    job_order_in_profile: int | None = None
+    company_linkedin_url: str | None = None
+    email_domain: str | None = None
+
+
+class EmailEnrichmentResponse(BlitzModel):
+    """Result of ``enrichment.email`` (LinkedIn URL -> verified work email)."""
+
+    found: bool | None = None
+    email: str | None = None
+    all_emails: list[EmailMatch] = []
+
+
+class PhoneEnrichmentResponse(BlitzModel):
+    """Result of ``enrichment.phone`` (LinkedIn URL -> phone)."""
+
+    found: bool | None = None
+    phone: str | None = None
+
+
+class EmailToPersonResponse(BlitzModel):
+    """Result of ``enrichment.email_to_person`` (email -> full profile)."""
+
+    found: bool | None = None
+    person: Person | None = None
+
+
+class PhoneToPersonResponse(BlitzModel):
+    """Result of ``enrichment.phone_to_person`` (phone -> full profile)."""
+
+    found: bool | None = None
+    person: Person | None = None
+
+
+class CompanyEnrichmentResponse(BlitzModel):
+    """Result of ``enrichment.company`` (company LinkedIn URL -> company profile)."""
+
+    found: bool | None = None
+    company: Company | None = None
+
+
+class DomainToLinkedinResponse(BlitzModel):
+    """Result of ``enrichment.domain_to_linkedin`` (domain -> company LinkedIn URL)."""
+
+    found: bool | None = None
+    company_linkedin_url: str | None = None
+
+
+class LinkedinToDomainResponse(BlitzModel):
+    """Result of ``enrichment.linkedin_to_domain`` (company LinkedIn URL -> email domain)."""
+
+    found: bool | None = None
+    email_domain: str | None = None