use generated models in resource clients

Author: vdusek

src/apify_client/clients/resource_clients/actor.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, Literal
 
+from apify_client._models import Actor, Build, Run
 from apify_client._utils import (
     encode_key_value_store_record_value,
     encode_webhook_list_to_base64,
@@ -105,15 +106,16 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         resource_path = kwargs.pop('resource_path', 'acts')
         super().__init__(*args, resource_path=resource_path, **kwargs)
 
-    def get(self) -> dict | None:
+    def get(self) -> Actor | None:
         """Retrieve the Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor
 
         Returns:
             The retrieved Actor.
         """
-        return self._get()
+        result = self._get()
+        return Actor.model_validate(result) if result is not None else None
 
     def update(
         self,
@@ -143,7 +145,7 @@ def update(
         actor_standby_memory_mbytes: int | None = None,
         pricing_infos: list[dict] | None = None,
         actor_permission_level: ActorPermissionLevel | None = None,
-    ) -> dict:
+    ) -> Actor:
         """Update the Actor with the specified fields.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor
@@ -211,7 +213,8 @@ def update(
             actor_permission_level=actor_permission_level,
         )
 
-        return self._update(filter_out_none_values_recursively(actor_representation))
+        result = self._update(filter_out_none_values_recursively(actor_representation))
+        return Actor.model_validate(result)
 
     def delete(self) -> None:
         """Delete the Actor.
@@ -234,7 +237,7 @@ def start(
         force_permission_level: ActorPermissionLevel | None = None,
         wait_for_finish: int | None = None,
         webhooks: list[dict] | None = None,
-    ) -> dict:
+    ) -> Run:
         """Start the Actor and immediately return the Run object.
 
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
@@ -290,7 +293,8 @@ def start(
             params=request_params,
         )
 
-        return parse_date_fields(pluck_data(response.json()))
+        result = parse_date_fields(pluck_data(response.json()))
+        return Run.model_validate(result)
 
     def call(
         self,
@@ -307,7 +311,7 @@ def call(
         force_permission_level: ActorPermissionLevel | None = None,
         wait_secs: int | None = None,
         logger: Logger | None | Literal['default'] = 'default',
-    ) -> dict | None:
+    ) -> Run | None:
         """Start the Actor and wait for it to finish before returning the Run object.
 
         It waits indefinitely, unless the wait_secs argument is provided.
@@ -356,15 +360,15 @@ def call(
             force_permission_level=force_permission_level,
         )
         if not logger:
-            return self.root_client.run(started_run['id']).wait_for_finish(wait_secs=wait_secs)
+            return self.root_client.run(started_run.id).wait_for_finish(wait_secs=wait_secs)
 
-        run_client = self.root_client.run(run_id=started_run['id'])
+        run_client = self.root_client.run(run_id=started_run.id)
 
         if logger == 'default':
             logger = None
 
         with run_client.get_status_message_watcher(to_logger=logger), run_client.get_streamed_log(to_logger=logger):
-            return self.root_client.run(started_run['id']).wait_for_finish(wait_secs=wait_secs)
+            return self.root_client.run(started_run.id).wait_for_finish(wait_secs=wait_secs)
 
     def build(
         self,
@@ -374,7 +378,7 @@ def build(
         tag: str | None = None,
         use_cache: bool | None = None,
         wait_for_finish: int | None = None,
-    ) -> dict:
+    ) -> Build:
         """Build the Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor
@@ -408,7 +412,8 @@ def build(
             params=request_params,
         )
 
-        return parse_date_fields(pluck_data(response.json()))
+        result = parse_date_fields(pluck_data(response.json()))
+        return Build.model_validate(result)
 
     def builds(self) -> BuildCollectionClient:
         """Retrieve a client for the builds of this Actor."""
@@ -528,15 +533,16 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         resource_path = kwargs.pop('resource_path', 'acts')
         super().__init__(*args, resource_path=resource_path, **kwargs)
 
-    async def get(self) -> dict | None:
+    async def get(self) -> Actor | None:
         """Retrieve the Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor
 
         Returns:
             The retrieved Actor.
         """
-        return await self._get()
+        result = await self._get()
+        return Actor.model_validate(result) if result is not None else None
 
     async def update(
         self,
@@ -566,7 +572,7 @@ async def update(
         actor_standby_memory_mbytes: int | None = None,
         pricing_infos: list[dict] | None = None,
         actor_permission_level: ActorPermissionLevel | None = None,
-    ) -> dict:
+    ) -> Actor:
         """Update the Actor with the specified fields.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor
@@ -634,7 +640,8 @@ async def update(
             actor_permission_level=actor_permission_level,
         )
 
-        return await self._update(filter_out_none_values_recursively(actor_representation))
+        result = await self._update(filter_out_none_values_recursively(actor_representation))
+        return Actor.model_validate(result)
 
     async def delete(self) -> None:
         """Delete the Actor.
@@ -657,7 +664,7 @@ async def start(
         force_permission_level: ActorPermissionLevel | None = None,
         wait_for_finish: int | None = None,
         webhooks: list[dict] | None = None,
-    ) -> dict:
+    ) -> Run:
         """Start the Actor and immediately return the Run object.
 
         https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor
@@ -713,7 +720,8 @@ async def start(
             params=request_params,
         )
 
-        return parse_date_fields(pluck_data(response.json()))
+        result = parse_date_fields(pluck_data(response.json()))
+        return Run.model_validate(result)
 
     async def call(
         self,
@@ -730,7 +738,7 @@ async def call(
         force_permission_level: ActorPermissionLevel | None = None,
         wait_secs: int | None = None,
         logger: Logger | None | Literal['default'] = 'default',
-    ) -> dict | None:
+    ) -> Run | None:
         """Start the Actor and wait for it to finish before returning the Run object.
 
         It waits indefinitely, unless the wait_secs argument is provided.
@@ -780,9 +788,9 @@ async def call(
         )
 
         if not logger:
-            return await self.root_client.run(started_run['id']).wait_for_finish(wait_secs=wait_secs)
+            return await self.root_client.run(started_run.id).wait_for_finish(wait_secs=wait_secs)
 
-        run_client = self.root_client.run(run_id=started_run['id'])
+        run_client = self.root_client.run(run_id=started_run.id)
 
         if logger == 'default':
             logger = None
@@ -791,7 +799,7 @@ async def call(
         streamed_log = await run_client.get_streamed_log(to_logger=logger)
 
         async with status_redirector, streamed_log:
-            return await self.root_client.run(started_run['id']).wait_for_finish(wait_secs=wait_secs)
+            return await self.root_client.run(started_run.id).wait_for_finish(wait_secs=wait_secs)
 
     async def build(
         self,
@@ -801,7 +809,7 @@ async def build(
         tag: str | None = None,
         use_cache: bool | None = None,
         wait_for_finish: int | None = None,
-    ) -> dict:
+    ) -> Build:
         """Build the Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor
@@ -835,7 +843,8 @@ async def build(
             params=request_params,
         )
 
-        return parse_date_fields(pluck_data(response.json()))
+        result = parse_date_fields(pluck_data(response.json()))
+        return Build.model_validate(result)
 
     def builds(self) -> BuildCollectionClientAsync:
         """Retrieve a client for the builds of this Actor."""

src/apify_client/clients/resource_clients/actor_collection.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, Literal
 
+from apify_client._models import Actor, ActorShort
 from apify_client._utils import filter_out_none_values_recursively
 from apify_client.clients.base import ResourceCollectionClient, ResourceCollectionClientAsync
 from apify_client.clients.resource_clients.actor import get_actor_representation
@@ -25,7 +26,7 @@ def list(
         offset: int | None = None,
         desc: bool | None = None,
         sort_by: Literal['createdAt', 'stats.lastRunStartedAt'] | None = 'createdAt',
-    ) -> ListPage[dict]:
+    ) -> ListPage[ActorShort]:
         """List the Actors the user has created or used.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
@@ -68,7 +69,7 @@ def create(
         actor_standby_idle_timeout_secs: int | None = None,
         actor_standby_build: str | None = None,
         actor_standby_memory_mbytes: int | None = None,
-    ) -> dict:
+    ) -> Actor:
         """Create a new Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
@@ -132,7 +133,8 @@ def create(
             actor_standby_memory_mbytes=actor_standby_memory_mbytes,
         )
 
-        return self._create(filter_out_none_values_recursively(actor_representation))
+        result = self._create(filter_out_none_values_recursively(actor_representation))
+        return Actor.model_validate(result)
 
 
 class ActorCollectionClientAsync(ResourceCollectionClientAsync):
@@ -150,7 +152,7 @@ async def list(
         offset: int | None = None,
         desc: bool | None = None,
         sort_by: Literal['createdAt', 'stats.lastRunStartedAt'] | None = 'createdAt',
-    ) -> ListPage[dict]:
+    ) -> ListPage[ActorShort]:
         """List the Actors the user has created or used.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
@@ -193,7 +195,7 @@ async def create(
         actor_standby_idle_timeout_secs: int | None = None,
         actor_standby_build: str | None = None,
         actor_standby_memory_mbytes: int | None = None,
-    ) -> dict:
+    ) -> Actor:
         """Create a new Actor.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
@@ -257,4 +259,5 @@ async def create(
             actor_standby_memory_mbytes=actor_standby_memory_mbytes,
         )
 
-        return await self._create(filter_out_none_values_recursively(actor_representation))
+        result = await self._create(filter_out_none_values_recursively(actor_representation))
+        return Actor.model_validate(result)

src/apify_client/clients/resource_clients/actor_env_var.py

@@ -2,6 +2,7 @@
 
 from typing import Any
 
+from apify_client._models import EnvVar
 from apify_client._utils import filter_out_none_values_recursively
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
 
@@ -27,23 +28,24 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         resource_path = kwargs.pop('resource_path', 'env-vars')
         super().__init__(*args, resource_path=resource_path, **kwargs)
 
-    def get(self) -> dict | None:
+    def get(self) -> EnvVar | None:
         """Return information about the Actor environment variable.
 
         https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
 
         Returns:
             The retrieved Actor environment variable data.
         """
-        return self._get()
+        result = self._get()
+        return EnvVar.model_validate(result) if result is not None else None
 
     def update(
         self,
         *,
         is_secret: bool | None = None,
         name: str,
         value: str,
-    ) -> dict:
+    ) -> EnvVar:
         """Update the Actor environment variable with specified fields.
 
         https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
@@ -62,7 +64,8 @@ def update(
             value=value,
         )
 
-        return self._update(filter_out_none_values_recursively(actor_env_var_representation))
+        result = self._update(filter_out_none_values_recursively(actor_env_var_representation))
+        return EnvVar.model_validate(result)
 
     def delete(self) -> None:
         """Delete the Actor environment variable.
@@ -79,23 +82,24 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         resource_path = kwargs.pop('resource_path', 'env-vars')
         super().__init__(*args, resource_path=resource_path, **kwargs)
 
-    async def get(self) -> dict | None:
+    async def get(self) -> EnvVar | None:
         """Return information about the Actor environment variable.
 
         https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
 
         Returns:
             The retrieved Actor environment variable data.
         """
-        return await self._get()
+        result = await self._get()
+        return EnvVar.model_validate(result) if result is not None else None
 
     async def update(
         self,
         *,
         is_secret: bool | None = None,
         name: str,
         value: str,
-    ) -> dict:
+    ) -> EnvVar:
         """Update the Actor environment variable with specified fields.
 
         https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable
@@ -114,7 +118,8 @@ async def update(
             value=value,
         )
 
-        return await self._update(filter_out_none_values_recursively(actor_env_var_representation))
+        result = await self._update(filter_out_none_values_recursively(actor_env_var_representation))
+        return EnvVar.model_validate(result)
 
     async def delete(self) -> None:
         """Delete the Actor environment variable.