Skip to content
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.

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

Version 4.0.0 - Orders API Rework and Tasking Updates #14

Merged
merged 37 commits into from
Aug 15, 2024
Merged

Conversation

martejj
Copy link
Collaborator

@martejj martejj commented Aug 15, 2024

This update brings the Arlula Python SDK in line with the Arlula API version 2024-07. It has numerous breaking changes, mainly relating to the new and thus has a new major version.

Additions:

  • New Dataset, Order and Campaign classes.
  • New Priority and CloudLevel classes.
  • New ListResponse and ListRequest helper classes.
  • New tests for Orders API.
  • New TaskingSearchFailure class and types.
  • New methods on OrdersAPI:
    • list_orders lists all orders the authenticated API account has access to.
    • list_datasets lists all datasets the authenticated API account has access to.
    • list_campaigns lists all campaigns the authenticated API account has access to.
    • list_order_campaigns lists all campaigns the associated with the specified order.
    • list_order_datasets lists all datasets the associated with the specified order.
    • list_campaign_datasets lists all datasets the associated with the specified campaign.
    • get_order gets details of specified order.
    • get_campaign gets details of specified campaign.
    • get_dataset gets details of specified dataset.
    • get_resource gets details of specified resource.

Breaking changes:

  • Removal of old OrderResult and DetailedOrder classes in favour of the new Order class
    • Update return type of TaskingAPI.batch_order and ArchiveAPI.batch_order from []OrderResult to Order
    • Update return type of TaskingAPI.order and ArchiveAPI.order from OrderResult to Order
  • Removal of old OrdersAPI.get and OrdersAPI.list endpoints in favour of OrdersAPI.get_order and OrdersAPI.list_orders
  • Addition of required priority and cloud fields to TaskingOrderRequest.
  • Rename functions on OrdersAPI:
    • download_order -> download_dataset
    • get_resource_as_file -> download_resource_as_file
    • get_resource_as_memory -> download_resource_as_memory
  • Updates TaskingSearchResult.polygons to TaskingSearchResult.polygon (now only returns a polygon rather than a multipolygon)

Other:

  • Moves many non-sensitive environment variables used in actions from secrets to environment variables.
  • Bumps dependency requests to 2.32.3.

Harrison Steyn added 30 commits August 14, 2024 16:57
@martejj martejj self-assigned this Aug 15, 2024
@martejj martejj marked this pull request as ready for review August 15, 2024 04:32
@martejj martejj merged commit 1ab6b30 into master Aug 15, 2024
2 checks passed
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.

1 participant