Skip to content

chore: update the docs for the voyage_date_range_activity field #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CookieMonitor merged 3 commits into from
Feb 19, 2026
Merged

chore: update the docs for the voyage_date_range_activity field #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
120da4c
chore: update the docs for the voyage_date_range_activity field
CookieMonitor Feb 18, 2026
8d7f986
chore: updated for consistency to avoid confusion in the prop value
CookieMonitor Feb 18, 2026
556c099
chore: vb
CookieMonitor Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_congestion_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_geography_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_product_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_routes_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_search_enriched.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_timeseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_timeseries_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_top_hits.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
6 changes: 5 additions & 1 deletion vortexasdk/endpoints/voyages_vessel_class_breakdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`].

Expand Down
2 changes: 1 addition & 1 deletion vortexasdk/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.0.18"
__version__ = "1.0.19"
Loading