From 120da4cbc67c1559236665248c6799da58ace50d Mon Sep 17 00:00:00 2001 From: Ben O'Brien Date: Wed, 18 Feb 2026 11:52:09 +0000 Subject: [PATCH 1/3] chore: update the docs for the voyage_date_range_activity field --- vortexasdk/endpoints/voyages_congestion_breakdown.py | 6 +++++- vortexasdk/endpoints/voyages_geography_breakdown.py | 6 +++++- vortexasdk/endpoints/voyages_product_breakdown.py | 6 +++++- vortexasdk/endpoints/voyages_routes_breakdown.py | 6 +++++- vortexasdk/endpoints/voyages_search_enriched.py | 6 +++++- vortexasdk/endpoints/voyages_timeseries.py | 6 +++++- vortexasdk/endpoints/voyages_timeseries_v2.py | 6 +++++- vortexasdk/endpoints/voyages_top_hits.py | 6 +++++- vortexasdk/endpoints/voyages_vessel_class_breakdown.py | 6 +++++- 9 files changed, 45 insertions(+), 9 deletions(-) diff --git a/vortexasdk/endpoints/voyages_congestion_breakdown.py b/vortexasdk/endpoints/voyages_congestion_breakdown.py index e17cca1f..bc2ad50a 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..b2ab64f8 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..70879257 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..2ea9d3c6 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..de175dff 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..ef50c86a 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..6a2267c9 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..32bba216 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..8db1551a 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`]. From 8d7f98656a69edaaf0343087c1806b8db51b61e4 Mon Sep 17 00:00:00 2001 From: Ben O'Brien Date: Wed, 18 Feb 2026 15:36:31 +0000 Subject: [PATCH 2/3] chore: updated for consistency to avoid confusion in the prop value --- vortexasdk/endpoints/voyages_congestion_breakdown.py | 8 ++++---- vortexasdk/endpoints/voyages_geography_breakdown.py | 8 ++++---- vortexasdk/endpoints/voyages_product_breakdown.py | 8 ++++---- vortexasdk/endpoints/voyages_routes_breakdown.py | 8 ++++---- vortexasdk/endpoints/voyages_search_enriched.py | 8 ++++---- vortexasdk/endpoints/voyages_timeseries.py | 8 ++++---- vortexasdk/endpoints/voyages_timeseries_v2.py | 8 ++++---- vortexasdk/endpoints/voyages_top_hits.py | 8 ++++---- vortexasdk/endpoints/voyages_vessel_class_breakdown.py | 8 ++++---- 9 files changed, 36 insertions(+), 36 deletions(-) diff --git a/vortexasdk/endpoints/voyages_congestion_breakdown.py b/vortexasdk/endpoints/voyages_congestion_breakdown.py index bc2ad50a..c05b4823 100644 --- a/vortexasdk/endpoints/voyages_congestion_breakdown.py +++ b/vortexasdk/endpoints/voyages_congestion_breakdown.py @@ -222,10 +222,10 @@ def search( descending. 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. + 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 b2ab64f8..c07faee4 100644 --- a/vortexasdk/endpoints/voyages_geography_breakdown.py +++ b/vortexasdk/endpoints/voyages_geography_breakdown.py @@ -264,10 +264,10 @@ 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 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. + 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 70879257..52d79735 100644 --- a/vortexasdk/endpoints/voyages_product_breakdown.py +++ b/vortexasdk/endpoints/voyages_product_breakdown.py @@ -264,10 +264,10 @@ 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 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. + 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 2ea9d3c6..c0185b23 100644 --- a/vortexasdk/endpoints/voyages_routes_breakdown.py +++ b/vortexasdk/endpoints/voyages_routes_breakdown.py @@ -263,10 +263,10 @@ 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 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. + 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 de175dff..f164652a 100644 --- a/vortexasdk/endpoints/voyages_search_enriched.py +++ b/vortexasdk/endpoints/voyages_search_enriched.py @@ -230,10 +230,10 @@ 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 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. + 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 ef50c86a..8cc9e599 100644 --- a/vortexasdk/endpoints/voyages_timeseries.py +++ b/vortexasdk/endpoints/voyages_timeseries.py @@ -227,10 +227,10 @@ 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 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. + 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 6a2267c9..65ba86e0 100644 --- a/vortexasdk/endpoints/voyages_timeseries_v2.py +++ b/vortexasdk/endpoints/voyages_timeseries_v2.py @@ -258,10 +258,10 @@ 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 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. + 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 32bba216..146eddad 100644 --- a/vortexasdk/endpoints/voyages_top_hits.py +++ b/vortexasdk/endpoints/voyages_top_hits.py @@ -226,10 +226,10 @@ 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 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. + 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 8db1551a..4be1dc16 100644 --- a/vortexasdk/endpoints/voyages_vessel_class_breakdown.py +++ b/vortexasdk/endpoints/voyages_vessel_class_breakdown.py @@ -261,10 +261,10 @@ 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 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. + 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`]. From 556c0992d7b88034d5661c1238bf771b6e8cf3a6 Mon Sep 17 00:00:00 2001 From: Ben O'Brien Date: Wed, 18 Feb 2026 17:19:23 +0000 Subject: [PATCH 3/3] chore: vb --- vortexasdk/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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"