robosystems-client 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

robosystems_client/api/graphs/get_graphs.py

@@ -1,57 +1,34 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union
+from typing import Any, Optional, Union, cast
 
 import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.http_validation_error import HTTPValidationError
 from ...models.user_graphs_response import UserGraphsResponse
-from ...types import UNSET, Response, Unset
+from ...types import Response
 
 
-def _get_kwargs(
-  *,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> dict[str, Any]:
-  headers: dict[str, Any] = {}
-  if not isinstance(authorization, Unset):
-    headers["authorization"] = authorization
-
-  params: dict[str, Any] = {}
-
-  json_token: Union[None, Unset, str]
-  if isinstance(token, Unset):
-    json_token = UNSET
-  else:
-    json_token = token
-  params["token"] = json_token
-
-  params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
-
+def _get_kwargs() -> dict[str, Any]:
   _kwargs: dict[str, Any] = {
     "method": "get",
     "url": "/v1/graphs",
-    "params": params,
   }
 
-  _kwargs["headers"] = headers
   return _kwargs
 
 
 def _parse_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[HTTPValidationError, UserGraphsResponse]]:
+) -> Optional[Union[Any, UserGraphsResponse]]:
   if response.status_code == 200:
     response_200 = UserGraphsResponse.from_dict(response.json())
 
     return response_200
 
-  if response.status_code == 422:
-    response_422 = HTTPValidationError.from_dict(response.json())
-
-    return response_422
+  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)
@@ -61,7 +38,7 @@ def _parse_response(
 
 def _build_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[HTTPValidationError, UserGraphsResponse]]:
+) -> Response[Union[Any, UserGraphsResponse]]:
   return Response(
     status_code=HTTPStatus(response.status_code),
     content=response.content,
@@ -73,29 +50,53 @@ def _build_response(
 def sync_detailed(
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Response[Union[HTTPValidationError, UserGraphsResponse]]:
-  """Get User Graphs
+) -> Response[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs
+
+   List all graph databases accessible to the current user with roles and selection status.
+
+  Returns a comprehensive list of all graphs the user can access, including their
+  role in each graph (admin or member) and which graph is currently selected as
+  the active workspace.
+
+  **Returned Information:**
+  - Graph ID and display name for each accessible graph
+  - User's role (admin/member) indicating permission level
+  - Selection status (one graph can be marked as \"selected\")
+  - Creation timestamp for each graph
 
-   Get all graph databases accessible to the current user.
+  **Graph Roles:**
+  - `admin`: Full access - can manage graph settings, invite users, delete graph
+  - `member`: Read/write access - can query and modify data, cannot manage settings
 
-  Args:
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace. Many API operations
+  default to the selected graph if no graph_id is provided. Users can change their
+  selected graph via the `POST /v1/graphs/{graph_id}/select` endpoint.
+
+  **Use Cases:**
+  - Display graph selector in UI
+  - Show user's accessible workspaces
+  - Identify which graph is currently active
+  - Filter graphs by role for permission-based features
+
+  **Empty Response:**
+  New users or users without graph access will receive an empty list with
+  `selectedGraphId: null`. Users should create a new graph or request access
+  to an existing graph.
+
+  **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[HTTPValidationError, UserGraphsResponse]]
+      Response[Union[Any, UserGraphsResponse]]
   """
 
-  kwargs = _get_kwargs(
-    token=token,
-    authorization=authorization,
-  )
+  kwargs = _get_kwargs()
 
   response = client.get_httpx_client().request(
     **kwargs,
@@ -107,58 +108,107 @@ def sync_detailed(
 def sync(
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Optional[Union[HTTPValidationError, UserGraphsResponse]]:
-  """Get User Graphs
+) -> Optional[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs
+
+   List all graph databases accessible to the current user with roles and selection status.
+
+  Returns a comprehensive list of all graphs the user can access, including their
+  role in each graph (admin or member) and which graph is currently selected as
+  the active workspace.
+
+  **Returned Information:**
+  - Graph ID and display name for each accessible graph
+  - User's role (admin/member) indicating permission level
+  - Selection status (one graph can be marked as \"selected\")
+  - Creation timestamp for each graph
+
+  **Graph Roles:**
+  - `admin`: Full access - can manage graph settings, invite users, delete graph
+  - `member`: Read/write access - can query and modify data, cannot manage settings
 
-   Get all graph databases accessible to the current user.
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace. Many API operations
+  default to the selected graph if no graph_id is provided. Users can change their
+  selected graph via the `POST /v1/graphs/{graph_id}/select` endpoint.
 
-  Args:
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+  **Use Cases:**
+  - Display graph selector in UI
+  - Show user's accessible workspaces
+  - Identify which graph is currently active
+  - Filter graphs by role for permission-based features
+
+  **Empty Response:**
+  New users or users without graph access will receive an empty list with
+  `selectedGraphId: null`. Users should create a new graph or request access
+  to an existing graph.
+
+  **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[HTTPValidationError, UserGraphsResponse]
+      Union[Any, UserGraphsResponse]
   """
 
   return sync_detailed(
     client=client,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
 async def asyncio_detailed(
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Response[Union[HTTPValidationError, UserGraphsResponse]]:
-  """Get User Graphs
+) -> Response[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs
+
+   List all graph databases accessible to the current user with roles and selection status.
+
+  Returns a comprehensive list of all graphs the user can access, including their
+  role in each graph (admin or member) and which graph is currently selected as
+  the active workspace.
+
+  **Returned Information:**
+  - Graph ID and display name for each accessible graph
+  - User's role (admin/member) indicating permission level
+  - Selection status (one graph can be marked as \"selected\")
+  - Creation timestamp for each graph
+
+  **Graph Roles:**
+  - `admin`: Full access - can manage graph settings, invite users, delete graph
+  - `member`: Read/write access - can query and modify data, cannot manage settings
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace. Many API operations
+  default to the selected graph if no graph_id is provided. Users can change their
+  selected graph via the `POST /v1/graphs/{graph_id}/select` endpoint.
+
+  **Use Cases:**
+  - Display graph selector in UI
+  - Show user's accessible workspaces
+  - Identify which graph is currently active
+  - Filter graphs by role for permission-based features
 
-   Get all graph databases accessible to the current user.
+  **Empty Response:**
+  New users or users without graph access will receive an empty list with
+  `selectedGraphId: null`. Users should create a new graph or request access
+  to an existing graph.
 
-  Args:
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+  **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[HTTPValidationError, UserGraphsResponse]]
+      Response[Union[Any, UserGraphsResponse]]
   """
 
-  kwargs = _get_kwargs(
-    token=token,
-    authorization=authorization,
-  )
+  kwargs = _get_kwargs()
 
   response = await client.get_async_httpx_client().request(**kwargs)
 
@@ -168,29 +218,54 @@ async def asyncio_detailed(
 async def asyncio(
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
-) -> Optional[Union[HTTPValidationError, UserGraphsResponse]]:
-  """Get User Graphs
+) -> Optional[Union[Any, UserGraphsResponse]]:
+  r"""Get User Graphs
+
+   List all graph databases accessible to the current user with roles and selection status.
+
+  Returns a comprehensive list of all graphs the user can access, including their
+  role in each graph (admin or member) and which graph is currently selected as
+  the active workspace.
+
+  **Returned Information:**
+  - Graph ID and display name for each accessible graph
+  - User's role (admin/member) indicating permission level
+  - Selection status (one graph can be marked as \"selected\")
+  - Creation timestamp for each graph
+
+  **Graph Roles:**
+  - `admin`: Full access - can manage graph settings, invite users, delete graph
+  - `member`: Read/write access - can query and modify data, cannot manage settings
+
+  **Selected Graph Concept:**
+  The \"selected\" graph is the user's currently active workspace. Many API operations
+  default to the selected graph if no graph_id is provided. Users can change their
+  selected graph via the `POST /v1/graphs/{graph_id}/select` endpoint.
+
+  **Use Cases:**
+  - Display graph selector in UI
+  - Show user's accessible workspaces
+  - Identify which graph is currently active
+  - Filter graphs by role for permission-based features
 
-   Get all graph databases accessible to the current user.
+  **Empty Response:**
+  New users or users without graph access will receive an empty list with
+  `selectedGraphId: null`. Users should create a new graph or request access
+  to an existing graph.
 
-  Args:
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
+  **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[HTTPValidationError, UserGraphsResponse]
+      Union[Any, UserGraphsResponse]
   """
 
   return (
     await asyncio_detailed(
       client=client,
-      token=token,
-      authorization=authorization,
     )
   ).parsed

robosystems_client/api/graphs/select_graph.py

@@ -8,37 +8,17 @@ from ...client import AuthenticatedClient, Client
 from ...models.error_response import ErrorResponse
 from ...models.http_validation_error import HTTPValidationError
 from ...models.success_response import SuccessResponse
-from ...types import UNSET, Response, Unset
+from ...types import Response
 
 
 def _get_kwargs(
   graph_id: str,
-  *,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> dict[str, Any]:
-  headers: dict[str, Any] = {}
-  if not isinstance(authorization, Unset):
-    headers["authorization"] = authorization
-
-  params: dict[str, Any] = {}
-
-  json_token: Union[None, Unset, str]
-  if isinstance(token, Unset):
-    json_token = UNSET
-  else:
-    json_token = token
-  params["token"] = json_token
-
-  params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
-
   _kwargs: dict[str, Any] = {
     "method": "post",
     "url": f"/v1/graphs/{graph_id}/select",
-    "params": params,
   }
 
-  _kwargs["headers"] = headers
   return _kwargs
 
 
@@ -91,17 +71,41 @@ def sync_detailed(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[ErrorResponse, HTTPValidationError, SuccessResponse]]:
   """Select Graph
 
-   Select a specific graph as the active graph for the user.
+   Select a specific graph as the active workspace for the user.
+
+  The selected graph becomes the default context for operations in client applications
+  and can be used to maintain user workspace preferences across sessions.
+
+  **Functionality:**
+  - Sets the specified graph as the user's currently selected graph
+  - Deselects any previously selected graph (only one can be selected at a time)
+  - Persists selection across sessions until changed
+  - Returns confirmation with the selected graph ID
+
+  **Requirements:**
+  - User must have access to the graph (as admin or member)
+  - Graph must exist and not be deleted
+  - User can only select graphs they have permission to access
+
+  **Use Cases:**
+  - Switch between multiple graphs in a multi-graph environment
+  - Set default workspace after creating a new graph
+  - Restore user's preferred workspace on login
+  - Support graph context switching in client applications
+
+  **Client Integration:**
+  Many client operations can default to the selected graph, simplifying API calls
+  by eliminating the need to specify graph_id repeatedly. Check the selected
+  graph with `GET /v1/graphs` which returns `selectedGraphId`.
+
+  **Note:**
+  Graph selection is included - no credit consumption required.
 
   Args:
       graph_id (str):
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -113,8 +117,6 @@ def sync_detailed(
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    token=token,
-    authorization=authorization,
   )
 
   response = client.get_httpx_client().request(
@@ -128,17 +130,41 @@ def sync(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[ErrorResponse, HTTPValidationError, SuccessResponse]]:
   """Select Graph
 
-   Select a specific graph as the active graph for the user.
+   Select a specific graph as the active workspace for the user.
+
+  The selected graph becomes the default context for operations in client applications
+  and can be used to maintain user workspace preferences across sessions.
+
+  **Functionality:**
+  - Sets the specified graph as the user's currently selected graph
+  - Deselects any previously selected graph (only one can be selected at a time)
+  - Persists selection across sessions until changed
+  - Returns confirmation with the selected graph ID
+
+  **Requirements:**
+  - User must have access to the graph (as admin or member)
+  - Graph must exist and not be deleted
+  - User can only select graphs they have permission to access
+
+  **Use Cases:**
+  - Switch between multiple graphs in a multi-graph environment
+  - Set default workspace after creating a new graph
+  - Restore user's preferred workspace on login
+  - Support graph context switching in client applications
+
+  **Client Integration:**
+  Many client operations can default to the selected graph, simplifying API calls
+  by eliminating the need to specify graph_id repeatedly. Check the selected
+  graph with `GET /v1/graphs` which returns `selectedGraphId`.
+
+  **Note:**
+  Graph selection is included - no credit consumption required.
 
   Args:
       graph_id (str):
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -151,8 +177,6 @@ def sync(
   return sync_detailed(
     graph_id=graph_id,
     client=client,
-    token=token,
-    authorization=authorization,
   ).parsed
 
 
@@ -160,17 +184,41 @@ async def asyncio_detailed(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Response[Union[ErrorResponse, HTTPValidationError, SuccessResponse]]:
   """Select Graph
 
-   Select a specific graph as the active graph for the user.
+   Select a specific graph as the active workspace for the user.
+
+  The selected graph becomes the default context for operations in client applications
+  and can be used to maintain user workspace preferences across sessions.
+
+  **Functionality:**
+  - Sets the specified graph as the user's currently selected graph
+  - Deselects any previously selected graph (only one can be selected at a time)
+  - Persists selection across sessions until changed
+  - Returns confirmation with the selected graph ID
+
+  **Requirements:**
+  - User must have access to the graph (as admin or member)
+  - Graph must exist and not be deleted
+  - User can only select graphs they have permission to access
+
+  **Use Cases:**
+  - Switch between multiple graphs in a multi-graph environment
+  - Set default workspace after creating a new graph
+  - Restore user's preferred workspace on login
+  - Support graph context switching in client applications
+
+  **Client Integration:**
+  Many client operations can default to the selected graph, simplifying API calls
+  by eliminating the need to specify graph_id repeatedly. Check the selected
+  graph with `GET /v1/graphs` which returns `selectedGraphId`.
+
+  **Note:**
+  Graph selection is included - no credit consumption required.
 
   Args:
       graph_id (str):
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -182,8 +230,6 @@ async def asyncio_detailed(
 
   kwargs = _get_kwargs(
     graph_id=graph_id,
-    token=token,
-    authorization=authorization,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -195,17 +241,41 @@ async def asyncio(
   graph_id: str,
   *,
   client: AuthenticatedClient,
-  token: Union[None, Unset, str] = UNSET,
-  authorization: Union[None, Unset, str] = UNSET,
 ) -> Optional[Union[ErrorResponse, HTTPValidationError, SuccessResponse]]:
   """Select Graph
 
-   Select a specific graph as the active graph for the user.
+   Select a specific graph as the active workspace for the user.
+
+  The selected graph becomes the default context for operations in client applications
+  and can be used to maintain user workspace preferences across sessions.
+
+  **Functionality:**
+  - Sets the specified graph as the user's currently selected graph
+  - Deselects any previously selected graph (only one can be selected at a time)
+  - Persists selection across sessions until changed
+  - Returns confirmation with the selected graph ID
+
+  **Requirements:**
+  - User must have access to the graph (as admin or member)
+  - Graph must exist and not be deleted
+  - User can only select graphs they have permission to access
+
+  **Use Cases:**
+  - Switch between multiple graphs in a multi-graph environment
+  - Set default workspace after creating a new graph
+  - Restore user's preferred workspace on login
+  - Support graph context switching in client applications
+
+  **Client Integration:**
+  Many client operations can default to the selected graph, simplifying API calls
+  by eliminating the need to specify graph_id repeatedly. Check the selected
+  graph with `GET /v1/graphs` which returns `selectedGraphId`.
+
+  **Note:**
+  Graph selection is included - no credit consumption required.
 
   Args:
       graph_id (str):
-      token (Union[None, Unset, str]): JWT token for SSE authentication
-      authorization (Union[None, Unset, str]):
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -219,7 +289,5 @@ async def asyncio(
     await asyncio_detailed(
       graph_id=graph_id,
       client=client,
-      token=token,
-      authorization=authorization,
     )
   ).parsed