- Add dedicated API Keys service

- Migrate API key-related functions to API Keys service, deprecated in User service
- Migrate unit tests, re-record cassettes as needed

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+- Add dedicated API Key-related service, available via the `api_keys` property of a client
+  - NOTE: Please note the naming. The `api_key` property of a client is the currently-used API key string, while the `api_keys` property is the service for managing API keys.
+- Migrated API Key-related functionality to `api_keys` service, deprecated old methods in `user` service
+
 ## v8.1.1 (2023-09-05)
 
 - Fix endpoint for creating a FedEx Smartpost carrier account

easypost/easypost_client.py

@@ -11,6 +11,7 @@
 )
 from easypost.services import (
     AddressService,
+    ApiKeyService,
     BatchService,
     BetaCarrierMetadataService,
     BetaRateService,
@@ -54,6 +55,7 @@ def __init__(
 
         # Services
         self.address = AddressService(self)
+        self.api_keys = ApiKeyService(self)
         self.batch = BatchService(self)
         self.beta_carrier_metadata = BetaCarrierMetadataService(self)
         self.beta_rate = BetaRateService(self)

easypost/services/__init__.py

@@ -1,5 +1,6 @@
 # flake8: noqa
 from easypost.services.address_service import AddressService
+from easypost.services.api_key_service import ApiKeyService
 from easypost.services.batch_service import BatchService
 from easypost.services.beta_carrier_metadata_service import BetaCarrierMetadataService
 from easypost.services.beta_rate_service import BetaRateService

easypost/services/api_key_service.py

@@ -0,0 +1,45 @@
+from typing import (
+    Any,
+    Dict,
+    List,
+)
+
+from easypost.easypost_object import convert_to_easypost_object
+from easypost.models import ApiKey
+from easypost.requestor import (
+    RequestMethod,
+    Requestor,
+)
+from easypost.services.base_service import BaseService
+
+
+class ApiKeyService(BaseService):
+    def __init__(self, client):
+        self._client = client
+        self._model_class = ApiKey.__name__
+
+    def all(self) -> Dict[str, Any]:
+        """Retrieve a list of all API keys."""
+        url = "/api_keys"
+
+        response = Requestor(self._client).request(method=RequestMethod.GET, url=url)
+
+        return convert_to_easypost_object(response=response)
+
+    def retrieve_api_keys_for(self, id: str) -> List[ApiKey]:
+        """Retrieve a list of API keys (works for the authenticated User or a child User)."""
+        api_keys = self.all()
+        my_api_keys = []
+
+        if api_keys["id"] == id:
+            # This function was called on the authenticated user
+            my_api_keys = api_keys["keys"]
+        else:
+            # This function was called on a child user (authenticated as parent, only return
+            # this child user's details).
+            for child in api_keys["children"]:
+                if child.id == id:
+                    my_api_keys = child.keys
+                    break
+
+        return my_api_keys

easypost/services/user_service.py

@@ -4,6 +4,7 @@
     List,
     Optional,
 )
+from warnings import warn
 
 from easypost.easypost_object import convert_to_easypost_object
 from easypost.models import (
@@ -68,6 +69,12 @@ def retrieve_me(self) -> User:
 
     def all_api_keys(self) -> Dict[str, Any]:
         """Retrieve a list of all API keys."""
+        warn(
+            'This method is deprecated, use the "all" function of "api_keys" on the client instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
         url = "/api_keys"
 
         response = Requestor(self._client).request(method=RequestMethod.GET, url=url)
@@ -76,6 +83,12 @@ def all_api_keys(self) -> Dict[str, Any]:
 
     def api_keys(self, id: str) -> List[ApiKey]:
         """Retrieve a list of API keys (works for the authenticated User or a child User)."""
+        warn(
+            'This method is deprecated, use the "retrieve_api_keys_for" function of "api_keys" on the client instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
         api_keys = self.all_api_keys()
         my_api_keys = []