Address comments

Author: vdusek

src/apify_client/_apify_client.py

@@ -53,12 +53,8 @@
     ScheduleClientAsync,
     ScheduleCollectionClient,
     ScheduleCollectionClientAsync,
-    StatusMessageWatcherAsync,
-    StatusMessageWatcherSync,
     StoreCollectionClient,
     StoreCollectionClientAsync,
-    StreamedLogAsync,
-    StreamedLogSync,
     TaskClient,
     TaskClientAsync,
     TaskCollectionClient,
@@ -181,8 +177,6 @@ def __init__(
             key_value_store_client=KeyValueStoreClient,
             key_value_store_collection_client=KeyValueStoreCollectionClient,
             log_client=LogClient,
-            status_message_watcher=StatusMessageWatcherSync,
-            streamed_log=StreamedLogSync,
             request_queue_client=RequestQueueClient,
             request_queue_collection_client=RequestQueueCollectionClient,
             run_client=RunClient,
@@ -386,6 +380,7 @@ class ApifyClientAsync:
 
     from apify_client import ApifyClientAsync
 
+
     async def main() -> None:
         client = ApifyClientAsync(token='MY-APIFY-TOKEN')
 
@@ -400,6 +395,7 @@ async def main() -> None:
             for item in items:
                 print(item)
 
+
     asyncio.run(main())
     ```
     """
@@ -475,8 +471,6 @@ def __init__(
             key_value_store_client=KeyValueStoreClientAsync,
             key_value_store_collection_client=KeyValueStoreCollectionClientAsync,
             log_client=LogClientAsync,
-            status_message_watcher=StatusMessageWatcherAsync,
-            streamed_log=StreamedLogAsync,
             request_queue_client=RequestQueueClientAsync,
             request_queue_collection_client=RequestQueueCollectionClientAsync,
             run_client=RunClientAsync,

src/apify_client/_client_registry.py

@@ -43,12 +43,8 @@
         ScheduleClientAsync,
         ScheduleCollectionClient,
         ScheduleCollectionClientAsync,
-        StatusMessageWatcherAsync,
-        StatusMessageWatcherSync,
         StoreCollectionClient,
         StoreCollectionClientAsync,
-        StreamedLogAsync,
-        StreamedLogSync,
         TaskClient,
         TaskClientAsync,
         TaskCollectionClient,
@@ -87,8 +83,6 @@ class ClientRegistry:
     key_value_store_client: type[KeyValueStoreClient]
     key_value_store_collection_client: type[KeyValueStoreCollectionClient]
     log_client: type[LogClient]
-    status_message_watcher: type[StatusMessageWatcherSync]
-    streamed_log: type[StreamedLogSync]
     request_queue_client: type[RequestQueueClient]
     request_queue_collection_client: type[RequestQueueCollectionClient]
     run_client: type[RunClient]
@@ -126,8 +120,6 @@ class ClientRegistryAsync:
     key_value_store_client: type[KeyValueStoreClientAsync]
     key_value_store_collection_client: type[KeyValueStoreCollectionClientAsync]
     log_client: type[LogClientAsync]
-    status_message_watcher: type[StatusMessageWatcherAsync]
-    streamed_log: type[StreamedLogAsync]
     request_queue_client: type[RequestQueueClientAsync]
     request_queue_collection_client: type[RequestQueueCollectionClientAsync]
     run_client: type[RunClientAsync]

src/apify_client/_docs.py

@@ -3,13 +3,15 @@
 from collections.abc import Callable
 from typing import Any, Literal, TypeVar
 
-# The order of the rendered API groups is defined in the website/docusaurus.config.js file.
+# The order of the rendered API groups is defined by GROUP_ORDER in website/transformDocs.js
+# and applied via groupSort in website/docusaurus.config.js.
 GroupName = Literal[
     'Apify API clients',
-    'Resource clients',
     'HTTP clients',
-    'Models',
+    'Resource clients',
     'Errors',
+    'Models',
+    'Other',
 ]
 
 T = TypeVar('T', bound=Callable[..., Any])

src/apify_client/_resource_clients/__init__.py

@@ -17,9 +17,7 @@
 from .run_collection import RunCollectionClient, RunCollectionClientAsync
 from .schedule import ScheduleClient, ScheduleClientAsync
 from .schedule_collection import ScheduleCollectionClient, ScheduleCollectionClientAsync
-from .status_message_watcher import StatusMessageWatcher, StatusMessageWatcherAsync, StatusMessageWatcherSync
 from .store_collection import StoreCollectionClient, StoreCollectionClientAsync
-from .streamed_log import StreamedLog, StreamedLogAsync, StreamedLogSync
 from .task import TaskClient, TaskClientAsync
 from .task_collection import TaskCollectionClient, TaskCollectionClientAsync
 from .user import UserClient, UserClientAsync
@@ -67,14 +65,8 @@
     'ScheduleClientAsync',
     'ScheduleCollectionClient',
     'ScheduleCollectionClientAsync',
-    'StatusMessageWatcher',
-    'StatusMessageWatcherAsync',
-    'StatusMessageWatcherSync',
     'StoreCollectionClient',
     'StoreCollectionClientAsync',
-    'StreamedLog',
-    'StreamedLogAsync',
-    'StreamedLogSync',
     'TaskClient',
     'TaskClientAsync',
     'TaskCollectionClient',

src/apify_client/_resource_clients/_resource_client.py

@@ -7,6 +7,7 @@
 from typing import TYPE_CHECKING, Any
 
 from apify_client._consts import DEFAULT_WAIT_FOR_FINISH, DEFAULT_WAIT_WHEN_JOB_NOT_EXIST, TERMINAL_STATUSES
+from apify_client._docs import docs_group
 from apify_client._internal_models import ActorJobResponse
 from apify_client._logging import WithLogDetailsClient
 from apify_client._utils import catch_not_found_or_throw, response_to_dict, to_safe_id, to_seconds
@@ -120,6 +121,7 @@ def _build_params(self, **kwargs: Any) -> dict:
         return {k: v for k, v in merged.items() if v is not None}
 
 
+@docs_group('Resource clients')
 class ResourceClient(ResourceClientBase):
     """Base class for synchronous resource clients."""
 
@@ -286,6 +288,7 @@ def _wait_for_finish(
         return actor_job
 
 
+@docs_group('Resource clients')
 class ResourceClientAsync(ResourceClientBase):
     """Base class for asynchronous resource clients."""
 

src/apify_client/_resource_clients/actor.py

@@ -52,8 +52,8 @@
 class ActorClient(ResourceClient):
     """Sub-client for managing a specific Actor.
 
-    Provides methods to get, update, delete, build, and start runs of an Actor.
-    Obtain an instance via `ApifyClient.actor`.
+    Provides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance
+    via an appropriate method on the `ApifyClient` class.
     """
 
     def __init__(
@@ -516,8 +516,8 @@ def validate_input(
 class ActorClientAsync(ResourceClientAsync):
     """Sub-client for managing a specific Actor.
 
-    Provides methods to get, update, delete, build, and start runs of an Actor.
-    Obtain an instance via `ApifyClientAsync.actor`.
+    Provides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance
+    via an appropriate method on the `ApifyClientAsync` class.
     """
 
     def __init__(

src/apify_client/_resource_clients/actor_collection.py

@@ -16,7 +16,8 @@
 class ActorCollectionClient(ResourceClient):
     """Sub-client for the Actor collection.
 
-    Provides methods to list and create Actors. Obtain an instance via `ApifyClient.actors`.
+    Provides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate
+    method on the `ApifyClient` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -147,7 +148,8 @@ def create(
 class ActorCollectionClientAsync(ResourceClientAsync):
     """Sub-client for the Actor collection.
 
-    Provides methods to list and create Actors. Obtain an instance via `ApifyClientAsync.actors`.
+    Provides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate
+    method on the `ApifyClientAsync` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:

src/apify_client/_resource_clients/actor_env_var.py

@@ -26,8 +26,8 @@ def get_actor_env_var_representation(
 class ActorEnvVarClient(ResourceClient):
     """Sub-client for managing a specific Actor environment variable.
 
-    Provides methods to get, update, and delete an environment variable.
-    Obtain an instance via `ActorVersionClient.env_var`.
+    Provides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance
+    via an appropriate method on the `ActorVersionClient` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -87,8 +87,8 @@ def delete(self) -> None:
 class ActorEnvVarClientAsync(ResourceClientAsync):
     """Sub-client for managing a specific Actor environment variable.
 
-    Provides methods to get, update, and delete an environment variable.
-    Obtain an instance via `ActorVersionClientAsync.env_var`.
+    Provides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance
+    via an appropriate method on the `ActorVersionClientAsync` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:

src/apify_client/_resource_clients/actor_env_var_collection.py

@@ -13,8 +13,8 @@
 class ActorEnvVarCollectionClient(ResourceClient):
     """Sub-client for the Actor environment variable collection.
 
-    Provides methods to list and create environment variables.
-    Obtain an instance via `ActorVersionClient.env_vars`.
+    Provides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an
+    appropriate method on the `ActorVersionClient` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -65,8 +65,8 @@ def create(
 class ActorEnvVarCollectionClientAsync(ResourceClientAsync):
     """Sub-client for the Actor environment variable collection.
 
-    Provides methods to list and create environment variables.
-    Obtain an instance via `ActorVersionClientAsync.env_vars`.
+    Provides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an
+    appropriate method on the `ActorVersionClientAsync` class.
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:

src/apify_client/_resource_clients/actor_version.py

@@ -21,8 +21,8 @@
 class ActorVersionClient(ResourceClient):
     """Sub-client for managing a specific Actor version.
 
-    Provides methods to get, update, and delete an Actor version.
-    Obtain an instance via `ActorClient.version`.
+    Provides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an
+    appropriate method on the `ActorClient` class.
     """
 
     def __init__(
@@ -131,8 +131,8 @@ def env_var(self, env_var_name: str) -> ActorEnvVarClient:
 class ActorVersionClientAsync(ResourceClientAsync):
     """Sub-client for managing a specific Actor version.
 
-    Provides methods to get, update, and delete an Actor version.
-    Obtain an instance via `ActorClientAsync.version`.
+    Provides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an
+    appropriate method on the `ActorClientAsync` class.
     """
 
     def __init__(