Version 4.0.1 - Minor Bug Fixes

Fixes an issue with the ArlulaObject __repr__ function

Version 4.0.0 - Orders API Rework and Tasking Updates

This release 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.

Version 3.3.0 - Tasking API, Collections API, and Sorting on Archive Search

This release brings compatibility with two new APIs offered by Arlula among other minor updates

• Adds support for the Arlula Collections API, a STAC API powered by our enterprise product Geostack Terra, offered through the CollectionsAPI class. It contains:
  • list for listing collections available
  • detail for detailing a specific collection
  • list_items for listing items within a collection with some simple filters
  • get_item for getting a specific item from within a collection
  • search_items for searching items within a collection with more complex filters than list_items
  • import_order for importing orders purchased through the Archive or Tasking APIs
  • remove_item for removing an item from a collection
  • create for creating a new collection
  • update for updating details of a collection
  • delete for deleting a collection
  • request_access_item for requesting access to items within a collection
  • conformance for determining the stac_extensions conformance of a collection
• Adds support for the Arlula Tasking API, offered through the TaskingAPI class. It contains:
  • search for finding future capturing opportunities
  • order for purchasing an opportunity from a search
  • batch_order for purchasing many opportunities at the same time
• Adds support for sort definitions on archive and tasking search

Version 3.2.0 - Batch Order, Licenses, and POST searching

This release brings compatibility with new features of the Arlula Archive API.

• Updates license on SearchResult to licenses, in line with new API updates.
• Updates archive search to send requests via POST rather than GET always. This is due to URL length limits and the recent polygon search update.
• Adds the ability to chain together multiple OrderRequest objects into a BatchOrderRequest.
• Adds the ability to send a BatchOrderRequest with the new ArchiveAPI.batch_search method.

v3.1.0 - Polygon Search

This release brings compatibility with the new features of API 2023-01, as well as some general house keeping and maintenance

Changes in this release:

• Adds the support for WKT and list polygons on search.
• Adds dict and string methods for all classes.
• Fixes a KeyError when resources on a DetailedOrderResult could not be found.
• Removes legacy support for Arlula API version 2021-09.
• Reworks how exceptions are handled, they will now give more relevant error messages.

Version 3.0.2 - Removal of backwards compatibility for 2021-09 and minor updates for 2022-07

This release removes backwards compatibility for API 2021-09, fixes some minor bugs, and adds some new features:

• Removes backwards compatibility for 2021-09
• Fixes the minor decoding bug for 2022-07 (Correctly decoding loading_amount and loading_percent for the License object)
• Adds a calculate_price() method on SearchResult, which wraps one in util.
• Adds centre() and width() methods on Band to allow conversion to FWHM (Full Width Half Max)
• Adds a calculate_price() method on SearchResult, which wraps the one available in util.

Version 3.0.1 - Updates to gsd and orderingID fields

This Release updates some field names that were missed in the major release, but which are backwards compatible:

• On OrderRequest res is updated to gsd
• On DetailedOrderResult and OrderResult, imagery_id is updated to ordering_id

v3.0.0 - Bands, order bundles and licensing for API 2022-07 release

This release is adding pre-release support for the 2022-07 API update to ensure minimal disruption during change over.

This release:

• makes archive search's return type an object
• removes eula and price from search results
• renames search result resolution to gsd and id to ordering_id
• adds spectral bands information to search results (pending 2022-07 server release)
• adds ordering bundles allowing processing level selection (currently the existing default, addition options pending 2022-07 server release)
• adds license selection for different license types (currently the existing default, addition options pending 2022-07 server release)
• removes seats from order request
• adds bundle_key to order request
• changes pricing calculations for scenes (see documentation)

Detailed documentation for all these changes is available at
https://arlula.com/documentation/documentation-pre-release/

Version 2.0.3 - Minor Fixes & Unit Tests

This release fixes some features of the API and adds comprehensive unit testing.

• Fixes request serialisation issues related to #5.
• Adds a lightweight RFC3339 parser to ensure timestamps are correctly parsed relating to #6.
• Adds unit tests for the archive and orders API as well as the RFC3339 parser.
• Fixes issues with setting webhooks and emails on OrderRequest objects.
• Ensures that files returned by OrderAPI.get_resource_as_file() are seeked to the beginning of the file and open for read and write.

Version 2.0.2 - Fixed search request resolution type hint

This release changes the type hint on resolution for search requests to be required.