robosystems-client 0.2.8__tar.gz → 0.2.9__tar.gz

{robosystems_client-0.2.8 → robosystems_client-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robosystems-client
-Version: 0.2.8
+Version: 0.2.9
 Summary: Python Client for RoboSystems financial graph database API
 Author: RFS LLC
 License: MIT

{robosystems_client-0.2.8 → robosystems_client-0.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "robosystems-client"
-version = "0.2.8"
+version = "0.2.9"
 description = "Python Client for RoboSystems financial graph database API"
 readme = "README.md"
 requires-python = ">=3.10"

robosystems_client-0.2.9/robosystems_client/api/graphs/get_graphs.py

@@ -0,0 +1,299 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.user_graphs_response import UserGraphsResponse
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+  _kwargs: dict[str, Any] = {
+    "method": "get",
+    "url": "/v1/graphs",
+  }
+
+  return _kwargs
+
+
+def _parse_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, UserGraphsResponse]]:
+  if response.status_code == 200:
+    response_200 = UserGraphsResponse.from_dict(response.json())
+
+    return response_200
+
+  if response.status_code == 500:
+    response_500 = cast(Any, None)
+    return response_500
+
+  if client.raise_on_unexpected_status:
+    raise errors.UnexpectedStatus(response.status_code, response.content)
+  else:
+    return None
+
+
+def _build_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, UserGraphsResponse]]:
+  return Response(
+    status_code=HTTPStatus(response.status_code),
+    content=response.content,
+    headers=response.headers,
+    parsed=_parse_response(client=client, response=response),
+  )
+
+
+def sync_detailed(
+  *,
+  client: AuthenticatedClient,
+) -> Response[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs and Repositories
+
+   List all graph databases and shared repositories accessible to the current user.
+
+  Returns a unified list of both user-created graphs and shared repositories (like SEC data)
+  that the user has access to, including their role/access level and selection status.
+
+  **Returned Information:**
+  - Graph/Repository ID and display name
+  - User's role/access level (admin/member for graphs, read/write/admin for repositories)
+  - Selection status (only user graphs can be selected)
+  - Creation timestamp
+  - Repository type indicator (isRepository: true for shared repositories)
+
+  **User Graphs (isRepository: false):**
+  - Collaborative workspaces that can be shared with other users
+  - Roles: `admin` (full access, can invite users) or `member` (read/write access)
+  - Can be selected as active workspace
+  - Graphs you create or have been invited to
+
+  **Shared Repositories (isRepository: true):**
+  - Read-only data repositories like SEC filings, industry benchmarks
+  - Access levels: `read`, `write` (for data contributions), `admin`
+  - Cannot be selected (each has separate subscription)
+  - Require separate subscriptions (personal, cannot be shared)
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace (user graphs only).
+  Many API operations default to the selected graph if no graph_id is provided.
+  Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
+
+  **Use Cases:**
+  - Display unified graph/repository selector in UI
+  - Show all accessible data sources (both owned graphs and subscribed repositories)
+  - Identify currently active workspace
+  - Filter by type (user graphs vs repositories)
+
+  **Empty Response:**
+  New users receive an empty list with `selectedGraphId: null`. Users should create
+  a graph or subscribe to a repository.
+
+  **Note:**
+  Graph listing is included - no credit consumption required.
+
+  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[Union[Any, UserGraphsResponse]]
+  """
+
+  kwargs = _get_kwargs()
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  *,
+  client: AuthenticatedClient,
+) -> Optional[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs and Repositories
+
+   List all graph databases and shared repositories accessible to the current user.
+
+  Returns a unified list of both user-created graphs and shared repositories (like SEC data)
+  that the user has access to, including their role/access level and selection status.
+
+  **Returned Information:**
+  - Graph/Repository ID and display name
+  - User's role/access level (admin/member for graphs, read/write/admin for repositories)
+  - Selection status (only user graphs can be selected)
+  - Creation timestamp
+  - Repository type indicator (isRepository: true for shared repositories)
+
+  **User Graphs (isRepository: false):**
+  - Collaborative workspaces that can be shared with other users
+  - Roles: `admin` (full access, can invite users) or `member` (read/write access)
+  - Can be selected as active workspace
+  - Graphs you create or have been invited to
+
+  **Shared Repositories (isRepository: true):**
+  - Read-only data repositories like SEC filings, industry benchmarks
+  - Access levels: `read`, `write` (for data contributions), `admin`
+  - Cannot be selected (each has separate subscription)
+  - Require separate subscriptions (personal, cannot be shared)
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace (user graphs only).
+  Many API operations default to the selected graph if no graph_id is provided.
+  Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
+
+  **Use Cases:**
+  - Display unified graph/repository selector in UI
+  - Show all accessible data sources (both owned graphs and subscribed repositories)
+  - Identify currently active workspace
+  - Filter by type (user graphs vs repositories)
+
+  **Empty Response:**
+  New users receive an empty list with `selectedGraphId: null`. Users should create
+  a graph or subscribe to a repository.
+
+  **Note:**
+  Graph listing is included - no credit consumption required.
+
+  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:
+      Union[Any, UserGraphsResponse]
+  """
+
+  return sync_detailed(
+    client=client,
+  ).parsed
+
+
+async def asyncio_detailed(
+  *,
+  client: AuthenticatedClient,
+) -> Response[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs and Repositories
+
+   List all graph databases and shared repositories accessible to the current user.
+
+  Returns a unified list of both user-created graphs and shared repositories (like SEC data)
+  that the user has access to, including their role/access level and selection status.
+
+  **Returned Information:**
+  - Graph/Repository ID and display name
+  - User's role/access level (admin/member for graphs, read/write/admin for repositories)
+  - Selection status (only user graphs can be selected)
+  - Creation timestamp
+  - Repository type indicator (isRepository: true for shared repositories)
+
+  **User Graphs (isRepository: false):**
+  - Collaborative workspaces that can be shared with other users
+  - Roles: `admin` (full access, can invite users) or `member` (read/write access)
+  - Can be selected as active workspace
+  - Graphs you create or have been invited to
+
+  **Shared Repositories (isRepository: true):**
+  - Read-only data repositories like SEC filings, industry benchmarks
+  - Access levels: `read`, `write` (for data contributions), `admin`
+  - Cannot be selected (each has separate subscription)
+  - Require separate subscriptions (personal, cannot be shared)
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace (user graphs only).
+  Many API operations default to the selected graph if no graph_id is provided.
+  Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
+
+  **Use Cases:**
+  - Display unified graph/repository selector in UI
+  - Show all accessible data sources (both owned graphs and subscribed repositories)
+  - Identify currently active workspace
+  - Filter by type (user graphs vs repositories)
+
+  **Empty Response:**
+  New users receive an empty list with `selectedGraphId: null`. Users should create
+  a graph or subscribe to a repository.
+
+  **Note:**
+  Graph listing is included - no credit consumption required.
+
+  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[Union[Any, UserGraphsResponse]]
+  """
+
+  kwargs = _get_kwargs()
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  *,
+  client: AuthenticatedClient,
+) -> Optional[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs and Repositories
+
+   List all graph databases and shared repositories accessible to the current user.
+
+  Returns a unified list of both user-created graphs and shared repositories (like SEC data)
+  that the user has access to, including their role/access level and selection status.
+
+  **Returned Information:**
+  - Graph/Repository ID and display name
+  - User's role/access level (admin/member for graphs, read/write/admin for repositories)
+  - Selection status (only user graphs can be selected)
+  - Creation timestamp
+  - Repository type indicator (isRepository: true for shared repositories)
+
+  **User Graphs (isRepository: false):**
+  - Collaborative workspaces that can be shared with other users
+  - Roles: `admin` (full access, can invite users) or `member` (read/write access)
+  - Can be selected as active workspace
+  - Graphs you create or have been invited to
+
+  **Shared Repositories (isRepository: true):**
+  - Read-only data repositories like SEC filings, industry benchmarks
+  - Access levels: `read`, `write` (for data contributions), `admin`
+  - Cannot be selected (each has separate subscription)
+  - Require separate subscriptions (personal, cannot be shared)
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace (user graphs only).
+  Many API operations default to the selected graph if no graph_id is provided.
+  Users can change their selected graph via `POST /v1/graphs/{graph_id}/select`.
+
+  **Use Cases:**
+  - Display unified graph/repository selector in UI
+  - Show all accessible data sources (both owned graphs and subscribed repositories)
+  - Identify currently active workspace
+  - Filter by type (user graphs vs repositories)
+
+  **Empty Response:**
+  New users receive an empty list with `selectedGraphId: null`. Users should create
+  a graph or subscribe to a repository.
+
+  **Note:**
+  Graph listing is included - no credit consumption required.
+
+  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:
+      Union[Any, UserGraphsResponse]
+  """
+
+  return (
+    await asyncio_detailed(
+      client=client,
+    )
+  ).parsed

{robosystems_client-0.2.8 → robosystems_client-0.2.9}/robosystems_client/models/graph_info.py

@@ -1,9 +1,11 @@
 from collections.abc import Mapping
-from typing import Any, TypeVar
+from typing import Any, TypeVar, Union, cast
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
+from ..types import UNSET, Unset
+
 T = TypeVar("T", bound="GraphInfo")
 
 
@@ -14,9 +16,11 @@ class GraphInfo:
   Attributes:
       graph_id (str): Graph database identifier
       graph_name (str): Display name for the graph
-      role (str): User's role in this graph
+      role (str): User's role/access level
       is_selected (bool): Whether this is the currently selected graph
       created_at (str): Creation timestamp
+      is_repository (Union[Unset, bool]): Whether this is a shared repository (vs user graph) Default: False.
+      repository_type (Union[None, Unset, str]): Repository type if isRepository=true
   """
 
   graph_id: str
@@ -24,6 +28,8 @@ class GraphInfo:
   role: str
   is_selected: bool
   created_at: str
+  is_repository: Union[Unset, bool] = False
+  repository_type: Union[None, Unset, str] = UNSET
   additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
   def to_dict(self) -> dict[str, Any]:
@@ -37,6 +43,14 @@ class GraphInfo:
 
     created_at = self.created_at
 
+    is_repository = self.is_repository
+
+    repository_type: Union[None, Unset, str]
+    if isinstance(self.repository_type, Unset):
+      repository_type = UNSET
+    else:
+      repository_type = self.repository_type
+
     field_dict: dict[str, Any] = {}
     field_dict.update(self.additional_properties)
     field_dict.update(
@@ -48,6 +62,10 @@ class GraphInfo:
         "createdAt": created_at,
       }
     )
+    if is_repository is not UNSET:
+      field_dict["isRepository"] = is_repository
+    if repository_type is not UNSET:
+      field_dict["repositoryType"] = repository_type
 
     return field_dict
 
@@ -64,12 +82,25 @@ class GraphInfo:
 
     created_at = d.pop("createdAt")
 
+    is_repository = d.pop("isRepository", UNSET)
+
+    def _parse_repository_type(data: object) -> Union[None, Unset, str]:
+      if data is None:
+        return data
+      if isinstance(data, Unset):
+        return data
+      return cast(Union[None, Unset, str], data)
+
+    repository_type = _parse_repository_type(d.pop("repositoryType", UNSET))
+
     graph_info = cls(
       graph_id=graph_id,
       graph_name=graph_name,
       role=role,
       is_selected=is_selected,
       created_at=created_at,
+      is_repository=is_repository,
+      repository_type=repository_type,
     )
 
     graph_info.additional_properties = d

{robosystems_client-0.2.8 → robosystems_client-0.2.9}/robosystems_client/models/graph_tier_instance.py

@@ -13,13 +13,13 @@ class GraphTierInstance:
 
   Attributes:
       type_ (str): Instance type identifier
-      memory_mb (int): Memory in megabytes
-      databases_per_instance (int): Databases per instance
+      memory_mb (int): Memory allocated to your graph in megabytes
+      is_multitenant (bool): Whether this tier shares infrastructure with other graphs
   """
 
   type_: str
   memory_mb: int
-  databases_per_instance: int
+  is_multitenant: bool
   additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
   def to_dict(self) -> dict[str, Any]:
@@ -27,7 +27,7 @@ class GraphTierInstance:
 
     memory_mb = self.memory_mb
 
-    databases_per_instance = self.databases_per_instance
+    is_multitenant = self.is_multitenant
 
     field_dict: dict[str, Any] = {}
     field_dict.update(self.additional_properties)
@@ -35,7 +35,7 @@ class GraphTierInstance:
       {
         "type": type_,
         "memory_mb": memory_mb,
-        "databases_per_instance": databases_per_instance,
+        "is_multitenant": is_multitenant,
       }
     )
 
@@ -48,12 +48,12 @@ class GraphTierInstance:
 
     memory_mb = d.pop("memory_mb")
 
-    databases_per_instance = d.pop("databases_per_instance")
+    is_multitenant = d.pop("is_multitenant")
 
     graph_tier_instance = cls(
       type_=type_,
       memory_mb=memory_mb,
-      databases_per_instance=databases_per_instance,
+      is_multitenant=is_multitenant,
     )
 
     graph_tier_instance.additional_properties = d