docs: add availability note to vessel_risk_level docstrings

[kdalkas]

CHANGELOG

• Add availability note to vessel_risk_level and vessel_risk_level_excluded docstrings
• Note explains filter may not be available for all accounts and vessel_risk_level will not
  appear in response data
• Update example notebooks with the same note

TESTS

• Documentation change only, no functional changes

COMMENTS

[Copilot]

Pull request overview

This PR updates the Python SDK documentation to clarify that the vessel_risk_level / vessel_risk_level_excluded filters may not be available for all accounts, and that when unavailable the API will ignore the filter and omit vessel_risk_level from response data. The same clarification is added to the affected example notebooks.

Changes:

• Add availability disclaimers to voyage endpoint search() docstrings for vessel_risk_level and vessel_risk_level_excluded.
• Add the same disclaimers to vessel availability endpoint docstrings for filter_vessel_risk_level / exclude_vessel_risk_level.
• Update academy notebooks with a user-facing note about risk_rating / risk_rating_excl mapping to the API fields.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
vortexasdk/endpoints/voyages_vessel_class_breakdown.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_top_hits.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_timeseries.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_timeseries_v2.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_search_enriched.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_routes_breakdown.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_product_breakdown.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_geography_breakdown.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/voyages_congestion_breakdown.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/vessel_availability_timeseries.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/vessel_availability_search.py	Docstring note added for risk level filter availability.
vortexasdk/endpoints/vessel_availability_breakdown.py	Docstring note added for risk level filter availability.
docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb	Notebook narrative updated with availability note for risk rating params.
docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb	Notebook narrative updated with availability note for risk rating params.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.