Handle adding carrier accounts that require custom workflows (#245)

- Overload existing `create` function in carrier_account to dynamically adjust URL based on carrier account type
- Update unit test, cassette

Author: nwithan8

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## NEXT RELEASE
 
-- Adds `register` function to CarrierAccount for carriers with custom registration such as FedEx or UPS
+- [ADDED] `create` function for CarrierAccount now supports carrier accounts with custom workflows (e.g. FedEx, UPS)
 
 ## v7.6.1 (2022-10-24)
 

easypost/carrier_account.py

@@ -1,8 +1,10 @@
 from typing import (
+    Any,
     List,
     Optional,
 )
 
+from easypost.constant import _CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_WORKFLOWS
 from easypost.easypost_object import convert_to_easypost_object
 from easypost.requestor import (
     RequestMethod,
@@ -16,6 +18,14 @@
 )
 
 
+def _select_carrier_account_creation_endpoint(carrier_account_type: Optional[Any]) -> str:
+    """Determines which API endpoint to use for the creation call."""
+    if carrier_account_type in _CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_WORKFLOWS:
+        return "/carrier_accounts/register"
+
+    return "/carrier_accounts"
+
+
 class CarrierAccount(AllResource, CreateResource, UpdateResource, DeleteResource):
     @classmethod
     def types(cls, api_key: Optional[str] = None) -> List[str]:
@@ -24,11 +34,18 @@ def types(cls, api_key: Optional[str] = None) -> List[str]:
         response, api_key = requestor.request(method=RequestMethod.GET, url="/carrier_types")
         return convert_to_easypost_object(response=response, api_key=api_key)
 
+    # Overrides CreateResource.create
     @classmethod
-    def register(cls, api_key: Optional[str] = None, **params) -> "CarrierAccount":
+    def create(cls, api_key: Optional[str] = None, **params) -> "CarrierAccount":
         """Creates a Carrier Account that requires custom registration (eg: FedEx & UPS)."""
         requestor = Requestor(local_api_key=api_key)
-        url = f"{cls.class_url()}/register"
+
+        carrier_account_type = params.get("type")
+
+        if carrier_account_type is None:
+            raise ValueError("Missing required parameter 'type'")
+
+        url = _select_carrier_account_creation_endpoint(carrier_account_type=carrier_account_type)
         wrapped_params = {cls.snakecase_name(): params}
         response, api_key = requestor.request(method=RequestMethod.POST, url=url, params=wrapped_params)
         return convert_to_easypost_object(response=response, api_key=api_key)

easypost/constant.py

@@ -1,2 +1,7 @@
 SUPPORT_EMAIL = "[email protected]"
 TIMEOUT = 60
+
+_CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_WORKFLOWS = [
+    "FedexAccount",
+    "UpsAccount",
+]

tests/cassettes/test_carrier_account_register.yaml renamed to tests/cassettes/test_carrier_account_create_with_custom_workflow.yaml

@@ -66,7 +66,7 @@ def test_carrier_account_type(prod_api_key):
 
 
 @pytest.mark.vcr()
-def test_carrier_account_register(prod_api_key):
+def test_carrier_account_create_with_custom_workflow(prod_api_key):
     """Test register a Carrier Account with custom registration such as FedEx or UPS.
 
     We purposefully don't pass data here because real data is required for this endpoint
@@ -78,7 +78,7 @@ def test_carrier_account_register(prod_api_key):
     }
 
     try:
-        easypost.CarrierAccount.register(**carrier_account)
+        easypost.CarrierAccount.create(**carrier_account)
     except easypost.Error as error:
         # TODO: Assert against error.errors when that property gets added
         assert '{"field": "account_number", "message": "must be present and a string"}' in error.http_body