inline all data fields in responses

Author: vdusek

src/apify_client/_resource_clients/dataset.py

@@ -7,7 +7,7 @@
 
 from apify_shared.utils import create_storage_content_signature
 
-from apify_client._models import Dataset, DatasetResponse, GetDatasetStatisticsResponse
+from apify_client._models import Data11, Dataset, DatasetResponse, GetDatasetStatisticsResponse
 from apify_client._resource_clients.base import ResourceClient, ResourceClientAsync
 from apify_client._types import ListPage
 from apify_client._utils import (
@@ -566,7 +566,7 @@ def push_items(self, items: JsonSerializable) -> None:
             timeout_secs=_MEDIUM_TIMEOUT,
         )
 
-    def get_statistics(self) -> GetDatasetStatisticsResponse | None:
+    def get_statistics(self) -> Data11 | None:
         """Get the dataset statistics.
 
         https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get
@@ -582,7 +582,7 @@ def get_statistics(self) -> GetDatasetStatisticsResponse | None:
                 timeout_secs=_SMALL_TIMEOUT,
             )
             result = response.json()
-            return GetDatasetStatisticsResponse.model_validate(result) if result is not None else None
+            return GetDatasetStatisticsResponse.model_validate(result).data if result is not None else None
         except ApifyApiError as exc:
             catch_not_found_or_throw(exc)
 
@@ -1092,7 +1092,7 @@ async def push_items(self, items: JsonSerializable) -> None:
             timeout_secs=_MEDIUM_TIMEOUT,
         )
 
-    async def get_statistics(self) -> GetDatasetStatisticsResponse | None:
+    async def get_statistics(self) -> Data11 | None:
         """Get the dataset statistics.
 
         https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get
@@ -1108,7 +1108,7 @@ async def get_statistics(self) -> GetDatasetStatisticsResponse | None:
                 timeout_secs=_SMALL_TIMEOUT,
             )
             result = response.json()
-            return GetDatasetStatisticsResponse.model_validate(result) if result is not None else None
+            return GetDatasetStatisticsResponse.model_validate(result).data if result is not None else None
         except ApifyApiError as exc:
             catch_not_found_or_throw(exc)
 

src/apify_client/_resource_clients/key_value_store.py

@@ -7,7 +7,7 @@
 
 from apify_shared.utils import create_hmac_signature, create_storage_content_signature
 
-from apify_client._models import GetStoreResponse, KeyValueStore, ListOfKeysResponse
+from apify_client._models import Data8, GetStoreResponse, KeyValueStore, ListOfKeysResponse
 from apify_client._resource_clients.base import ResourceClient, ResourceClientAsync
 from apify_client._utils import (
     catch_not_found_or_throw,
@@ -79,7 +79,7 @@ def list_keys(
         collection: str | None = None,
         prefix: str | None = None,
         signature: str | None = None,
-    ) -> ListOfKeysResponse:
+    ) -> Data8:
         """List the keys in the key-value store.
 
         https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys
@@ -110,7 +110,7 @@ def list_keys(
         )
 
         result = response.json()
-        return ListOfKeysResponse.model_validate(result)
+        return ListOfKeysResponse.model_validate(result).data
 
     def get_record(self, key: str, signature: str | None = None) -> dict | None:
         """Retrieve the given record from the key-value store.
@@ -411,7 +411,7 @@ async def list_keys(
         collection: str | None = None,
         prefix: str | None = None,
         signature: str | None = None,
-    ) -> ListOfKeysResponse:
+    ) -> Data8:
         """List the keys in the key-value store.
 
         https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys
@@ -442,7 +442,7 @@ async def list_keys(
         )
 
         result = response.json()
-        return ListOfKeysResponse.model_validate(result)
+        return ListOfKeysResponse.model_validate(result).data
 
     async def get_record(self, key: str, signature: str | None = None) -> dict | None:
         """Retrieve the given record from the key-value store.

src/apify_client/_resource_clients/request_queue.py

@@ -13,6 +13,10 @@
     AddRequestResponse,
     BatchOperationResponse,
     Data13,
+    Data14,
+    Data15,
+    Data16,
+    Data17,
     GetHeadAndLockResponse,
     GetHeadResponse,
     GetRequestQueueResponse,
@@ -100,7 +104,7 @@ def delete(self) -> None:
         """
         return self._delete(timeout_secs=_SMALL_TIMEOUT)
 
-    def list_head(self, *, limit: int | None = None) -> GetHeadResponse:
+    def list_head(self, *, limit: int | None = None) -> Data15:
         """Retrieve a given number of requests from the beginning of the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head
@@ -121,9 +125,9 @@ def list_head(self, *, limit: int | None = None) -> GetHeadResponse:
         )
 
         result = response.json()
-        return GetHeadResponse.model_validate(result)
+        return GetHeadResponse.model_validate(result).data
 
-    def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None) -> GetHeadAndLockResponse:
+    def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None) -> Data16:
         """Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.
 
         https://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock
@@ -145,7 +149,7 @@ def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None) -> Get
         )
 
         result = response.json()
-        return GetHeadAndLockResponse.model_validate(result)
+        return GetHeadAndLockResponse.model_validate(result).data
 
     def add_request(self, request: dict, *, forefront: bool | None = None) -> RequestOperationInfo:
         """Add a request to the queue.
@@ -250,7 +254,7 @@ def prolong_request_lock(
         *,
         forefront: bool | None = None,
         lock_secs: int,
-    ) -> ProlongRequestLockResponse:
+    ) -> Data17 | None:
         """Prolong the lock on a request.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock
@@ -270,7 +274,7 @@ def prolong_request_lock(
         )
 
         result = response.json()
-        return ProlongRequestLockResponse.model_validate(result)
+        return ProlongRequestLockResponse.model_validate(result).data
 
     def delete_request_lock(self, request_id: str, *, forefront: bool | None = None) -> None:
         """Delete the lock on a request.
@@ -371,7 +375,7 @@ def batch_add_requests(
             )
         )
 
-    def batch_delete_requests(self, requests: list[dict]) -> BatchOperationResponse:
+    def batch_delete_requests(self, requests: list[dict]) -> Data13:
         """Delete given requests from the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests
@@ -390,14 +394,14 @@ def batch_delete_requests(self, requests: list[dict]) -> BatchOperationResponse:
         )
 
         result = response.json()
-        return BatchOperationResponse.model_validate(result)
+        return BatchOperationResponse.model_validate(result).data
 
     def list_requests(
         self,
         *,
         limit: int | None = None,
         exclusive_start_id: str | None = None,
-    ) -> ListRequestsResponse:
+    ) -> Data14:
         """List requests in the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests
@@ -416,9 +420,9 @@ def list_requests(
         )
 
         result = response.json()
-        return ListRequestsResponse.model_validate(result)
+        return ListRequestsResponse.model_validate(result).data
 
-    def unlock_requests(self: RequestQueueClient) -> BatchOperationResponse:
+    def unlock_requests(self: RequestQueueClient) -> Data13:
         """Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests
@@ -435,7 +439,7 @@ def unlock_requests(self: RequestQueueClient) -> BatchOperationResponse:
         )
 
         result = response.json()
-        return BatchOperationResponse.model_validate(result)
+        return BatchOperationResponse.model_validate(result).data
 
 
 class RequestQueueClientAsync(ResourceClientAsync):
@@ -499,7 +503,7 @@ async def delete(self) -> None:
         """
         return await self._delete(timeout_secs=_SMALL_TIMEOUT)
 
-    async def list_head(self, *, limit: int | None = None) -> GetHeadResponse:
+    async def list_head(self, *, limit: int | None = None) -> Data15:
         """Retrieve a given number of requests from the beginning of the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head
@@ -520,9 +524,9 @@ async def list_head(self, *, limit: int | None = None) -> GetHeadResponse:
         )
 
         result = response.json()
-        return GetHeadResponse.model_validate(result)
+        return GetHeadResponse.model_validate(result).data
 
-    async def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None) -> GetHeadAndLockResponse:
+    async def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None) -> Data16:
         """Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.
 
         https://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock
@@ -544,7 +548,7 @@ async def list_and_lock_head(self, *, lock_secs: int, limit: int | None = None)
         )
 
         result = response.json()
-        return GetHeadAndLockResponse.model_validate(result)
+        return GetHeadAndLockResponse.model_validate(result).data
 
     async def add_request(self, request: dict, *, forefront: bool | None = None) -> RequestOperationInfo:
         """Add a request to the queue.
@@ -647,7 +651,7 @@ async def prolong_request_lock(
         *,
         forefront: bool | None = None,
         lock_secs: int,
-    ) -> ProlongRequestLockResponse:
+    ) -> Data17 | None:
         """Prolong the lock on a request.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock
@@ -667,7 +671,7 @@ async def prolong_request_lock(
         )
 
         result = response.json()
-        return ProlongRequestLockResponse.model_validate(result)
+        return ProlongRequestLockResponse.model_validate(result).data
 
     async def delete_request_lock(
         self,
@@ -821,7 +825,7 @@ async def batch_add_requests(
             )
         )
 
-    async def batch_delete_requests(self, requests: list[dict]) -> BatchOperationResponse:
+    async def batch_delete_requests(self, requests: list[dict]) -> Data13:
         """Delete given requests from the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests
@@ -839,14 +843,14 @@ async def batch_delete_requests(self, requests: list[dict]) -> BatchOperationRes
             timeout_secs=_SMALL_TIMEOUT,
         )
         result = response.json()
-        return BatchOperationResponse.model_validate(result)
+        return BatchOperationResponse.model_validate(result).data
 
     async def list_requests(
         self,
         *,
         limit: int | None = None,
         exclusive_start_id: str | None = None,
-    ) -> ListRequestsResponse:
+    ) -> Data14:
         """List requests in the queue.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests
@@ -865,9 +869,9 @@ async def list_requests(
         )
 
         result = response.json()
-        return ListRequestsResponse.model_validate(result)
+        return ListRequestsResponse.model_validate(result).data
 
-    async def unlock_requests(self: RequestQueueClientAsync) -> BatchOperationResponse:
+    async def unlock_requests(self: RequestQueueClientAsync) -> Data13:
         """Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.
 
         https://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests
@@ -884,4 +888,4 @@ async def unlock_requests(self: RequestQueueClientAsync) -> BatchOperationRespon
         )
 
         result = response.json()
-        return BatchOperationResponse.model_validate(result)
+        return BatchOperationResponse.model_validate(result).data

tests/integration/test_key_value_store.py

@@ -144,7 +144,7 @@ def test_list_keys_signature(apify_client: ApifyClient, test_kvs_of_another_user
 
     # Kvs content retrieved with correct signature
     response = kvs.list_keys(signature=test_kvs_of_another_user.signature)
-    raw_items = response.data.items
+    raw_items = response.items
 
     assert set(test_kvs_of_another_user.expected_content) == {item.key for item in raw_items}
 
@@ -323,11 +323,10 @@ def test_key_value_store_list_keys(apify_client: ApifyClient) -> None:
     # List keys
     keys_response = store_client.list_keys()
     assert keys_response is not None
-    assert keys_response.data is not None
-    assert len(keys_response.data.items) == 5
+    assert len(keys_response.items) == 5
 
     # Verify key names
-    key_names = [item.key for item in keys_response.data.items]
+    key_names = [item.key for item in keys_response.items]
     for i in range(5):
         assert f'key-{i}' in key_names
 
@@ -352,8 +351,7 @@ def test_key_value_store_list_keys_with_limit(apify_client: ApifyClient) -> None
     # List with limit
     keys_response = store_client.list_keys(limit=5)
     assert keys_response is not None
-    assert keys_response.data is not None
-    assert len(keys_response.data.items) == 5
+    assert len(keys_response.items) == 5
 
     # Cleanup
     store_client.delete()

tests/integration/test_key_value_store_async.py

@@ -150,7 +150,7 @@ async def test_list_keys_signature(apify_client_async: ApifyClientAsync, test_kv
 
     # Kvs content retrieved with correct signature
     response = await kvs.list_keys(signature=test_kvs_of_another_user.signature)
-    raw_items = response.data.items
+    raw_items = response.items
 
     assert set(test_kvs_of_another_user.expected_content) == {item.key for item in raw_items}
 
@@ -329,11 +329,10 @@ async def test_key_value_store_list_keys(apify_client_async: ApifyClientAsync) -
     # List keys
     keys_response = await store_client.list_keys()
     assert keys_response is not None
-    assert keys_response.data is not None
-    assert len(keys_response.data.items) == 5
+    assert len(keys_response.items) == 5
 
     # Verify key names
-    key_names = [item.key for item in keys_response.data.items]
+    key_names = [item.key for item in keys_response.items]
     for i in range(5):
         assert f'key-{i}' in key_names
 
@@ -358,8 +357,7 @@ async def test_key_value_store_list_keys_with_limit(apify_client_async: ApifyCli
     # List with limit
     keys_response = await store_client.list_keys(limit=5)
     assert keys_response is not None
-    assert keys_response.data is not None
-    assert len(keys_response.data.items) == 5
+    assert len(keys_response.items) == 5
 
     # Cleanup
     await store_client.delete()