robosystems-client 0.2.11__tar.gz → 0.2.12__tar.gz

{robosystems_client-0.2.11 → robosystems_client-0.2.12}/PKG-INFO

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

{robosystems_client-0.2.11 → robosystems_client-0.2.12}/pyproject.toml

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

{robosystems_client-0.2.11 → robosystems_client-0.2.12}/robosystems_client/api/auth/register_user.py

@@ -83,8 +83,15 @@ def sync_detailed(
 ) -> Response[Union[AuthResponse, ErrorResponse, HTTPValidationError]]:
   """Register New User
 
-   Register a new user account with email and password. Security controls vary by environment: CAPTCHA
-  and email verification are disabled in development for API testing, but required in production.
+   Register a new user account with email and password.
+
+  **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal
+  organization is automatically created for you. All resources (graphs, subscriptions, billing) belong
+  to organizations, not individual users. You can later upgrade your personal org to a team or
+  enterprise organization.
+
+  **Security Controls**: CAPTCHA and email verification are disabled in development for API testing,
+  but required in production.
 
   Args:
       body (RegisterRequest): Registration request model.
@@ -115,8 +122,15 @@ def sync(
 ) -> Optional[Union[AuthResponse, ErrorResponse, HTTPValidationError]]:
   """Register New User
 
-   Register a new user account with email and password. Security controls vary by environment: CAPTCHA
-  and email verification are disabled in development for API testing, but required in production.
+   Register a new user account with email and password.
+
+  **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal
+  organization is automatically created for you. All resources (graphs, subscriptions, billing) belong
+  to organizations, not individual users. You can later upgrade your personal org to a team or
+  enterprise organization.
+
+  **Security Controls**: CAPTCHA and email verification are disabled in development for API testing,
+  but required in production.
 
   Args:
       body (RegisterRequest): Registration request model.
@@ -142,8 +156,15 @@ async def asyncio_detailed(
 ) -> Response[Union[AuthResponse, ErrorResponse, HTTPValidationError]]:
   """Register New User
 
-   Register a new user account with email and password. Security controls vary by environment: CAPTCHA
-  and email verification are disabled in development for API testing, but required in production.
+   Register a new user account with email and password.
+
+  **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal
+  organization is automatically created for you. All resources (graphs, subscriptions, billing) belong
+  to organizations, not individual users. You can later upgrade your personal org to a team or
+  enterprise organization.
+
+  **Security Controls**: CAPTCHA and email verification are disabled in development for API testing,
+  but required in production.
 
   Args:
       body (RegisterRequest): Registration request model.
@@ -172,8 +193,15 @@ async def asyncio(
 ) -> Optional[Union[AuthResponse, ErrorResponse, HTTPValidationError]]:
   """Register New User
 
-   Register a new user account with email and password. Security controls vary by environment: CAPTCHA
-  and email verification are disabled in development for API testing, but required in production.
+   Register a new user account with email and password.
+
+  **Organization Creation**: RoboSystems is an org-centric platform. When you register, a personal
+  organization is automatically created for you. All resources (graphs, subscriptions, billing) belong
+  to organizations, not individual users. You can later upgrade your personal org to a team or
+  enterprise organization.
+
+  **Security Controls**: CAPTCHA and email verification are disabled in development for API testing,
+  but required in production.
 
   Args:
       body (RegisterRequest): Registration request model.

robosystems_client-0.2.11/robosystems_client/api/billing/cancel_subscription.py → robosystems_client-0.2.12/robosystems_client/api/billing/cancel_org_subscription.py

@@ -11,11 +11,12 @@ from ...types import Response
 
 
 def _get_kwargs(
+  org_id: str,
   subscription_id: str,
 ) -> dict[str, Any]:
   _kwargs: dict[str, Any] = {
     "method": "post",
-    "url": f"/v1/billing/subscriptions/{subscription_id}/cancel",
+    "url": f"/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}/cancel",
   }
 
   return _kwargs
@@ -52,17 +53,22 @@ def _build_response(
 
 
 def sync_detailed(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Cancel Subscription
+  """Cancel Organization Subscription
 
-   Cancel a subscription.
+   Cancel an organization subscription.
 
   The subscription will remain active until the end of the current billing period.
 
+  **Requirements:**
+  - User must be an OWNER of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -74,6 +80,7 @@ def sync_detailed(
   """
 
   kwargs = _get_kwargs(
+    org_id=org_id,
     subscription_id=subscription_id,
   )
 
@@ -85,17 +92,22 @@ def sync_detailed(
 
 
 def sync(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Cancel Subscription
+  """Cancel Organization Subscription
 
-   Cancel a subscription.
+   Cancel an organization subscription.
 
   The subscription will remain active until the end of the current billing period.
 
+  **Requirements:**
+  - User must be an OWNER of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -107,23 +119,29 @@ def sync(
   """
 
   return sync_detailed(
+    org_id=org_id,
     subscription_id=subscription_id,
     client=client,
   ).parsed
 
 
 async def asyncio_detailed(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Cancel Subscription
+  """Cancel Organization Subscription
 
-   Cancel a subscription.
+   Cancel an organization subscription.
 
   The subscription will remain active until the end of the current billing period.
 
+  **Requirements:**
+  - User must be an OWNER of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -135,6 +153,7 @@ async def asyncio_detailed(
   """
 
   kwargs = _get_kwargs(
+    org_id=org_id,
     subscription_id=subscription_id,
   )
 
@@ -144,17 +163,22 @@ async def asyncio_detailed(
 
 
 async def asyncio(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Cancel Subscription
+  """Cancel Organization Subscription
 
-   Cancel a subscription.
+   Cancel an organization subscription.
 
   The subscription will remain active until the end of the current billing period.
 
+  **Requirements:**
+  - User must be an OWNER of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -167,6 +191,7 @@ async def asyncio(
 
   return (
     await asyncio_detailed(
+      org_id=org_id,
       subscription_id=subscription_id,
       client=client,
     )

{robosystems_client-0.2.11 → robosystems_client-0.2.12}/robosystems_client/api/billing/create_checkout_session.py

@@ -69,19 +69,21 @@ def sync_detailed(
 
    Create a Stripe checkout session for collecting payment method.
 
-  This endpoint is used when a user needs to add a payment method before
+  This endpoint is used when an organization owner needs to add a payment method before
   provisioning resources. It creates a pending subscription and redirects
-  the user to Stripe Checkout to collect payment details.
+  to Stripe Checkout to collect payment details.
 
   **Flow:**
-  1. User tries to create a graph but has no payment method
+  1. Owner tries to create a graph but org has no payment method
   2. Frontend calls this endpoint with graph configuration
-  3. Backend creates a subscription in PENDING_PAYMENT status
+  3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
   4. Returns Stripe Checkout URL
   5. User completes payment on Stripe
   6. Webhook activates subscription and provisions resource
 
-  **Enterprise customers** (with invoice_billing_enabled) should not call this endpoint.
+  **Requirements:**
+  - User must be an OWNER of their organization
+  - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
 
   Args:
       body (CreateCheckoutRequest): Request to create a checkout session for payment collection.
@@ -114,19 +116,21 @@ def sync(
 
    Create a Stripe checkout session for collecting payment method.
 
-  This endpoint is used when a user needs to add a payment method before
+  This endpoint is used when an organization owner needs to add a payment method before
   provisioning resources. It creates a pending subscription and redirects
-  the user to Stripe Checkout to collect payment details.
+  to Stripe Checkout to collect payment details.
 
   **Flow:**
-  1. User tries to create a graph but has no payment method
+  1. Owner tries to create a graph but org has no payment method
   2. Frontend calls this endpoint with graph configuration
-  3. Backend creates a subscription in PENDING_PAYMENT status
+  3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
   4. Returns Stripe Checkout URL
   5. User completes payment on Stripe
   6. Webhook activates subscription and provisions resource
 
-  **Enterprise customers** (with invoice_billing_enabled) should not call this endpoint.
+  **Requirements:**
+  - User must be an OWNER of their organization
+  - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
 
   Args:
       body (CreateCheckoutRequest): Request to create a checkout session for payment collection.
@@ -154,19 +158,21 @@ async def asyncio_detailed(
 
    Create a Stripe checkout session for collecting payment method.
 
-  This endpoint is used when a user needs to add a payment method before
+  This endpoint is used when an organization owner needs to add a payment method before
   provisioning resources. It creates a pending subscription and redirects
-  the user to Stripe Checkout to collect payment details.
+  to Stripe Checkout to collect payment details.
 
   **Flow:**
-  1. User tries to create a graph but has no payment method
+  1. Owner tries to create a graph but org has no payment method
   2. Frontend calls this endpoint with graph configuration
-  3. Backend creates a subscription in PENDING_PAYMENT status
+  3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
   4. Returns Stripe Checkout URL
   5. User completes payment on Stripe
   6. Webhook activates subscription and provisions resource
 
-  **Enterprise customers** (with invoice_billing_enabled) should not call this endpoint.
+  **Requirements:**
+  - User must be an OWNER of their organization
+  - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
 
   Args:
       body (CreateCheckoutRequest): Request to create a checkout session for payment collection.
@@ -197,19 +203,21 @@ async def asyncio(
 
    Create a Stripe checkout session for collecting payment method.
 
-  This endpoint is used when a user needs to add a payment method before
+  This endpoint is used when an organization owner needs to add a payment method before
   provisioning resources. It creates a pending subscription and redirects
-  the user to Stripe Checkout to collect payment details.
+  to Stripe Checkout to collect payment details.
 
   **Flow:**
-  1. User tries to create a graph but has no payment method
+  1. Owner tries to create a graph but org has no payment method
   2. Frontend calls this endpoint with graph configuration
-  3. Backend creates a subscription in PENDING_PAYMENT status
+  3. Backend creates a subscription in PENDING_PAYMENT status for the user's org
   4. Returns Stripe Checkout URL
   5. User completes payment on Stripe
   6. Webhook activates subscription and provisions resource
 
-  **Enterprise customers** (with invoice_billing_enabled) should not call this endpoint.
+  **Requirements:**
+  - User must be an OWNER of their organization
+  - Enterprise customers (with invoice_billing_enabled) should not call this endpoint.
 
   Args:
       body (CreateCheckoutRequest): Request to create a checkout session for payment collection.

robosystems_client-0.2.11/robosystems_client/api/billing/get_billing_customer.py → robosystems_client-0.2.12/robosystems_client/api/billing/get_org_billing_customer.py

@@ -6,13 +6,16 @@ import httpx
 from ... import errors
 from ...client import AuthenticatedClient, Client
 from ...models.billing_customer import BillingCustomer
+from ...models.http_validation_error import HTTPValidationError
 from ...types import Response
 
 
-def _get_kwargs() -> dict[str, Any]:
+def _get_kwargs(
+  org_id: str,
+) -> dict[str, Any]:
   _kwargs: dict[str, Any] = {
     "method": "get",
-    "url": "/v1/billing/customer",
+    "url": f"/v1/billing/customer/{org_id}",
   }
 
   return _kwargs
@@ -20,12 +23,17 @@ def _get_kwargs() -> dict[str, Any]:
 
 def _parse_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[BillingCustomer]:
+) -> Optional[Union[BillingCustomer, HTTPValidationError]]:
   if response.status_code == 200:
     response_200 = BillingCustomer.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:
@@ -34,7 +42,7 @@ def _parse_response(
 
 def _build_response(
   *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[BillingCustomer]:
+) -> Response[Union[BillingCustomer, HTTPValidationError]]:
   return Response(
     status_code=HTTPStatus(response.status_code),
     content=response.content,
@@ -44,24 +52,34 @@ def _build_response(
 
 
 def sync_detailed(
+  org_id: str,
   *,
   client: AuthenticatedClient,
-) -> Response[BillingCustomer]:
-  """Get Customer Info
+) -> Response[Union[BillingCustomer, HTTPValidationError]]:
+  """Get Organization Customer Info
 
-   Get billing customer information including payment methods on file.
+   Get billing customer information for an organization including payment methods on file.
 
   Returns customer details, payment methods, and whether invoice billing is enabled.
 
+  **Requirements:**
+  - User must be a member of the organization
+  - Sensitive payment details are only visible to owners
+
+  Args:
+      org_id (str):
+
   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[BillingCustomer]
+      Response[Union[BillingCustomer, HTTPValidationError]]
   """
 
-  kwargs = _get_kwargs()
+  kwargs = _get_kwargs(
+    org_id=org_id,
+  )
 
   response = client.get_httpx_client().request(
     **kwargs,
@@ -71,47 +89,66 @@ def sync_detailed(
 
 
 def sync(
+  org_id: str,
   *,
   client: AuthenticatedClient,
-) -> Optional[BillingCustomer]:
-  """Get Customer Info
+) -> Optional[Union[BillingCustomer, HTTPValidationError]]:
+  """Get Organization Customer Info
 
-   Get billing customer information including payment methods on file.
+   Get billing customer information for an organization including payment methods on file.
 
   Returns customer details, payment methods, and whether invoice billing is enabled.
 
+  **Requirements:**
+  - User must be a member of the organization
+  - Sensitive payment details are only visible to owners
+
+  Args:
+      org_id (str):
+
   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:
-      BillingCustomer
+      Union[BillingCustomer, HTTPValidationError]
   """
 
   return sync_detailed(
+    org_id=org_id,
     client=client,
   ).parsed
 
 
 async def asyncio_detailed(
+  org_id: str,
   *,
   client: AuthenticatedClient,
-) -> Response[BillingCustomer]:
-  """Get Customer Info
+) -> Response[Union[BillingCustomer, HTTPValidationError]]:
+  """Get Organization Customer Info
 
-   Get billing customer information including payment methods on file.
+   Get billing customer information for an organization including payment methods on file.
 
   Returns customer details, payment methods, and whether invoice billing is enabled.
 
+  **Requirements:**
+  - User must be a member of the organization
+  - Sensitive payment details are only visible to owners
+
+  Args:
+      org_id (str):
+
   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[BillingCustomer]
+      Response[Union[BillingCustomer, HTTPValidationError]]
   """
 
-  kwargs = _get_kwargs()
+  kwargs = _get_kwargs(
+    org_id=org_id,
+  )
 
   response = await client.get_async_httpx_client().request(**kwargs)
 
@@ -119,25 +156,34 @@ async def asyncio_detailed(
 
 
 async def asyncio(
+  org_id: str,
   *,
   client: AuthenticatedClient,
-) -> Optional[BillingCustomer]:
-  """Get Customer Info
+) -> Optional[Union[BillingCustomer, HTTPValidationError]]:
+  """Get Organization Customer Info
 
-   Get billing customer information including payment methods on file.
+   Get billing customer information for an organization including payment methods on file.
 
   Returns customer details, payment methods, and whether invoice billing is enabled.
 
+  **Requirements:**
+  - User must be a member of the organization
+  - Sensitive payment details are only visible to owners
+
+  Args:
+      org_id (str):
+
   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:
-      BillingCustomer
+      Union[BillingCustomer, HTTPValidationError]
   """
 
   return (
     await asyncio_detailed(
+      org_id=org_id,
       client=client,
     )
   ).parsed

robosystems_client-0.2.11/robosystems_client/api/billing/get_subscription.py → robosystems_client-0.2.12/robosystems_client/api/billing/get_org_subscription.py

@@ -11,11 +11,12 @@ from ...types import Response
 
 
 def _get_kwargs(
+  org_id: str,
   subscription_id: str,
 ) -> dict[str, Any]:
   _kwargs: dict[str, Any] = {
     "method": "get",
-    "url": f"/v1/billing/subscriptions/{subscription_id}",
+    "url": f"/v1/billing/subscriptions/{org_id}/subscription/{subscription_id}",
   }
 
   return _kwargs
@@ -52,15 +53,20 @@ def _build_response(
 
 
 def sync_detailed(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Get Subscription Details
+  """Get Organization Subscription Details
 
    Get detailed information about a specific subscription.
 
+  **Requirements:**
+  - User must be a member of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -72,6 +78,7 @@ def sync_detailed(
   """
 
   kwargs = _get_kwargs(
+    org_id=org_id,
     subscription_id=subscription_id,
   )
 
@@ -83,15 +90,20 @@ def sync_detailed(
 
 
 def sync(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Get Subscription Details
+  """Get Organization Subscription Details
 
    Get detailed information about a specific subscription.
 
+  **Requirements:**
+  - User must be a member of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -103,21 +115,27 @@ def sync(
   """
 
   return sync_detailed(
+    org_id=org_id,
     subscription_id=subscription_id,
     client=client,
   ).parsed
 
 
 async def asyncio_detailed(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Response[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Get Subscription Details
+  """Get Organization Subscription Details
 
    Get detailed information about a specific subscription.
 
+  **Requirements:**
+  - User must be a member of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -129,6 +147,7 @@ async def asyncio_detailed(
   """
 
   kwargs = _get_kwargs(
+    org_id=org_id,
     subscription_id=subscription_id,
   )
 
@@ -138,15 +157,20 @@ async def asyncio_detailed(
 
 
 async def asyncio(
+  org_id: str,
   subscription_id: str,
   *,
   client: AuthenticatedClient,
 ) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
-  """Get Subscription Details
+  """Get Organization Subscription Details
 
    Get detailed information about a specific subscription.
 
+  **Requirements:**
+  - User must be a member of the organization
+
   Args:
+      org_id (str):
       subscription_id (str):
 
   Raises:
@@ -159,6 +183,7 @@ async def asyncio(
 
   return (
     await asyncio_detailed(
+      org_id=org_id,
       subscription_id=subscription_id,
       client=client,
     )