hyperfluid 0.1.0__py3-none-any.whl

hyperfluid/models/abort_managed_postgresql_import_upload_request_body.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 AbortManagedPostgresqlImportUploadRequestBody(BaseModel):
+    """The `AbortManagedPostgresqlImportUploadRequestBody` object."""
+
+    bucket_name: str
+
+    object_key: str
+    """The `object_key` prepare-upload returned."""
+
+    upload_id: str

hyperfluid/models/abort_multipart_upload_request.py

@@ -0,0 +1,17 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AbortMultipartUploadRequest(BaseModel):
+    """The `AbortMultipartUploadRequest` object."""
+
+    bucket: str
+
+    key: str
+
+    upload_id: str

hyperfluid/models/accept_invitation_body.py

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

hyperfluid/models/access_binding.py

@@ -0,0 +1,56 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AccessBinding(BaseModel):
+    """One access binding at a resource scope, for the resource-anchored "Access"
+    view (who can do what *here*). A flattened `grants` row joined with the
+    principal's display name and the role/permission name, so the UI can list
+    bindings on a resource without N per-principal lookups. Each binding is a
+    `grants` row, so `grant_id` is what the delete-grant endpoint revokes."""
+
+    effect: str
+    """`"allow"` | `"deny"`."""
+
+    grant_id: UUID
+    """The `grants` row id — pass to the delete-grant endpoint to revoke."""
+
+    principal_id: UUID
+
+    principal_name: str
+    """Human-readable principal: a user's email or a service account's name
+    (falls back to the id for an orphaned row)."""
+
+    principal_type: str
+    """`"user"` | `"service_account"`."""
+
+    inherited: bool | None = None
+    """`true` when the binding is not attached to exactly this resource but
+    reaches it through inheritance — an org-wide grant, an ancestor folder,
+    or a covering wildcard. Inherited bindings are read-only on this resource
+    (managed on the ancestor they are attached to). Only populated by the
+    inheritance-aware listing; defaults to `false` for the exact-scope list."""
+
+    permission_id: UUID | None = None
+    """Set when the binding confers a single permission; `permission_key` is its
+    `resource:action` label."""
+
+    permission_key: str | None = None
+
+    resource_uuid: UUID | None = None
+    """Attached-tier anchor: the concrete resource id when bound from the
+    resource itself (survives a slug rename). `None` = pattern-tier."""
+
+    role_id: UUID | None = None
+    """Set when the binding confers a whole role bundle; `role_name` is its label."""
+
+    role_name: str | None = None
+
+    scope_path: str | None = None
+    """The resource path the binding is scoped to (matches the query `scope_path`)."""

hyperfluid/models/access_check_item.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 .permission_key import PermissionKey
+
+
+@dataclasses.dataclass(kw_only=True)
+class AccessCheckItem(BaseModel):
+    """One `(action, resource)` pair to test for the caller."""
+
+    action: PermissionKey
+
+    resource_id: str | None = None
+    """Resource scope path / HRN id; empty for an org- or collection-level action."""

hyperfluid/models/access_check_request_body.py

@@ -0,0 +1,17 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .access_check_item import AccessCheckItem
+
+
+@dataclasses.dataclass(kw_only=True)
+class AccessCheckRequestBody(BaseModel):
+    """The `AccessCheckRequestBody` object."""
+
+    checks: list[AccessCheckItem]

hyperfluid/models/access_check_result.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .permission_key import PermissionKey
+
+
+@dataclasses.dataclass(kw_only=True)
+class AccessCheckResult(BaseModel):
+    """The verdict for one checked pair (echoed back so the client can map results)."""
+
+    action: PermissionKey
+
+    allowed: bool
+
+    resource_id: str

hyperfluid/models/action_parameter.py

@@ -0,0 +1,31 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class ActionParameter(BaseModel):
+    """One declared parameter of an [`ActionType`] — a named input mapped to a
+    backing column *through* a property of the target object type
+    (`property_api_name`), never a raw column. At execution the property
+    resolves to its `source_column` + `data_type`, and the caller-supplied
+    value is rendered to a typed SQL literal — the only way a value enters DML."""
+
+    api_name: str
+    """Machine name the caller uses as the key in `ExecuteActionRequest.parameters`."""
+
+    data_type: str
+    """Semantic type driving literal rendering (string/integer/double/...),
+    re-derived from the resolved property at execution time; carried here so
+    the definition is self-describing."""
+
+    display_name: str
+
+    property_api_name: str
+    """The target object type's property this parameter writes — resolved to a
+    physical `source_column` at execution time."""
+
+    required: bool | None = None

hyperfluid/models/action_result.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class ActionResult(BaseModel):
+    """Result of executing an [`ActionType`] — the DML ran (and was audited via
+    query history); this reports the outcome, not the affected rows."""
+
+    action_type_id: UUID
+
+    executed: bool
+
+    message: str
+
+    operation: str

hyperfluid/models/action_type.py

@@ -0,0 +1,47 @@
+# 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
+
+if t.TYPE_CHECKING:
+    from .action_parameter import ActionParameter
+
+
+@dataclasses.dataclass(kw_only=True)
+class ActionType(BaseModel):
+    """A governed, parameterized write-back to an object type's backing Iceberg
+    table — the Kinetic layer's unit. Declares WHAT a write may do (target,
+    operation, parameter shape); executing it builds ONE constrained DML
+    statement run through the caller's JWT (Vauban/OPA + Trino authorize the
+    actual write, and it is recorded in query history). Never arbitrary DML."""
+
+    api_name: str
+    """Stable machine name, unique per org. Immutable after creation (same
+    rationale as [`ObjectType::api_name`])."""
+
+    created_at: datetime
+
+    creator_id: UUID
+
+    display_name: str
+
+    id: UUID
+
+    object_type_id: UUID
+
+    operation: str
+    """One of [`ACTION_OPERATIONS`]."""
+
+    organization_id: UUID
+
+    parameters: list[ActionParameter]
+    """Decoded straight from the JSONB `parameters` column."""
+
+    updated_at: datetime
+
+    description: str | None = None

hyperfluid/models/add_group_member_request_body.py

@@ -0,0 +1,17 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AddGroupMemberRequestBody(BaseModel):
+    """The `AddGroupMemberRequestBody` object."""
+
+    principal_id: UUID
+
+    principal_type: str
+    """`user` | `service_account`."""

hyperfluid/models/add_service_account_attribute_request.py

@@ -0,0 +1,14 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AddServiceAccountAttributeRequest(BaseModel):
+    """One attribute to add."""
+
+    attribute: str
+    """Attribute in `namespace::value` format, e.g. `region::occitanie`."""

hyperfluid/models/add_user.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 AddUser(BaseModel):
+    """The `AddUser` object."""
+
+    email: str

hyperfluid/models/add_user_attribute_request.py

@@ -0,0 +1,15 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AddUserAttributeRequest(BaseModel):
+    """Request to add a single attribute to a user."""
+
+    attribute: str
+    """Attribute in `namespace::value` format.
+    Example: `"region::occitanie"`"""

hyperfluid/models/add_workstation_repository_response.py

@@ -0,0 +1,26 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .workstation_repository_response import WorkstationRepositoryResponse
+
+
+@dataclasses.dataclass(kw_only=True)
+class AddWorkstationRepositoryResponse(BaseModel):
+    """Result of adding a repository to a workstation."""
+
+    cloned: bool
+    """Whether the repository was cloned into the running pod straight away.
+    `false` means the workstation was not running (or the clone failed, e.g.
+    egress down) — the declared state is saved either way and the entrypoint
+    clones it on the pod's next start."""
+
+    repository: WorkstationRepositoryResponse
+
+    message: str | None = None
+    """Clone failure detail when `cloned` is false and the pod was reachable."""

hyperfluid/models/agent_mode.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AgentMode(BaseModel):
+    """An opencode agent/mode the user can switch between (Build, Plan, ...). The
+    chat toolbar renders one toggle per primary agent."""
+
+    description: str
+    """One-line description from opencode."""
+
+    mode: str
+    """"primary" (user-launchable) or "subagent" (callable by others)."""
+
+    name: str
+    """opencode agent name (e.g. "build", "plan")."""

hyperfluid/models/agent_request_kind.py

@@ -0,0 +1,24 @@
+# this file is @generated
+import typing as t
+
+from ..serialization import StrEnum
+
+
+class AgentRequestKind(StrEnum):
+    """Which workstation surface a recorded agent request came through."""
+
+    PROMPT = "prompt"
+    PERMISSION_REPLY = "permission_reply"
+    QUESTION_REPLY = "question_reply"
+    PERMISSION_POLICY_CHANGE = "permission_policy_change"
+    INLINE_EDIT_INSTRUCTION = "inline_edit_instruction"
+
+
+AgentRequestKindLiteral: t.TypeAlias = t.Literal[
+    "prompt",
+    "permission_reply",
+    "question_reply",
+    "permission_policy_change",
+    "inline_edit_instruction",
+]
+"""The values of :class:`AgentRequestKind`, which arguments take as plain strings too."""

hyperfluid/models/agent_workspaces.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .agent_worktree import AgentWorktree
+
+
+@dataclasses.dataclass(kw_only=True)
+class AgentWorkspaces(BaseModel):
+    """The `AgentWorkspaces` object."""
+
+    branches: list[str]
+
+    current_branch: str
+
+    worktrees: list[AgentWorktree]

hyperfluid/models/agent_worktree.py

@@ -0,0 +1,17 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AgentWorktree(BaseModel):
+    """The `AgentWorktree` object."""
+
+    branch: str
+
+    is_main: bool
+
+    path: str

hyperfluid/models/ai_agent_budgets_dto.py

@@ -0,0 +1,18 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentBudgetsDto(BaseModel):
+    """What the agent may spend answering one question. Both unset means the
+    runtime derives them from the serving's advertised context window."""
+
+    max_completion_tokens: int | None | Unset = UNSET
+    """Completion tokens per turn."""
+
+    max_turns: int | None | Unset = UNSET
+    """Tool-call round-trips per question (runtime default 10)."""

hyperfluid/models/ai_agent_capabilities_response.py

@@ -0,0 +1,17 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .ai_agent_capability_response import AiAgentCapabilityResponse
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentCapabilitiesResponse(BaseModel):
+    """The `AiAgentCapabilitiesResponse` object."""
+
+    capabilities: list[AiAgentCapabilityResponse]

hyperfluid/models/ai_agent_capability_response.py

@@ -0,0 +1,45 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentCapabilityResponse(BaseModel):
+    """One capability, as a client lists it."""
+
+    capability: str
+    """The word a user and the CLI use for it (`documents`, `platform-ops`), and the
+    value to send as `speciality` when creating it. Named for what a user is
+    choosing rather than for the CR field it lands in."""
+
+    default_enabled: bool
+    """Whether a client should offer it pre-selected: an agent with no capability
+    registers no dispatch tool and can answer nothing at all."""
+
+    description: str
+    """One line for a client with no copy of its own. English: a client that
+    translates its own copy (the console) uses that instead."""
+
+    name: str
+    """What the capability is called, and what a correspondent sees when it answers
+    their mail (#3479). Not translated, on purpose — a name that changed with the
+    locale of whoever created the agent would make that attribution unstable."""
+
+    needs_data_source: bool
+    """Whether this capability answers from a data source, so a client knows to ask
+    for one. A `documents` capability created without a dock says "I could not
+    find anything", which is indistinguishable from an empty corpus."""
+
+    preamble: str
+    """The instructions this capability runs with, before the user's own mission is
+    layered on top. Read-only, and returned for transparency rather than for a
+    client to echo: `create` composes it, and a caller that sends its own is
+    taken at its word — which is how the two would drift apart."""
+
+    tools: list[str]
+    """The commands and tools this capability is given. Informational — `create`
+    fills it in — but worth showing: it is the difference between what two
+    capabilities can actually do."""

hyperfluid/models/ai_agent_data_source_dto.py

@@ -0,0 +1,21 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentDataSourceDto(BaseModel):
+    """A data dock the agent may read."""
+
+    data_dock_id: UUID
+
+    slug: str
+
+    tables: list[str] | None = None
+    """Fully-qualified tables (`catalog.schema.table`) the agent may read in
+    this dock. Omitted or empty means the whole dock, which is what every
+    agent created before this field gets."""

hyperfluid/models/ai_agent_desired_state_dto.py

@@ -0,0 +1,17 @@
+# this file is @generated
+import typing as t
+
+from ..serialization import StrEnum
+
+
+class AiAgentDesiredStateDto(StrEnum):
+    """Whether the agent should be running. Stopping and starting is user-driven,
+    exactly like a container app: there is no autoscaler and no wake-on-request,
+    so a stopped agent answers nothing until someone starts it."""
+
+    RUNNING = "Running"
+    STOPPED = "Stopped"
+
+
+AiAgentDesiredStateDtoLiteral: t.TypeAlias = t.Literal["Running", "Stopped"]
+"""The values of :class:`AiAgentDesiredStateDto`, which arguments take as plain strings too."""

hyperfluid/models/ai_agent_inference_dto.py

@@ -0,0 +1,27 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentInferenceDto(BaseModel):
+    """Inference selection for an agent."""
+
+    provider: str
+    """`sapience` (in-cluster LLMaaS, default) or `openrouter` (external)."""
+
+    api_key_secret_id: UUID | None | Unset = UNSET
+    """Id of a Passe Partout secret of type `plaintext` holding the OpenRouter
+    API key. Required when `provider` is `openrouter`."""
+
+    endpoint_url: str | None | Unset = UNSET
+    """TEST-ONLY (#3021): OpenAI-compatible base URL for the `custom` provider."""
+
+    model: str | None | Unset = UNSET
+    """Model selection. For `sapience`: `sapience:shared/<name>` or
+    `sapience:org/<name>`. For `openrouter`: the bare model id
+    (e.g. `deepseek/deepseek-chat`)."""

hyperfluid/models/ai_agent_mail_dto.py

@@ -0,0 +1,64 @@
+# 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_mail_mode_dto import AiAgentMailModeDto
+
+
+@dataclasses.dataclass(kw_only=True)
+class AiAgentMailDto(BaseModel):
+    """Mailbox configuration for the `mail` interface: one account used for both
+    IMAP (inbound) and SMTP (replies).
+
+    Every field below `mode` besides `display_name`/`allowed_senders` is
+    meaningful, and accepted, **only** in `External` mode (FR6): a `Managed`
+    payload need not — and, per `validate_mail`, must not — set them."""
+
+    allowed_senders: list[str] | None = None
+    """Senders the agent answers (substring/domain match against the parsed
+    address). Empty = answer everyone. Both modes."""
+
+    display_name: str | None | Unset = UNSET
+    """Friendly name recipients see instead of the bare address
+    (`Support Assistant <agent@example.com>`), so several agents sharing a
+    domain stay distinguishable. Omit to fall back to the agent's name. Printable
+    single-line text, at most 64 characters. Both modes."""
+
+    from_address: str | None | Unset = UNSET
+    """From address on replies (usually the mailbox address). External mode
+    only."""
+
+    imap_host: str | None | Unset = UNSET
+    """IMAP server host (e.g. `ssl0.ovh.net`). External mode only."""
+
+    imap_port: int | None | Unset = UNSET
+    """IMAP port (993 for implicit TLS). External mode only."""
+
+    mode: AiAgentMailModeDto | None = None
+
+    password_secret_id: UUID | None | Unset = UNSET
+    """Id of a Passe Partout secret of type `plaintext` holding the mailbox
+    password. External mode only."""
+
+    smtp_host: str | None | Unset = UNSET
+    """SMTP server host (e.g. `ssl0.ovh.net`). External mode only."""
+
+    smtp_port: int | None | Unset = UNSET
+    """SMTP port (465 implicit TLS, 587 STARTTLS). External mode only."""
+
+    use_tls: bool | None | Unset = UNSET
+    """TLS on the mail connections; defaults to `true` when omitted. Disable
+    only for in-cluster dev servers. External mode only — a managed payload
+    must leave it unset (managed mode is always in-cluster plaintext), and
+    an explicit value is rejected there like every other external-only
+    field rather than silently overridden."""
+
+    username: str | None | Unset = UNSET
+    """Login for both IMAP and SMTP (usually the mailbox address). External
+    mode only."""