woltapi 0.4.1__tar.gz → 0.5.0__tar.gz

{woltapi-0.4.1/src/woltapi.egg-info → woltapi-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woltapi
-Version: 0.4.1
+Version: 0.5.0
 Summary: A small synchronous client for observed Wolt ordering flows.
 License-Expression: AGPL-3.0-only
 Project-URL: Repository, https://github.com/skorokithakis/woltapi
@@ -298,14 +298,16 @@ Item, option, and value IDs come from the assortment dictionary. For
 current menu.
 
 Wolt also stores one basket per restaurant on its servers. These are the
-baskets you see in the Wolt app. The library can read and replace them:
+baskets you see in the Wolt app. The library can read, replace, and delete
+them:
 
 | Call | What it does |
 | --- | --- |
 | `client.save_basket_items(assortment, venue=..., items=...)` | Replaces the whole server basket for that restaurant. Needs only the menu, a venue context, and items. This does not place an order. |
 | `client.save_basket(selection)` | Also replaces the whole server basket, but takes a full `OrderSelection`. |
 | `client.get_basket_count()` | The number of baskets stored on the server. |
-| `client.get_baskets_page(latitude, longitude)` | The full baskets page as a dictionary. It can contain personal data; do not log it raw. |
+| `client.get_baskets_page(latitude, longitude)` | Lists the saved baskets, as one page of the raw dictionary. It can contain personal data; do not log it raw. |
+| `client.delete_baskets(basket_ids)` | Deletes the listed server baskets. |
 | `client.get_venue_checkout_context(slug)` | The `VenueCheckoutContext` for a restaurant, read from its static page. |
 
 There are two ways to save. `save_basket_items()` needs no saved address and no
@@ -315,8 +317,56 @@ after `list_delivery_targets()` and `get_payment_methods()` on the same client,
 so it needs a saved delivery address and an enabled card. That cost is worth
 paying only when you go on to request a checkout quote with the same selection.
 
-Deleting a server basket is not supported. There is also no call that adds or
-removes a single item: every save replaces the whole basket.
+There is no call that adds or removes a single item: every save replaces the
+whole basket.
+
+#### Delete a saved basket
+
+`delete_baskets()` takes a list of basket IDs and deletes all of them in one
+call. You get a basket ID from `get_baskets_page()`, or from the `SavedBasket`
+that `save_basket()` and `save_basket_items()` return.
+
+An empty list is rejected, because Wolt's behaviour in that case has never been
+observed. So check the list before you send it, as both examples below do.
+
+To delete every saved basket:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [entry["id"] for entry in page["baskets"]]
+if ids:
+    client.delete_baskets(ids)
+```
+
+To delete the basket for one restaurant:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [
+    entry["id"] for entry in page["baskets"]
+    if entry["venue"]["slug"] == "<restaurant slug>"
+]
+if ids:
+    client.delete_baskets(ids)
+```
+
+Every saved basket has items in it, because a basket only exists once you put
+something in one. There is no empty saved basket to skip.
+
+Wolt sends nothing back, so the call cannot tell you whether the baskets were
+really there or whether anything was deleted. If you need to be sure, read
+`get_basket_count()` or `get_baskets_page()` again afterwards.
+
+Two limits of `get_baskets_page()` matter when you delete in bulk:
+
+- It reads one page. The response carries a `start_after_time` cursor, which
+  suggests Wolt can split a long list, and the library does not follow that
+  cursor. Compare `len(page["baskets"])` with `get_basket_count()` to see
+  whether you have the whole list.
+- It requires coordinates, and it is not known whether they only drive the
+  delivery estimates shown in the app or actually restrict which baskets come
+  back. If a basket you expect is missing, try coordinates near that
+  restaurant.
 
 #### Change a saved basket
 

{woltapi-0.4.1 → woltapi-0.5.0}/README.md

@@ -280,14 +280,16 @@ Item, option, and value IDs come from the assortment dictionary. For
 current menu.
 
 Wolt also stores one basket per restaurant on its servers. These are the
-baskets you see in the Wolt app. The library can read and replace them:
+baskets you see in the Wolt app. The library can read, replace, and delete
+them:
 
 | Call | What it does |
 | --- | --- |
 | `client.save_basket_items(assortment, venue=..., items=...)` | Replaces the whole server basket for that restaurant. Needs only the menu, a venue context, and items. This does not place an order. |
 | `client.save_basket(selection)` | Also replaces the whole server basket, but takes a full `OrderSelection`. |
 | `client.get_basket_count()` | The number of baskets stored on the server. |
-| `client.get_baskets_page(latitude, longitude)` | The full baskets page as a dictionary. It can contain personal data; do not log it raw. |
+| `client.get_baskets_page(latitude, longitude)` | Lists the saved baskets, as one page of the raw dictionary. It can contain personal data; do not log it raw. |
+| `client.delete_baskets(basket_ids)` | Deletes the listed server baskets. |
 | `client.get_venue_checkout_context(slug)` | The `VenueCheckoutContext` for a restaurant, read from its static page. |
 
 There are two ways to save. `save_basket_items()` needs no saved address and no
@@ -297,8 +299,56 @@ after `list_delivery_targets()` and `get_payment_methods()` on the same client,
 so it needs a saved delivery address and an enabled card. That cost is worth
 paying only when you go on to request a checkout quote with the same selection.
 
-Deleting a server basket is not supported. There is also no call that adds or
-removes a single item: every save replaces the whole basket.
+There is no call that adds or removes a single item: every save replaces the
+whole basket.
+
+#### Delete a saved basket
+
+`delete_baskets()` takes a list of basket IDs and deletes all of them in one
+call. You get a basket ID from `get_baskets_page()`, or from the `SavedBasket`
+that `save_basket()` and `save_basket_items()` return.
+
+An empty list is rejected, because Wolt's behaviour in that case has never been
+observed. So check the list before you send it, as both examples below do.
+
+To delete every saved basket:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [entry["id"] for entry in page["baskets"]]
+if ids:
+    client.delete_baskets(ids)
+```
+
+To delete the basket for one restaurant:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [
+    entry["id"] for entry in page["baskets"]
+    if entry["venue"]["slug"] == "<restaurant slug>"
+]
+if ids:
+    client.delete_baskets(ids)
+```
+
+Every saved basket has items in it, because a basket only exists once you put
+something in one. There is no empty saved basket to skip.
+
+Wolt sends nothing back, so the call cannot tell you whether the baskets were
+really there or whether anything was deleted. If you need to be sure, read
+`get_basket_count()` or `get_baskets_page()` again afterwards.
+
+Two limits of `get_baskets_page()` matter when you delete in bulk:
+
+- It reads one page. The response carries a `start_after_time` cursor, which
+  suggests Wolt can split a long list, and the library does not follow that
+  cursor. Compare `len(page["baskets"])` with `get_basket_count()` to see
+  whether you have the whole list.
+- It requires coordinates, and it is not known whether they only drive the
+  delivery estimates shown in the app or actually restrict which baskets come
+  back. If a basket you expect is missing, try coordinates near that
+  restaurant.
 
 #### Change a saved basket
 

{woltapi-0.4.1 → woltapi-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "woltapi"
-version = "0.4.1"
+version = "0.5.0"
 description = "A small synchronous client for observed Wolt ordering flows."
 readme = "README.md"
 requires-python = ">=3.10"

{woltapi-0.4.1 → woltapi-0.5.0}/src/woltapi/client.py

@@ -149,6 +149,22 @@ class WoltClient:
             query={"lat": latitude, "lon": longitude},
         )
 
+    def delete_baskets(self, basket_ids: Sequence[str]) -> None:
+        """Delete server baskets without confirmation from the response.
+
+        The response carries no result, so a caller who wants to confirm must
+        re-read get_basket_count() or get_baskets_page().
+        """
+
+        basket_ids = _basket_ids(basket_ids)
+        self._transport.request(
+            ServiceHost.CONSUMER,
+            "POST",
+            "/order-xp/v1/baskets/bulk/delete",
+            json_body={"ids": basket_ids},
+            expect_response_body=False,
+        )
+
     def get_venue_static(self, venue_slug: str) -> dict[str, Any]:
         """Read the static venue page for a slug."""
 
@@ -546,6 +562,14 @@ def _required_text(value: object, name: str) -> str:
     return value
 
 
+def _basket_ids(value: object) -> list[str]:
+    if not isinstance(value, Sequence) or isinstance(value, (str, bytes)):
+        raise TypeError("basket_ids must be a sequence.")
+    if not value:
+        raise ValueError("basket_ids must not be empty.")
+    return [_required_text(basket_id, "basket ID") for basket_id in value]
+
+
 def _path_segment(value: object, name: str) -> str:
     return quote(_required_text(value, name), safe="")
 

{woltapi-0.4.1 → woltapi-0.5.0}/src/woltapi/transport.py

@@ -74,6 +74,7 @@ class WoltTransport:
         *,
         query: Mapping[str, Any] | None = None,
         json_body: Mapping[str, Any] | None = None,
+        expect_response_body: bool = True,
     ) -> dict[str, Any]:
         """Make one JSON request to a fixed host without retries or redirects."""
 
@@ -87,6 +88,8 @@ class WoltTransport:
             raise TypeError("query must be a mapping when provided.")
         if json_body is not None and not isinstance(json_body, Mapping):
             raise TypeError("json_body must be a mapping when provided.")
+        if not isinstance(expect_response_body, bool):
+            raise TypeError("expect_response_body must be a bool.")
 
         data = _encode_json(json_body, service) if json_body is not None else None
         headers = _request_headers(
@@ -116,6 +119,8 @@ class WoltTransport:
 
         if not 200 <= status_code < 300:
             raise HTTPStatusError(service.value, status_code)
+        if not expect_response_body:
+            return {}
         return _decode_json_object(response_body, service)
 
 

{woltapi-0.4.1 → woltapi-0.5.0/src/woltapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: woltapi
-Version: 0.4.1
+Version: 0.5.0
 Summary: A small synchronous client for observed Wolt ordering flows.
 License-Expression: AGPL-3.0-only
 Project-URL: Repository, https://github.com/skorokithakis/woltapi
@@ -298,14 +298,16 @@ Item, option, and value IDs come from the assortment dictionary. For
 current menu.
 
 Wolt also stores one basket per restaurant on its servers. These are the
-baskets you see in the Wolt app. The library can read and replace them:
+baskets you see in the Wolt app. The library can read, replace, and delete
+them:
 
 | Call | What it does |
 | --- | --- |
 | `client.save_basket_items(assortment, venue=..., items=...)` | Replaces the whole server basket for that restaurant. Needs only the menu, a venue context, and items. This does not place an order. |
 | `client.save_basket(selection)` | Also replaces the whole server basket, but takes a full `OrderSelection`. |
 | `client.get_basket_count()` | The number of baskets stored on the server. |
-| `client.get_baskets_page(latitude, longitude)` | The full baskets page as a dictionary. It can contain personal data; do not log it raw. |
+| `client.get_baskets_page(latitude, longitude)` | Lists the saved baskets, as one page of the raw dictionary. It can contain personal data; do not log it raw. |
+| `client.delete_baskets(basket_ids)` | Deletes the listed server baskets. |
 | `client.get_venue_checkout_context(slug)` | The `VenueCheckoutContext` for a restaurant, read from its static page. |
 
 There are two ways to save. `save_basket_items()` needs no saved address and no
@@ -315,8 +317,56 @@ after `list_delivery_targets()` and `get_payment_methods()` on the same client,
 so it needs a saved delivery address and an enabled card. That cost is worth
 paying only when you go on to request a checkout quote with the same selection.
 
-Deleting a server basket is not supported. There is also no call that adds or
-removes a single item: every save replaces the whole basket.
+There is no call that adds or removes a single item: every save replaces the
+whole basket.
+
+#### Delete a saved basket
+
+`delete_baskets()` takes a list of basket IDs and deletes all of them in one
+call. You get a basket ID from `get_baskets_page()`, or from the `SavedBasket`
+that `save_basket()` and `save_basket_items()` return.
+
+An empty list is rejected, because Wolt's behaviour in that case has never been
+observed. So check the list before you send it, as both examples below do.
+
+To delete every saved basket:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [entry["id"] for entry in page["baskets"]]
+if ids:
+    client.delete_baskets(ids)
+```
+
+To delete the basket for one restaurant:
+
+```python
+page = client.get_baskets_page(60.17, 24.94)
+ids = [
+    entry["id"] for entry in page["baskets"]
+    if entry["venue"]["slug"] == "<restaurant slug>"
+]
+if ids:
+    client.delete_baskets(ids)
+```
+
+Every saved basket has items in it, because a basket only exists once you put
+something in one. There is no empty saved basket to skip.
+
+Wolt sends nothing back, so the call cannot tell you whether the baskets were
+really there or whether anything was deleted. If you need to be sure, read
+`get_basket_count()` or `get_baskets_page()` again afterwards.
+
+Two limits of `get_baskets_page()` matter when you delete in bulk:
+
+- It reads one page. The response carries a `start_after_time` cursor, which
+  suggests Wolt can split a long list, and the library does not follow that
+  cursor. Compare `len(page["baskets"])` with `get_basket_count()` to see
+  whether you have the whole list.
+- It requires coordinates, and it is not known whether they only drive the
+  delivery estimates shown in the app or actually restrict which baskets come
+  back. If a basket you expect is missing, try coordinates near that
+  restaurant.
 
 #### Change a saved basket
 

{woltapi-0.4.1 → woltapi-0.5.0}/tests/test_client.py

@@ -17,6 +17,7 @@ from woltapi import (
     WoltClient,
     WoltTransport,
 )
+from woltapi.services import ServiceHost
 
 
 class FakeResponse:
@@ -261,6 +262,52 @@ class WoltClientTests(unittest.TestCase):
             self.assertEqual(headers["x-consumer-session"], "consumer-secret")
             self.assertNotIn("x-restaurant-session", headers)
 
+    def test_delete_baskets_posts_ids_and_accepts_null_response(self) -> None:
+        client, opener = make_client(FakeResponse(None))
+
+        result = client.delete_baskets(["basket-1", "basket-2"])
+
+        self.assertIsNone(result)
+        self.assertEqual(len(opener.requests), 1)
+        request = opener.requests[0]
+        self.assertEqual(request.method, "POST")
+        self.assertEqual(urlsplit(request.full_url).netloc, "consumer-api.wolt.com")
+        self.assertEqual(
+            urlsplit(request.full_url).path,
+            "/order-xp/v1/baskets/bulk/delete",
+        )
+        headers = _headers(request)
+        self.assertEqual(headers["x-consumer-session"], "consumer-secret")
+        self.assertEqual(
+            json.loads(request.data.decode("utf-8")), {"ids": ["basket-1", "basket-2"]}
+        )
+
+    def test_transport_rejects_null_body_when_response_is_expected(self) -> None:
+        client, _ = make_client(FakeResponse(None))
+
+        with self.assertRaises(ResponseShapeError):
+            client._transport.request(
+                ServiceHost.CONSUMER, "POST", "/order-xp/v1/baskets/bulk/delete"
+            )
+
+    def test_delete_baskets_validates_ids_before_request(self) -> None:
+        for basket_ids, error_type in (
+            ([], ValueError),
+            ("basket-1", TypeError),
+            (None, TypeError),
+            (1, TypeError),
+            (b"basket-1", TypeError),
+            ([1], ValueError),
+            (["  "], ValueError),
+        ):
+            with self.subTest(basket_ids=basket_ids):
+                client, opener = make_client()
+
+                with self.assertRaises(error_type):
+                    client.delete_baskets(basket_ids)  # type: ignore[arg-type]
+
+                self.assertEqual(opener.requests, [])
+
     def test_get_basket_count_rejects_non_integer_counts(self) -> None:
         for payload in ({}, {"count": True}, {"count": "1"}):
             with self.subTest(payload=payload):