dart-tools 0.7.4__tar.gz → 0.7.5__tar.gz

{dart_tools-0.7.4/dart_tools.egg-info → dart_tools-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dart-tools
-Version: 0.7.4
+Version: 0.7.5
 Summary: The Dart CLI and Python Library
 Author-email: Dart <software@itsdart.com>
 License: MIT License

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart/dart.py

@@ -36,6 +36,7 @@ from .generated.models import (
     Doc,
     DocCreate,
     DocUpdate,
+    PaginatedCommentList,
     PaginatedConciseDocList,
     PaginatedConciseTaskList,
     Priority,
@@ -334,6 +335,11 @@ class Dart:
         response = api.create_comment.sync_detailed(client=self._public_api, body=body)
         return _get_response_parsed(response)
 
+    @_handle_request_errors
+    def list_comments(self, **kwargs) -> PaginatedCommentList:
+        response = api.list_comments.sync_detailed(client=self._public_api, **kwargs)
+        return _get_response_parsed(response)
+
     @_handle_request_errors
     def create_doc(self, body: WrappedDocCreate) -> WrappedDoc:
         response = api.create_doc.sync_detailed(client=self._public_api, body=body)

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart/generated/api/__init__.py

@@ -1,6 +1,6 @@
 """Contains methods for accessing the API"""
 
-from .comment import create_comment
+from .comment import create_comment, list_comments
 from .config import get_config
 from .dartboard import retrieve_dartboard
 from .doc import create_doc, delete_doc, list_docs, retrieve_doc, update_doc

dart_tools-0.7.5/dart/generated/api/comment/list_comments.py

@@ -0,0 +1,351 @@
+import datetime
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.list_comments_o_item import ListCommentsOItem
+from ...models.paginated_comment_list import PaginatedCommentList
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    author: Union[Unset, str] = UNSET,
+    author_id: Union[Unset, str] = UNSET,
+    ids: Union[Unset, str] = UNSET,
+    limit: Union[Unset, int] = UNSET,
+    o: Union[Unset, list[ListCommentsOItem]] = UNSET,
+    offset: Union[Unset, int] = UNSET,
+    parent_id: Union[None, Unset, str] = UNSET,
+    published_at_after: Union[Unset, datetime.datetime] = UNSET,
+    published_at_before: Union[Unset, datetime.datetime] = UNSET,
+    task: Union[Unset, str] = UNSET,
+    task_id: str,
+    text: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["author"] = author
+
+    params["author_id"] = author_id
+
+    params["ids"] = ids
+
+    params["limit"] = limit
+
+    json_o: Union[Unset, list[str]] = UNSET
+    if not isinstance(o, Unset):
+        json_o = []
+        for o_item_data in o:
+            o_item = o_item_data.value
+            json_o.append(o_item)
+
+    params["o"] = json_o
+
+    params["offset"] = offset
+
+    json_parent_id: Union[None, Unset, str]
+    if isinstance(parent_id, Unset):
+        json_parent_id = UNSET
+    else:
+        json_parent_id = parent_id
+    params["parent_id"] = json_parent_id
+
+    json_published_at_after: Union[Unset, str] = UNSET
+    if not isinstance(published_at_after, Unset):
+        json_published_at_after = published_at_after.isoformat()
+    params["published_at_after"] = json_published_at_after
+
+    json_published_at_before: Union[Unset, str] = UNSET
+    if not isinstance(published_at_before, Unset):
+        json_published_at_before = published_at_before.isoformat()
+    params["published_at_before"] = json_published_at_before
+
+    params["task"] = task
+
+    params["task_id"] = task_id
+
+    params["text"] = text
+
+    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": "/comments/list",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[PaginatedCommentList]:
+    if response.status_code == 200:
+        response_200 = PaginatedCommentList.from_dict(response.json())
+
+        return response_200
+    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[PaginatedCommentList]:
+    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],
+    author: Union[Unset, str] = UNSET,
+    author_id: Union[Unset, str] = UNSET,
+    ids: Union[Unset, str] = UNSET,
+    limit: Union[Unset, int] = UNSET,
+    o: Union[Unset, list[ListCommentsOItem]] = UNSET,
+    offset: Union[Unset, int] = UNSET,
+    parent_id: Union[None, Unset, str] = UNSET,
+    published_at_after: Union[Unset, datetime.datetime] = UNSET,
+    published_at_before: Union[Unset, datetime.datetime] = UNSET,
+    task: Union[Unset, str] = UNSET,
+    task_id: str,
+    text: Union[Unset, str] = UNSET,
+) -> Response[PaginatedCommentList]:
+    """List all comments that the user has access to. This will return a list of comments, including the
+    text, associated task ID, and others. Comments are ordered by thread and then by when they were
+    written.
+
+    Args:
+        author (Union[Unset, str]):
+        author_id (Union[Unset, str]):
+        ids (Union[Unset, str]):
+        limit (Union[Unset, int]):
+        o (Union[Unset, list[ListCommentsOItem]]):
+        offset (Union[Unset, int]):
+        parent_id (Union[None, Unset, str]):
+        published_at_after (Union[Unset, datetime.datetime]):
+        published_at_before (Union[Unset, datetime.datetime]):
+        task (Union[Unset, str]):
+        task_id (str):
+        text (Union[Unset, 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[PaginatedCommentList]
+    """
+
+    kwargs = _get_kwargs(
+        author=author,
+        author_id=author_id,
+        ids=ids,
+        limit=limit,
+        o=o,
+        offset=offset,
+        parent_id=parent_id,
+        published_at_after=published_at_after,
+        published_at_before=published_at_before,
+        task=task,
+        task_id=task_id,
+        text=text,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    author: Union[Unset, str] = UNSET,
+    author_id: Union[Unset, str] = UNSET,
+    ids: Union[Unset, str] = UNSET,
+    limit: Union[Unset, int] = UNSET,
+    o: Union[Unset, list[ListCommentsOItem]] = UNSET,
+    offset: Union[Unset, int] = UNSET,
+    parent_id: Union[None, Unset, str] = UNSET,
+    published_at_after: Union[Unset, datetime.datetime] = UNSET,
+    published_at_before: Union[Unset, datetime.datetime] = UNSET,
+    task: Union[Unset, str] = UNSET,
+    task_id: str,
+    text: Union[Unset, str] = UNSET,
+) -> Optional[PaginatedCommentList]:
+    """List all comments that the user has access to. This will return a list of comments, including the
+    text, associated task ID, and others. Comments are ordered by thread and then by when they were
+    written.
+
+    Args:
+        author (Union[Unset, str]):
+        author_id (Union[Unset, str]):
+        ids (Union[Unset, str]):
+        limit (Union[Unset, int]):
+        o (Union[Unset, list[ListCommentsOItem]]):
+        offset (Union[Unset, int]):
+        parent_id (Union[None, Unset, str]):
+        published_at_after (Union[Unset, datetime.datetime]):
+        published_at_before (Union[Unset, datetime.datetime]):
+        task (Union[Unset, str]):
+        task_id (str):
+        text (Union[Unset, 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:
+        PaginatedCommentList
+    """
+
+    return sync_detailed(
+        client=client,
+        author=author,
+        author_id=author_id,
+        ids=ids,
+        limit=limit,
+        o=o,
+        offset=offset,
+        parent_id=parent_id,
+        published_at_after=published_at_after,
+        published_at_before=published_at_before,
+        task=task,
+        task_id=task_id,
+        text=text,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    author: Union[Unset, str] = UNSET,
+    author_id: Union[Unset, str] = UNSET,
+    ids: Union[Unset, str] = UNSET,
+    limit: Union[Unset, int] = UNSET,
+    o: Union[Unset, list[ListCommentsOItem]] = UNSET,
+    offset: Union[Unset, int] = UNSET,
+    parent_id: Union[None, Unset, str] = UNSET,
+    published_at_after: Union[Unset, datetime.datetime] = UNSET,
+    published_at_before: Union[Unset, datetime.datetime] = UNSET,
+    task: Union[Unset, str] = UNSET,
+    task_id: str,
+    text: Union[Unset, str] = UNSET,
+) -> Response[PaginatedCommentList]:
+    """List all comments that the user has access to. This will return a list of comments, including the
+    text, associated task ID, and others. Comments are ordered by thread and then by when they were
+    written.
+
+    Args:
+        author (Union[Unset, str]):
+        author_id (Union[Unset, str]):
+        ids (Union[Unset, str]):
+        limit (Union[Unset, int]):
+        o (Union[Unset, list[ListCommentsOItem]]):
+        offset (Union[Unset, int]):
+        parent_id (Union[None, Unset, str]):
+        published_at_after (Union[Unset, datetime.datetime]):
+        published_at_before (Union[Unset, datetime.datetime]):
+        task (Union[Unset, str]):
+        task_id (str):
+        text (Union[Unset, 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[PaginatedCommentList]
+    """
+
+    kwargs = _get_kwargs(
+        author=author,
+        author_id=author_id,
+        ids=ids,
+        limit=limit,
+        o=o,
+        offset=offset,
+        parent_id=parent_id,
+        published_at_after=published_at_after,
+        published_at_before=published_at_before,
+        task=task,
+        task_id=task_id,
+        text=text,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    author: Union[Unset, str] = UNSET,
+    author_id: Union[Unset, str] = UNSET,
+    ids: Union[Unset, str] = UNSET,
+    limit: Union[Unset, int] = UNSET,
+    o: Union[Unset, list[ListCommentsOItem]] = UNSET,
+    offset: Union[Unset, int] = UNSET,
+    parent_id: Union[None, Unset, str] = UNSET,
+    published_at_after: Union[Unset, datetime.datetime] = UNSET,
+    published_at_before: Union[Unset, datetime.datetime] = UNSET,
+    task: Union[Unset, str] = UNSET,
+    task_id: str,
+    text: Union[Unset, str] = UNSET,
+) -> Optional[PaginatedCommentList]:
+    """List all comments that the user has access to. This will return a list of comments, including the
+    text, associated task ID, and others. Comments are ordered by thread and then by when they were
+    written.
+
+    Args:
+        author (Union[Unset, str]):
+        author_id (Union[Unset, str]):
+        ids (Union[Unset, str]):
+        limit (Union[Unset, int]):
+        o (Union[Unset, list[ListCommentsOItem]]):
+        offset (Union[Unset, int]):
+        parent_id (Union[None, Unset, str]):
+        published_at_after (Union[Unset, datetime.datetime]):
+        published_at_before (Union[Unset, datetime.datetime]):
+        task (Union[Unset, str]):
+        task_id (str):
+        text (Union[Unset, 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:
+        PaginatedCommentList
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            author=author,
+            author_id=author_id,
+            ids=ids,
+            limit=limit,
+            o=o,
+            offset=offset,
+            parent_id=parent_id,
+            published_at_after=published_at_after,
+            published_at_before=published_at_before,
+            task=task,
+            task_id=task_id,
+            text=text,
+        )
+    ).parsed

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart/generated/models/__init__.py

@@ -10,7 +10,9 @@ from .doc import Doc
 from .doc_create import DocCreate
 from .doc_update import DocUpdate
 from .folder import Folder
+from .list_comments_o_item import ListCommentsOItem
 from .list_docs_o_item import ListDocsOItem
+from .paginated_comment_list import PaginatedCommentList
 from .paginated_concise_doc_list import PaginatedConciseDocList
 from .paginated_concise_task_list import PaginatedConciseTaskList
 from .priority import Priority
@@ -73,7 +75,9 @@ __all__ = (
     "DocCreate",
     "DocUpdate",
     "Folder",
+    "ListCommentsOItem",
     "ListDocsOItem",
+    "PaginatedCommentList",
     "PaginatedConciseDocList",
     "PaginatedConciseTaskList",
     "Priority",

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart/generated/models/comment.py

@@ -1,9 +1,11 @@
 from collections.abc import Mapping
-from typing import Any, TypeVar
+from typing import Any, TypeVar, Union
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
+from ..types import UNSET, Unset
+
 T = TypeVar("T", bound="Comment")
 
 
@@ -13,16 +15,18 @@ class Comment:
     Attributes:
         id (str): The universal, unique ID of the comment.
         html_url (str): The URL that can be used to open the comment in the Dart web UI.
-        task_id (str): The universal, unique ID of the task that the comment is associated with.
         author (str): The name or email of the user that authored the comment.
+        task_id (str): The universal, unique ID of the task that the comment is associated with.
         text (str): The full content of the comment, which can include markdown formatting.
+        parent_id (Union[Unset, str]): The universal, unique ID of the parent comment, if any.
     """
 
     id: str
     html_url: str
-    task_id: str
     author: str
+    task_id: str
     text: str
+    parent_id: Union[Unset, str] = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -30,23 +34,27 @@ class Comment:
 
         html_url = self.html_url
 
-        task_id = self.task_id
-
         author = self.author
 
+        task_id = self.task_id
+
         text = self.text
 
+        parent_id = self.parent_id
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
             {
                 "id": id,
                 "htmlUrl": html_url,
-                "taskId": task_id,
                 "author": author,
+                "taskId": task_id,
                 "text": text,
             }
         )
+        if parent_id is not UNSET:
+            field_dict["parentId"] = parent_id
 
         return field_dict
 
@@ -57,18 +65,21 @@ class Comment:
 
         html_url = d.pop("htmlUrl")
 
-        task_id = d.pop("taskId")
-
         author = d.pop("author")
 
+        task_id = d.pop("taskId")
+
         text = d.pop("text")
 
+        parent_id = d.pop("parentId", UNSET)
+
         comment = cls(
             id=id,
             html_url=html_url,
-            task_id=task_id,
             author=author,
+            task_id=task_id,
             text=text,
+            parent_id=parent_id,
         )
 
         comment.additional_properties = d

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart/generated/models/comment_create.py

@@ -1,9 +1,11 @@
 from collections.abc import Mapping
-from typing import Any, TypeVar
+from typing import Any, TypeVar, Union
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
+from ..types import UNSET, Unset
+
 T = TypeVar("T", bound="CommentCreate")
 
 
@@ -13,10 +15,12 @@ class CommentCreate:
     Attributes:
         task_id (str): The universal, unique ID of the task that the comment is associated with.
         text (str): The full content of the comment, which can include markdown formatting.
+        parent_id (Union[Unset, str]): The universal, unique ID of the parent comment, if any.
     """
 
     task_id: str
     text: str
+    parent_id: Union[Unset, str] = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -24,6 +28,8 @@ class CommentCreate:
 
         text = self.text
 
+        parent_id = self.parent_id
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -32,6 +38,8 @@ class CommentCreate:
                 "text": text,
             }
         )
+        if parent_id is not UNSET:
+            field_dict["parentId"] = parent_id
 
         return field_dict
 
@@ -42,9 +50,12 @@ class CommentCreate:
 
         text = d.pop("text")
 
+        parent_id = d.pop("parentId", UNSET)
+
         comment_create = cls(
             task_id=task_id,
             text=text,
+            parent_id=parent_id,
         )
 
         comment_create.additional_properties = d

dart_tools-0.7.5/dart/generated/models/list_comments_o_item.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class ListCommentsOItem(str, Enum):
+    HIERARCHICAL = "hierarchical"
+    PUBLISHED_AT = "published_at"
+    PUBLISHED_AT_DESC = "-published_at"
+
+    def __str__(self) -> str:
+        return str(self.value)

dart_tools-0.7.5/dart/generated/models/paginated_comment_list.py

@@ -0,0 +1,123 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, Union, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.comment import Comment
+
+
+T = TypeVar("T", bound="PaginatedCommentList")
+
+
+@_attrs_define
+class PaginatedCommentList:
+    """
+    Attributes:
+        count (int):  Example: 123.
+        results (list['Comment']):
+        next_ (Union[None, Unset, str]):  Example: http://api.example.org/accounts/?offset=400&limit=100.
+        previous (Union[None, Unset, str]):  Example: http://api.example.org/accounts/?offset=200&limit=100.
+    """
+
+    count: int
+    results: list["Comment"]
+    next_: Union[None, Unset, str] = UNSET
+    previous: Union[None, Unset, str] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        count = self.count
+
+        results = []
+        for results_item_data in self.results:
+            results_item = results_item_data.to_dict()
+            results.append(results_item)
+
+        next_: Union[None, Unset, str]
+        if isinstance(self.next_, Unset):
+            next_ = UNSET
+        else:
+            next_ = self.next_
+
+        previous: Union[None, Unset, str]
+        if isinstance(self.previous, Unset):
+            previous = UNSET
+        else:
+            previous = self.previous
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "count": count,
+                "results": results,
+            }
+        )
+        if next_ is not UNSET:
+            field_dict["next"] = next_
+        if previous is not UNSET:
+            field_dict["previous"] = previous
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.comment import Comment
+
+        d = dict(src_dict)
+        count = d.pop("count")
+
+        results = []
+        _results = d.pop("results")
+        for results_item_data in _results:
+            results_item = Comment.from_dict(results_item_data)
+
+            results.append(results_item)
+
+        def _parse_next_(data: object) -> Union[None, Unset, str]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, str], data)
+
+        next_ = _parse_next_(d.pop("next", UNSET))
+
+        def _parse_previous(data: object) -> Union[None, Unset, str]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, str], data)
+
+        previous = _parse_previous(d.pop("previous", UNSET))
+
+        paginated_comment_list = cls(
+            count=count,
+            results=results,
+            next_=next_,
+            previous=previous,
+        )
+
+        paginated_comment_list.additional_properties = d
+        return paginated_comment_list
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

{dart_tools-0.7.4 → dart_tools-0.7.5/dart_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dart-tools
-Version: 0.7.4
+Version: 0.7.5
 Summary: The Dart CLI and Python Library
 Author-email: Dart <software@itsdart.com>
 License: MIT License

{dart_tools-0.7.4 → dart_tools-0.7.5}/dart_tools.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ dart/generated/types.py
 dart/generated/api/__init__.py
 dart/generated/api/comment/__init__.py
 dart/generated/api/comment/create_comment.py
+dart/generated/api/comment/list_comments.py
 dart/generated/api/config/__init__.py
 dart/generated/api/config/get_config.py
 dart/generated/api/dartboard/__init__.py
@@ -45,7 +46,9 @@ dart/generated/models/doc.py
 dart/generated/models/doc_create.py
 dart/generated/models/doc_update.py
 dart/generated/models/folder.py
+dart/generated/models/list_comments_o_item.py
 dart/generated/models/list_docs_o_item.py
+dart/generated/models/paginated_comment_list.py
 dart/generated/models/paginated_concise_doc_list.py
 dart/generated/models/paginated_concise_task_list.py
 dart/generated/models/priority.py

{dart_tools-0.7.4 → dart_tools-0.7.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dart-tools"
-version = "0.7.4"
+version = "0.7.5"
 description = "The Dart CLI and Python Library"
 readme = "README.md"
 requires-python = ">=3.9"