hyperfluid 0.1.0__py3-none-any.whl

hyperfluid/models/contextual_restriction_response.py

@@ -0,0 +1,36 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from datetime import datetime
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class ContextualRestrictionResponse(BaseModel):
+    """Response for a contextual restriction."""
+
+    created_at: datetime
+
+    data_selector: t.Any
+
+    enabled: bool
+
+    id: UUID
+
+    name: str
+
+    organization_id: UUID
+
+    priority: int
+
+    updated_at: datetime
+
+    user_requirement: t.Any
+
+    data_dock_id: UUID | None = None
+
+    description: str | None = None

hyperfluid/models/copilot_generate_request.py

@@ -0,0 +1,39 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .copilot_repair_context import CopilotRepairContext
+    from .copilot_turn import CopilotTurn
+    from .dashboard_widget import DashboardWidget
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopilotGenerateRequest(BaseModel):
+    """The `CopilotGenerateRequest` object."""
+
+    data_dock_id: UUID
+    """Data Dock whose schema grounds the generation."""
+
+    current_widget: DashboardWidget | None | Unset = UNSET
+
+    existing_widget_titles: list[str] | None = None
+    """Titles of widgets already on the dashboard, so the copilot avoids
+    duplicates and builds complementary ones (issue #2955)."""
+
+    history: list[CopilotTurn] | None = None
+    """Prior conversation turns for context (issue #2955). Bounded server-side."""
+
+    model: str | None | Unset = UNSET
+    """Model override; defaults to the platform's generation model."""
+
+    prompt: str | None = None
+    """The user's natural-language ask ("bed occupancy by service, monthly").
+    May be empty when `repair` drives the request."""
+
+    repair: CopilotRepairContext | None | Unset = UNSET

hyperfluid/models/copilot_generate_response.py

@@ -0,0 +1,23 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .copilot_widget_proposal import CopilotWidgetProposal
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopilotGenerateResponse(BaseModel):
+    """The `CopilotGenerateResponse` object."""
+
+    model: str
+    """Model that produced the proposals."""
+
+    widgets: list[CopilotWidgetProposal]
+
+    notes: str | None = None
+    """Copilot commentary shown in the chat (assumptions, caveats)."""

hyperfluid/models/copilot_repair_context.py

@@ -0,0 +1,20 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .dashboard_widget import DashboardWidget
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopilotRepairContext(BaseModel):
+    """The `CopilotRepairContext` object."""
+
+    error: str
+    """The execution error surfaced by Bifrost/Trino."""
+
+    widget: DashboardWidget

hyperfluid/models/copilot_turn.py

@@ -0,0 +1,18 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopilotTurn(BaseModel):
+    """One prior exchange, replayed to the model so iteration has context
+    ("add the same for 2025") without the client resending full widgets
+    (issue #2955)."""
+
+    content: str
+
+    role: str
+    """"user" or "assistant"."""

hyperfluid/models/copilot_widget_proposal.py

@@ -0,0 +1,25 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .widget_chart import WidgetChart
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopilotWidgetProposal(BaseModel):
+    """A widget proposal: everything but id/layout, which the client assigns when
+    the user pins it."""
+
+    chart: WidgetChart
+
+    data_dock_id: UUID
+
+    sql: str
+
+    title: str

hyperfluid/models/copy_destination_config.py

@@ -0,0 +1,40 @@
+# this file is @generated
+from __future__ import annotations
+
+import typing as t
+
+from ..serialization import Discriminator, UnknownVariant
+from .copy_destination_config_data_container_variant import (
+    CopyDestinationConfigDataContainerVariant,
+)
+from .copy_destination_config_harbor_bucket_variant import (
+    CopyDestinationConfigHarborBucketVariant,
+)
+
+CopyDestinationConfig: t.TypeAlias = t.Annotated[
+    CopyDestinationConfigDataContainerVariant
+    | CopyDestinationConfigHarborBucketVariant
+    | UnknownVariant,
+    Discriminator(
+        "type",
+        {
+            "data_container": CopyDestinationConfigDataContainerVariant,
+            "harbor_bucket": CopyDestinationConfigHarborBucketVariant,
+        },
+    ),
+]
+"""Copy pipeline destination configuration (S3 bucket).
+
+Symmetric with [`CopyS3SourceConfig`]. Two variants are accepted:
+
+* **`DataContainer`** (legacy) — a `DataContainerBucket` UUID from Postgres.
+  The DataDock that owns the container is resolved automatically, and the
+  shared-RGW path is attempted first with a fallback to the legacy per-DataDock
+  Vault credentials.
+
+* **`HarborBucket`** (ADR-0008) — an `HFBucket` CRD name under a Harbor UUID.
+  The bucket must exist and be Ready. **No legacy fallback** — if the Harbor
+  has no `HarborStorageBinding` pointing at a Ready `OrgStorage`, the request
+  fails immediately with a clear error.
+
+Told apart by `type`; a variant this SDK version does not know is an `UnknownVariant`."""

hyperfluid/models/copy_destination_config_data_container_variant.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopyDestinationConfigDataContainerVariant(BaseModel):
+    """Legacy path: resolve via DataContainerBucket UUID."""
+
+    data_container_id: UUID
+    """Data Container ID for the destination bucket (DataDock is resolved automatically)"""
+
+    type: t.Literal["data_container"] = "data_container"
+
+    destination_prefix: str | None | Unset = UNSET
+    """Optional prefix path within the destination bucket"""

hyperfluid/models/copy_destination_config_harbor_bucket_variant.py

@@ -0,0 +1,24 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopyDestinationConfigHarborBucketVariant(BaseModel):
+    """ADR-0008 path: resolve via Harbor-scoped HFBucket CRD."""
+
+    bucket_name: str
+    """HFBucket CRD name (must be Ready)"""
+
+    harbor_id: UUID
+    """Harbor UUID that owns the bucket"""
+
+    type: t.Literal["harbor_bucket"] = "harbor_bucket"
+
+    destination_prefix: str | None | Unset = UNSET
+    """Optional prefix path within the destination bucket"""

hyperfluid/models/copy_s3_source_config.py

@@ -0,0 +1,36 @@
+# this file is @generated
+from __future__ import annotations
+
+import typing as t
+
+from ..serialization import Discriminator, UnknownVariant
+from .copy_s3_source_config_data_container_variant import (
+    CopyS3SourceConfigDataContainerVariant,
+)
+from .copy_s3_source_config_harbor_bucket_variant import (
+    CopyS3SourceConfigHarborBucketVariant,
+)
+
+CopyS3SourceConfig: t.TypeAlias = t.Annotated[
+    CopyS3SourceConfigDataContainerVariant
+    | CopyS3SourceConfigHarborBucketVariant
+    | UnknownVariant,
+    Discriminator(
+        "type",
+        {
+            "data_container": CopyS3SourceConfigDataContainerVariant,
+            "harbor_bucket": CopyS3SourceConfigHarborBucketVariant,
+        },
+    ),
+]
+"""S3 source configuration for S3-to-S3 copy.
+
+Two variants are accepted:
+
+* **`DataContainer`** (legacy) — a `DataContainerBucket` UUID from Postgres.
+  Behaves identically to `FileSorterSourceConfig::DataContainer`.
+
+* **`HarborBucket`** (ADR-0008) — an `HFBucket` CRD name under a Harbor UUID.
+  The bucket must exist and be Ready. No legacy fallback.
+
+Told apart by `type`; a variant this SDK version does not know is an `UnknownVariant`."""

hyperfluid/models/copy_s3_source_config_data_container_variant.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopyS3SourceConfigDataContainerVariant(BaseModel):
+    """Legacy path: resolve via DataContainerBucket UUID."""
+
+    data_container_id: UUID
+    """Data Container ID for the source S3 bucket (DataDock is resolved automatically)"""
+
+    type: t.Literal["data_container"] = "data_container"
+
+    source_prefix: str | None | Unset = UNSET
+    """Optional prefix to filter source files (stripped during copy)"""

hyperfluid/models/copy_s3_source_config_harbor_bucket_variant.py

@@ -0,0 +1,24 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopyS3SourceConfigHarborBucketVariant(BaseModel):
+    """ADR-0008 path: resolve via Harbor-scoped HFBucket CRD."""
+
+    bucket_name: str
+    """HFBucket CRD name (must be Ready)"""
+
+    harbor_id: UUID
+    """Harbor UUID that owns the bucket"""
+
+    type: t.Literal["harbor_bucket"] = "harbor_bucket"
+
+    source_prefix: str | None | Unset = UNSET
+    """Optional prefix to filter source files (stripped during copy)"""

hyperfluid/models/copy_source_config.py

@@ -0,0 +1,23 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .import_api_extra_filter import ImportApiExtraFilter
+
+
+@dataclasses.dataclass(kw_only=True)
+class CopySourceConfig(BaseModel):
+    """Copy pipeline source configuration (Import API)"""
+
+    import_api_key: str
+    """Import API Key for authentication"""
+
+    import_api_url: str
+    """Import API URL (source endpoint)"""
+
+    extra_filter: ImportApiExtraFilter | None | Unset = UNSET

hyperfluid/models/count_ref_request.py

@@ -0,0 +1,29 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from datetime import datetime
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .ref_status import RefStatus
+
+
+@dataclasses.dataclass(kw_only=True)
+class CountRefRequest(BaseModel):
+    """The `CountRefRequest` object."""
+
+    key: str | None | Unset = UNSET
+
+    locked: bool | None | Unset = UNSET
+
+    pipeline_id: UUID | None | Unset = UNSET
+
+    status: RefStatus | None | Unset = UNSET
+
+    updated_at_after: datetime | None | Unset = UNSET
+
+    updated_at_before: datetime | None | Unset = UNSET

hyperfluid/models/count_secrets_response.py

@@ -0,0 +1,13 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CountSecretsResponse(BaseModel):
+    """The `CountSecretsResponse` object."""
+
+    count: int

hyperfluid/models/crd_owner.py

@@ -0,0 +1,32 @@
+# this file is @generated
+from __future__ import annotations
+
+import typing as t
+
+from ..serialization import Discriminator, UnknownVariant
+from .crd_owner_gitops_variant import CrdOwnerGitopsVariant
+from .crd_owner_pipeline_variant import CrdOwnerPipelineVariant
+from .crd_owner_ui_variant import CrdOwnerUiVariant
+from .crd_owner_unknown_variant import CrdOwnerUnknownVariant
+
+CrdOwner: t.TypeAlias = t.Annotated[
+    CrdOwnerUiVariant
+    | CrdOwnerPipelineVariant
+    | CrdOwnerGitopsVariant
+    | CrdOwnerUnknownVariant
+    | UnknownVariant,
+    Discriminator(
+        "kind",
+        {
+            "ui": CrdOwnerUiVariant,
+            "pipeline": CrdOwnerPipelineVariant,
+            "gitops": CrdOwnerGitopsVariant,
+            "unknown": CrdOwnerUnknownVariant,
+        },
+    ),
+]
+"""Who "owns" a CRD from the console's point of view — derived purely
+from metadata markers, never from the CRD's spec. Useful to explain to
+the user what will happen when they delete it.
+
+Told apart by `kind`; a variant this SDK version does not know is an `UnknownVariant`."""

hyperfluid/models/crd_owner_gitops_variant.py

@@ -0,0 +1,23 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CrdOwnerGitopsVariant(BaseModel):
+    """Any ArgoCD/Flux/Helm marker detected. Deleting here is almost
+    always pointless — the GitOps reconciler will recreate the CRD
+    on its next sync."""
+
+    kind: t.Literal["gitops"] = "gitops"
+
+    tool: str
+
+    reference: str | None = None
+    """Best-effort app / release identifier (ArgoCD app name, Helm
+    release name, Flux kustomization). `None` if the marker is a
+    bare `managed-by` label without a qualifying annotation."""

hyperfluid/models/crd_owner_pipeline_variant.py

@@ -0,0 +1,18 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CrdOwnerPipelineVariant(BaseModel):
+    """Stamped with `source=pipeline`. Deleting is legit (one-shot
+    imports, cleanup after a bad run) but should be explicit —
+    `name` carries whichever pipeline identifier the operator wrote."""
+
+    kind: t.Literal["pipeline"] = "pipeline"
+
+    name: str | None = None

hyperfluid/models/crd_owner_ui_variant.py

@@ -0,0 +1,14 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CrdOwnerUiVariant(BaseModel):
+    """Stamped with `source=ui`. Deleting from the UI is the normal path."""
+
+    kind: t.Literal["ui"] = "ui"

hyperfluid/models/crd_owner_unknown_variant.py

@@ -0,0 +1,15 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CrdOwnerUnknownVariant(BaseModel):
+    """No ownership markers at all — legacy CRD or created by a tool we
+    don't recognize."""
+
+    kind: t.Literal["unknown"] = "unknown"

hyperfluid/models/crd_status_snapshot.py

@@ -0,0 +1,39 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CrdStatusSnapshot(BaseModel):
+    """Projection of a Hyperfluid CRD's `.status` subresource, suitable for
+    surfacing in list endpoints so the UI can render a live status badge
+    without having to call kube-apiserver itself.
+
+    - For `TrinoSchema`: `phase` + `message` are populated; drift fields
+      stay empty.
+    - For `TrinoTable`: all four fields are meaningful — `missing_columns`
+      and `extra_columns` come from the reconciler's drift detection."""
+
+    _JSON_KEYS: t.ClassVar[t.Mapping[str, str]] = {
+        "extra_columns": "extraColumns",
+        "missing_columns": "missingColumns",
+    }
+
+    phase: str
+    """`Pending` / `Ready` / `Drifted` / `Failed` / `Terminating`.
+    Stringly-typed because `TrinoSchema` and `TrinoTable` don't share
+    the same phase enum (Drifted is Table-only)."""
+
+    extra_columns: list[str] | None = None
+    """Columns present in Trino but not declared in the CRD spec. The
+    reconciler never drops these automatically. Empty for schemas."""
+
+    message: str | None = None
+
+    missing_columns: list[str] | None = None
+    """Columns declared in the CRD spec but absent from the actual Trino
+    table (subject to opt-in migration). Empty for schemas."""

hyperfluid/models/create_action_type_request.py

@@ -0,0 +1,29 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .action_parameter import ActionParameter
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateActionTypeRequest(BaseModel):
+    """The `CreateActionTypeRequest` object."""
+
+    api_name: str
+
+    display_name: str
+
+    object_type_id: UUID
+
+    operation: str
+    """One of [`ACTION_OPERATIONS`] (validated by the service)."""
+
+    description: str | None | Unset = UNSET
+
+    parameters: list[ActionParameter] | None = None

hyperfluid/models/create_ai_agent_request.py

@@ -0,0 +1,89 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .ai_agent_budgets_dto import AiAgentBudgetsDto
+    from .ai_agent_data_source_dto import AiAgentDataSourceDto
+    from .ai_agent_desired_state_dto import AiAgentDesiredStateDto
+    from .ai_agent_inference_dto import AiAgentInferenceDto
+    from .ai_agent_mail_dto import AiAgentMailDto
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateAiAgentRequest(BaseModel):
+    """The `CreateAiAgentRequest` object."""
+
+    harbor_id: UUID
+    """Harbor (environment) the agent belongs to. Must be in the path org."""
+
+    inference: AiAgentInferenceDto
+
+    budgets: AiAgentBudgetsDto | None | Unset = UNSET
+
+    context: str | None | Unset = UNSET
+    """Extra context appended to the system prompt."""
+
+    data_sources: list[AiAgentDataSourceDto] | None = None
+    """Data docks the agent may read."""
+
+    description: str | None | Unset = UNSET
+
+    desired_state: AiAgentDesiredStateDto | None | Unset = UNSET
+
+    interfaces: list[str] | None | Unset = UNSET
+    """Interfaces the agent is reachable from. Defaults to ["web"]."""
+
+    mail: AiAgentMailDto | None | Unset = UNSET
+
+    mission: str | None | Unset = UNSET
+    """The user's own instructions for a CAPABILITY, layered on top of the catalogue
+    preamble in `system_prompt` — which, for a capability, is the console's rather
+    than the user's. Kept separate so the runtime composes the two in a fixed order
+    and user text cannot contradict the tool subset the capability was given (#3477)."""
+
+    name: str | None | Unset = UNSET
+    """Agent name (unique within the organization; slugified for the CR name).
+
+    Optional for a CAPABILITY: a request naming `subagent_of` and a `speciality`
+    the platform offers is named `"<agent name> <capability name>"`, so what a
+    capability is called does not depend on which client created it. Required for
+    anything else."""
+
+    question_set: list[str] | None = None
+    """Intent-extraction question set."""
+
+    service_account_id: UUID | None | Unset = UNSET
+    """Hyperfluid Service-Account entity id the agent authenticates as. Must
+    be viewer-scoped. Optional at creation."""
+
+    speciality: str | None | Unset = UNSET
+    """What this agent is for, and what a routing agent matches a question
+    against: `routing`, `platform-ops`, `data-sql`, `documents`, or a value of
+    your own. Omit for an unspecialized agent."""
+
+    subagent_of: str | None | Unset = UNSET
+    """The routing agent this one answers for, by CR name. Omit for a standalone
+    agent. A subagent must declare a speciality and cannot have a mailbox."""
+
+    system_prompt: str | None | Unset = UNSET
+    """System prompt injected at the start of every agent run.
+
+    Optional when `speciality` names a capability the platform offers: it is then
+    filled from that capability's catalogue preamble. A preamble is deliberately
+    not a client's to send — it is measured against the runtime, and a second copy
+    in a client is a second copy to keep in step. `routing` still requires one:
+    a router's prompt IS the user's own mission."""
+
+    tools: list[str] | None | Unset = UNSET
+    """Tools the agent may use: `ask_sender`, `hfctl` (all commands) or
+    `hfctl:<command>`. An empty array means every tool and command.
+
+    Omitting the field — which is not the same as sending `[]` — takes the subset
+    the `speciality` comes with: the capability's own from the catalogue, or
+    `ask_sender` + `ask_subagent` for `routing`."""