dart-tools 0.6.16__py3-none-any.whl → 0.7.0__py3-none-any.whl

dart/generated/__init__.py

@@ -1,4 +1,4 @@
-"""A client library for accessing Dart API"""
+"""A client library for accessing Dart Public API"""
 
 from .client import AuthenticatedClient, Client
 

dart/generated/api/__init__.py

@@ -1 +1,9 @@
 """Contains methods for accessing the API"""
+
+from .comment import create_comment
+from .config import get_config
+from .dartboard import retrieve_dartboard
+from .doc import create_doc, delete_doc, list_docs, retrieve_doc, update_doc
+from .folder import retrieve_folder
+from .task import create_task, delete_task, list_tasks, retrieve_task, update_task
+from .view import retrieve_view

dart/generated/api/comment/__init__.py

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

dart/generated/api/{transactions/transactions_create.py → comment/create_comment.py}

@@ -1,28 +1,24 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union, cast
 
 import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.request_body import RequestBody
-from ...models.response_body import ResponseBody
-from ...models.validation_error_response import ValidationErrorResponse
-from ...types import UNSET, Response, Unset
+from ...models.wrapped_comment import WrappedComment
+from ...models.wrapped_comment_create import WrappedCommentCreate
+from ...types import Response
 
 
 def _get_kwargs(
     *,
-    body: RequestBody,
-    x_csrftoken: Union[Unset, str] = UNSET,
-) -> Dict[str, Any]:
-    headers: Dict[str, Any] = {}
-    if not isinstance(x_csrftoken, Unset):
-        headers["x-csrftoken"] = x_csrftoken
-
-    _kwargs: Dict[str, Any] = {
+    body: WrappedCommentCreate,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
         "method": "post",
-        "url": "/api/v0/transactions/create",
+        "url": "/comments",
     }
 
     _body = body.to_dict()
@@ -36,14 +32,13 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[ResponseBody, ValidationErrorResponse]]:
-    if response.status_code == HTTPStatus.CREATED:
-        response_201 = ResponseBody.from_dict(response.json())
-
-        return response_201
-    if response.status_code == HTTPStatus.BAD_REQUEST:
-        response_400 = ValidationErrorResponse.from_dict(response.json())
+) -> Optional[Union[Any, WrappedComment]]:
+    if response.status_code == 200:
+        response_200 = WrappedComment.from_dict(response.json())
 
+        return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
         return response_400
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
@@ -53,7 +48,7 @@ def _parse_response(
 
 def _build_response(
     *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[ResponseBody, ValidationErrorResponse]]:
+) -> Response[Union[Any, WrappedComment]]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -64,26 +59,27 @@ def _build_response(
 
 def sync_detailed(
     *,
-    client: AuthenticatedClient,
-    body: RequestBody,
-    x_csrftoken: Union[Unset, str] = UNSET,
-) -> Response[Union[ResponseBody, ValidationErrorResponse]]:
-    """
+    client: Union[AuthenticatedClient, Client],
+    body: WrappedCommentCreate,
+) -> Response[Union[Any, WrappedComment]]:
+    """Create a new comment
+
+     Record a new comment that the user intends to add to a given task. This will save the comment in
+    Dart for later access, search, etc.
+
     Args:
-        x_csrftoken (Union[Unset, str]):
-        body (RequestBody):
+        body (WrappedCommentCreate):
 
     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[ResponseBody, ValidationErrorResponse]]
+        Response[Union[Any, WrappedComment]]
     """
 
     kwargs = _get_kwargs(
         body=body,
-        x_csrftoken=x_csrftoken,
     )
 
     response = client.get_httpx_client().request(
@@ -95,52 +91,54 @@ def sync_detailed(
 
 def sync(
     *,
-    client: AuthenticatedClient,
-    body: RequestBody,
-    x_csrftoken: Union[Unset, str] = UNSET,
-) -> Optional[Union[ResponseBody, ValidationErrorResponse]]:
-    """
+    client: Union[AuthenticatedClient, Client],
+    body: WrappedCommentCreate,
+) -> Optional[Union[Any, WrappedComment]]:
+    """Create a new comment
+
+     Record a new comment that the user intends to add to a given task. This will save the comment in
+    Dart for later access, search, etc.
+
     Args:
-        x_csrftoken (Union[Unset, str]):
-        body (RequestBody):
+        body (WrappedCommentCreate):
 
     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[ResponseBody, ValidationErrorResponse]
+        Union[Any, WrappedComment]
     """
 
     return sync_detailed(
         client=client,
         body=body,
-        x_csrftoken=x_csrftoken,
     ).parsed
 
 
 async def asyncio_detailed(
     *,
-    client: AuthenticatedClient,
-    body: RequestBody,
-    x_csrftoken: Union[Unset, str] = UNSET,
-) -> Response[Union[ResponseBody, ValidationErrorResponse]]:
-    """
+    client: Union[AuthenticatedClient, Client],
+    body: WrappedCommentCreate,
+) -> Response[Union[Any, WrappedComment]]:
+    """Create a new comment
+
+     Record a new comment that the user intends to add to a given task. This will save the comment in
+    Dart for later access, search, etc.
+
     Args:
-        x_csrftoken (Union[Unset, str]):
-        body (RequestBody):
+        body (WrappedCommentCreate):
 
     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[ResponseBody, ValidationErrorResponse]]
+        Response[Union[Any, WrappedComment]]
     """
 
     kwargs = _get_kwargs(
         body=body,
-        x_csrftoken=x_csrftoken,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -150,27 +148,28 @@ async def asyncio_detailed(
 
 async def asyncio(
     *,
-    client: AuthenticatedClient,
-    body: RequestBody,
-    x_csrftoken: Union[Unset, str] = UNSET,
-) -> Optional[Union[ResponseBody, ValidationErrorResponse]]:
-    """
+    client: Union[AuthenticatedClient, Client],
+    body: WrappedCommentCreate,
+) -> Optional[Union[Any, WrappedComment]]:
+    """Create a new comment
+
+     Record a new comment that the user intends to add to a given task. This will save the comment in
+    Dart for later access, search, etc.
+
     Args:
-        x_csrftoken (Union[Unset, str]):
-        body (RequestBody):
+        body (WrappedCommentCreate):
 
     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[ResponseBody, ValidationErrorResponse]
+        Union[Any, WrappedComment]
     """
 
     return (
         await asyncio_detailed(
             client=client,
             body=body,
-            x_csrftoken=x_csrftoken,
         )
     ).parsed

dart/generated/api/config/__init__.py

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

dart/generated/api/config/get_config.py

@@ -0,0 +1,141 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.user_space_configuration import UserSpaceConfiguration
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/config",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, UserSpaceConfiguration]]:
+    if response.status_code == 200:
+        response_200 = UserSpaceConfiguration.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+    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, UserSpaceConfiguration]]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, UserSpaceConfiguration]]:
+    """Get user space configuration
+
+     Get information about the user's space, including all of the possible values that can be provided to
+    other endpoints.
+
+    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, UserSpaceConfiguration]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, UserSpaceConfiguration]]:
+    """Get user space configuration
+
+     Get information about the user's space, including all of the possible values that can be provided to
+    other endpoints.
+
+    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, UserSpaceConfiguration]
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, UserSpaceConfiguration]]:
+    """Get user space configuration
+
+     Get information about the user's space, including all of the possible values that can be provided to
+    other endpoints.
+
+    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, UserSpaceConfiguration]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, UserSpaceConfiguration]]:
+    """Get user space configuration
+
+     Get information about the user's space, including all of the possible values that can be provided to
+    other endpoints.
+
+    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, UserSpaceConfiguration]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

dart/generated/api/dartboard/__init__.py

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

dart/generated/api/{attachments/attachments_list.py → dartboard/retrieve_dartboard.py}

@@ -1,31 +1,20 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union, cast
 
 import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.paginated_attachment_list import PaginatedAttachmentList
-from ...types import UNSET, Response, Unset
+from ...models.wrapped_dartboard import WrappedDartboard
+from ...types import Response
 
 
 def _get_kwargs(
-    *,
-    limit: Union[Unset, int] = UNSET,
-    offset: Union[Unset, int] = UNSET,
-) -> Dict[str, Any]:
-    params: Dict[str, Any] = {}
-
-    params["limit"] = limit
-
-    params["offset"] = offset
-
-    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
-
-    _kwargs: Dict[str, Any] = {
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": "/api/v0/attachments",
-        "params": params,
+        "url": f"/dartboards/{id}",
     }
 
     return _kwargs
@@ -33,11 +22,14 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[PaginatedAttachmentList]:
-    if response.status_code == HTTPStatus.OK:
-        response_200 = PaginatedAttachmentList.from_dict(response.json())
+) -> Optional[Union[Any, WrappedDartboard]]:
+    if response.status_code == 200:
+        response_200 = WrappedDartboard.from_dict(response.json())
 
         return response_200
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
@@ -46,7 +38,7 @@ def _parse_response(
 
 def _build_response(
     *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[PaginatedAttachmentList]:
+) -> Response[Union[Any, WrappedDartboard]]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -56,27 +48,28 @@ def _build_response(
 
 
 def sync_detailed(
+    id: str,
     *,
-    client: AuthenticatedClient,
-    limit: Union[Unset, int] = UNSET,
-    offset: Union[Unset, int] = UNSET,
-) -> Response[PaginatedAttachmentList]:
-    """
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, WrappedDartboard]]:
+    """Retrieve an existing dartboard
+
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title,
+    description, all tasks within it, and others.
+
     Args:
-        limit (Union[Unset, int]):
-        offset (Union[Unset, int]):
+        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[PaginatedAttachmentList]
+        Response[Union[Any, WrappedDartboard]]
     """
 
     kwargs = _get_kwargs(
-        limit=limit,
-        offset=offset,
+        id=id,
     )
 
     response = client.get_httpx_client().request(
@@ -87,53 +80,55 @@ def sync_detailed(
 
 
 def sync(
+    id: str,
     *,
-    client: AuthenticatedClient,
-    limit: Union[Unset, int] = UNSET,
-    offset: Union[Unset, int] = UNSET,
-) -> Optional[PaginatedAttachmentList]:
-    """
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, WrappedDartboard]]:
+    """Retrieve an existing dartboard
+
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title,
+    description, all tasks within it, and others.
+
     Args:
-        limit (Union[Unset, int]):
-        offset (Union[Unset, int]):
+        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:
-        PaginatedAttachmentList
+        Union[Any, WrappedDartboard]
     """
 
     return sync_detailed(
+        id=id,
         client=client,
-        limit=limit,
-        offset=offset,
     ).parsed
 
 
 async def asyncio_detailed(
+    id: str,
     *,
-    client: AuthenticatedClient,
-    limit: Union[Unset, int] = UNSET,
-    offset: Union[Unset, int] = UNSET,
-) -> Response[PaginatedAttachmentList]:
-    """
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, WrappedDartboard]]:
+    """Retrieve an existing dartboard
+
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title,
+    description, all tasks within it, and others.
+
     Args:
-        limit (Union[Unset, int]):
-        offset (Union[Unset, int]):
+        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[PaginatedAttachmentList]
+        Response[Union[Any, WrappedDartboard]]
     """
 
     kwargs = _get_kwargs(
-        limit=limit,
-        offset=offset,
+        id=id,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -142,28 +137,29 @@ async def asyncio_detailed(
 
 
 async def asyncio(
+    id: str,
     *,
-    client: AuthenticatedClient,
-    limit: Union[Unset, int] = UNSET,
-    offset: Union[Unset, int] = UNSET,
-) -> Optional[PaginatedAttachmentList]:
-    """
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, WrappedDartboard]]:
+    """Retrieve an existing dartboard
+
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title,
+    description, all tasks within it, and others.
+
     Args:
-        limit (Union[Unset, int]):
-        offset (Union[Unset, int]):
+        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:
-        PaginatedAttachmentList
+        Union[Any, WrappedDartboard]
     """
 
     return (
         await asyncio_detailed(
+            id=id,
             client=client,
-            limit=limit,
-            offset=offset,
         )
     ).parsed

dart/generated/api/doc/__init__.py

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