diff --git a/vortexasdk/endpoints/voyages_congestion_breakdown.py b/vortexasdk/endpoints/voyages_congestion_breakdown.py index e17cca1f..c05b4823 100644 --- a/vortexasdk/endpoints/voyages_congestion_breakdown.py +++ b/vortexasdk/endpoints/voyages_congestion_breakdown.py @@ -221,7 +221,11 @@ def search( order_direction: Determines the direction of sorting. ‘asc’ for ascending, ‘desc’ for descending. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_geography_breakdown.py b/vortexasdk/endpoints/voyages_geography_breakdown.py index 2ba8ac7b..c07faee4 100644 --- a/vortexasdk/endpoints/voyages_geography_breakdown.py +++ b/vortexasdk/endpoints/voyages_geography_breakdown.py @@ -263,7 +263,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_product_breakdown.py b/vortexasdk/endpoints/voyages_product_breakdown.py index af8c84fa..52d79735 100644 --- a/vortexasdk/endpoints/voyages_product_breakdown.py +++ b/vortexasdk/endpoints/voyages_product_breakdown.py @@ -263,7 +263,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_routes_breakdown.py b/vortexasdk/endpoints/voyages_routes_breakdown.py index ab9e8cdf..c0185b23 100644 --- a/vortexasdk/endpoints/voyages_routes_breakdown.py +++ b/vortexasdk/endpoints/voyages_routes_breakdown.py @@ -262,7 +262,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_search_enriched.py b/vortexasdk/endpoints/voyages_search_enriched.py index 7cacd895..f164652a 100644 --- a/vortexasdk/endpoints/voyages_search_enriched.py +++ b/vortexasdk/endpoints/voyages_search_enriched.py @@ -229,7 +229,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_timeseries.py b/vortexasdk/endpoints/voyages_timeseries.py index c7e77d18..8cc9e599 100644 --- a/vortexasdk/endpoints/voyages_timeseries.py +++ b/vortexasdk/endpoints/voyages_timeseries.py @@ -226,7 +226,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_timeseries_v2.py b/vortexasdk/endpoints/voyages_timeseries_v2.py index f421a379..65ba86e0 100644 --- a/vortexasdk/endpoints/voyages_timeseries_v2.py +++ b/vortexasdk/endpoints/voyages_timeseries_v2.py @@ -257,7 +257,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_top_hits.py b/vortexasdk/endpoints/voyages_top_hits.py index 3b64bdad..146eddad 100644 --- a/vortexasdk/endpoints/voyages_top_hits.py +++ b/vortexasdk/endpoints/voyages_top_hits.py @@ -225,7 +225,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/endpoints/voyages_vessel_class_breakdown.py b/vortexasdk/endpoints/voyages_vessel_class_breakdown.py index 9ae7fdc6..4be1dc16 100644 --- a/vortexasdk/endpoints/voyages_vessel_class_breakdown.py +++ b/vortexasdk/endpoints/voyages_vessel_class_breakdown.py @@ -260,7 +260,11 @@ def search( intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer. - voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [`active`, `departures`, `arrivals`] + voyage_date_range_activity: Filter to return voyages within the given time range - must be one of [`'active'`, `'arrivals'`, `'departures'`, `'waypoint'`]. + active - active (or ongoing) during the specified time range, + arrivals - arrived during the specified time range, + departures - departed during the specified time range. + waypoint - had a waypoint event during the specified time range. origin_behaviour: The origin behaviour determines which departure mode the `voyage_date_range_activity` should count, must be one of [`first_load`, `any_load`]. diff --git a/vortexasdk/version.py b/vortexasdk/version.py index 441304cd..b931c6aa 100644 --- a/vortexasdk/version.py +++ b/vortexasdk/version.py @@ -1 +1 @@ -__version__ = "1.0.18" +__version__ = "1.0.19"