- Address feedback

Author: nwithan8

easypost/shipment.py

@@ -21,20 +21,23 @@
 
 class Shipment(AllResource, CreateResource):
     @classmethod
-    def create(cls, api_key: Optional[str] = None, carbon_offset: Optional[bool] = False, **params) -> "Shipment":
+    def create(cls, api_key: Optional[str] = None, with_carbon_offset: Optional[bool] = False, **params) -> "Shipment":
         """Create an Shipment object."""
         requestor = Requestor(local_api_key=api_key)
         url = cls.class_url()
-        wrapped_params = {cls.snakecase_name(): params, "carbon_offset": carbon_offset}
+        wrapped_params = {
+            cls.snakecase_name(): params,
+            "carbon_offset": with_carbon_offset,
+        }
         response, api_key = requestor.request(method=RequestMethod.POST, url=url, params=wrapped_params)
         return convert_to_easypost_object(response=response, api_key=api_key)
 
-    def regenerate_rates(self, carbon_offset: Optional[bool] = False) -> "Shipment":
+    def regenerate_rates(self, with_carbon_offset: Optional[bool] = False) -> "Shipment":
         """Regenerate rates for a shipment."""
         requestor = Requestor(local_api_key=self._api_key)
         url = "%s/%s" % (self.instance_url(), "rerate")
         params = {
-            "carbon_offset": carbon_offset,
+            "carbon_offset": with_carbon_offset,
         }
         response, api_key = requestor.request(method=RequestMethod.POST, url=url, params=params)
         self.refresh_from(values=response, api_key=api_key)
@@ -47,11 +50,11 @@ def get_smartrates(self) -> List[object]:
         response, _ = requestor.request(method=RequestMethod.GET, url=url)
         return response.get("result", [])
 
-    def buy(self, carbon_offset: Optional[bool] = False, **params) -> "Shipment":
+    def buy(self, with_carbon_offset: Optional[bool] = False, **params) -> "Shipment":
         """Buy a shipment."""
         requestor = Requestor(local_api_key=self._api_key)
         url = "%s/%s" % (self.instance_url(), "buy")
-        params["carbon_offset"] = carbon_offset
+        params["carbon_offset"] = with_carbon_offset
 
         response, api_key = requestor.request(method=RequestMethod.POST, url=url, params=params)
         self.refresh_from(values=response, api_key=api_key)

tests/test_shipment.py

@@ -248,7 +248,7 @@ def test_generate_form(one_call_buy_shipment, rma_form_options):
 
 @pytest.mark.vcr()
 def test_shipment_create_with_carbon_offset(carbon_offset_shipment):
-    shipment = easypost.Shipment.create(carbon_offset=True, **carbon_offset_shipment)
+    shipment = easypost.Shipment.create(with_carbon_offset=True, **carbon_offset_shipment)
 
     assert isinstance(shipment, easypost.Shipment)
     assert shipment.rates is not None
@@ -266,7 +266,7 @@ def test_shipment_buy_with_carbon_offset(carbon_offset_shipment):
 
 @pytest.mark.vcr()
 def test_shipment_one_call_buy_with_carbon_offset(carbon_offset_shipment_one_call_buy):
-    shipment = easypost.Shipment.create(carbon_offset=True, **carbon_offset_shipment_one_call_buy)
+    shipment = easypost.Shipment.create(with_carbon_offset=True, **carbon_offset_shipment_one_call_buy)
 
     assert isinstance(shipment, easypost.Shipment)
     assert all(rate.carbon_offset is not None for rate in shipment.rates)