hellopivot-sdk 0.1.4__tar.gz → 0.1.6__tar.gz

{hellopivot_sdk-0.1.4 → hellopivot_sdk-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hellopivot-sdk
-Version: 0.1.4
+Version: 0.1.6
 Summary: Official Python SDK for the Pivot REST API
 Requires-Python: >=3.10
 Requires-Dist: attrs>=25.4.0
@@ -28,7 +28,7 @@ pip install hellopivot-sdk
 import os
 
 from hellopivot_sdk import AuthenticatedClient
-from hellopivot_sdk.api.spaces import get_spaces_by_organization_id
+from hellopivot_sdk.api.spaces import get_spaces_by_organization_id_v2
 
 client = AuthenticatedClient(
     base_url="https://api.pivot.app",
@@ -36,9 +36,9 @@ client = AuthenticatedClient(
 )
 
 with client as authenticated_client:
-    response = get_spaces_by_organization_id.sync(
+    response = get_spaces_by_organization_id_v2.sync(
         organization_id="your-org-id",
-        offset=0,
+        limit=100,
         client=authenticated_client,
     )
     print(response)

{hellopivot_sdk-0.1.4 → hellopivot_sdk-0.1.6}/README.md

@@ -18,7 +18,7 @@ pip install hellopivot-sdk
 import os
 
 from hellopivot_sdk import AuthenticatedClient
-from hellopivot_sdk.api.spaces import get_spaces_by_organization_id
+from hellopivot_sdk.api.spaces import get_spaces_by_organization_id_v2
 
 client = AuthenticatedClient(
     base_url="https://api.pivot.app",
@@ -26,9 +26,9 @@ client = AuthenticatedClient(
 )
 
 with client as authenticated_client:
-    response = get_spaces_by_organization_id.sync(
+    response = get_spaces_by_organization_id_v2.sync(
         organization_id="your-org-id",
-        offset=0,
+        limit=100,
         client=authenticated_client,
     )
     print(response)

{hellopivot_sdk-0.1.4 → hellopivot_sdk-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hellopivot-sdk"
-version = "0.1.4"
+version = "0.1.6"
 description = "Official Python SDK for the Pivot REST API"
 readme = "README.md"
 requires-python = ">=3.10"

{hellopivot_sdk-0.1.4 → hellopivot_sdk-0.1.6}/src/hellopivot_sdk/api/blocks/get_block_by_id.py

@@ -8,18 +8,27 @@ from ... import errors
 from ...client import AuthenticatedClient, Client
 from ...models.get_block_by_id_response import GetBlockByIdResponse
 from ...models.status import Status
-from ...types import UNSET, Response
+from ...types import UNSET, Response, Unset
 
 
 def _get_kwargs(
     block_id: str,
+    *,
+    include_descendants: bool | Unset = UNSET,
 ) -> dict[str, Any]:
 
+    params: dict[str, Any] = {}
+
+    params["includeDescendants"] = include_descendants
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
     _kwargs: dict[str, Any] = {
         "method": "get",
         "url": "/v1/blocks/{block_id}".format(
             block_id=quote(str(block_id), safe=""),
         ),
+        "params": params,
     }
 
     return _kwargs
@@ -64,13 +73,16 @@ def sync_detailed(
     block_id: str,
     *,
     client: AuthenticatedClient | Client,
+    include_descendants: bool | Unset = UNSET,
 ) -> Response[GetBlockByIdResponse | Status]:
     """Get block
 
-     Returns a block by ID.
+     Returns a block by ID. Set includeDescendants to return all visible descendants in the descendants
+    field.
 
     Args:
         block_id (str):
+        include_descendants (bool | Unset):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -82,6 +94,7 @@ def sync_detailed(
 
     kwargs = _get_kwargs(
         block_id=block_id,
+        include_descendants=include_descendants,
     )
 
     response = client.get_httpx_client().request(
@@ -95,13 +108,16 @@ def sync(
     block_id: str,
     *,
     client: AuthenticatedClient | Client,
+    include_descendants: bool | Unset = UNSET,
 ) -> GetBlockByIdResponse | Status | None:
     """Get block
 
-     Returns a block by ID.
+     Returns a block by ID. Set includeDescendants to return all visible descendants in the descendants
+    field.
 
     Args:
         block_id (str):
+        include_descendants (bool | Unset):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -114,6 +130,7 @@ def sync(
     return sync_detailed(
         block_id=block_id,
         client=client,
+        include_descendants=include_descendants,
     ).parsed
 
 
@@ -121,13 +138,16 @@ async def asyncio_detailed(
     block_id: str,
     *,
     client: AuthenticatedClient | Client,
+    include_descendants: bool | Unset = UNSET,
 ) -> Response[GetBlockByIdResponse | Status]:
     """Get block
 
-     Returns a block by ID.
+     Returns a block by ID. Set includeDescendants to return all visible descendants in the descendants
+    field.
 
     Args:
         block_id (str):
+        include_descendants (bool | Unset):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -139,6 +159,7 @@ async def asyncio_detailed(
 
     kwargs = _get_kwargs(
         block_id=block_id,
+        include_descendants=include_descendants,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -150,13 +171,16 @@ async def asyncio(
     block_id: str,
     *,
     client: AuthenticatedClient | Client,
+    include_descendants: bool | Unset = UNSET,
 ) -> GetBlockByIdResponse | Status | None:
     """Get block
 
-     Returns a block by ID.
+     Returns a block by ID. Set includeDescendants to return all visible descendants in the descendants
+    field.
 
     Args:
         block_id (str):
+        include_descendants (bool | Unset):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -170,5 +194,6 @@ async def asyncio(
         await asyncio_detailed(
             block_id=block_id,
             client=client,
+            include_descendants=include_descendants,
         )
     ).parsed

hellopivot_sdk-0.1.6/src/hellopivot_sdk/api/blocks/update_block.py

@@ -0,0 +1,227 @@
+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.status import Status
+from ...models.update_block_content import UpdateBlockContent
+from ...models.update_block_response import UpdateBlockResponse
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    block_id: str,
+    *,
+    body: UpdateBlockContent,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "patch",
+        "url": "/v1/blocks/{block_id}".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) -> Status | UpdateBlockResponse:
+    if response.status_code == 200:
+        response_200 = UpdateBlockResponse.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, TypeError):
+        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[Status | UpdateBlockResponse]:
+    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: UpdateBlockContent,
+) -> Response[Status | UpdateBlockResponse]:
+    """Update a block
+
+     Applies a partial update to a block, changing exactly one property per request. Currently supports
+    hiding and unhiding: a block is hidden once `hide_after` has passed and shown again once
+    `unhide_after` has passed. To hide a block immediately set `hide_after` to the current time; to show
+    it again set `unhide_after` to the current time. Exactly one field must be provided.
+
+    Args:
+        block_id (str):
+        body (UpdateBlockContent): Partial update for a block. Exactly one block property is
+            changed per
+             request, mapped to the corresponding property via the underlying
+             UpdateBlockProperty RPC, so a single PATCH applies one property atomically.
+             More block properties will be added to this oneof over time; today only
+             hide/unhide are supported.
+
+    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[Status | UpdateBlockResponse]
+    """
+
+    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: UpdateBlockContent,
+) -> Status | UpdateBlockResponse | None:
+    """Update a block
+
+     Applies a partial update to a block, changing exactly one property per request. Currently supports
+    hiding and unhiding: a block is hidden once `hide_after` has passed and shown again once
+    `unhide_after` has passed. To hide a block immediately set `hide_after` to the current time; to show
+    it again set `unhide_after` to the current time. Exactly one field must be provided.
+
+    Args:
+        block_id (str):
+        body (UpdateBlockContent): Partial update for a block. Exactly one block property is
+            changed per
+             request, mapped to the corresponding property via the underlying
+             UpdateBlockProperty RPC, so a single PATCH applies one property atomically.
+             More block properties will be added to this oneof over time; today only
+             hide/unhide are supported.
+
+    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:
+        Status | UpdateBlockResponse
+    """
+
+    return sync_detailed(
+        block_id=block_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    block_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    body: UpdateBlockContent,
+) -> Response[Status | UpdateBlockResponse]:
+    """Update a block
+
+     Applies a partial update to a block, changing exactly one property per request. Currently supports
+    hiding and unhiding: a block is hidden once `hide_after` has passed and shown again once
+    `unhide_after` has passed. To hide a block immediately set `hide_after` to the current time; to show
+    it again set `unhide_after` to the current time. Exactly one field must be provided.
+
+    Args:
+        block_id (str):
+        body (UpdateBlockContent): Partial update for a block. Exactly one block property is
+            changed per
+             request, mapped to the corresponding property via the underlying
+             UpdateBlockProperty RPC, so a single PATCH applies one property atomically.
+             More block properties will be added to this oneof over time; today only
+             hide/unhide are supported.
+
+    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[Status | UpdateBlockResponse]
+    """
+
+    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: UpdateBlockContent,
+) -> Status | UpdateBlockResponse | None:
+    """Update a block
+
+     Applies a partial update to a block, changing exactly one property per request. Currently supports
+    hiding and unhiding: a block is hidden once `hide_after` has passed and shown again once
+    `unhide_after` has passed. To hide a block immediately set `hide_after` to the current time; to show
+    it again set `unhide_after` to the current time. Exactly one field must be provided.
+
+    Args:
+        block_id (str):
+        body (UpdateBlockContent): Partial update for a block. Exactly one block property is
+            changed per
+             request, mapped to the corresponding property via the underlying
+             UpdateBlockProperty RPC, so a single PATCH applies one property atomically.
+             More block properties will be added to this oneof over time; today only
+             hide/unhide are supported.
+
+    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:
+        Status | UpdateBlockResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            block_id=block_id,
+            client=client,
+            body=body,
+        )
+    ).parsed

hellopivot_sdk-0.1.4/src/hellopivot_sdk/api/groups/get_groups_by_organization_id.py → hellopivot_sdk-0.1.6/src/hellopivot_sdk/api/groups/get_groups_by_organization_id_v2.py

@@ -6,22 +6,32 @@ import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.get_groups_by_organization_id_response import GetGroupsByOrganizationIdResponse
+from ...models.get_groups_by_organization_id_v2_response import GetGroupsByOrganizationIdV2Response
 from ...models.status import Status
-from ...types import UNSET, Response
+from ...types import UNSET, Response, Unset
 
 
 def _get_kwargs(
     organization_id: str,
-    offset: int,
+    *,
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = UNSET,
 ) -> dict[str, Any]:
 
+    params: dict[str, Any] = {}
+
+    params["cursor"] = cursor
+
+    params["limit"] = limit
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
     _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": "/v1/organizations/{organization_id}/groups/{offset}".format(
+        "url": "/v2/organizations/{organization_id}/groups".format(
             organization_id=quote(str(organization_id), safe=""),
-            offset=quote(str(offset), safe=""),
         ),
+        "params": params,
     }
 
     return _kwargs
@@ -29,9 +39,9 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> GetGroupsByOrganizationIdResponse | Status:
+) -> GetGroupsByOrganizationIdV2Response | Status:
     if response.status_code == 200:
-        response_200 = GetGroupsByOrganizationIdResponse.from_dict(response.json())
+        response_200 = GetGroupsByOrganizationIdV2Response.from_dict(response.json())
 
         return response_200
 
@@ -55,7 +65,7 @@ def _safe_http_status(code: int) -> int | HTTPStatus:
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[GetGroupsByOrganizationIdResponse | Status]:
+) -> Response[GetGroupsByOrganizationIdV2Response | Status]:
     return Response(
         status_code=_safe_http_status(response.status_code),
         content=response.content,
@@ -66,29 +76,32 @@ def _build_response(
 
 def sync_detailed(
     organization_id: str,
-    offset: int,
     *,
     client: AuthenticatedClient | Client,
-) -> Response[GetGroupsByOrganizationIdResponse | Status]:
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = UNSET,
+) -> Response[GetGroupsByOrganizationIdV2Response | Status]:
     """List groups
 
-     Returns groups in the organization.
+     Returns groups in the organization using cursor-based pagination.
 
     Args:
         organization_id (str):
-        offset (int):
+        cursor (str | Unset):
+        limit (int | Unset):
 
     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[GetGroupsByOrganizationIdResponse | Status]
+        Response[GetGroupsByOrganizationIdV2Response | Status]
     """
 
     kwargs = _get_kwargs(
         organization_id=organization_id,
-        offset=offset,
+        cursor=cursor,
+        limit=limit,
     )
 
     response = client.get_httpx_client().request(
@@ -100,58 +113,64 @@ def sync_detailed(
 
 def sync(
     organization_id: str,
-    offset: int,
     *,
     client: AuthenticatedClient | Client,
-) -> GetGroupsByOrganizationIdResponse | Status | None:
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = UNSET,
+) -> GetGroupsByOrganizationIdV2Response | Status | None:
     """List groups
 
-     Returns groups in the organization.
+     Returns groups in the organization using cursor-based pagination.
 
     Args:
         organization_id (str):
-        offset (int):
+        cursor (str | Unset):
+        limit (int | Unset):
 
     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:
-        GetGroupsByOrganizationIdResponse | Status
+        GetGroupsByOrganizationIdV2Response | Status
     """
 
     return sync_detailed(
         organization_id=organization_id,
-        offset=offset,
         client=client,
+        cursor=cursor,
+        limit=limit,
     ).parsed
 
 
 async def asyncio_detailed(
     organization_id: str,
-    offset: int,
     *,
     client: AuthenticatedClient | Client,
-) -> Response[GetGroupsByOrganizationIdResponse | Status]:
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = UNSET,
+) -> Response[GetGroupsByOrganizationIdV2Response | Status]:
     """List groups
 
-     Returns groups in the organization.
+     Returns groups in the organization using cursor-based pagination.
 
     Args:
         organization_id (str):
-        offset (int):
+        cursor (str | Unset):
+        limit (int | Unset):
 
     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[GetGroupsByOrganizationIdResponse | Status]
+        Response[GetGroupsByOrganizationIdV2Response | Status]
     """
 
     kwargs = _get_kwargs(
         organization_id=organization_id,
-        offset=offset,
+        cursor=cursor,
+        limit=limit,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -161,30 +180,33 @@ async def asyncio_detailed(
 
 async def asyncio(
     organization_id: str,
-    offset: int,
     *,
     client: AuthenticatedClient | Client,
-) -> GetGroupsByOrganizationIdResponse | Status | None:
+    cursor: str | Unset = UNSET,
+    limit: int | Unset = UNSET,
+) -> GetGroupsByOrganizationIdV2Response | Status | None:
     """List groups
 
-     Returns groups in the organization.
+     Returns groups in the organization using cursor-based pagination.
 
     Args:
         organization_id (str):
-        offset (int):
+        cursor (str | Unset):
+        limit (int | Unset):
 
     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:
-        GetGroupsByOrganizationIdResponse | Status
+        GetGroupsByOrganizationIdV2Response | Status
     """
 
     return (
         await asyncio_detailed(
             organization_id=organization_id,
-            offset=offset,
             client=client,
+            cursor=cursor,
+            limit=limit,
         )
     ).parsed