Merge pull request #266 from EasyPost/retrieve_estimated_delivery_date

feat: adds retrieve_estimated_delivery_date function

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Next Release
+
+- Adds `retrieve_estimated_delivery_date` function to the Shipment class
+
 ## v7.12.0 (2023-04-18)
 
 - Adds beta `retrieve_carrier_metadata` function

easypost/shipment.py

@@ -161,3 +161,13 @@ def get_lowest_smartrate(smartrates, delivery_days: int, delivery_accuracy: str)
             raise Error(message="No rates found.")
 
         return lowest_smartrate
+
+    def retrieve_estimated_delivery_date(self, planned_ship_date: str) -> List[Dict[str, Any]]:
+        """Retrieves the estimated delivery date of each Rate via SmartRate."""
+        requestor = Requestor(local_api_key=self._api_key)
+        url = "%s/%s" % (self.instance_url(), "smartrate/delivery_date")
+        params = {
+            "planned_ship_date": planned_ship_date,
+        }
+        response, api_key = requestor.request(method=RequestMethod.GET, url=url, params=params)
+        return convert_to_easypost_object(response=response.get("rates", []), api_key=api_key)

tests/test_shipment.py

@@ -305,3 +305,13 @@ def test_shipment_buy_with_end_shipper_id(ca_address_1, basic_shipment):
     shipment.buy(rate=shipment.lowest_rate(), end_shipper_id=end_shipper["id"])
 
     assert shipment.postage_label is not None
+
+
+@pytest.mark.vcr()
+def test_retrieve_estimated_delivery_date(basic_shipment):
+    """Tests that we retrieve time-in-transit data for each of the Rates of a Shipment."""
+    shipment = easypost.Shipment.create(**basic_shipment)
+
+    rates = shipment.retrieve_estimated_delivery_date(planned_ship_date="2023-04-28")
+
+    assert all(entry.get("easypost_time_in_transit_data") for entry in rates)