databay-cli 0.1.0__py3-none-any.whl

databay/models/shopify_store.py

@@ -0,0 +1,19 @@
+"""Models of the ``shopify_store`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import ResponseModel
+from databay.models.shared import SourceStatus
+
+
+class ShopifyStoreResponse(ResponseModel):
+    scopes: str = ''
+    shop_domain: str
+    status: SourceStatus
+    uuid: str
+
+
+ShopifyStoreListResponse = list[ShopifyStoreResponse]

databay/models/sink_data_type.py

@@ -0,0 +1,11 @@
+"""Models of the ``sink_data_type`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+
+
+
+SinkDataTypeListResponse = list[str]

databay/models/source.py

@@ -0,0 +1,263 @@
+"""Models of the ``source`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Annotated, Any, Literal
+
+from pydantic import Field
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+from databay.models.shared import AuthKind, ConnectedSourceResponse, DependentPipeView, PipeEligibility, PrecheckFixView, PublicationMode, SourceStatus, SourceType
+
+
+class InstagramConnectedConfigLogin(OpenStrEnum):
+    FACEBOOK = 'facebook'
+    INSTAGRAM = 'instagram'
+
+
+class PrecheckCheckViewOwner(OpenStrEnum):
+    CUSTOMER = 'customer'
+    DBA = 'dba'
+    DATABAY = 'databay'
+    PROVIDER = 'provider'
+
+
+class PrecheckCheckViewStatus(OpenStrEnum):
+    PASS = 'pass'
+    FAIL = 'fail'
+    WARN = 'warn'
+    UNKNOWN = 'unknown'
+    NOT_RUN = 'not_run'
+
+
+class ReadinessOverrideViewActor(OpenStrEnum):
+    SUPPORT = 'support'
+    CUSTOMER = 'customer'
+
+
+class PrecheckReportViewProvider(OpenStrEnum):
+    RDS = 'rds'
+    CLOUDSQL = 'cloudsql'
+    AZURE = 'azure'
+    ATLAS = 'atlas'
+    SELF_MANAGED = 'self_managed'
+    UNKNOWN = 'unknown'
+
+
+class FileParseSettings(RequestModel):
+    delimiter: str | None = None
+    encoding: str = 'utf-8'
+    header_rows: dict[str, int] | None = None
+
+
+class FileUploadConnectedConfig(RequestModel):
+    settings: FileParseSettings | None = None
+    source_type: Literal['file_upload'] = 'file_upload'
+
+
+class Ga4ConnectedConfig(RequestModel):
+    extra_account_ids: list[str] | None = None
+    multi_property: bool = False
+    property_id: str
+    refresh_token: str = ''
+    service_account_json: str = ''
+    source_type: Literal['ga4'] = 'ga4'
+    start_date: str = '2023-01-01'
+
+
+class GoogleAdsConnectedConfig(RequestModel):
+    client_id: str = ''
+    client_secret: str = ''
+    customer_id: str
+    developer_token: str = ''
+    login_customer_id: str | None = None
+    refresh_token: str
+    source_type: Literal['google_ads'] = 'google_ads'
+    start_date: str = '2023-01-01'
+
+
+class InstagramConnectedConfig(RequestModel):
+    access_token: str
+    account_id: str = ''
+    login: InstagramConnectedConfigLogin = 'facebook'
+    source_type: Literal['instagram'] = 'instagram'
+    start_date: str = '2023-01-01'
+
+
+class LinkedInPagesConnectedConfig(RequestModel):
+    access_token: str
+    organization_id: str = ''
+    source_type: Literal['linkedin_pages'] = 'linkedin_pages'
+    start_date: str = '2023-01-01'
+
+
+class MSSQLConnectedConfig(RequestModel):
+    db_name: str
+    host: str
+    password: str = ''
+    port: int
+    source_type: Literal['mssql'] = 'mssql'
+    ssl_mode: str = 'disable'
+    username: str
+
+
+class MetaAdsConnectedConfig(RequestModel):
+    access_token: str
+    account_id: str
+    app_id: str = ''
+    app_secret: str = ''
+    extra_account_ids: list[str] | None = None
+    source_type: Literal['meta_ads'] = 'meta_ads'
+    start_date: str = '2023-01-01'
+
+
+class MongoDBConnectedConfig(RequestModel):
+    db_name: str
+    host: str
+    password: str = ''
+    port: int
+    source_type: Literal['mongodb'] = 'mongodb'
+    ssl_mode: str = 'disable'
+    username: str
+
+
+class MySQLConnectedConfig(RequestModel):
+    db_name: str
+    host: str
+    password: str = ''
+    port: int
+    source_type: Literal['mysql'] = 'mysql'
+    ssl_mode: str = 'disable'
+    username: str
+
+
+class PostgresConnectedConfig(RequestModel):
+    db_name: str
+    host: str
+    password: str = ''
+    port: int
+    source_type: Literal['postgres'] = 'postgres'
+    ssl_mode: str = 'disable'
+    username: str
+
+
+class ShopifyConnectedConfig(RequestModel):
+    access_token: str
+    bulk_window_in_days: int = 30
+    source_type: Literal['shopify'] = 'shopify'
+    start_date: str = '2020-01-01'
+
+
+class ConnectedSourceCreate(RequestModel):
+    acknowledge_org_visible: bool = False
+    allow_incomplete: bool = False
+    config: Annotated[PostgresConnectedConfig | MySQLConnectedConfig | MSSQLConnectedConfig | MongoDBConnectedConfig | ShopifyConnectedConfig | MetaAdsConnectedConfig | GoogleAdsConnectedConfig | Ga4ConnectedConfig | InstagramConnectedConfig | LinkedInPagesConnectedConfig | FileUploadConnectedConfig, Field(discriminator='source_type')]
+    name: str
+    publication_mode: PublicationMode | None = None
+
+
+class PrecheckCheckView(ResponseModel):
+    blocking: bool
+    cause: str | None = None
+    code: str | None = None
+    detail: str
+    detail_code: str | None = None
+    docs_href: str | None = None
+    fixes: list[PrecheckFixView] | None = None
+    overridden: bool = False
+    owner: PrecheckCheckViewOwner
+    requirement_id: str
+    retriable: bool = False
+    status: PrecheckCheckViewStatus
+    support_ref: str | None = None
+    title: str
+    values: dict[str, str | int] | None = None
+    why: str
+
+
+class ReadinessOverrideView(ResponseModel):
+    actor: ReadinessOverrideViewActor
+    at: datetime
+    by: str
+    reason: str
+    requirement_ids: list[str]
+
+
+class PrecheckReportView(ResponseModel):
+    checked_at: datetime
+    checked_by: str | None = None
+    checks: list[PrecheckCheckView]
+    override: ReadinessOverrideView | None = None
+    provider: PrecheckReportViewProvider
+    reachable: bool
+    ready: bool
+    report_version: int
+    run_id: str | None = None
+    snapshot_strategy: str | None = None
+    source_status: SourceStatus | None = None
+    source_type: SourceType
+
+
+class ConnectedSourceDetailResponse(ResponseModel):
+    auth_kind: AuthKind
+    binding_status: str | None = None
+    blocking_requirements: list[str] | None = None
+    config: dict[str, Any] | None = None
+    created_at: datetime | None = None
+    external_ref: str | None = None
+    home_project_id: str | None = None
+    in_use: bool | None = None
+    name: str
+    pending_home_project_id: str | None = None
+    pipe_count: int | None = None
+    pipe_eligibility: PipeEligibility
+    pipes: list[DependentPipeView] | None = None
+    pipes_truncated: bool = False
+    pipes_unavailable: bool = False
+    publication_mode: PublicationMode | None = None
+    readiness: PrecheckReportView | None = None
+    readiness_checked_at: datetime | None = None
+    relation: str | None = None
+    scopes: str | None = None
+    secrets_set: dict[str, bool] | None = None
+    snapshot_strategy: str | None = None
+    source_type: SourceType
+    ssl_modes: list[str] | None = None
+    status: SourceStatus
+    updated_at: datetime | None = None
+    uuid: str
+
+
+class ConnectedSourceUpdate(RequestModel):
+    allow_incomplete: bool = False
+    db_name: str | None = None
+    host: str | None = None
+    name: str | None = None
+    password: str | None = None
+    port: int | None = None
+    source_type: SourceType | None = None
+    ssl_mode: str | None = None
+    username: str | None = None
+
+
+class SourceCascadeDeleteResponse(ResponseModel):
+    pipes: int
+    status: Literal['deleting']
+
+
+class SourceCredentialsRenew(RequestModel):
+    credentials: dict[str, str]
+
+
+class SourceForceDeleteResponse(ResponseModel):
+    pipes_at_deletion: int | None
+    source_id: str
+    status: Literal['force_deleted']
+    warning: str
+
+
+SourceListResponse = list[ConnectedSourceResponse]

databay/models/source_catalog.py

@@ -0,0 +1,82 @@
+"""Models of the ``source_catalog`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import Field
+
+from databay.model_base import OpenStrEnum, ResponseModel
+from databay.models.shared import AuthKind, SourceType
+
+
+class RequirementViewOwner(OpenStrEnum):
+    CUSTOMER = 'customer'
+    DBA = 'dba'
+    DATABAY = 'databay'
+    PROVIDER = 'provider'
+
+
+class SourceFieldDescriptorType(OpenStrEnum):
+    STRING = 'string'
+    INTEGER = 'integer'
+    ENUM = 'enum'
+
+
+class SourceCatalogEntryOauthApps(OpenStrEnum):
+    DATABAY = 'databay'
+    OWN = 'own'
+
+
+class RequirementView(ResponseModel):
+    blocking: bool
+    docs_href: str | None = None
+    id: str
+    owner: RequirementViewOwner
+    title: str
+    why: str
+
+
+class SetupStepView(ResponseModel):
+    body_md: str
+    docs_href: str | None = None
+    id: str
+    sql_template: str | None = None
+    title: str
+
+
+class SourceFieldDescriptor(ResponseModel):
+    default: Any | None = None
+    help: str | None = None
+    label: str
+    name: str
+    options: list[str] | None = None
+    required: bool = False
+    secret: bool = False
+    type: SourceFieldDescriptorType = 'string'
+
+
+class SourceCatalogEntry(ResponseModel):
+    already_connected: bool = False
+    auth_kind: AuthKind
+    available: bool = True
+    display_name: str
+    egress_addresses: list[str] | None = None
+    fields_: list[SourceFieldDescriptor] = Field(alias='fields')
+    journey: bool = False
+    journey_recipe: dict[str, Any] | None = None
+    manual_fields: list[SourceFieldDescriptor] | None = None
+    oauth_apps: list[SourceCatalogEntryOauthApps] | None = None
+    oauth_coming_soon: bool = False
+    oauth_methods: list[str] | None = None
+    requirements: list[RequirementView] | None = None
+    setup_steps: list[SetupStepView] | None = None
+    supports_oauth: bool = True
+    table_checks: bool = False
+    type: SourceType
+
+
+SourceCatalogListResponse = list[SourceCatalogEntry]

databay/models/source_check_run.py

@@ -0,0 +1,63 @@
+"""Models of the ``source_check_run`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+from databay.models.shared import CheckRunResponse, SourceType
+
+
+class TablesReadStatus(OpenStrEnum):
+    PENDING = 'pending'
+    OK = 'ok'
+    FAILED = 'failed'
+
+
+class CheckRunConnection(RequestModel):
+    db_name: str
+    host: str
+    port: int
+    ssl_mode: str = 'disable'
+    username: str
+
+
+class CheckRunStartRequest(RequestModel):
+    active_probes: bool = False
+    config: CheckRunConnection | None = None
+    name: str | None = None
+    password: str | None = None
+    source_id: str | None = None
+    source_type: SourceType | None = None
+
+
+class CheckRunTableRow(ResponseModel):
+    detail_code: str
+    fix_sql: str | None
+    in_publication: bool
+    name: str
+    owned: bool
+    schema_name: str
+    state: str
+    table_name: str
+    text: str
+    values: dict[str, str | int] | None = None
+
+
+class CheckRunTablesResponse(ResponseModel):
+    as_of: datetime | None
+    cap: int
+    capped: bool
+    matched: int
+    read_status: TablesReadStatus
+    rows: list[CheckRunTableRow]
+    total_in: int
+    total_in_publication: int
+    total_not_in_publication: int
+    total_out: int
+
+
+SourceCheckRunLatestResponse = CheckRunResponse | None

databay/models/source_hidden_type.py

@@ -0,0 +1,13 @@
+"""Models of the ``source_hidden_type`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import ResponseModel
+
+
+class HiddenSourceTypesResponse(ResponseModel):
+    enforced: bool
+    hidden_types: list[str] | None = None

databay/models/source_name.py

@@ -0,0 +1,18 @@
+"""Models of the ``source_name`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import RequestModel, ResponseModel
+from databay.models.shared import SourceType
+
+
+class NameCheckRequest(RequestModel):
+    name: str
+    source_type: SourceType | None = None
+
+
+class NameCheckResponse(ResponseModel):
+    available: bool

databay/models/source_pipe.py

@@ -0,0 +1,16 @@
+"""Models of the ``source_pipe`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import ResponseModel
+from databay.models.shared import DependentPipeView
+
+
+class DependentPipePage(ResponseModel):
+    data: list[DependentPipeView]
+    page: int
+    page_size: int
+    total: int

databay/models/source_publication.py

@@ -0,0 +1,30 @@
+"""Models of the ``source_publication`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import RequestModel, ResponseModel
+from databay.models.shared import PublicationMode
+
+
+class PublicationModeRequest(RequestModel):
+    publication_mode: PublicationMode
+
+
+class PublicationOption(ResponseModel):
+    available: bool
+    detail_code: str | None
+    mode: PublicationMode
+    text: str | None
+    values: dict[str, str | int] | None = None
+
+
+class SourcePublicationResponse(ResponseModel):
+    locked: bool
+    options: list[PublicationOption]
+    pipe_count: int
+    publication_mode: PublicationMode | None
+    publication_name: str
+    source_id: str

databay/models/source_readiness_override.py

@@ -0,0 +1,13 @@
+"""Models of the ``source_readiness_override`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import RequestModel
+
+
+class ReadinessOverrideRequest(RequestModel):
+    reason: str
+    requirement_ids: list[str] | None = None

databay/models/source_setup_choice.py

@@ -0,0 +1,33 @@
+"""Models of the ``source_setup_choice`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class SetupChoiceId(OpenStrEnum):
+    PUBLICATION = 'publication'
+
+
+class SetupChoiceOption(ResponseModel):
+    available: bool
+    detail_code: str | None
+    text: str | None
+    value: str
+    values: dict[str, str | int] | None = None
+
+
+class SetupChoiceRequest(RequestModel):
+    value: str
+
+
+class SetupChoiceResponse(ResponseModel):
+    choice_id: SetupChoiceId
+    locked: bool
+    options: list[SetupChoiceOption]
+    pipe_count: int
+    source_id: str
+    value: str | None

databay/models/source_stream.py

@@ -0,0 +1,65 @@
+"""Models of the ``source_stream`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import OpenStrEnum, ResponseModel
+from databay.models.shared import ColumnInfo
+
+
+class KeyCandidateViewKind(OpenStrEnum):
+    PRIMARY_KEY = 'primary_key'
+    UNIQUE_CONSTRAINT = 'unique_constraint'
+    UNIQUE_INDEX = 'unique_index'
+
+
+class StreamViewKind(OpenStrEnum):
+    TABLE = 'table'
+    COLLECTION = 'collection'
+    REPORT = 'report'
+    RESOURCE = 'resource'
+
+
+class StreamViewSyncModes(OpenStrEnum):
+    CDC = 'cdc'
+    INCREMENTAL = 'incremental'
+    FULL_REFRESH = 'full_refresh'
+
+
+class NamespaceViewKind(OpenStrEnum):
+    SCHEMA = 'schema'
+    DATABASE = 'database'
+    SOURCE = 'source'
+
+
+class KeyCandidateView(ResponseModel):
+    all_non_nullable: bool
+    columns: list[str]
+    kind: KeyCandidateViewKind
+
+
+class StreamView(ResponseModel):
+    in_publication: bool | None = None
+    kind: StreamViewKind
+    name: str
+    sync_modes: list[StreamViewSyncModes]
+
+
+class NamespaceView(ResponseModel):
+    kind: NamespaceViewKind
+    name: str
+    streams: list[StreamView] | None = None
+
+
+class StreamCatalogResponse(ResponseModel):
+    namespaces: list[NamespaceView]
+
+
+class StreamShapeResponse(ResponseModel):
+    columns: list[ColumnInfo]
+    key_candidates: list[KeyCandidateView]
+    primary_key: list[str]
+    replica_identity: str | None = None
+    schemaless: bool

databay/models/source_table.py

@@ -0,0 +1,27 @@
+"""Models of the ``source_table`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.model_base import ResponseModel
+
+
+class TableIssueView(ResponseModel):
+    blocking: bool
+    code: str
+    fix_sql: str | None = None
+    note: str | None = None
+    title: str
+
+
+class TableReadinessView(ResponseModel):
+    issues: list[TableIssueView] | None = None
+    ready: bool
+    table: str
+
+
+class TableReadinessReport(ResponseModel):
+    ready: bool
+    tables: list[TableReadinessView]

databay/models/sql.py

@@ -0,0 +1,31 @@
+"""Models of the ``sql`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from databay.model_base import RequestModel, ResponseModel
+
+
+class SqlExecuteRequest(RequestModel):
+    db_uuid: str | None = None
+    query: str
+
+
+class SqlWarning(ResponseModel):
+    code: str
+    message: str
+
+
+class SqlExecuteResponse(ResponseModel):
+    columns: list[str]
+    elapsed_ms: int
+    project_id: str | None = None
+    row_count: int
+    rows: list[list[Any]]
+    truncated: bool
+    warehouse_uuid: str | None = None
+    warnings: list[SqlWarning] | None = None