Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

5.2 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.sdk import (
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    ResumableSource,
    ResumableSourceManager,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
    detect,
)
from products.warehouse_sources.sources.simplesat._config import SimplesatSourceConfig
from products.warehouse_sources.sources.simplesat.settings import ENDPOINTS, INCREMENTAL_FIELDS, SIMPLESAT_ENDPOINTS
from products.warehouse_sources.sources.simplesat.simplesat import (
    SimplesatResumeConfig,
    simplesat_source,
    validate_credentials,
)


@SourceRegistry.register
class SimplesatSource(ResumableSource[SimplesatSourceConfig, SimplesatResumeConfig]):
    codebase_detection = detect(env=("^SIMPLESAT_",))

    supported_versions = ("v1",)
    default_version = "v1"
    api_docs_url = "https://developer.simplesat.io/api"

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs

    @property
    def source_type(self) -> ExternalDataSourceType:
        return ExternalDataSourceType.SIMPLESAT

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.SIMPLESAT,
            category=DataWarehouseSourceCategory.CUSTOMER_SUPPORT,
            label="Simplesat",
            releaseStatus=ReleaseStatus.BETA,
            caption="""Enter your Simplesat API key to pull your customer satisfaction survey data into the PostHog Data warehouse.

You can create an API key under **Settings → API keys** in [Simplesat](https://app.simplesat.io/). The key must include read scopes for each resource you want to sync — surveys, questions, answers, responses, and customers.
""",
            iconPath="/static/services/simplesat.png",
            docsUrl="https://posthog.com/docs/cdp/sources/simplesat",
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API key",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                ],
            ),
        )

    def get_canonical_descriptions(self) -> CanonicalDescriptions:
        from products.warehouse_sources.sources.simplesat.canonical_descriptions import (
            CANONICAL_DESCRIPTIONS,  # noqa: PLC0415
        )

        return CANONICAL_DESCRIPTIONS

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            "401 Client Error: Unauthorized for url: https://api.simplesat.io": "Your Simplesat API key is invalid or has been revoked. Generate a new key under Settings → API keys, then reconnect.",
            "403 Client Error: Forbidden for url: https://api.simplesat.io": "Your Simplesat API key does not have access to this data. Check the key's scopes, then reconnect.",
        }

    def get_schemas(
        self,
        config: SimplesatSourceConfig,
        team_id: int,
        with_counts: bool = False,
        names: list[str] | None = None,
        force_refresh: bool = False,
        api_version: str | None = None,
    ) -> list[SourceSchema]:
        # Only endpoints with a server-side timestamp filter (customers) have INCREMENTAL_FIELDS;
        # build_endpoint_schemas marks the rest as full refresh.
        return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names)

    def validate_credentials(
        self,
        config: SimplesatSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        # The API key is account-wide, so a single probe validates access to every schema.
        # Delegate to the transport-level helper so the status → message mapping lives in one place.
        return validate_credentials(config.api_key)

    def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[SimplesatResumeConfig]:
        return ResumableSourceManager[SimplesatResumeConfig](inputs, SimplesatResumeConfig)

    def source_for_pipeline(
        self,
        config: SimplesatSourceConfig,
        resumable_source_manager: ResumableSourceManager[SimplesatResumeConfig],
        inputs: SourceInputs,
    ) -> SourceResponse:
        if inputs.schema_name not in SIMPLESAT_ENDPOINTS:
            raise ValueError(f"Unknown Simplesat schema '{inputs.schema_name}'")

        return simplesat_source(
            api_key=config.api_key,
            endpoint=inputs.schema_name,
            team_id=inputs.team_id,
            job_id=inputs.job_id,
            resumable_source_manager=resumable_source_manager,
            should_use_incremental_field=inputs.should_use_incremental_field,
            db_incremental_field_last_value=inputs.db_incremental_field_last_value,
            incremental_field=inputs.incremental_field,
        )