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

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

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

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

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

robosystems_client-0.2.10/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/api/user_subscriptions/cancel_shared_repository_subscription.py → robosystems_client-0.2.10/robosystems_client/api/subscriptions/cancel_subscription.py

@@ -11,11 +11,11 @@ from ...types import Response
 
 
 def _get_kwargs(
-  subscription_id: str,
+  graph_id: str,
 ) -> dict[str, Any]:
   _kwargs: dict[str, Any] = {
     "method": "delete",
-    "url": f"/v1/user/subscriptions/shared-repositories/{subscription_id}",
+    "url": f"/v1/graphs/{graph_id}/subscriptions",
   }
 
   return _kwargs
@@ -29,9 +29,9 @@ def _parse_response(
 
     return response_200
 
-  if response.status_code == 401:
-    response_401 = cast(Any, None)
-    return response_401
+  if response.status_code == 400:
+    response_400 = cast(Any, None)
+    return response_400
 
   if response.status_code == 404:
     response_404 = cast(Any, None)
@@ -42,10 +42,6 @@ def _parse_response(
 
     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)
   else:
@@ -64,16 +60,21 @@ def _build_response(
 
 
 def sync_detailed(
-  subscription_id: str,
+  graph_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[Any, CancellationResponse, HTTPValidationError]]:
   """Cancel Subscription
 
-   Cancel a shared repository subscription and disable associated credit pool
+   Cancel a subscription.
+
+  For shared repositories: Cancels the user's personal subscription
+  For user graphs: Not allowed - delete the graph instead
+
+  The subscription will be marked as canceled and will end at the current period end date.
 
   Args:
-      subscription_id (str):
+      graph_id (str): Graph ID or repository name
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -84,7 +85,7 @@ def sync_detailed(
   """
 
   kwargs = _get_kwargs(
-    subscription_id=subscription_id,
+    graph_id=graph_id,
   )
 
   response = client.get_httpx_client().request(
@@ -95,16 +96,21 @@ def sync_detailed(
 
 
 def sync(
-  subscription_id: str,
+  graph_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[Any, CancellationResponse, HTTPValidationError]]:
   """Cancel Subscription
 
-   Cancel a shared repository subscription and disable associated credit pool
+   Cancel a subscription.
+
+  For shared repositories: Cancels the user's personal subscription
+  For user graphs: Not allowed - delete the graph instead
+
+  The subscription will be marked as canceled and will end at the current period end date.
 
   Args:
-      subscription_id (str):
+      graph_id (str): Graph ID or repository name
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -115,22 +121,27 @@ def sync(
   """
 
   return sync_detailed(
-    subscription_id=subscription_id,
+    graph_id=graph_id,
     client=client,
   ).parsed
 
 
 async def asyncio_detailed(
-  subscription_id: str,
+  graph_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[Any, CancellationResponse, HTTPValidationError]]:
   """Cancel Subscription
 
-   Cancel a shared repository subscription and disable associated credit pool
+   Cancel a subscription.
+
+  For shared repositories: Cancels the user's personal subscription
+  For user graphs: Not allowed - delete the graph instead
+
+  The subscription will be marked as canceled and will end at the current period end date.
 
   Args:
-      subscription_id (str):
+      graph_id (str): Graph ID or repository name
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -141,7 +152,7 @@ async def asyncio_detailed(
   """
 
   kwargs = _get_kwargs(
-    subscription_id=subscription_id,
+    graph_id=graph_id,
   )
 
   response = await client.get_async_httpx_client().request(**kwargs)
@@ -150,16 +161,21 @@ async def asyncio_detailed(
 
 
 async def asyncio(
-  subscription_id: str,
+  graph_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[Any, CancellationResponse, HTTPValidationError]]:
   """Cancel Subscription
 
-   Cancel a shared repository subscription and disable associated credit pool
+   Cancel a subscription.
+
+  For shared repositories: Cancels the user's personal subscription
+  For user graphs: Not allowed - delete the graph instead
+
+  The subscription will be marked as canceled and will end at the current period end date.
 
   Args:
-      subscription_id (str):
+      graph_id (str): Graph ID or repository name
 
   Raises:
       errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -171,7 +187,7 @@ async def asyncio(
 
   return (
     await asyncio_detailed(
-      subscription_id=subscription_id,
+      graph_id=graph_id,
       client=client,
     )
   ).parsed

robosystems_client-0.2.10/robosystems_client/api/subscriptions/create_repository_subscription.py

@@ -0,0 +1,217 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_repository_subscription_request import (
+  CreateRepositorySubscriptionRequest,
+)
+from ...models.graph_subscription_response import GraphSubscriptionResponse
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: CreateRepositorySubscriptionRequest,
+) -> dict[str, Any]:
+  headers: dict[str, Any] = {}
+
+  _kwargs: dict[str, Any] = {
+    "method": "post",
+    "url": f"/v1/graphs/{graph_id}/subscriptions",
+  }
+
+  _kwargs["json"] = body.to_dict()
+
+  headers["Content-Type"] = "application/json"
+
+  _kwargs["headers"] = headers
+  return _kwargs
+
+
+def _parse_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  if response.status_code == 201:
+    response_201 = GraphSubscriptionResponse.from_dict(response.json())
+
+    return response_201
+
+  if response.status_code == 400:
+    response_400 = cast(Any, None)
+    return response_400
+
+  if response.status_code == 409:
+    response_409 = cast(Any, None)
+    return response_409
+
+  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: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  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: CreateRepositorySubscriptionRequest,
+) -> Response[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  """Create Repository Subscription
+
+   Create a new subscription to a shared repository.
+
+  This endpoint is ONLY for shared repositories (sec, industry, economic).
+  User graph subscriptions are created automatically when the graph is provisioned.
+
+  The subscription will be created in ACTIVE status immediately and credits will be allocated.
+
+  Args:
+      graph_id (str): Repository name (e.g., 'sec', 'industry')
+      body (CreateRepositorySubscriptionRequest): Request to create a repository subscription.
+
+  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, GraphSubscriptionResponse, HTTPValidationError]]
+  """
+
+  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: CreateRepositorySubscriptionRequest,
+) -> Optional[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  """Create Repository Subscription
+
+   Create a new subscription to a shared repository.
+
+  This endpoint is ONLY for shared repositories (sec, industry, economic).
+  User graph subscriptions are created automatically when the graph is provisioned.
+
+  The subscription will be created in ACTIVE status immediately and credits will be allocated.
+
+  Args:
+      graph_id (str): Repository name (e.g., 'sec', 'industry')
+      body (CreateRepositorySubscriptionRequest): Request to create a repository subscription.
+
+  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, GraphSubscriptionResponse, HTTPValidationError]
+  """
+
+  return sync_detailed(
+    graph_id=graph_id,
+    client=client,
+    body=body,
+  ).parsed
+
+
+async def asyncio_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: CreateRepositorySubscriptionRequest,
+) -> Response[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  """Create Repository Subscription
+
+   Create a new subscription to a shared repository.
+
+  This endpoint is ONLY for shared repositories (sec, industry, economic).
+  User graph subscriptions are created automatically when the graph is provisioned.
+
+  The subscription will be created in ACTIVE status immediately and credits will be allocated.
+
+  Args:
+      graph_id (str): Repository name (e.g., 'sec', 'industry')
+      body (CreateRepositorySubscriptionRequest): Request to create a repository subscription.
+
+  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, GraphSubscriptionResponse, HTTPValidationError]]
+  """
+
+  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: CreateRepositorySubscriptionRequest,
+) -> Optional[Union[Any, GraphSubscriptionResponse, HTTPValidationError]]:
+  """Create Repository Subscription
+
+   Create a new subscription to a shared repository.
+
+  This endpoint is ONLY for shared repositories (sec, industry, economic).
+  User graph subscriptions are created automatically when the graph is provisioned.
+
+  The subscription will be created in ACTIVE status immediately and credits will be allocated.
+
+  Args:
+      graph_id (str): Repository name (e.g., 'sec', 'industry')
+      body (CreateRepositorySubscriptionRequest): Request to create a repository subscription.
+
+  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, GraphSubscriptionResponse, HTTPValidationError]
+  """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+    )
+  ).parsed