robosystems-client 0.2.15__py3-none-any.whl → 0.2.16__py3-none-any.whl

robosystems_client/api/views/save_view.py

@@ -0,0 +1,299 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.save_view_request import SaveViewRequest
+from ...models.save_view_response import SaveViewResponse
+from ...types import Response
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: SaveViewRequest,
+) -> dict[str, Any]:
+  headers: dict[str, Any] = {}
+
+  _kwargs: dict[str, Any] = {
+    "method": "post",
+    "url": f"/v1/graphs/{graph_id}/views/save",
+  }
+
+  _kwargs["json"] = body.to_dict()
+
+  headers["Content-Type"] = "application/json"
+
+  _kwargs["headers"] = headers
+  return _kwargs
+
+
+def _parse_response(
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | SaveViewResponse | None:
+  if response.status_code == 200:
+    response_200 = SaveViewResponse.from_dict(response.json())
+
+    return response_200
+
+  if response.status_code == 422:
+    response_422 = HTTPValidationError.from_dict(response.json())
+
+    return response_422
+
+  if client.raise_on_unexpected_status:
+    raise errors.UnexpectedStatus(response.status_code, response.content)
+  else:
+    return None
+
+
+def _build_response(
+  *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | SaveViewResponse]:
+  return Response(
+    status_code=HTTPStatus(response.status_code),
+    content=response.content,
+    headers=response.headers,
+    parsed=_parse_response(client=client, response=response),
+  )
+
+
+def sync_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: SaveViewRequest,
+) -> Response[HTTPValidationError | SaveViewResponse]:
+  """Save View
+
+   Save or update view as materialized report in the graph.
+
+  Converts computed view results into persistent Report, Fact, and Structure nodes.
+  This establishes what data exists in the subgraph, which then defines what
+  needs to be exported for publishing to the parent graph.
+
+  **Create Mode** (no report_id provided):
+  - Generates new report_id from entity + period + report type
+  - Creates new Report, Facts, and Structures
+
+  **Update Mode** (report_id provided):
+  - Deletes all existing Facts and Structures for the report
+  - Updates Report metadata
+  - Creates fresh Facts and Structures from current view
+  - Useful for refreshing reports with updated data or view configurations
+
+  **This is NOT publishing** - it only creates nodes in the subgraph workspace.
+  Publishing (export → parquet → parent ingest) happens separately.
+
+  Creates/Updates:
+  - Report node with metadata
+  - Fact nodes with all aspects (period, entity, element, unit)
+  - PresentationStructure nodes (how facts are displayed)
+  - CalculationStructure nodes (how facts roll up)
+
+  Returns:
+  - report_id: Unique identifier used as parquet export prefix
+  - parquet_export_prefix: Filename prefix for future exports
+  - All created facts and structures
+
+  Args:
+      graph_id (str):
+      body (SaveViewRequest):
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      Response[HTTPValidationError | SaveViewResponse]
+  """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+  )
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: SaveViewRequest,
+) -> HTTPValidationError | SaveViewResponse | None:
+  """Save View
+
+   Save or update view as materialized report in the graph.
+
+  Converts computed view results into persistent Report, Fact, and Structure nodes.
+  This establishes what data exists in the subgraph, which then defines what
+  needs to be exported for publishing to the parent graph.
+
+  **Create Mode** (no report_id provided):
+  - Generates new report_id from entity + period + report type
+  - Creates new Report, Facts, and Structures
+
+  **Update Mode** (report_id provided):
+  - Deletes all existing Facts and Structures for the report
+  - Updates Report metadata
+  - Creates fresh Facts and Structures from current view
+  - Useful for refreshing reports with updated data or view configurations
+
+  **This is NOT publishing** - it only creates nodes in the subgraph workspace.
+  Publishing (export → parquet → parent ingest) happens separately.
+
+  Creates/Updates:
+  - Report node with metadata
+  - Fact nodes with all aspects (period, entity, element, unit)
+  - PresentationStructure nodes (how facts are displayed)
+  - CalculationStructure nodes (how facts roll up)
+
+  Returns:
+  - report_id: Unique identifier used as parquet export prefix
+  - parquet_export_prefix: Filename prefix for future exports
+  - All created facts and structures
+
+  Args:
+      graph_id (str):
+      body (SaveViewRequest):
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      HTTPValidationError | SaveViewResponse
+  """
+
+  return sync_detailed(
+    graph_id=graph_id,
+    client=client,
+    body=body,
+  ).parsed
+
+
+async def asyncio_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: SaveViewRequest,
+) -> Response[HTTPValidationError | SaveViewResponse]:
+  """Save View
+
+   Save or update view as materialized report in the graph.
+
+  Converts computed view results into persistent Report, Fact, and Structure nodes.
+  This establishes what data exists in the subgraph, which then defines what
+  needs to be exported for publishing to the parent graph.
+
+  **Create Mode** (no report_id provided):
+  - Generates new report_id from entity + period + report type
+  - Creates new Report, Facts, and Structures
+
+  **Update Mode** (report_id provided):
+  - Deletes all existing Facts and Structures for the report
+  - Updates Report metadata
+  - Creates fresh Facts and Structures from current view
+  - Useful for refreshing reports with updated data or view configurations
+
+  **This is NOT publishing** - it only creates nodes in the subgraph workspace.
+  Publishing (export → parquet → parent ingest) happens separately.
+
+  Creates/Updates:
+  - Report node with metadata
+  - Fact nodes with all aspects (period, entity, element, unit)
+  - PresentationStructure nodes (how facts are displayed)
+  - CalculationStructure nodes (how facts roll up)
+
+  Returns:
+  - report_id: Unique identifier used as parquet export prefix
+  - parquet_export_prefix: Filename prefix for future exports
+  - All created facts and structures
+
+  Args:
+      graph_id (str):
+      body (SaveViewRequest):
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      Response[HTTPValidationError | SaveViewResponse]
+  """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+  )
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: SaveViewRequest,
+) -> HTTPValidationError | SaveViewResponse | None:
+  """Save View
+
+   Save or update view as materialized report in the graph.
+
+  Converts computed view results into persistent Report, Fact, and Structure nodes.
+  This establishes what data exists in the subgraph, which then defines what
+  needs to be exported for publishing to the parent graph.
+
+  **Create Mode** (no report_id provided):
+  - Generates new report_id from entity + period + report type
+  - Creates new Report, Facts, and Structures
+
+  **Update Mode** (report_id provided):
+  - Deletes all existing Facts and Structures for the report
+  - Updates Report metadata
+  - Creates fresh Facts and Structures from current view
+  - Useful for refreshing reports with updated data or view configurations
+
+  **This is NOT publishing** - it only creates nodes in the subgraph workspace.
+  Publishing (export → parquet → parent ingest) happens separately.
+
+  Creates/Updates:
+  - Report node with metadata
+  - Fact nodes with all aspects (period, entity, element, unit)
+  - PresentationStructure nodes (how facts are displayed)
+  - CalculationStructure nodes (how facts roll up)
+
+  Returns:
+  - report_id: Unique identifier used as parquet export prefix
+  - parquet_export_prefix: Filename prefix for future exports
+  - All created facts and structures
+
+  Args:
+      graph_id (str):
+      body (SaveViewRequest):
+
+  Raises:
+      errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+      httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+  Returns:
+      HTTPValidationError | SaveViewResponse
+  """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+    )
+  ).parsed

robosystems_client/client.py

@@ -1,5 +1,5 @@
 import ssl
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 from attrs import define, evolve, field
@@ -38,14 +38,14 @@ class Client:
   _base_url: str = field(alias="base_url")
   _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
   _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
-  _timeout: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
-  _verify_ssl: Union[str, bool, ssl.SSLContext] = field(
+  _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+  _verify_ssl: str | bool | ssl.SSLContext = field(
     default=True, kw_only=True, alias="verify_ssl"
   )
   _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
   _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
-  _client: Optional[httpx.Client] = field(default=None, init=False)
-  _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+  _client: httpx.Client | None = field(default=None, init=False)
+  _async_client: httpx.AsyncClient | None = field(default=None, init=False)
 
   def with_headers(self, headers: dict[str, str]) -> "Client":
     """Get a new client matching this one with additional headers"""
@@ -64,7 +64,7 @@ class Client:
     return evolve(self, cookies={**self._cookies, **cookies})
 
   def with_timeout(self, timeout: httpx.Timeout) -> "Client":
-    """Get a new client matching this one with a new timeout (in seconds)"""
+    """Get a new client matching this one with a new timeout configuration"""
     if self._client is not None:
       self._client.timeout = timeout
     if self._async_client is not None:
@@ -103,7 +103,7 @@ class Client:
     self.get_httpx_client().__exit__(*args, **kwargs)
 
   def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
-    """Manually the underlying httpx.AsyncClient
+    """Manually set the underlying httpx.AsyncClient
 
     **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
     """
@@ -170,14 +170,14 @@ class AuthenticatedClient:
   _base_url: str = field(alias="base_url")
   _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
   _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
-  _timeout: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
-  _verify_ssl: Union[str, bool, ssl.SSLContext] = field(
+  _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+  _verify_ssl: str | bool | ssl.SSLContext = field(
     default=True, kw_only=True, alias="verify_ssl"
   )
   _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
   _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
-  _client: Optional[httpx.Client] = field(default=None, init=False)
-  _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+  _client: httpx.Client | None = field(default=None, init=False)
+  _async_client: httpx.AsyncClient | None = field(default=None, init=False)
 
   token: str
   prefix: str = "Bearer"
@@ -200,7 +200,7 @@ class AuthenticatedClient:
     return evolve(self, cookies={**self._cookies, **cookies})
 
   def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
-    """Get a new client matching this one with a new timeout (in seconds)"""
+    """Get a new client matching this one with a new timeout configuration"""
     if self._client is not None:
       self._client.timeout = timeout
     if self._async_client is not None:
@@ -244,7 +244,7 @@ class AuthenticatedClient:
   def set_async_httpx_client(
     self, async_client: httpx.AsyncClient
   ) -> "AuthenticatedClient":
-    """Manually the underlying httpx.AsyncClient
+    """Manually set the underlying httpx.AsyncClient
 
     **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
     """

robosystems_client/extensions/__init__.py

@@ -46,6 +46,27 @@ from .extensions import (
   RoboSystemsExtensionConfig,
   AsyncRoboSystemsExtensions,
 )
+from .element_mapping_client import (
+  ElementMappingClient,
+  MappingStructure,
+  ElementAssociation,
+  AggregationMethod,
+)
+from .subgraph_workspace_client import (
+  SubgraphWorkspaceClient,
+  SubgraphWorkspace,
+  StorageType,
+  ExportResult,
+  PublishResult,
+)
+from .view_builder_client import (
+  ViewBuilderClient,
+  ViewSourceType,
+  ViewSource,
+  ViewAxis,
+  ViewConfig,
+  ViewResponse,
+)
 from .utils import (
   QueryBuilder,
   ResultProcessor,
@@ -114,6 +135,24 @@ __all__ = [
   "RoboSystemsExtensions",
   "RoboSystemsExtensionConfig",
   "AsyncRoboSystemsExtensions",
+  # Element Mapping Client
+  "ElementMappingClient",
+  "MappingStructure",
+  "ElementAssociation",
+  "AggregationMethod",
+  # Subgraph Workspace Client
+  "SubgraphWorkspaceClient",
+  "SubgraphWorkspace",
+  "StorageType",
+  "ExportResult",
+  "PublishResult",
+  # View Builder Client
+  "ViewBuilderClient",
+  "ViewSourceType",
+  "ViewSource",
+  "ViewAxis",
+  "ViewConfig",
+  "ViewResponse",
   # SSE Client
   "SSEClient",
   "EventType",