databay-cli 0.1.0__py3-none-any.whl

databay/models/notebook_credential.py

@@ -0,0 +1,51 @@
+"""Models of the ``notebook_credential`` 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 ResponseModel
+
+
+class NotebookBindingResponse(ResponseModel):
+    issued_at: datetime | None = None
+    project_id: str | None
+
+
+class NotebookWarehouse(ResponseModel):
+    name: str
+    origin: str | None = None
+    physical_name: str | None = None
+    status: str | None = None
+    uuid: str
+
+
+class NotebookCredentialsResponse(ResponseModel):
+    database: str
+    databases: list[NotebookWarehouse]
+    host: str
+    organization: str
+    password: str
+    port: int
+    project_id: str
+    scratch_database: str
+    settings_profile: str
+    username: str
+
+
+class NotebookCredentialsRotateResponse(ResponseModel):
+    database: str
+    databases: list[NotebookWarehouse]
+    host: str
+    invalidates_running_kernels: bool
+    organization: str
+    password: str
+    port: int
+    project_id: str
+    rotation_scope: str
+    scratch_database: str
+    settings_profile: str
+    username: str

databay/models/org.py

@@ -0,0 +1,44 @@
+"""Models of the ``org`` 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 MyOrganizationOutKind(OpenStrEnum):
+    PERSONAL = 'personal'
+    COMPANY = 'company'
+
+
+class MyOrganizationOutRole(OpenStrEnum):
+    READER = 'reader'
+    EDITOR = 'editor'
+    ORG_ADMIN = 'org_admin'
+
+
+class ActiveOrgResponse(ResponseModel):
+    active_org: str
+
+
+class MyOrganizationOut(ResponseModel):
+    display_name: str
+    enabled: bool
+    is_active: bool
+    kind: MyOrganizationOutKind | None
+    member_count: int | None
+    organization: str
+    role: MyOrganizationOutRole | None
+
+
+class MyOrganizationsResponse(ResponseModel):
+    active_org: str | None
+    needs_org_choice: bool
+    organizations: list[MyOrganizationOut]
+    usable_orgs: int
+
+
+class SwitchActiveOrgRequest(RequestModel):
+    organization: str

databay/models/org_member.py

@@ -0,0 +1,123 @@
+"""Models of the ``org_member`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from pydantic import Field
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class AddMemberRequestLanguage(OpenStrEnum):
+    EN = 'en'
+    FA = 'fa'
+
+
+class AddMemberRequestRole(OpenStrEnum):
+    READER = 'reader'
+    EDITOR = 'editor'
+    ORG_ADMIN = 'org_admin'
+
+
+class ChangeRoleRequestRole(OpenStrEnum):
+    READER = 'reader'
+    EDITOR = 'editor'
+    ORG_ADMIN = 'org_admin'
+
+
+class InvitationAddressResultResult(OpenStrEnum):
+    INVITED = 'invited'
+    ALREADY_MEMBER = 'already_member'
+    ALREADY_INVITED = 'already_invited'
+    INVALID_EMAIL = 'invalid_email'
+    DUPLICATE = 'duplicate'
+
+
+class OrgMemberRefRole(OpenStrEnum):
+    READER = 'reader'
+    EDITOR = 'editor'
+    ORG_ADMIN = 'org_admin'
+
+
+class OrgMemberAddResponseStatus(OpenStrEnum):
+    PENDING = 'pending'
+    DONE = 'done'
+    FAILED = 'failed'
+    INVITED = 'invited'
+
+
+class OrgMemberChangeResponseStatus(OpenStrEnum):
+    PENDING = 'pending'
+    DONE = 'done'
+    FAILED = 'failed'
+    UNCHANGED = 'unchanged'
+
+
+class OrgMemberOutRole(OpenStrEnum):
+    READER = 'reader'
+    EDITOR = 'editor'
+    ORG_ADMIN = 'org_admin'
+
+
+class AddMemberRequest(RequestModel):
+    email: str
+    first_name: str | None = None
+    language: AddMemberRequestLanguage = 'en'
+    last_name: str | None = None
+    role: AddMemberRequestRole
+
+
+class ChangeRoleRequest(RequestModel):
+    role: ChangeRoleRequestRole
+
+
+class InvitationAddressResult(ResponseModel):
+    email: str
+    invitation_id: str | None
+    result: InvitationAddressResultResult
+
+
+class InviteByEmail(ResponseModel):
+    delivery: Literal['email']
+
+
+class InviteFailed(ResponseModel):
+    delivery: Literal['failed']
+
+
+class InviteNotRecorded(ResponseModel):
+    delivery: Literal['not_recorded']
+
+
+class OrgMemberRef(ResponseModel):
+    id: str | None
+    role: OrgMemberRefRole | None
+
+
+class OrgMemberAddResponse(ResponseModel):
+    invitation: InvitationAddressResult | None
+    invite: Annotated[InviteByEmail | InviteFailed | InviteNotRecorded, Field(discriminator='delivery')] | None
+    member: OrgMemberRef | None
+    operation_id: str | None
+    status: OrgMemberAddResponseStatus
+
+
+class OrgMemberChangeResponse(ResponseModel):
+    member: OrgMemberRef
+    operation_id: str | None
+    status: OrgMemberChangeResponseStatus
+
+
+class OrgMemberOut(ResponseModel):
+    email: str
+    id: str
+    name: str
+    role: OrgMemberOutRole | None
+
+
+class OrgMembersResponse(ResponseModel):
+    members: list[OrgMemberOut]

databay/models/org_offboarding.py

@@ -0,0 +1,36 @@
+"""Models of the ``org_offboarding`` 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
+
+
+class OffboardingItemReason(OpenStrEnum):
+    MEMBER_REMOVED = 'member_removed'
+    ACCESS_RESTRICTED = 'access_restricted'
+    ORG_MEMBER_REMOVED = 'org_member_removed'
+    ORG_ROLE_CHANGED = 'org_role_changed'
+    PROJECT_DELETED = 'project_deleted'
+
+
+class OffboardingItemStatus(OpenStrEnum):
+    PENDING = 'pending'
+    DONE = 'done'
+    STUCK = 'stuck'
+
+
+class OffboardingItem(ResponseModel):
+    created_at: str | None
+    offboarding_id: str
+    pending_services: list[str]
+    project_id: str | None
+    reason: OffboardingItemReason
+    status: OffboardingItemStatus
+
+
+class MemberOffboarding(ResponseModel):
+    items: list[OffboardingItem]
+    user_id: str

databay/models/pipe.py

@@ -0,0 +1,340 @@
+"""Models of the ``pipe`` 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 Literal
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+from databay.models.shared import AttachState, BackendKind, FreshnessState, PipeHealth, PipeMaskFieldV2, PipeV2Response, PipeV2Status, SyncMode
+
+
+class AttachMode(OpenStrEnum):
+    NEW_READER = 'new_reader'
+    ATTACHED = 'attached'
+
+
+class PipeRollupBy(OpenStrEnum):
+    SOURCE = 'source'
+    SINK = 'sink'
+
+
+class PreflightCheck(OpenStrEnum):
+    WAL_LEVEL = 'wal_level'
+    SLOT_HEADROOM = 'slot_headroom'
+    REPLICA_IDENTITY = 'replica_identity'
+    SELECTED_COLUMNS = 'selected_columns'
+
+
+class ReaderDesiredState(OpenStrEnum):
+    RUNNING = 'running'
+    PAUSED = 'paused'
+    DELETED = 'deleted'
+
+
+class ReaderPublicationCheckOutcome(OpenStrEnum):
+    PASSED = 'passed'
+    FAILED = 'failed'
+    UNKNOWN = 'unknown'
+
+
+class ReaderRunState(OpenStrEnum):
+    UNASSIGNED = 'unassigned'
+    RUNNING = 'running'
+    RETRYING = 'retrying'
+    HALTED = 'halted'
+
+
+class ReaderTableState(OpenStrEnum):
+    ACTIVE = 'active'
+    SNAPSHOTTING = 'snapshotting'
+    QUARANTINED = 'quarantined'
+
+
+class PipeNewColumnsResponseNewColumns(OpenStrEnum):
+    ADD = 'add'
+    ASK = 'ask'
+
+
+class PipeNewColumnsResponseNewColumnsSource(OpenStrEnum):
+    REQUEST = 'request'
+    PROJECT_DEFAULT = 'project_default'
+
+
+class PipeRebuildRequestSource(OpenStrEnum):
+    WAREHOUSE_COPY = 'warehouse-copy'
+    RE_EXTRACT = 're-extract'
+    SNAPSHOT = 'snapshot'
+    RETYPE = 'retype'
+
+
+class PipeUpdateNewColumns(OpenStrEnum):
+    ADD = 'add'
+    ASK = 'ask'
+
+
+class PipeV2CreateNewColumns(OpenStrEnum):
+    ADD = 'add'
+    ASK = 'ask'
+
+
+class PipeV2CreateResponseNewColumns(OpenStrEnum):
+    ADD = 'add'
+    ASK = 'ask'
+
+
+class PipeV2CreateResponseNewColumnsSource(OpenStrEnum):
+    REQUEST = 'request'
+    PROJECT_DEFAULT = 'project_default'
+
+
+class PipeV2DetailResponseNewColumns(OpenStrEnum):
+    ADD = 'add'
+    ASK = 'ask'
+
+
+class PipeV2DetailResponseNewColumnsSource(OpenStrEnum):
+    REQUEST = 'request'
+    PROJECT_DEFAULT = 'project_default'
+
+
+class MovePipeline(RequestModel):
+    target_project_id: str
+
+
+class PipeDeleteAccepted(ResponseModel):
+    drop_destination: bool
+    pipe_uuid: str
+    status: Literal['deleting']
+
+
+class PipeNewColumnsResponse(ResponseModel):
+    new_columns: PipeNewColumnsResponseNewColumns
+    new_columns_source: PipeNewColumnsResponseNewColumnsSource
+    uuid: str
+
+
+class ReaderPublicationCheck(ResponseModel):
+    cause: str | None
+    checked_at: datetime
+    outcome: ReaderPublicationCheckOutcome
+
+
+class ReaderSubscriber(ResponseModel):
+    attach_state: AttachState | None
+    dest_table_name: str | None
+    pipe_uuid: str
+    sink: str
+    status: PipeV2Status
+    table: str
+
+
+class ReaderTableInfo(ResponseModel):
+    quarantine_code: str | None
+    state: ReaderTableState
+    table: str
+
+
+class ReaderInfo(ResponseModel):
+    desired_state: ReaderDesiredState
+    engine: str
+    error_code: str | None
+    publication_check: ReaderPublicationCheck | None
+    reader_id: str
+    state: ReaderRunState
+    subscribers: list[ReaderSubscriber]
+    tables: list[ReaderTableInfo]
+
+
+class PipePauseResponse(ResponseModel):
+    lossless_resume_until: datetime | None
+    reader: ReaderInfo | None = None
+    status: Literal['paused']
+
+
+class PipeRebuildAccepted(ResponseModel):
+    rebuild_id: str
+    state: str
+
+
+class PipeRebuildRequest(RequestModel):
+    reason: str | None = None
+    source: PipeRebuildRequestSource
+
+
+class PipeRestartAccepted(ResponseModel):
+    status: Literal['restarting']
+
+
+class PipeResumeResponse(ResponseModel):
+    reader: ReaderInfo | None = None
+    status: Literal['resumed']
+
+
+class PipeRetryAccepted(ResponseModel):
+    status: Literal['retrying']
+
+
+class PipeRollupPeer(ResponseModel):
+    id: str
+    pipe_count: int
+    project_id: str
+
+
+class PipeRollupGroup(ResponseModel):
+    hidden_pipe_count: int
+    key: str
+    max_lag_seconds: float | None
+    peers: list[PipeRollupPeer]
+    pipe_count: int
+    status_counts: dict[str, int]
+    stored_rows: int | None
+    unmeasured_pipe_count: int
+    worst_freshness: FreshnessState
+
+
+class PipeRollup(ResponseModel):
+    by: PipeRollupBy
+    groups: list[PipeRollupGroup]
+    measured_at: datetime
+    rows_unavailable: bool
+
+
+class PipeUpdate(RequestModel):
+    new_columns: PipeUpdateNewColumns
+
+
+class PipeV2Create(RequestModel):
+    acknowledge_org_visible: bool = False
+    backend: BackendKind | None = None
+    column_types: dict[str, str] | None = None
+    columns: list[str] | None = None
+    cron_expression: str = '0 */5 * * * ?'
+    dest_table_name: str
+    mask_fields: list[PipeMaskFieldV2] | None = None
+    mask_secret: str | None = None
+    new_columns: PipeV2CreateNewColumns | None = None
+    nullable_overrides: dict[str, bool] | None = None
+    primary_key: list[str] | None = None
+    project_id: str
+    reader_id: str | None = None
+    schedule_type: str = 'cron'
+    schema_name: str = ''
+    sink_db_uuid: str | None = None
+    source_id: str
+    sync_mode: SyncMode = 'incremental_deduped_history'
+    table_name: str
+
+
+class PipeV2CreateResponse(ResponseModel):
+    attach_mode: AttachMode | None = None
+    attach_state: AttachState | None = None
+    backend: str
+    columns_count: int | None = None
+    created_at: datetime | None = None
+    cron_expression: str | None = None
+    dest_table_name: str | None = None
+    error_code: str | None = None
+    freshness_state: FreshnessState | None = None
+    health: PipeHealth | None = None
+    health_detail: str | None = None
+    health_detail_code: str | None = None
+    health_detail_retriable: bool | None = None
+    lag_seconds: float | None = None
+    last_change_at: datetime | None = None
+    last_checked_at: datetime | None = None
+    last_error: str | None = None
+    last_healthy_at: datetime | None = None
+    last_sync_status: str | None = None
+    masked_count: int = 0
+    new_columns: PipeV2CreateResponseNewColumns
+    new_columns_source: PipeV2CreateResponseNewColumnsSource | None
+    preflight_skipped: list[PreflightCheck]
+    primary_key: list[str] | None = None
+    project_id: str | None = None
+    reader_id: str | None = None
+    retriable: bool | None = None
+    schedule_type: str | None = None
+    schema_name: str | None = None
+    sink_db_uuid: str
+    source_id: str
+    status: PipeV2Status = 'pending'
+    stream_ref: str | None = None
+    sync_mode: str | None = None
+    table_name: str | None = None
+    uuid: str
+
+
+class PipeV2DetailResponse(ResponseModel):
+    attach_state: AttachState | None = None
+    backend: str
+    columns: list[str] | None = None
+    columns_count: int | None = None
+    created_at: datetime | None = None
+    cron_expression: str | None = None
+    dest_table_name: str | None = None
+    error_code: str | None = None
+    freshness_state: FreshnessState | None = None
+    health: PipeHealth | None = None
+    health_detail: str | None = None
+    health_detail_code: str | None = None
+    health_detail_retriable: bool | None = None
+    lag_seconds: float | None = None
+    last_change_at: datetime | None = None
+    last_checked_at: datetime | None = None
+    last_error: str | None = None
+    last_healthy_at: datetime | None = None
+    last_sync_status: str | None = None
+    masked_columns: list[PipeMaskFieldV2] | None = None
+    masked_count: int = 0
+    new_columns: PipeV2DetailResponseNewColumns
+    new_columns_source: PipeV2DetailResponseNewColumnsSource | None
+    primary_key: list[str] | None = None
+    project_id: str | None = None
+    reader: ReaderInfo | None = None
+    reader_id: str | None = None
+    retriable: bool | None = None
+    schedule_type: str | None = None
+    schema_name: str | None = None
+    sink_db_uuid: str
+    source_id: str
+    status: PipeV2Status = 'pending'
+    stream_ref: str | None = None
+    sync_mode: str | None = None
+    table_name: str | None = None
+    uuid: str
+
+
+class PipeV2Page(ResponseModel):
+    data: list[PipeV2Response]
+    page: int
+    page_size: int | None = None
+    status_counts: dict[str, int] | None = None
+    total: int
+
+
+class PipeV2StatusResponse(ResponseModel):
+    error_code: str | None = None
+    error_detail: dict[str, str | int] | None = None
+    health: PipeHealth
+    health_detail: str | None = None
+    health_detail_code: str | None = None
+    health_detail_retriable: bool | None = None
+    last_error: str | None = None
+    last_sync_status: str | None = None
+    pipe_status: PipeV2Status
+    pipe_uuid: str
+    retriable: bool | None = None
+    stream_ref: str | None = None
+    support_ref: str | None = None
+
+
+class PipelineMoved(ResponseModel):
+    pipeline_id: str
+    project_id: str
+
+
+PipeListResponse = PipeV2Page | list[PipeV2Response]

databay/models/pipe_config_option.py

@@ -0,0 +1,25 @@
+"""Models of the ``pipe_config_option`` 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
+
+
+class TransformsUnavailable(OpenStrEnum):
+    DIRECT_LOAD_SOURCE = 'direct_load_source'
+    DESTINATION_UNSUPPORTED = 'destination_unsupported'
+    SOURCE_UNSUPPORTED = 'source_unsupported'
+
+
+class PipeConfigOptionsResponse(ResponseModel):
+    dest_table_rename_locked_sink_types: list[str] | None = None
+    scheduling: bool
+    serviceable: bool
+    supports_blocking_snapshot: bool = False
+    supports_filtered_backfill: bool = False
+    sync_mode_selection: bool
+    transform_types: list[str] | None = None
+    transforms_unavailable: TransformsUnavailable | None = None