add events API endpoints base Result class with matched AIS vessels properties#65
Merged
lykmapipo merged 25 commits intoJul 20, 2026
Merged
Conversation
This: - Add `EventResult` class as base `Result` for Events API endpoints - Add `vessel_ids`, `start_dates` and `end_dates` properties to `EventResult` - Refactor `EventDetailResult` and `EventListResult` to inherit `EventResult`
This: - Update `bulk_downloads`, `events`, and `fourwings` resources to support the `Region` - Refactor `**kwargs` type annotations from `Dict[str, Any]` to `Any`
…eports This: - Add `dataset` field to `BulkReportItem` to track the `dataset` used to generate the bulk report - Add `dataset` field to `BulkReportListParams` to support filtering bulk reports by a specific `dataset` - Update `BulkDownloadResource.get_all_bulk_reports()` public method to accept the optional `dataset` filter parameter
…ebook This: - Update vessel search examples to use `vessel_search_result.vessel_ids` - Update vessel details workflow to use `vessels_result.vessel_ids` - Simplify start/end date logic using `.transmission_dates_from` and `.transmission_dates_to` - Pass list of vessel IDs(strings) to get vessel insights - Add documentation references to the Vessels API, Insights API and Vessel Viewer
This: - Document `result.vessel_ids` shortcut for passing matched vessel IDs to other APIs - Add documentation references to Vessels API, Insights API, and the Vessel Viewer
This: - Add examples and notes for filtering and obtaining Regions of Interest (ROIs) from (EEZ, MPA, RFMO) regions - Update guide and notebook outputs
lykmapipo
requested review from
aperdizs,
giselamo,
rrequero,
tomaslink and
yaaNuamahGFW
June 23, 2026 22:59
This: - Update usage guides and notebook to demonstrate how to pass custom regions - Update type hint annotations and docstrings for the `geometry` parameter
This: - Update usage guides and notebook to demonstrate how to pass custom regions - Update examples to use the Reference Data API to fetch predefined regions of interest (ROIs) - Sync code block snippets and execution outputs across `4wings-api.md` and `4wings-api.ipynb` - Update type hint annotations and docstrings for the `geojson` parameter
…book This: - Update usage guides and notebook to demonstrate how to pass custom regions - Update examples to use the Reference Data API to fetch predefined regions of interest (ROIs) - Update type hint annotations and docstrings for the `geojson` parameter
This: - Update workflow to use the Reference Data API to fetch predefined regions of interest (ROIs) - Transition from fixed string date filters to dynamic windows using `datetime` - Re-run notebook cells to capture updated DataFrame outputs
This: - Fix typo in the Getting Started example - Correct Markdown code fences in the Events API guide - Clarify GeoJSON parameter descriptions for bulk downloads and 4Wings resources
update usage guides, workflow guides, and notebooks
…-result-utils add dataset to bulk downloads request and response models
…-utils support base Region usage across API endpoints
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This:
EventResultclass for events API endpointsEventDetailResultandEventListResultto inheritEventResultvessel_ids,start_datesandend_datesproperties toEventResult