modulex-python 0.1.0__py3-none-any.whl

modulex/resources/templates.py

@@ -0,0 +1,115 @@
+"""Templates resource for the ModuleX Python SDK."""
+
+from __future__ import annotations
+
+import builtins
+from typing import Any
+
+from modulex._base import _BaseResource
+
+
+class Templates(_BaseResource):
+    """Resource for browsing, creating, and managing workflow templates."""
+
+    async def list(self) -> Any:
+        """Return all publicly available templates."""
+        return await self._get("/templates")
+
+    async def get(self, template_id: str) -> Any:
+        """Return a single template by its ID."""
+        return await self._get(f"/templates/{template_id}")
+
+    async def my_templates(self) -> Any:
+        """Return all templates created by the authenticated user."""
+        return await self._get("/templates/me")
+
+    async def create(
+        self,
+        workflow_id: str,
+        name: str,
+        *,
+        description: str | None = None,
+        tags: builtins.list[str] | None = None,
+        schema_image_url: str | None = None,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Create a new template from an existing workflow."""
+        body: dict[str, Any] = {
+            k: v
+            for k, v in {
+                "workflow_id": workflow_id,
+                "name": name,
+                "description": description,
+                "tags": tags,
+                "schema_image_url": schema_image_url,
+            }.items()
+            if v is not None
+        }
+        return await self._post("/templates", json=body, organization_id=organization_id)
+
+    async def like(self, template_id: str) -> Any:
+        """Toggle a like on a template for the authenticated user."""
+        return await self._post(f"/templates/{template_id}/like")
+
+    async def use(
+        self,
+        template_id: str,
+        *,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Instantiate a workflow from a template into the caller's organization."""
+        return await self._post(f"/templates/{template_id}/use", organization_id=organization_id)
+
+    async def update_request(
+        self,
+        template_id: str,
+        workflow_id: str,
+        *,
+        name: str | None = None,
+        description: str | None = None,
+        tags: builtins.list[str] | None = None,
+        schema_image_url: str | None = None,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Submit an update request to refresh a published template from a workflow."""
+        body: dict[str, Any] = {
+            k: v
+            for k, v in {
+                "workflow_id": workflow_id,
+                "name": name,
+                "description": description,
+                "tags": tags,
+                "schema_image_url": schema_image_url,
+            }.items()
+            if v is not None
+        }
+        return await self._post(
+            f"/templates/{template_id}/update-request",
+            json=body,
+            organization_id=organization_id,
+        )
+
+    async def create_creator(
+        self,
+        name: str,
+        *,
+        about: str | None = None,
+        display_photo: str | None = None,
+        socials: dict[str, Any] | None = None,
+    ) -> Any:
+        """Create a creator profile for the authenticated user."""
+        body: dict[str, Any] = {
+            k: v
+            for k, v in {
+                "name": name,
+                "about": about,
+                "display_photo": display_photo,
+                "socials": socials,
+            }.items()
+            if v is not None
+        }
+        return await self._post("/templates/creators", json=body)
+
+    async def my_creator(self) -> Any:
+        """Return the creator profile of the authenticated user."""
+        return await self._get("/templates/creators/me")

modulex/resources/workflows.py

@@ -0,0 +1,156 @@
+"""Workflows resource for the ModuleX Python SDK."""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator
+from typing import Any
+
+from modulex._base import _BaseResource
+from modulex._streaming import EventSourceStream
+
+
+class Workflows(_BaseResource):
+    """Resource for creating and managing workflow definitions."""
+
+    async def create(
+        self,
+        workflow_schema: dict[str, Any],
+        *,
+        name: str | None = None,
+        description: str | None = None,
+        version: str | None = None,
+        tags: list[str] | None = None,
+        category: str | None = None,
+        status: str = "draft",
+        visibility: str = "private",
+        input: dict[str, Any] | None = None,
+        config: dict[str, Any] | None = None,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Create a new workflow from the given schema and metadata."""
+        body: dict[str, Any] = {
+            "workflow_schema": workflow_schema,
+            "status": status,
+            "visibility": visibility,
+        }
+        if name is not None:
+            body["name"] = name
+        if description is not None:
+            body["description"] = description
+        if version is not None:
+            body["version"] = version
+        if tags is not None:
+            body["tags"] = tags
+        if category is not None:
+            body["category"] = category
+        if input is not None:
+            body["input"] = input
+        if config is not None:
+            body["config"] = config
+        return await self._post("/workflows", json=body, organization_id=organization_id)
+
+    async def list(
+        self,
+        *,
+        status: str | None = None,
+        category: str | None = None,
+        visibility: str | None = None,
+        search: str | None = None,
+        page: int | None = None,
+        page_size: int | None = None,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Return a paginated list of workflows matching the given filters."""
+        params: dict[str, Any] = {}
+        if status is not None:
+            params["status"] = status
+        if category is not None:
+            params["category"] = category
+        if visibility is not None:
+            params["visibility"] = visibility
+        if search is not None:
+            params["search"] = search
+        if page is not None:
+            params["page"] = page
+        if page_size is not None:
+            params["page_size"] = page_size
+        return await self._get("/workflows", params=params or None, organization_id=organization_id)
+
+    async def list_all(
+        self,
+        *,
+        status: str | None = None,
+        category: str | None = None,
+        visibility: str | None = None,
+        search: str | None = None,
+        organization_id: str | None = None,
+    ) -> AsyncIterator[Any]:
+        """Auto-paginate through all workflows matching the given filters."""
+        params: dict[str, Any] = {}
+        if status is not None:
+            params["status"] = status
+        if category is not None:
+            params["category"] = category
+        if visibility is not None:
+            params["visibility"] = visibility
+        if search is not None:
+            params["search"] = search
+        params["page"] = 1
+        async for item in self._paginate(
+            "/workflows",
+            items_key="workflows",
+            params=params,
+            organization_id=organization_id,
+        ):
+            yield item
+
+    async def get(self, workflow_id: str, *, organization_id: str | None = None) -> Any:
+        """Return a single workflow by its ID."""
+        return await self._get(f"/workflows/{workflow_id}", organization_id=organization_id)
+
+    async def update(self, workflow_id: str, *, organization_id: str | None = None, **kwargs: Any) -> Any:
+        """Update a workflow's fields with any combination of allowed keys."""
+        allowed_keys = {
+            "name",
+            "description",
+            "version",
+            "tags",
+            "category",
+            "status",
+            "visibility",
+            "workflow_schema",
+            "input",
+            "config",
+        }
+        body = {k: v for k, v in kwargs.items() if k in allowed_keys and v is not None}
+        return await self._put(f"/workflows/{workflow_id}", json=body, organization_id=organization_id)
+
+    async def delete(self, workflow_id: str, *, organization_id: str | None = None) -> Any:
+        """Delete a workflow by its ID."""
+        return await self._delete(f"/workflows/{workflow_id}", organization_id=organization_id)
+
+    async def builder_details(
+        self,
+        *,
+        node_type: str | None = None,
+        category: str | None = None,
+        integration_name: str | None = None,
+        organization_id: str | None = None,
+    ) -> Any:
+        """Return workflow builder node details, optionally filtered by type, category, or integration."""
+        params: dict[str, Any] = {}
+        if node_type is not None:
+            params["node_type"] = node_type
+        if category is not None:
+            params["category"] = category
+        if integration_name is not None:
+            params["integration_name"] = integration_name
+        return await self._get(
+            "/workflows/builder/details",
+            params=params or None,
+            organization_id=organization_id,
+        )
+
+    def listen_changes(self, workflow_id: str, *, organization_id: str | None = None) -> EventSourceStream:
+        """Open an SSE stream for live changes to a workflow definition."""
+        return self._stream_sse(f"/workflows/{workflow_id}/changes", organization_id=organization_id)

modulex/types/__init__.py

@@ -0,0 +1,294 @@
+"""ModuleX SDK type definitions.
+
+Re-exports every public type from all submodules so callers can use a single
+import path:
+
+    from modulex.types import WorkflowResponse, CredentialResponse, ...
+"""
+
+from __future__ import annotations
+
+# ---------------------------------------------------------------------------
+# api_keys
+# ---------------------------------------------------------------------------
+from modulex.types.api_keys import (
+    ApiKeyResponse,
+)
+
+# ---------------------------------------------------------------------------
+# auth
+# ---------------------------------------------------------------------------
+from modulex.types.auth import (
+    InvitationInfo,
+    LeaveOrganizationResponse,
+    OrganizationMembership,
+    UserOrganizationsResponse,
+    UserProfile,
+)
+
+# ---------------------------------------------------------------------------
+# chats
+# ---------------------------------------------------------------------------
+from modulex.types.chats import (
+    ChatListResponse,
+    ChatMessageResponse,
+    ChatMessagesListResponse,
+    ChatResponse,
+)
+
+# ---------------------------------------------------------------------------
+# composer
+# ---------------------------------------------------------------------------
+from modulex.types.composer import (
+    ComposerChatResponse,
+    ComposerStatusResponse,
+)
+
+# ---------------------------------------------------------------------------
+# credentials
+# ---------------------------------------------------------------------------
+from modulex.types.credentials import (
+    AuditEntry,
+    CredentialResponse,
+    CredentialTestResult,
+    CredentialUsageStats,
+    MCPRefreshResponse,
+    MCPToolsResponse,
+)
+
+# ---------------------------------------------------------------------------
+# dashboard
+# ---------------------------------------------------------------------------
+from modulex.types.dashboard import (
+    AnalyticsOverviewResponse,
+    LogEntry,
+    LogsResponse,
+    UserListResponse,
+)
+
+# ---------------------------------------------------------------------------
+# executions
+# ---------------------------------------------------------------------------
+from modulex.types.executions import (
+    CancelResponse,
+    DoneEvent,
+    ErrorEvent,
+    InterruptEvent,
+    MetadataEvent,
+    NodeUpdateEvent,
+    ResumeResponse,
+    RunResponse,
+    StateResponse,
+)
+
+# ---------------------------------------------------------------------------
+# integrations
+# ---------------------------------------------------------------------------
+from modulex.types.integrations import (
+    IntegrationBrowseResponse,
+    IntegrationInfo,
+)
+
+# ---------------------------------------------------------------------------
+# knowledge
+# ---------------------------------------------------------------------------
+from modulex.types.knowledge import (
+    ChunkInfo,
+    ContextResponse,
+    DocumentResponse,
+    KnowledgeBaseResponse,
+    KnowledgeStatsResponse,
+    SearchResult,
+    SupportedFileTypesResponse,
+)
+
+# ---------------------------------------------------------------------------
+# notifications
+# ---------------------------------------------------------------------------
+from modulex.types.notifications import (
+    NotificationResponse,
+)
+
+# ---------------------------------------------------------------------------
+# organizations
+# ---------------------------------------------------------------------------
+from modulex.types.organizations import (
+    InviteResponse,
+    LLMListResponse,
+    OrganizationResponse,
+    RoleUpdateResponse,
+)
+
+# ---------------------------------------------------------------------------
+# schedules
+# ---------------------------------------------------------------------------
+from modulex.types.schedules import (
+    RunStatsResponse,
+    ScheduleResponse,
+    ScheduleRunResponse,
+)
+
+# ---------------------------------------------------------------------------
+# shared
+# ---------------------------------------------------------------------------
+from modulex.types.shared import (
+    ErrorDetail,
+    PagePaginatedResponse,
+    PaginatedResponse,
+    SuccessResponse,
+)
+
+# ---------------------------------------------------------------------------
+# subscriptions
+# ---------------------------------------------------------------------------
+from modulex.types.subscriptions import (
+    BillingResponse,
+    BillingSubscription,
+    CheckoutResponse,
+    PlanInfo,
+    PlanPrice,
+    PlansResponse,
+)
+
+# ---------------------------------------------------------------------------
+# templates
+# ---------------------------------------------------------------------------
+from modulex.types.templates import (
+    CreatorProfile,
+    TemplateListResponse,
+    TemplateResponse,
+)
+
+# ---------------------------------------------------------------------------
+# workflows
+# ---------------------------------------------------------------------------
+from modulex.types.workflows import (
+    AgentNodeConfig,
+    BuilderDetailsResponse,
+    ConditionalNodeConfig,
+    EdgeDefinition,
+    ExpressionBranch,
+    GuardrailsNodeConfig,
+    InterruptNodeConfig,
+    KnowledgeNodeConfig,
+    LLMConfig,
+    LLMNodeConfig,
+    LoopConfig,
+    NodeDefinition,
+    RetryConfig,
+    StateField,
+    StateSchema,
+    ToolDefinition,
+    ToolNodeConfig,
+    TransformerNodeConfig,
+    TransformerOperation,
+    WorkflowConfig,
+    WorkflowDefinition,
+    WorkflowListResponse,
+    WorkflowMetadata,
+    WorkflowResponse,
+)
+
+__all__ = [
+    # api_keys
+    "ApiKeyResponse",
+    # auth
+    "InvitationInfo",
+    "LeaveOrganizationResponse",
+    "OrganizationMembership",
+    "UserOrganizationsResponse",
+    "UserProfile",
+    # chats
+    "ChatListResponse",
+    "ChatMessageResponse",
+    "ChatMessagesListResponse",
+    "ChatResponse",
+    # composer
+    "ComposerChatResponse",
+    "ComposerStatusResponse",
+    # credentials
+    "AuditEntry",
+    "CredentialResponse",
+    "CredentialTestResult",
+    "CredentialUsageStats",
+    "MCPRefreshResponse",
+    "MCPToolsResponse",
+    # dashboard
+    "AnalyticsOverviewResponse",
+    "LogEntry",
+    "LogsResponse",
+    "UserListResponse",
+    # executions
+    "CancelResponse",
+    "DoneEvent",
+    "ErrorEvent",
+    "InterruptEvent",
+    "MetadataEvent",
+    "NodeUpdateEvent",
+    "ResumeResponse",
+    "RunResponse",
+    "StateResponse",
+    # integrations
+    "IntegrationBrowseResponse",
+    "IntegrationInfo",
+    # knowledge
+    "ChunkInfo",
+    "ContextResponse",
+    "DocumentResponse",
+    "KnowledgeBaseResponse",
+    "KnowledgeStatsResponse",
+    "SearchResult",
+    "SupportedFileTypesResponse",
+    # notifications
+    "NotificationResponse",
+    # organizations
+    "InviteResponse",
+    "LLMListResponse",
+    "OrganizationResponse",
+    "RoleUpdateResponse",
+    # schedules
+    "RunStatsResponse",
+    "ScheduleResponse",
+    "ScheduleRunResponse",
+    # shared
+    "ErrorDetail",
+    "PagePaginatedResponse",
+    "PaginatedResponse",
+    "SuccessResponse",
+    # subscriptions
+    "BillingResponse",
+    "BillingSubscription",
+    "CheckoutResponse",
+    "PlanInfo",
+    "PlanPrice",
+    "PlansResponse",
+    # templates
+    "CreatorProfile",
+    "TemplateListResponse",
+    "TemplateResponse",
+    # workflows
+    "AgentNodeConfig",
+    "BuilderDetailsResponse",
+    "ConditionalNodeConfig",
+    "EdgeDefinition",
+    "ExpressionBranch",
+    "GuardrailsNodeConfig",
+    "InterruptNodeConfig",
+    "KnowledgeNodeConfig",
+    "LLMConfig",
+    "LLMNodeConfig",
+    "LoopConfig",
+    "NodeDefinition",
+    "RetryConfig",
+    "StateField",
+    "StateSchema",
+    "ToolDefinition",
+    "ToolNodeConfig",
+    "TransformerNodeConfig",
+    "TransformerOperation",
+    "WorkflowConfig",
+    "WorkflowDefinition",
+    "WorkflowListResponse",
+    "WorkflowMetadata",
+    "WorkflowResponse",
+]

modulex/types/api_keys.py

@@ -0,0 +1,19 @@
+"""API key-related type definitions."""
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+
+class ApiKeyResponse(TypedDict, total=False):
+    """Response representing an API key."""
+
+    id: str
+    name: str
+    key: str | None
+    key_hint: str
+    organization_id: str
+    expires_at: str | None
+    rate_limit_per_minute: int | None
+    created_at: str
+    is_revoked: bool

modulex/types/auth.py

@@ -0,0 +1,62 @@
+"""Auth-related type definitions."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from typing_extensions import TypedDict
+
+
+class UserProfile(TypedDict, total=False):
+    """User profile from /auth/me."""
+
+    id: str
+    email: str
+    username: str
+    role: str
+    is_active: bool
+    organization_ids: list[str]
+    primary_organization_id: str | None
+
+
+class OrganizationMembership(TypedDict, total=False):
+    """Organization membership info."""
+
+    id: str
+    name: str
+    slug: str
+    role: str
+    created_at: str
+
+
+class UserOrganizationsResponse(TypedDict, total=False):
+    """Response from /auth/me/organizations."""
+
+    success: bool
+    user_id: str
+    organizations: list[OrganizationMembership]
+    total: int
+
+
+class InvitationInfo(TypedDict, total=False):
+    """Invitation details."""
+
+    id: str
+    organization_id: str
+    organization_name: str
+    invited_email: str
+    role: str
+    status: str
+    invitation_message: str | None
+    created_at: str
+    expires_at: str | None
+
+
+class LeaveOrganizationResponse(TypedDict, total=False):
+    """Response from /auth/organizations/leave."""
+
+    success: bool
+    message: str
+    left_organization: dict[str, Any]
+    remaining_organizations: list[dict[str, Any]]
+    total_remaining: int

modulex/types/chats.py

@@ -0,0 +1,55 @@
+"""Chat-related type definitions."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from typing_extensions import TypedDict
+
+
+class ChatResponse(TypedDict, total=False):
+    """Response representing a chat session."""
+
+    id: str
+    organization_id: str
+    creator_id: str
+    title: str | None
+    is_private: bool
+    running_id: str | None
+    messages: list[Any]
+    created_at: str
+    updated_at: str
+    deleted_at: str | None
+
+
+class ChatMessageResponse(TypedDict, total=False):
+    """Response representing a single chat message."""
+
+    id: str
+    chat_id: str
+    role: str
+    content: Any
+    workflow: dict[str, Any]
+    run_id: str | None
+    running_status: str | None
+    created_at: str
+    updated_at: str
+
+
+class ChatListResponse(TypedDict, total=False):
+    """Categorized list of chats for the current user."""
+
+    chats: list[Any]
+    pinned: list[Any]
+    archived: list[Any]
+
+
+class ChatMessagesListResponse(TypedDict, total=False):
+    """Paginated list of messages within a chat."""
+
+    messages: list[Any]
+    total: int
+    limit: int
+    offset: int
+    has_next: bool
+    actual_count: int