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

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

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

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

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

{robosystems_client-0.2.10 → 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.12/robosystems_client/api/billing/cancel_org_subscription.py

@@ -0,0 +1,198 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.graph_subscription_response import GraphSubscriptionResponse
+from ...models.http_validation_error import HTTPValidationError
+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/{org_id}/subscription/{subscription_id}/cancel",
+  }
+
+  return _kwargs
+
+
+def _parse_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
+  if response.status_code == 200:
+    response_200 = GraphSubscriptionResponse.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: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[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(
+  org_id: str,
+  subscription_id: str,
+  *,
+  client: AuthenticatedClient,
+) -> Response[Union[GraphSubscriptionResponse, HTTPValidationError]]:
+  """Cancel Organization 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:
+      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[GraphSubscriptionResponse, HTTPValidationError]]
+  """
+
+  kwargs = _get_kwargs(
+    org_id=org_id,
+    subscription_id=subscription_id,
+  )
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  org_id: str,
+  subscription_id: str,
+  *,
+  client: AuthenticatedClient,
+) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
+  """Cancel Organization 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:
+      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[GraphSubscriptionResponse, HTTPValidationError]
+  """
+
+  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 Organization 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:
+      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[GraphSubscriptionResponse, HTTPValidationError]]
+  """
+
+  kwargs = _get_kwargs(
+    org_id=org_id,
+    subscription_id=subscription_id,
+  )
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  org_id: str,
+  subscription_id: str,
+  *,
+  client: AuthenticatedClient,
+) -> Optional[Union[GraphSubscriptionResponse, HTTPValidationError]]:
+  """Cancel Organization 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:
+      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[GraphSubscriptionResponse, HTTPValidationError]
+  """
+
+  return (
+    await asyncio_detailed(
+      org_id=org_id,
+      subscription_id=subscription_id,
+      client=client,
+    )
+  ).parsed

robosystems_client-0.2.12/robosystems_client/api/billing/create_checkout_session.py

@@ -0,0 +1,238 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.checkout_response import CheckoutResponse
+from ...models.create_checkout_request import CreateCheckoutRequest
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+  *,
+  body: CreateCheckoutRequest,
+) -> dict[str, Any]:
+  headers: dict[str, Any] = {}
+
+  _kwargs: dict[str, Any] = {
+    "method": "post",
+    "url": "/v1/billing/checkout",
+  }
+
+  _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[CheckoutResponse, HTTPValidationError]]:
+  if response.status_code == 201:
+    response_201 = CheckoutResponse.from_dict(response.json())
+
+    return response_201
+
+  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[CheckoutResponse, 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(
+  *,
+  client: AuthenticatedClient,
+  body: CreateCheckoutRequest,
+) -> Response[Union[CheckoutResponse, HTTPValidationError]]:
+  """Create Payment Checkout Session
+
+   Create a Stripe checkout session for collecting payment method.
+
+  This endpoint is used when an organization owner needs to add a payment method before
+  provisioning resources. It creates a pending subscription and redirects
+  to Stripe Checkout to collect payment details.
+
+  **Flow:**
+  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 for the user's org
+  4. Returns Stripe Checkout URL
+  5. User completes payment on Stripe
+  6. Webhook activates subscription and provisions resource
+
+  **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.
+
+  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[CheckoutResponse, HTTPValidationError]]
+  """
+
+  kwargs = _get_kwargs(
+    body=body,
+  )
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  *,
+  client: AuthenticatedClient,
+  body: CreateCheckoutRequest,
+) -> Optional[Union[CheckoutResponse, HTTPValidationError]]:
+  """Create Payment Checkout Session
+
+   Create a Stripe checkout session for collecting payment method.
+
+  This endpoint is used when an organization owner needs to add a payment method before
+  provisioning resources. It creates a pending subscription and redirects
+  to Stripe Checkout to collect payment details.
+
+  **Flow:**
+  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 for the user's org
+  4. Returns Stripe Checkout URL
+  5. User completes payment on Stripe
+  6. Webhook activates subscription and provisions resource
+
+  **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.
+
+  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[CheckoutResponse, HTTPValidationError]
+  """
+
+  return sync_detailed(
+    client=client,
+    body=body,
+  ).parsed
+
+
+async def asyncio_detailed(
+  *,
+  client: AuthenticatedClient,
+  body: CreateCheckoutRequest,
+) -> Response[Union[CheckoutResponse, HTTPValidationError]]:
+  """Create Payment Checkout Session
+
+   Create a Stripe checkout session for collecting payment method.
+
+  This endpoint is used when an organization owner needs to add a payment method before
+  provisioning resources. It creates a pending subscription and redirects
+  to Stripe Checkout to collect payment details.
+
+  **Flow:**
+  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 for the user's org
+  4. Returns Stripe Checkout URL
+  5. User completes payment on Stripe
+  6. Webhook activates subscription and provisions resource
+
+  **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.
+
+  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[CheckoutResponse, HTTPValidationError]]
+  """
+
+  kwargs = _get_kwargs(
+    body=body,
+  )
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  *,
+  client: AuthenticatedClient,
+  body: CreateCheckoutRequest,
+) -> Optional[Union[CheckoutResponse, HTTPValidationError]]:
+  """Create Payment Checkout Session
+
+   Create a Stripe checkout session for collecting payment method.
+
+  This endpoint is used when an organization owner needs to add a payment method before
+  provisioning resources. It creates a pending subscription and redirects
+  to Stripe Checkout to collect payment details.
+
+  **Flow:**
+  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 for the user's org
+  4. Returns Stripe Checkout URL
+  5. User completes payment on Stripe
+  6. Webhook activates subscription and provisions resource
+
+  **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.
+
+  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[CheckoutResponse, HTTPValidationError]
+  """
+
+  return (
+    await asyncio_detailed(
+      client=client,
+      body=body,
+    )
+  ).parsed