[feat] Consolidate SmartRate functions, add recommended ship date function #566
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… date - Clarify existing endpoint to get estimated delivery date based on ship date - Consolidate SmartRate-related functions into new SmartRate service - Mark legacy SmartRate functions and classes with obsolete warnings - Update unit tests accordingly
Justintime50
reviewed
Jun 3, 2024
There was a problem hiding this comment.
I think this looks good. As discussed, we'll hold off until this goes GA to merge in and release. I feel splitting SmartRate to its own service is a good idea especially as the product matures and more functionality becomes available. Since everything is static now, it doesn't make sense to keep it in the Shipment service because you have to pass in the shipment ID anyway now, it no longer inherently belongs to Shipment.
jchen293
reviewed
Jun 10, 2024
| /// Class representing a set of SmartRate-related beta functionality. | ||
| /// </summary> | ||
| // ReSharper disable once ClassNeverInstantiated.Global | ||
| public class SmartRateService : EasyPostService |
There was a problem hiding this comment.
Should this class be out of beta when the endpoints are in GA?
|
|
||
| /// <summary> | ||
| /// Retrieve the estimated delivery date of each rate for a <see cref="Shipment"/> via the SmartRates API, based on a specific ship date. | ||
| /// <a href="https://www.easypost.com/docs/api#retrieve-estimated-delivery-date-and-total-transit-days-across-all-rates-for-a-shipment">Related API documentation</a>. |
There was a problem hiding this comment.
URL seems incorrect to what this function does, you might want to add a TODO and come back to fix it when API docs is added for this endpoint
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
SmartRateservice under beta for interacting with the SmartRate APIRecommendShipDateByDeliveryDatefunction to recommend a ship date based on a delivery date for each shipment rateEstimateDeliveryDateByShipDatefunction to get an estimated delivery date based on a ship date for each shipment rateShipmentservice marked as deprecated and will be removed in a future releaseThe entire service is under beta, although inside it the
EstimatedDeliveryDateByShipDateandGetSmartRatesfunctions in it point to GA endpoints. OnlyRecommendShipDateByDeliveryDateis a new "beta" endpoint.When the service is promoted to GA, the existing SmartRate functions in the
Shipmentservice should be removed.Testing
Pull Request Type
Please select the option(s) that are relevant to this PR.