feat: update descriptions

tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py

@@ -57,16 +57,3 @@ def test_search_with_avoid_zone(self):
 
         result_list = result.to_list()
         assert len(result_list) > 0
-
-    def test_search_with_include_port_costs(self):
-        result = AnywhereFreightPricingForecastExplanation().search(
-            origin="68faf65af1345067f11dc6723b8da32f00e304a6f33c000118fccd81947deb4e",
-            destination="ea4921c8ad4fddb5fe3e7a4f834c1aa5863e43283c73da5f02d93bbc5dba72eb",
-            vessel_class="oil_handymax_mr2",
-            product="clean",
-            frequency="month",
-            include_port_costs=True,
-        )
-
-        result_list = result.to_list()
-        assert len(result_list) > 0

vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py

@@ -32,8 +32,9 @@ class AnywhereFreightPricingForecastExplanation:
     """
     Anywhere Freight Pricing Forecast Explanation endpoint.
 
-    Explains forecast price movements for a route by providing a base date
-    and a list of explanations for upcoming time periods.
+    Given a route (origin, destination, vessel class, product), this returns
+    a base date and a list of forecast explanations for upcoming dates at
+    the given frequency.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -50,13 +51,13 @@ def search(
         product: AfpProduct,
         frequency: AfpExplanationFrequency = "month_fixed",
         avoid_zone: Optional[List[AfpAvoidZone]] = None,
-        include_port_costs: Optional[bool] = None,
     ) -> AnywhereFreightPricingResult:
         """
         Get forecast price movement explanations for a route.
 
         Given a route (origin, destination, vessel class, product), this returns
-        a base date and a list of forecast explanations for upcoming time periods.
+        a base date and a list of forecast explanations for upcoming dates at
+        the given frequency.
 
         # Arguments
 
@@ -79,8 +80,6 @@ def search(
             avoid_zone: Routing zones to avoid for this route. Options:
                 `'Panama Canal'`, `'Suez Canal'`.
 
-            include_port_costs: Whether to include port costs in the calculation.
-
         # Returns
         `AnywhereFreightPricingResult`
 
@@ -129,9 +128,6 @@ def search(
         if avoid_zone is not None:
             params["avoid_zone"] = avoid_zone
 
-        if include_port_costs is not None:
-            params["include_port_costs"] = str(include_port_costs).lower()
-
         client = default_client()
         url = client._create_url_with_params(
             self._resource, params, doseq=True

vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py

@@ -46,9 +46,10 @@ def search(
         """
         Get forecast pricing over time for multiple routes.
 
-        Given a set of details about multiple routes (origin, destination, etc),
-        a time period and frequency, this returns forecast pricing over time
-        bucketed by the chosen frequency.
+        Given a set of routes, a frequency, unit and a time period, this endpoint
+        returns forecast-only prices, lumpsums and upper and lower bounds bucketed
+        by the requested frequency per route. Price is the total cost including
+        voyage, port and canal costs. Lumpsum is the total voyage cost in USD.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py

@@ -31,7 +31,10 @@ class AnywhereFreightPricingGetPriceDetails:
     Anywhere Freight Pricing Get Price Details endpoint.
 
     Given a set of details about a single route (origin, destination, etc),
-    this will find rates, lumpsums and prediction confidence of the route.
+    this will find rates, lumpsums and prediction confidences of the route.
+    Rates represent the per-unit price (voyage + port + canal costs).
+    Lumpsums are the total voyage cost in USD.
+    The confidence returns the confidence of these estimations.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -53,10 +56,13 @@ def search(
         suggested_tonnage: Optional[float] = None,
     ) -> AnywhereFreightPricingResult:
         """
-        List prices of a route.
+        List historical prices of a route.
 
         Given a set of details about a single route (origin, destination, etc),
-        this will find rates, lumpsums and prediction confidence of the route.
+        this will find historical rates, lumpsums and prediction confidences of the route.
+        Rates represent the per-unit price (voyage + port + canal costs).
+        Lumpsums are the total voyage cost in USD.
+        The confidence returns the confidence of these estimations.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py

@@ -28,7 +28,10 @@ class AnywhereFreightPricingPostPriceDetails(Search):
     Anywhere Freight Pricing Post Price Details endpoint.
 
     Given a set of details about multiple routes (origin, destination, etc),
-    this will find rates, lumpsums and prediction confidence for each route.
+    this will find rates, lumpsums and prediction confidences of each of the routes.
+    Rates represent the per-unit price (voyage + port + canal costs).
+    Lumpsums are the total voyage cost in USD.
+    The confidence returns the confidence of these value estimations.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -45,10 +48,13 @@ def search(
         unit: AfpUnit = "usd_per_tonne",
     ) -> AnywhereFreightPricingResult:
         """
-        List prices for multiple routes.
+        List historical prices for multiple routes.
 
         Given a set of details about multiple routes (origin, destination, etc),
-        this will find rates, lumpsums and prediction confidence for each route.
+        this will find historical rates, lumpsums and prediction confidences of each of the routes.
+        Rates represent the per-unit price (voyage + port + canal costs).
+        Lumpsums are the total voyage cost in USD.
+        The confidence returns the confidence of these value estimations.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py

@@ -46,9 +46,13 @@ def search(
         """
         Get historical pricing over time for multiple routes.
 
-        Given a set of details about multiple routes (origin, destination, etc),
-        a time period and frequency, this returns historical pricing over time
-        bucketed by the chosen frequency.
+        Given a set of details about multiple routes (origin, destination, product
+        and vessel class), a time period, unit and a frequency, this returns
+        historical pricing and voyage pricing over time per route bucketed by the
+        chosen frequency. Price is defined as the overall cost including voyage cost,
+        port costs and canal costs where applicable, given in the selected unit.
+        Voyage price is the price of just the voyage, given in the selected unit.
+        Lumpsum is the overall cost total of the voyage.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py

@@ -28,8 +28,13 @@ class AnywhereFreightPricingTopPortsDestination:
     """
     Anywhere Freight Pricing Top Ports Destination endpoint.
 
-    List top destination ports. A top destination port refers to the port
-    with the greatest volume of incoming voyages from vessels in a specified class.
+    Fetches the top destination ports for a given origin with a specified class.
+    These are the top ten ports with the greatest count of laden voyages from
+    vessels of the specified class departing the given origin.
+    Rates return the voyage costs as well as a breakdown of additional costs
+    in the given unit. Lumpsum return the total voyage cost as well as a
+    breakdown of additional costs as a total cost.
+    The confidence score indicates the confidence of these estimates.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -49,8 +54,13 @@ def search(
         """
         List top destination ports from a given origin.
 
-        A top destination port refers to the port with the greatest volume of
-        incoming voyages from vessels in a specified class.
+        Fetches the top destination ports for a given origin with a specified class.
+        These are the top ten ports with the greatest count of laden voyages from
+        vessels of the specified class departing the given origin.
+        Rates return the voyage costs as well as a breakdown of additional costs
+        in the given unit. Lumpsum return the total voyage cost as well as a
+        breakdown of additional costs as a total cost.
+        The confidence score indicates the confidence of these estimates.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py

@@ -28,8 +28,13 @@ class AnywhereFreightPricingTopPortsOrigin:
     """
     Anywhere Freight Pricing Top Ports Origin endpoint.
 
-    List top origin ports. A top origin port refers to the port
-    with the greatest volume of outgoing voyages from vessels in a specified class.
+    Fetches the top origin ports for a given destination with a specified class.
+    These are the top ten ports with the greatest count of laden voyages to the
+    given destination from vessels with the specified class.
+    Rates return the voyage costs as well as a breakdown of additional costs
+    in the given unit. Lumpsum return the total voyage cost as well as a
+    breakdown of additional costs as a total cost.
+    The confidence score indicates the confidence of these estimates.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -49,8 +54,13 @@ def search(
         """
         List top origin ports for a given destination.
 
-        A top origin port refers to the port with the greatest volume of
-        outgoing voyages from vessels in a specified class.
+        Fetches the top origin ports for a given destination with a specified class.
+        These are the top ten ports with the greatest count of laden voyages to the
+        given destination from vessels with the specified class.
+        Rates return the voyage costs as well as a breakdown of additional costs
+        in the given unit. Lumpsum return the total voyage cost as well as a
+        breakdown of additional costs as a total cost.
+        The confidence score indicates the confidence of these estimates.
 
         # Arguments
 

vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py

@@ -20,8 +20,9 @@ class AnywhereFreightPricingVesselClassesDetails:
     """
     Anywhere Freight Pricing Vessel Classes Details endpoint.
 
-    Lists all the vessel classes supported for Anywhere Freight Pricing
-    and the tonnages they can carry.
+    Returns the list of vessel classes supported in Anywhere Freight Pricing,
+    along with their suggested default tonnage and minimum and maximum
+    supported tonnages.
 
     Please note, a subscription to our Anywhere Freight Pricing module is
     required to access Anywhere Freight Pricing.
@@ -34,8 +35,9 @@ def search(self) -> AnywhereFreightPricingResult:
         """
         List vessel classes with tonnages.
 
-        Lists all the vessel classes supported for Anywhere Freight Pricing
-        and the tonnages they can carry.
+        Returns the list of vessel classes supported in Anywhere Freight Pricing,
+        along with their suggested default tonnage and minimum and maximum
+        supported tonnages.
 
         # Returns
         `AnywhereFreightPricingResult`

vortexasdk/version.py

@@ -1 +1 @@
-__version__ = "1.0.27"
+__version__ = "1.0.28"