Skip to content

Add AFP methods to SDK#564

Open
Jack-Burge55 wants to merge 9 commits into
masterfrom
rnd-21261
Open

Add AFP methods to SDK#564
Jack-Burge55 wants to merge 9 commits into
masterfrom
rnd-21261

Conversation

@Jack-Burge55
Copy link
Copy Markdown

@Jack-Burge55 Jack-Burge55 commented May 20, 2026

Copilot AI review requested due to automatic review settings May 20, 2026 14:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds initial support for the Anywhere Freight Pricing (AFP) module to the SDK, wiring new API paths, endpoint classes, documentation pages, and live tests.

Changes:

  • Added AFP endpoint constants and exported two new SDK endpoints: latest update timestamp + price timeseries (with a dedicated result container).
  • Extended docs generation/navigation for AFP and introduced a small CSS tweak to prevent long headings overflowing.
  • Added live API tests for the new AFP endpoints (plus scaffold modules for additional AFP endpoints).

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
vortexasdk/endpoints/endpoints.py Adds AFP endpoint path constants.
vortexasdk/endpoints/anywhere_freight_pricing_latest_update_timestamp.py New AFP “latest update timestamp” endpoint implementation (GET).
vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py New AFP “price timeseries” endpoint implementation (POST search).
vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries_result.py Result wrapper + to_df() flattening for AFP timeseries response.
vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Scaffold (currently empty) AFP endpoint module.
vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py Scaffold (currently empty) AFP endpoint module.
vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py Scaffold (currently empty) AFP endpoint module.
vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py Scaffold (currently empty) AFP endpoint module.
vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py Scaffold (currently empty) AFP endpoint module.
vortexasdk/endpoints/__init__.py Exports the two implemented AFP endpoints.
vortexasdk/__init__.py Re-exports the two implemented AFP endpoints at package root.
tests/endpoints/test_anywhere_freight_pricing_price_timeseries.py Live API test coverage for AFP price timeseries + to_df().
tests/endpoints/test_anywhere_freight_pricing_latest_update_timestamp.py Live API test for AFP latest update timestamp.
pydocmd.yml Adds AFP docs generation entries.
mkdocs.yml Adds AFP docs navigation and references new extra_css.
docs/scripts/serve_docs.sh Copies docs CSS into build dir for local serving.
docs/css/custom.css New CSS to wrap long headings.
README.md Small text change (currently introduces a typo).
CONTRIBUTING.md Updates “run tests” instructions to use pytest.

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

Comment thread README.md Outdated
Comment thread mkdocs.yml
Comment thread docs/scripts/serve_docs.sh
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_latest_update_timestamp.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py Outdated
@Jack-Burge55 Jack-Burge55 changed the title feat: added afp latest update and timeseries Add AFP endpoints to SDK May 21, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 27 changed files in this pull request and generated 7 comments.

Comment thread README.md Outdated
Comment thread Untitled.ipynb Outdated
Comment thread Untitled.ipynb Outdated
Comment thread scripts/Untitled.ipynb Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Outdated
@Jack-Burge55 Jack-Burge55 changed the title Add AFP endpoints to SDK Add AFP methods to SDK May 22, 2026
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_result.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Outdated
Comment thread vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py Outdated
Comment thread vortexasdk/utils.py Outdated
Comment thread mkdocs.yml Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants