hellopivot-sdk 0.1.0__tar.gz

hellopivot_sdk-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+dist/
+*.egg-info/

hellopivot_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: hellopivot-sdk
+Version: 0.1.0
+Summary: Official Python SDK for the Pivot REST API
+Requires-Python: >=3.10
+Requires-Dist: attrs>=25.4.0
+Requires-Dist: httpx<0.29.0,>=0.28.1
+Requires-Dist: python-dateutil<3.0.0,>=2.9.0.post0
+Description-Content-Type: text/markdown
+
+# hellopivot-sdk
+
+Official Python SDK for the Pivot REST API.
+
+This SDK is generated from `apps/rest/openapi.yaml` with
+[`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client).
+To keep hardcoded code to a minimum, nearly all request/response models and endpoint
+functions are generated code.
+
+## Installation
+
+```bash
+pip install hellopivot-sdk
+```
+
+## Quick start
+
+```python
+import os
+
+from hellopivot_sdk import AuthenticatedClient
+from hellopivot_sdk.api.spaces import get_spaces_by_organization_id
+
+client = AuthenticatedClient(
+    base_url="https://api.pivot.app",
+    token=os.environ["PIVOT_API_KEY"],
+)
+
+with client as authenticated_client:
+    response = get_spaces_by_organization_id.sync(
+        organization_id="your-org-id",
+        offset=0,
+        client=authenticated_client,
+    )
+    print(response)
+```
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and
+packaging.
+
+```bash
+cd libs/pivot-python-sdk
+uv sync --group dev
+uv run --group dev python scripts/codegen.py
+uv run --group dev ruff check --select I .
+uv run --group dev pytest
+uv build
+```
+
+## Regenerating from OpenAPI
+
+Run this any time `apps/rest/openapi.yaml` changes:
+
+```bash
+pnpm nx codegen pivot-python-sdk
+```
+
+Generated files live in `libs/pivot-python-sdk/src/hellopivot_sdk/`.
+Do not edit generated files manually.

hellopivot_sdk-0.1.0/README.md

@@ -0,0 +1,61 @@
+# hellopivot-sdk
+
+Official Python SDK for the Pivot REST API.
+
+This SDK is generated from `apps/rest/openapi.yaml` with
+[`openapi-python-client`](https://github.com/openapi-generators/openapi-python-client).
+To keep hardcoded code to a minimum, nearly all request/response models and endpoint
+functions are generated code.
+
+## Installation
+
+```bash
+pip install hellopivot-sdk
+```
+
+## Quick start
+
+```python
+import os
+
+from hellopivot_sdk import AuthenticatedClient
+from hellopivot_sdk.api.spaces import get_spaces_by_organization_id
+
+client = AuthenticatedClient(
+    base_url="https://api.pivot.app",
+    token=os.environ["PIVOT_API_KEY"],
+)
+
+with client as authenticated_client:
+    response = get_spaces_by_organization_id.sync(
+        organization_id="your-org-id",
+        offset=0,
+        client=authenticated_client,
+    )
+    print(response)
+```
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and
+packaging.
+
+```bash
+cd libs/pivot-python-sdk
+uv sync --group dev
+uv run --group dev python scripts/codegen.py
+uv run --group dev ruff check --select I .
+uv run --group dev pytest
+uv build
+```
+
+## Regenerating from OpenAPI
+
+Run this any time `apps/rest/openapi.yaml` changes:
+
+```bash
+pnpm nx codegen pivot-python-sdk
+```
+
+Generated files live in `libs/pivot-python-sdk/src/hellopivot_sdk/`.
+Do not edit generated files manually.

hellopivot_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "hellopivot-sdk"
+version = "0.1.0"
+description = "Official Python SDK for the Pivot REST API"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "attrs>=25.4.0",
+    "httpx>=0.28.1,<0.29.0",
+    "python-dateutil>=2.9.0.post0,<3.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "openapi-python-client>=0.28.1",
+    "pytest>=8.4.2",
+    "pyyaml>=6.0.3",
+    "ruff>=0.15.0",
+]
+
+[build-system]
+requires = ["hatchling>=1.27.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/hellopivot_sdk"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/README.md",
+    "/pyproject.toml",
+    "/src/hellopivot_sdk",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["I"]

hellopivot_sdk-0.1.0/src/hellopivot_sdk/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Pivot REST API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

hellopivot_sdk-0.1.0/src/hellopivot_sdk/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

hellopivot_sdk-0.1.0/src/hellopivot_sdk/api/blocks/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

hellopivot_sdk-0.1.0/src/hellopivot_sdk/api/blocks/create_block_response_attachment.py

@@ -0,0 +1,197 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_block_response_attachment_content import CreateBlockResponseAttachmentContent
+from ...models.create_block_response_attachment_response import CreateBlockResponseAttachmentResponse
+from ...models.status import Status
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    response_id: str,
+    *,
+    body: CreateBlockResponseAttachmentContent,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/blocks/responses/{response_id}/attachments".format(
+            response_id=quote(str(response_id), safe=""),
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CreateBlockResponseAttachmentResponse | Status:
+    if response.status_code == 200:
+        response_200 = CreateBlockResponseAttachmentResponse.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+
+    try:
+        response_default = Status.from_dict(response.json())
+    except ValueError:
+        response_default = Status.from_dict({})
+
+    return response_default
+
+
+def _safe_http_status(code: int) -> int | HTTPStatus:
+    try:
+        return HTTPStatus(code)
+    except ValueError:
+        return code
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[CreateBlockResponseAttachmentResponse | Status]:
+    return Response(
+        status_code=_safe_http_status(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    response_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateBlockResponseAttachmentContent,
+) -> Response[CreateBlockResponseAttachmentResponse | Status]:
+    """Create an attachment for a block response
+
+     Adds a file to a block response.
+
+    Args:
+        response_id (str):
+        body (CreateBlockResponseAttachmentContent):
+
+    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[CreateBlockResponseAttachmentResponse | Status]
+    """
+
+    kwargs = _get_kwargs(
+        response_id=response_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    response_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateBlockResponseAttachmentContent,
+) -> CreateBlockResponseAttachmentResponse | Status | None:
+    """Create an attachment for a block response
+
+     Adds a file to a block response.
+
+    Args:
+        response_id (str):
+        body (CreateBlockResponseAttachmentContent):
+
+    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:
+        CreateBlockResponseAttachmentResponse | Status
+    """
+
+    return sync_detailed(
+        response_id=response_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    response_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateBlockResponseAttachmentContent,
+) -> Response[CreateBlockResponseAttachmentResponse | Status]:
+    """Create an attachment for a block response
+
+     Adds a file to a block response.
+
+    Args:
+        response_id (str):
+        body (CreateBlockResponseAttachmentContent):
+
+    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[CreateBlockResponseAttachmentResponse | Status]
+    """
+
+    kwargs = _get_kwargs(
+        response_id=response_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    response_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateBlockResponseAttachmentContent,
+) -> CreateBlockResponseAttachmentResponse | Status | None:
+    """Create an attachment for a block response
+
+     Adds a file to a block response.
+
+    Args:
+        response_id (str):
+        body (CreateBlockResponseAttachmentContent):
+
+    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:
+        CreateBlockResponseAttachmentResponse | Status
+    """
+
+    return (
+        await asyncio_detailed(
+            response_id=response_id,
+            client=client,
+            body=body,
+        )
+    ).parsed

hellopivot_sdk-0.1.0/src/hellopivot_sdk/api/blocks/create_response_for_block.py

@@ -0,0 +1,197 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_response_for_block_content import CreateResponseForBlockContent
+from ...models.create_response_for_block_response import CreateResponseForBlockResponse
+from ...models.status import Status
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    block_id: str,
+    *,
+    body: CreateResponseForBlockContent,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/blocks/{block_id}/responses".format(
+            block_id=quote(str(block_id), safe=""),
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CreateResponseForBlockResponse | Status:
+    if response.status_code == 200:
+        response_200 = CreateResponseForBlockResponse.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+
+    try:
+        response_default = Status.from_dict(response.json())
+    except ValueError:
+        response_default = Status.from_dict({})
+
+    return response_default
+
+
+def _safe_http_status(code: int) -> int | HTTPStatus:
+    try:
+        return HTTPStatus(code)
+    except ValueError:
+        return code
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[CreateResponseForBlockResponse | Status]:
+    return Response(
+        status_code=_safe_http_status(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    block_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateResponseForBlockContent,
+) -> Response[CreateResponseForBlockResponse | Status]:
+    """Create block response
+
+     Creates a new response for a block.
+
+    Args:
+        block_id (str):
+        body (CreateResponseForBlockContent):
+
+    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[CreateResponseForBlockResponse | Status]
+    """
+
+    kwargs = _get_kwargs(
+        block_id=block_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    block_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateResponseForBlockContent,
+) -> CreateResponseForBlockResponse | Status | None:
+    """Create block response
+
+     Creates a new response for a block.
+
+    Args:
+        block_id (str):
+        body (CreateResponseForBlockContent):
+
+    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:
+        CreateResponseForBlockResponse | Status
+    """
+
+    return sync_detailed(
+        block_id=block_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    block_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateResponseForBlockContent,
+) -> Response[CreateResponseForBlockResponse | Status]:
+    """Create block response
+
+     Creates a new response for a block.
+
+    Args:
+        block_id (str):
+        body (CreateResponseForBlockContent):
+
+    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[CreateResponseForBlockResponse | Status]
+    """
+
+    kwargs = _get_kwargs(
+        block_id=block_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    block_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: CreateResponseForBlockContent,
+) -> CreateResponseForBlockResponse | Status | None:
+    """Create block response
+
+     Creates a new response for a block.
+
+    Args:
+        block_id (str):
+        body (CreateResponseForBlockContent):
+
+    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:
+        CreateResponseForBlockResponse | Status
+    """
+
+    return (
+        await asyncio_detailed(
+            block_id=block_id,
+            client=client,
+            body=body,
+        )
+    ).parsed