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
andCampaign
classes. - New
Priority
andCloudLevel
classes. - New
ListResponse
andListRequest
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
andDetailedOrder
classes in favour of the newOrder
class- Update return type of
TaskingAPI.batch_order
andArchiveAPI.batch_order
from[]OrderResult
toOrder
- Update return type of
TaskingAPI.order
andArchiveAPI.order
fromOrderResult
toOrder
- Update return type of
- Removal of old
OrdersAPI.get
andOrdersAPI.list
endpoints in favour ofOrdersAPI.get_order
andOrdersAPI.list_orders
- Addition of required
priority
andcloud
fields toTaskingOrderRequest
. - 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
toTaskingSearchResult.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
to2.32.3
.