feat: add monthlyUsage() and limits() methods to UserClient (#183)

These endpoints have been around for some quite time and now we're
exposing them via the Python client.

Author: tobice

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## [1.6.4](../../releases/tag/v1.6.4) - Not released yet
 
-...
+### Added
+
+- added `monthlyUsage()` and `limits()` methods to `UserClient`
 
 ## [1.6.3](../../releases/tag/v1.6.3) - 2023-01-16
 

src/apify_client/clients/resource_clients/user.py

@@ -2,8 +2,10 @@
 
 from typing import Any
 
-from apify_shared.utils import ignore_docs
+from apify_shared.utils import ignore_docs, parse_date_fields
 
+from apify_client._errors import ApifyApiError
+from apify_client._utils import catch_not_found_or_throw, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
 
 
@@ -27,10 +29,59 @@ def get(self: UserClient) -> dict | None:
         https://docs.apify.com/api/v2#/reference/users
 
         Returns:
-            dict, optional: The retrieved user data, or None if the user does not exist.
+            The retrieved user data, or None if the user does not exist.
         """
         return self._get()
 
+    def monthly_usage(self: UserClient) -> dict | None:
+        """Return monthly usage of the user account.
+
+        This includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown
+        of usage. It is the same information which is available on the account's Billing page. The information includes
+        use of storage, data transfer, and request queue usage.
+
+        https://docs.apify.com/api/v2/#/reference/users/monthly-usage
+
+        Returns:
+            The retrieved request, or None, if it did not exist.
+        """
+        try:
+            response = self.http_client.call(
+                url=self._url('usage/monthly'),
+                method='GET',
+                params=self._params(),
+            )
+            return parse_date_fields(pluck_data(response.json()))
+
+        except ApifyApiError as exc:
+            catch_not_found_or_throw(exc)
+
+        return None
+
+    def limits(self: UserClient) -> dict | None:
+        """Returns a complete summary of the user account's limits.
+
+        It is the same information which is available on the account's Limits page. The returned data includes the current
+        usage cycle, a summary of the account's limits, and the current usage.
+
+        https://docs.apify.com/api/v2#/reference/request-queues/request/get-request
+
+        Returns:
+            The retrieved request, or None, if it did not exist.
+        """
+        try:
+            response = self.http_client.call(
+                url=self._url('limits'),
+                method='GET',
+                params=self._params(),
+            )
+            return parse_date_fields(pluck_data(response.json()))
+
+        except ApifyApiError as exc:
+            catch_not_found_or_throw(exc)
+
+        return None
+
 
 class UserClientAsync(ResourceClientAsync):
     """Async sub-client for querying user data."""
@@ -52,6 +103,55 @@ async def get(self: UserClientAsync) -> dict | None:
         https://docs.apify.com/api/v2#/reference/users
 
         Returns:
-            dict, optional: The retrieved user data, or None if the user does not exist.
+            The retrieved user data, or None if the user does not exist.
         """
         return await self._get()
+
+    async def monthly_usage(self: UserClientAsync) -> dict | None:
+        """Return monthly usage of the user account.
+
+        This includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown
+        of usage. It is the same information which is available on the account's Billing page. The information includes
+        use of storage, data transfer, and request queue usage.
+
+        https://docs.apify.com/api/v2/#/reference/users/monthly-usage
+
+        Returns:
+            The retrieved request, or None, if it did not exist.
+        """
+        try:
+            response = await self.http_client.call(
+                url=self._url('usage/monthly'),
+                method='GET',
+                params=self._params(),
+            )
+            return parse_date_fields(pluck_data(response.json()))
+
+        except ApifyApiError as exc:
+            catch_not_found_or_throw(exc)
+
+        return None
+
+    async def limits(self: UserClientAsync) -> dict | None:
+        """Returns a complete summary of the user account's limits.
+
+        It is the same information which is available on the account's Limits page. The returned data includes the current
+        usage cycle, a summary of the account's limits, and the current usage.
+
+        https://docs.apify.com/api/v2#/reference/request-queues/request/get-request
+
+        Returns:
+            The retrieved request, or None, if it did not exist.
+        """
+        try:
+            response = await self.http_client.call(
+                url=self._url('limits'),
+                method='GET',
+                params=self._params(),
+            )
+            return parse_date_fields(pluck_data(response.json()))
+
+        except ApifyApiError as exc:
+            catch_not_found_or_throw(exc)
+
+        return None