click_and_drop_api 3.3.0__tar.gz → 3.4.0__tar.gz

{click_and_drop_api-3.3.0/click_and_drop_api.egg-info → click_and_drop_api-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_and_drop_api
-Version: 3.3.0
+Version: 3.4.0
 Summary: ChannelShipper & Royal Mail Public API
 Author-email: Nicco Kunzmann <niccokunzmann@rambler.ru>, OpenAPI Generator Community <team@openapitools.org>
 Project-URL: Documentation, https://niccokunzmann.github.io/python-royal-mail-click-and-drop-api/

{click_and_drop_api-3.3.0 → click_and_drop_api-3.4.0}/click_and_drop_api/simple/__init__.py

@@ -20,6 +20,7 @@ from .types import (
     UpdateOrdersStatus,
     ManifestedOrders,
     OrderInfo,
+    ReferenceLookup,
 )
 from .api import ClickAndDrop
 from .mock import MockClickAndDrop
@@ -29,7 +30,15 @@ from .shipping.db import (
     db,
 )
 from .shipping import check_service_codes
-from .errors import InvalidWeight, InvalidDimensions
+from .errors import ClickAndDropError, InvalidDimensions, InvalidWeight
+from .strategy import (
+    CreateOrderStrategy,
+    NullStrategy,
+    PreparedOrders,
+    RejectDuplicateReferences,
+    ReplaceDuplicateReferences,
+    StrategyErrorCode,
+)
 
 __all__ = [
     "ClickAndDrop",
@@ -37,6 +46,13 @@ __all__ = [
     "CreateOrder",
     "InvalidWeight",
     "InvalidDimensions",
+    "ClickAndDropError",
+    "CreateOrderStrategy",
+    "NullStrategy",
+    "PreparedOrders",
+    "RejectDuplicateReferences",
+    "ReplaceDuplicateReferences",
+    "StrategyErrorCode",
     "check_service_codes",
     "RecipientDetails",
     "Address",
@@ -49,6 +65,7 @@ __all__ = [
     "UpdateOrderStatusResponse",
     "LabelGeneration",
     "OrderInfo",
+    "ReferenceLookup",
     "ManifestedOrders",
     "ManifestEligibleOrders",
     "ManifestDetailsResponse",

{click_and_drop_api-3.3.0 → click_and_drop_api-3.4.0}/click_and_drop_api/simple/api.py

@@ -1,8 +1,10 @@
 """The simple API interface."""
 
 from dataclasses import dataclass
+from datetime import datetime
 from typing import Literal, Optional, Union
 from .base import AbstractClickAndDrop
+from .strategy import CreateOrderStrategy, NullStrategy
 from .types import CreateOrder
 import click_and_drop_api
 
@@ -43,15 +45,23 @@ class ClickAndDrop(AbstractClickAndDrop):
 
     host = "https://api.parcel.royalmail.com/api/v1"
     """The Click & Drop API host.
-    
+
     There seems to be only one host available.
     """
 
-    def __init__(self, key: str):
+    def __init__(
+        self, key: str, create_order_strategy: Optional[CreateOrderStrategy] = None
+    ):
         """Create a new API object.
 
         Parameters:
             key: The Click & Drop API authorisation key.
+            create_order_strategy: The strategy to check orders before they are created.
+                See :mod:`click_and_drop_api.simple.strategy`.
+
+        Raises:
+            TypeError: The key is not a string.
+            ValueError: The key does not have about 36 characters or contains whitespace.
         """
         if not isinstance(key, str):
             raise TypeError(f"Expected str, got {key}.")
@@ -61,6 +71,9 @@ class ClickAndDrop(AbstractClickAndDrop):
         if "".join(key.split()) != key:
             raise ValueError(f"Expected no whitespace in {key!r}.")
         self._key = key
+        self.create_order_strategy = (
+            NullStrategy() if create_order_strategy is None else create_order_strategy
+        )
         self._configuration = click_and_drop_api.Configuration(host=self.host)
         self._configuration.api_key["Bearer"] = self._key
         self._api_client = click_and_drop_api.ApiClient(self._configuration)
@@ -72,6 +85,9 @@ class ClickAndDrop(AbstractClickAndDrop):
     def get_version(self) -> click_and_drop_api.GetVersionResource:
         """Get the version of the Click & Drop API.
 
+        Raises:
+            click_and_drop_api.exceptions.ApiException: The request failed, see :class:`~click_and_drop_api.simple.base.AbstractClickAndDrop`.
+
         https://api.parcel.royalmail.com/#tag/Version
         """
         return self._version_api.get_version_async()
@@ -89,6 +105,9 @@ class ClickAndDrop(AbstractClickAndDrop):
         """Wether this is an OBA account.
 
         Check wether this is an OBA account by trying to create an order service code.
+
+        Raises:
+            click_and_drop_api.exceptions.ApiException: The request failed, see :class:`~click_and_drop_api.simple.base.AbstractClickAndDrop`.
         """
         if self._account_cache.is_oba is not None:
             return self._account_cache.is_oba
@@ -108,6 +127,20 @@ class ClickAndDrop(AbstractClickAndDrop):
             order_identifiers=order_identifiers_to_string(order_identifiers)
         )
 
+    def _get_orders_page(
+        self,
+        page_size: int,
+        start: Optional[datetime],
+        end: Optional[datetime],
+        continuation_token: Optional[str],
+    ) -> click_and_drop_api.GetOrdersResponse:
+        return self._orders_api.get_orders_async(
+            page_size=page_size,
+            start_date_time=start,
+            end_date_time=end,
+            continuation_token=continuation_token,
+        )
+
     def _get_orders_details(
         self, order_identifiers: list[Union[str, int]]
     ) -> list[click_and_drop_api.GetOrderDetailsResource]:
@@ -123,10 +156,8 @@ class ClickAndDrop(AbstractClickAndDrop):
         )
 
     def _create_orders(
-        self, orders: Union[list[CreateOrder], CreateOrder]
+        self, orders: list[CreateOrder]
     ) -> click_and_drop_api.CreateOrdersResponse:
-        if not isinstance(orders, list):
-            orders = [orders]
         request = click_and_drop_api.CreateOrdersRequest(items=orders)
         return self._orders_api.create_orders_async(request)
 
@@ -168,6 +199,12 @@ class ClickAndDrop(AbstractClickAndDrop):
 
         Label generation only available for orders with postage applied status.
 
+        Raises:
+            click_and_drop_api.exceptions.ForbiddenException: The account is not an OBA account.
+            click_and_drop_api.exceptions.BadRequestException: An order does not exist
+                or has no postage applied.
+            click_and_drop_api.exceptions.ApiException: The request failed, see :class:`~click_and_drop_api.simple.base.AbstractClickAndDrop`.
+
         https://api.parcel.royalmail.com/#tag/Labels/operation/GetOrdersLabelAsync
         """
         return self._labels_api.get_orders_label_async(