dart-tools 0.8.0__tar.gz → 0.8.2__tar.gz

{dart_tools-0.8.0/dart_tools.egg-info → dart_tools-0.8.2}/PKG-INFO

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

{dart_tools-0.8.0 → dart_tools-0.8.2}/dart/generated/api/__init__.py

@@ -5,5 +5,7 @@ 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 .help_center_article import list_help_center_articles
+from .skill import retrieve_skill_by_title
 from .task import create_task, delete_task, list_tasks, retrieve_task, update_task
 from .view import retrieve_view

{dart_tools-0.8.0 → dart_tools-0.8.2}/dart/generated/api/comment/list_comments.py

@@ -19,7 +19,7 @@ def _get_kwargs(
     limit: Union[Unset, int] = UNSET,
     o: Union[Unset, list[ListCommentsOItem]] = UNSET,
     offset: Union[Unset, int] = UNSET,
-    parent_id: Union[None, Unset, str] = UNSET,
+    parent_id: Union[Unset, str] = UNSET,
     published_at_after: Union[Unset, datetime.datetime] = UNSET,
     published_at_before: Union[Unset, datetime.datetime] = UNSET,
     task: Union[Unset, str] = UNSET,
@@ -47,12 +47,7 @@ def _get_kwargs(
 
     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
+    params["parent_id"] = parent_id
 
     json_published_at_after: Union[Unset, str] = UNSET
     if not isinstance(published_at_after, Unset):
@@ -114,16 +109,15 @@ def sync_detailed(
     limit: Union[Unset, int] = UNSET,
     o: Union[Unset, list[ListCommentsOItem]] = UNSET,
     offset: Union[Unset, int] = UNSET,
-    parent_id: Union[None, Unset, str] = UNSET,
+    parent_id: Union[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.
+    """List comments for a task with filtering options. Filter by author, text content, or date range. Sort
+    by date or hierarchical thread order. Task ID required. Supports pagination.
 
     Args:
         author (Union[Unset, str]):
@@ -132,7 +126,7 @@ def sync_detailed(
         limit (Union[Unset, int]):
         o (Union[Unset, list[ListCommentsOItem]]):
         offset (Union[Unset, int]):
-        parent_id (Union[None, Unset, str]):
+        parent_id (Union[Unset, str]):
         published_at_after (Union[Unset, datetime.datetime]):
         published_at_before (Union[Unset, datetime.datetime]):
         task (Union[Unset, str]):
@@ -178,16 +172,15 @@ def sync(
     limit: Union[Unset, int] = UNSET,
     o: Union[Unset, list[ListCommentsOItem]] = UNSET,
     offset: Union[Unset, int] = UNSET,
-    parent_id: Union[None, Unset, str] = UNSET,
+    parent_id: Union[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.
+    """List comments for a task with filtering options. Filter by author, text content, or date range. Sort
+    by date or hierarchical thread order. Task ID required. Supports pagination.
 
     Args:
         author (Union[Unset, str]):
@@ -196,7 +189,7 @@ def sync(
         limit (Union[Unset, int]):
         o (Union[Unset, list[ListCommentsOItem]]):
         offset (Union[Unset, int]):
-        parent_id (Union[None, Unset, str]):
+        parent_id (Union[Unset, str]):
         published_at_after (Union[Unset, datetime.datetime]):
         published_at_before (Union[Unset, datetime.datetime]):
         task (Union[Unset, str]):
@@ -237,16 +230,15 @@ async def asyncio_detailed(
     limit: Union[Unset, int] = UNSET,
     o: Union[Unset, list[ListCommentsOItem]] = UNSET,
     offset: Union[Unset, int] = UNSET,
-    parent_id: Union[None, Unset, str] = UNSET,
+    parent_id: Union[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.
+    """List comments for a task with filtering options. Filter by author, text content, or date range. Sort
+    by date or hierarchical thread order. Task ID required. Supports pagination.
 
     Args:
         author (Union[Unset, str]):
@@ -255,7 +247,7 @@ async def asyncio_detailed(
         limit (Union[Unset, int]):
         o (Union[Unset, list[ListCommentsOItem]]):
         offset (Union[Unset, int]):
-        parent_id (Union[None, Unset, str]):
+        parent_id (Union[Unset, str]):
         published_at_after (Union[Unset, datetime.datetime]):
         published_at_before (Union[Unset, datetime.datetime]):
         task (Union[Unset, str]):
@@ -299,16 +291,15 @@ async def asyncio(
     limit: Union[Unset, int] = UNSET,
     o: Union[Unset, list[ListCommentsOItem]] = UNSET,
     offset: Union[Unset, int] = UNSET,
-    parent_id: Union[None, Unset, str] = UNSET,
+    parent_id: Union[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.
+    """List comments for a task with filtering options. Filter by author, text content, or date range. Sort
+    by date or hierarchical thread order. Task ID required. Supports pagination.
 
     Args:
         author (Union[Unset, str]):
@@ -317,7 +308,7 @@ async def asyncio(
         limit (Union[Unset, int]):
         o (Union[Unset, list[ListCommentsOItem]]):
         offset (Union[Unset, int]):
-        parent_id (Union[None, Unset, str]):
+        parent_id (Union[Unset, str]):
         published_at_after (Union[Unset, datetime.datetime]):
         published_at_before (Union[Unset, datetime.datetime]):
         task (Union[Unset, str]):

{dart_tools-0.8.0 → dart_tools-0.8.2}/dart/generated/api/dartboard/retrieve_dartboard.py

@@ -59,8 +59,8 @@ def sync_detailed(
 ) -> 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.
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title
+    and description.
 
     Args:
         id (str):
@@ -91,8 +91,8 @@ def sync(
 ) -> 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.
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title
+    and description.
 
     Args:
         id (str):
@@ -118,8 +118,8 @@ async def asyncio_detailed(
 ) -> 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.
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title
+    and description.
 
     Args:
         id (str):
@@ -148,8 +148,8 @@ async def asyncio(
 ) -> 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.
+     Retrieve an existing dartboard. This will return the dartboard's information, including the title
+    and description.
 
     Args:
         id (str):

{dart_tools-0.8.0 → dart_tools-0.8.2}/dart/generated/api/doc/list_docs.py

@@ -101,8 +101,8 @@ def sync_detailed(
     text: Union[Unset, str] = UNSET,
     title: Union[Unset, str] = UNSET,
 ) -> Response[PaginatedConciseDocList]:
-    """List all docs that the user has access to. This will return a list of docs, including the title,
-    folder, text and others.
+    """List docs with filtering and search capabilities. Filter by folder, title, text content, or use
+    full-text search. Sort by creation/update date or title. Supports pagination.
 
     Args:
         folder (Union[Unset, str]):
@@ -158,8 +158,8 @@ def sync(
     text: Union[Unset, str] = UNSET,
     title: Union[Unset, str] = UNSET,
 ) -> Optional[PaginatedConciseDocList]:
-    """List all docs that the user has access to. This will return a list of docs, including the title,
-    folder, text and others.
+    """List docs with filtering and search capabilities. Filter by folder, title, text content, or use
+    full-text search. Sort by creation/update date or title. Supports pagination.
 
     Args:
         folder (Union[Unset, str]):
@@ -210,8 +210,8 @@ async def asyncio_detailed(
     text: Union[Unset, str] = UNSET,
     title: Union[Unset, str] = UNSET,
 ) -> Response[PaginatedConciseDocList]:
-    """List all docs that the user has access to. This will return a list of docs, including the title,
-    folder, text and others.
+    """List docs with filtering and search capabilities. Filter by folder, title, text content, or use
+    full-text search. Sort by creation/update date or title. Supports pagination.
 
     Args:
         folder (Union[Unset, str]):
@@ -265,8 +265,8 @@ async def asyncio(
     text: Union[Unset, str] = UNSET,
     title: Union[Unset, str] = UNSET,
 ) -> Optional[PaginatedConciseDocList]:
-    """List all docs that the user has access to. This will return a list of docs, including the title,
-    folder, text and others.
+    """List docs with filtering and search capabilities. Filter by folder, title, text content, or use
+    full-text search. Sort by creation/update date or title. Supports pagination.
 
     Args:
         folder (Union[Unset, str]):

dart_tools-0.8.2/dart/generated/api/help_center_article/list_help_center_articles.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.wrapped_help_center_articles import WrappedHelpCenterArticles
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    query: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["query"] = query
+
+    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": "/help-center-articles/list",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[WrappedHelpCenterArticles]:
+    if response.status_code == 200:
+        response_200 = WrappedHelpCenterArticles.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[WrappedHelpCenterArticles]:
+    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],
+    query: Union[Unset, str] = UNSET,
+) -> Response[WrappedHelpCenterArticles]:
+    """List help center articles by query
+
+     Search for up to two help center articles by their semantic similarity to a short (1-5 word) query.
+
+    Args:
+        query (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[WrappedHelpCenterArticles]
+    """
+
+    kwargs = _get_kwargs(
+        query=query,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    query: Union[Unset, str] = UNSET,
+) -> Optional[WrappedHelpCenterArticles]:
+    """List help center articles by query
+
+     Search for up to two help center articles by their semantic similarity to a short (1-5 word) query.
+
+    Args:
+        query (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:
+        WrappedHelpCenterArticles
+    """
+
+    return sync_detailed(
+        client=client,
+        query=query,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    query: Union[Unset, str] = UNSET,
+) -> Response[WrappedHelpCenterArticles]:
+    """List help center articles by query
+
+     Search for up to two help center articles by their semantic similarity to a short (1-5 word) query.
+
+    Args:
+        query (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[WrappedHelpCenterArticles]
+    """
+
+    kwargs = _get_kwargs(
+        query=query,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    query: Union[Unset, str] = UNSET,
+) -> Optional[WrappedHelpCenterArticles]:
+    """List help center articles by query
+
+     Search for up to two help center articles by their semantic similarity to a short (1-5 word) query.
+
+    Args:
+        query (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:
+        WrappedHelpCenterArticles
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            query=query,
+        )
+    ).parsed

dart_tools-0.8.2/dart/generated/api/skill/retrieve_skill_by_title.py

@@ -0,0 +1,173 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.wrapped_skill import WrappedSkill
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    title: str,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["title"] = title
+
+    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": "/skills/by-title",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, WrappedSkill]]:
+    if response.status_code == 200:
+        response_200 = WrappedSkill.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+    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, WrappedSkill]]:
+    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],
+    title: str,
+) -> Response[Union[Any, WrappedSkill]]:
+    """Retrieve a skill by title
+
+     Retrieve a skill by its title. Skills are user-defined instructions or templates for performing
+    specific task types in the workspace. Returns the skill's title and instructions if found.
+
+    Args:
+        title (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[Any, WrappedSkill]]
+    """
+
+    kwargs = _get_kwargs(
+        title=title,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    title: str,
+) -> Optional[Union[Any, WrappedSkill]]:
+    """Retrieve a skill by title
+
+     Retrieve a skill by its title. Skills are user-defined instructions or templates for performing
+    specific task types in the workspace. Returns the skill's title and instructions if found.
+
+    Args:
+        title (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[Any, WrappedSkill]
+    """
+
+    return sync_detailed(
+        client=client,
+        title=title,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    title: str,
+) -> Response[Union[Any, WrappedSkill]]:
+    """Retrieve a skill by title
+
+     Retrieve a skill by its title. Skills are user-defined instructions or templates for performing
+    specific task types in the workspace. Returns the skill's title and instructions if found.
+
+    Args:
+        title (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[Any, WrappedSkill]]
+    """
+
+    kwargs = _get_kwargs(
+        title=title,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    title: str,
+) -> Optional[Union[Any, WrappedSkill]]:
+    """Retrieve a skill by title
+
+     Retrieve a skill by its title. Skills are user-defined instructions or templates for performing
+    specific task types in the workspace. Returns the skill's title and instructions if found.
+
+    Args:
+        title (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[Any, WrappedSkill]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            title=title,
+        )
+    ).parsed

dart_tools-0.8.2/dart/generated/api/task/__init__.py

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

{dart_tools-0.8.0 → dart_tools-0.8.2}/dart/generated/api/task/create_task.py

@@ -57,9 +57,9 @@ def sync_detailed(
 ) -> Response[WrappedTask]:
     """Create a new task
 
-     Record a new task that the user intends to do. This will save the task in Dart for later access,
-    search, etc. By default the created task will be assigned to the user, with a status of to-do, with
-    no parent, in the Active dartboard. More information can be included in the description.
+     Record a new task that the user intends to do. By default the task will be assigned to the current
+    user, have an unstarted status, have no parent, and be in the default dartboard. More information
+    can be included in the description.
 
     Args:
         body (WrappedTaskCreate):
@@ -90,9 +90,9 @@ def sync(
 ) -> Optional[WrappedTask]:
     """Create a new task
 
-     Record a new task that the user intends to do. This will save the task in Dart for later access,
-    search, etc. By default the created task will be assigned to the user, with a status of to-do, with
-    no parent, in the Active dartboard. More information can be included in the description.
+     Record a new task that the user intends to do. By default the task will be assigned to the current
+    user, have an unstarted status, have no parent, and be in the default dartboard. More information
+    can be included in the description.
 
     Args:
         body (WrappedTaskCreate):
@@ -118,9 +118,9 @@ async def asyncio_detailed(
 ) -> Response[WrappedTask]:
     """Create a new task
 
-     Record a new task that the user intends to do. This will save the task in Dart for later access,
-    search, etc. By default the created task will be assigned to the user, with a status of to-do, with
-    no parent, in the Active dartboard. More information can be included in the description.
+     Record a new task that the user intends to do. By default the task will be assigned to the current
+    user, have an unstarted status, have no parent, and be in the default dartboard. More information
+    can be included in the description.
 
     Args:
         body (WrappedTaskCreate):
@@ -149,9 +149,9 @@ async def asyncio(
 ) -> Optional[WrappedTask]:
     """Create a new task
 
-     Record a new task that the user intends to do. This will save the task in Dart for later access,
-    search, etc. By default the created task will be assigned to the user, with a status of to-do, with
-    no parent, in the Active dartboard. More information can be included in the description.
+     Record a new task that the user intends to do. By default the task will be assigned to the current
+    user, have an unstarted status, have no parent, and be in the default dartboard. More information
+    can be included in the description.
 
     Args:
         body (WrappedTaskCreate):