python-amazon-sp-api 2.0.15__py3-none-any.whl → 2.1.3__py3-none-any.whl

sp_api/api/external_fulfillment/inventory.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+import enum
+from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
+
+from sp_api.base import Client
+
+from .inventory_2021_01_06 import ExternalFulfillmentInventoryV20210106
+from .inventory_2024_09_11 import ExternalFulfillmentInventoryV20240911
+
+
+class ExternalFulfillmentInventoryVersion(str, enum.Enum):
+    V_2021_01_06 = "2021-01-06"
+    V_2024_09_11 = "2024-09-11"
+    LATEST = "2024-09-11"
+
+
+if TYPE_CHECKING:
+
+    class _ExternalFulfillmentInventoryMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[
+                ExternalFulfillmentInventoryVersion.V_2024_09_11,
+                ExternalFulfillmentInventoryVersion.LATEST,
+                "2024-09-11",
+            ],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20240911: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[ExternalFulfillmentInventoryVersion.V_2021_01_06, "2021-01-06"],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20210106: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20210106: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | ExternalFulfillmentInventoryVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _ExternalFulfillmentInventoryMeta = VersionedClientMeta
+
+
+class ExternalFulfillmentInventory(Client, metaclass=_ExternalFulfillmentInventoryMeta):
+    """External Fulfillment Inventory API client.
+
+    This class dispatches to a versioned External Fulfillment Inventory API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2021-01-06").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[
+                ExternalFulfillmentInventoryVersion.V_2024_09_11,
+                ExternalFulfillmentInventoryVersion.LATEST,
+                "2024-09-11",
+            ],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20240911: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[ExternalFulfillmentInventoryVersion.V_2021_01_06, "2021-01-06"],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20210106: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ExternalFulfillmentInventoryV20210106: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | ExternalFulfillmentInventoryVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2021-01-06"
+
+    _VERSION_MAP = {
+        "2021-01-06": ExternalFulfillmentInventoryV20210106,
+        "2024-09-11": ExternalFulfillmentInventoryV20240911,
+    }
+
+    _VERSION_ALIASES = {
+        "2021-01-06": "2021-01-06",
+        "2024-09-11": "2024-09-11",
+    }

sp_api/api/external_fulfillment/inventory_2021_01_06.py

@@ -0,0 +1,71 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class ExternalFulfillmentInventoryV20210106(Client):
+    """
+    External Fulfillment Inventory API (version 2021-01-06).
+    """
+
+    @sp_endpoint("/externalFulfillment/inventory/2021-01-06/locations/{}/skus/{}", method="GET")
+    def get_inventory(self, locationId, skuId, **kwargs) -> ApiResponse:
+        """
+        get_inventory(self, locationId, skuId, **kwargs) -> ApiResponse
+        
+        Get the current inventory for a given SKU at a given location.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentInventoryV20210106().get_inventory("value", "value")
+        
+        Args:
+            locationId:  | required
+            skuId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        headers = self.headers.copy()
+        return self._request(
+            fill_query_params(kwargs.pop("path"), locationId, skuId),
+            params=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/inventory/2021-01-06/locations/{}/skus/{}", method="PUT")
+    def update_inventory(self, locationId, skuId, quantity, **kwargs) -> ApiResponse:
+        """
+        update_inventory(self, locationId, skuId, quantity, **kwargs) -> ApiResponse
+        
+        Get the current inventory for a given SKU at a given location.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentInventoryV20210106().update_inventory("value", "value", "value")
+        
+        Args:
+            locationId:  | required
+            skuId:  | required
+            quantity:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        kwargs["quantity"] = quantity
+
+        headers = self.headers.copy()
+        if "if_match" in kwargs:
+            headers["If-Match"] = kwargs.pop("if_match")
+        if "if_unmodified_since" in kwargs:
+            headers["If-Unmodified-Since"] = kwargs.pop("if_unmodified_since")
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), locationId, skuId),
+            params=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )

sp_api/api/external_fulfillment/inventory_2024_09_11.py

@@ -0,0 +1,96 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class ExternalFulfillmentInventoryV20240911(Client):
+    """
+    External Fulfillment Inventory API (version 2024-09-11).
+    """
+
+    @sp_endpoint("/externalFulfillment/inventory/2024-09-11/locations/{}/skus/{}", method="GET")
+    def get_inventory(self, locationId, skuId, **kwargs) -> ApiResponse:
+        """
+        get_inventory(self, locationId, skuId, **kwargs) -> ApiResponse
+        
+        Get the current inventory for a given SKU at a given location.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentInventoryV20240911().get_inventory("value", "value")
+        
+        Args:
+            locationId:  | required
+            skuId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        headers = self.headers.copy()
+        return self._request(
+            fill_query_params(kwargs.pop("path"), locationId, skuId),
+            params=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/inventory/2024-09-11/locations/{}/skus/{}", method="PUT")
+    def update_inventory(self, locationId, skuId, quantity, **kwargs) -> ApiResponse:
+        """
+        update_inventory(self, locationId, skuId, quantity, **kwargs) -> ApiResponse
+        
+        Get the current inventory for a given SKU at a given location.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentInventoryV20240911().update_inventory("value", "value", "value")
+        
+        Args:
+            locationId:  | required
+            skuId:  | required
+            quantity:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        kwargs["quantity"] = quantity
+
+        headers = self.headers.copy()
+        if "if_match" in kwargs:
+            headers["If-Match"] = kwargs.pop("if_match")
+        if "if_unmodified_since" in kwargs:
+            headers["If-Unmodified-Since"] = kwargs.pop("if_unmodified_since")
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), locationId, skuId),
+            params=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/inventory/2024-09-11/inventories", method="POST")
+    def batch_inventory(self, **kwargs) -> ApiResponse:
+        """
+        batch_inventory(self, **kwargs) -> ApiResponse
+        
+        Make up to 10 inventory requests. The response includes the set of responses that correspond to requests. The response for each successful request in the set includes the  inventory count for the provided `sku` and `locationId` pair.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentInventoryV20240911().batch_inventory()
+        
+        Args:
+            body: BatchInventoryRequest | required A list of inventory requests.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            kwargs.pop("path"),
+            data=kwargs,
+            add_marketplace=False,
+        )

sp_api/api/external_fulfillment/returns.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+import enum
+from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
+
+from sp_api.base import Client
+
+from .returns_2021_08_19 import ExternalFulfillmentReturnsV20210819
+from .returns_2024_09_11 import ExternalFulfillmentReturnsV20240911
+
+
+class ExternalFulfillmentReturnsVersion(str, enum.Enum):
+    V_2021_08_19 = "2021-08-19"
+    V_2024_09_11 = "2024-09-11"
+    LATEST = "2024-09-11"
+
+
+if TYPE_CHECKING:
+
+    class _ExternalFulfillmentReturnsMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[
+                ExternalFulfillmentReturnsVersion.V_2024_09_11,
+                ExternalFulfillmentReturnsVersion.LATEST,
+                "2024-09-11",
+            ],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20240911: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[ExternalFulfillmentReturnsVersion.V_2021_08_19, "2021-08-19"],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20210819: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20210819: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | ExternalFulfillmentReturnsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _ExternalFulfillmentReturnsMeta = VersionedClientMeta
+
+
+class ExternalFulfillmentReturns(Client, metaclass=_ExternalFulfillmentReturnsMeta):
+    """External Fulfillment Returns API client.
+
+    This class dispatches to a versioned External Fulfillment Returns API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2021-08-19").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[
+                ExternalFulfillmentReturnsVersion.V_2024_09_11,
+                ExternalFulfillmentReturnsVersion.LATEST,
+                "2024-09-11",
+            ],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20240911: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[ExternalFulfillmentReturnsVersion.V_2021_08_19, "2021-08-19"],
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20210819: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ExternalFulfillmentReturnsV20210819: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | ExternalFulfillmentReturnsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2021-08-19"
+
+    _VERSION_MAP = {
+        "2021-08-19": ExternalFulfillmentReturnsV20210819,
+        "2024-09-11": ExternalFulfillmentReturnsV20240911,
+    }
+
+    _VERSION_ALIASES = {
+        "2021-08-19": "2021-08-19",
+        "2024-09-11": "2024-09-11",
+    }

sp_api/api/external_fulfillment/returns_2021_08_19.py

@@ -0,0 +1,88 @@
+import uuid
+
+from sp_api.base import Client, sp_endpoint, ApiResponse, fill_query_params
+
+
+class ExternalFulfillmentReturnsV20210819(Client):
+    """
+    External Fulfillment Returns API (version 2021-08-19).
+    """
+
+    @sp_endpoint("/externalFulfillment/returns/2021-08-19/returns", method="GET")
+    def list_returns(self, **kwargs) -> ApiResponse:
+        """
+        list_returns(self, **kwargs) -> ApiResponse
+        
+        Get a list of return items dropped for the seller in the specified node, and in the specified status. Returns can be further filtered based on their creation date/time
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20210819().list_returns()
+        
+        Args:
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/externalFulfillment/returns/2021-08-19/returns/{}", method="GET")
+    def get_return(self, returnId, **kwargs) -> ApiResponse:
+        """
+        get_return(self, returnId, **kwargs) -> ApiResponse
+        
+        Get a single return item with the specified id.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20210819().get_return("value")
+        
+        Args:
+            returnId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(
+            fill_query_params(kwargs.pop("path"), returnId),
+            params=kwargs,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/returns/2021-08-19/returns/{}", method="PATCH")
+    def process_return_item(self, returnId, **kwargs) -> ApiResponse:
+        """
+        process_return_item(self, returnId, **kwargs) -> ApiResponse
+        
+        Process a return by grading. Determine the item condition and update the quantities for each item condition.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20210819().process_return_item("value")
+        
+        Args:
+            returnId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+
+        headers = self.headers.copy()
+        if "x-amzn-idempotency-token" in kwargs:
+            headers["x-amzn-idempotency-token"] = kwargs.pop("x-amzn-idempotency-token")
+        else:
+            headers["x-amzn-idempotency-token"] = str(uuid.uuid4())
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), returnId),
+            data=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )

sp_api/api/external_fulfillment/returns_2024_09_11.py

@@ -0,0 +1,141 @@
+import uuid
+
+from sp_api.base import Client, sp_endpoint, ApiResponse, fill_query_params
+
+
+class ExternalFulfillmentReturnsV20240911(Client):
+    """
+    External Fulfillment Returns API (version 2024-09-11).
+    """
+
+    @sp_endpoint("/externalFulfillment/returns/2024-09-11/returns", method="GET")
+    def list_returns(self, **kwargs) -> ApiResponse:
+        """
+        list_returns(self, **kwargs) -> ApiResponse
+        
+        Get a list of return items dropped for the seller in the specified node, and in the specified status. Returns can be further filtered based on their creation date/time
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20240911().list_returns()
+        
+        Args:
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/externalFulfillment/returns/2024-09-11/returns/{}", method="GET")
+    def get_return(self, returnId, **kwargs) -> ApiResponse:
+        """
+        get_return(self, returnId, **kwargs) -> ApiResponse
+        
+        Get a single return item with the specified id.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20240911().get_return("value")
+        
+        Args:
+            returnId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(
+            fill_query_params(kwargs.pop("path"), returnId),
+            params=kwargs,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/returns/2024-09-11/returns/{}", method="PATCH")
+    def process_return_item(self, returnId, **kwargs) -> ApiResponse:
+        """
+        process_return_item(self, returnId, **kwargs) -> ApiResponse
+        
+        Process a return by grading. Determine the item condition and update the quantities for each item condition.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20240911().process_return_item("value")
+        
+        Args:
+            returnId:  | required
+            **kwargs:
+        
+        Returns:
+            ApiResponse
+        """
+
+        headers = self.headers.copy()
+        if "x-amzn-idempotency-token" in kwargs:
+            headers["x-amzn-idempotency-token"] = kwargs.pop("x-amzn-idempotency-token")
+        else:
+            headers["x-amzn-idempotency-token"] = str(uuid.uuid4())
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), returnId),
+            data=kwargs,
+            headers=headers,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/externalFulfillment/2024-09-11/returns", method="GET")
+    def list_returns_get(self, **kwargs) -> ApiResponse:
+        """
+        list_returns_get(self, **kwargs) -> ApiResponse
+        
+        Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20240911().list_returns_get()
+        
+        Args:
+            key returnLocationId: object |  The SmartConnect location ID of the location from which you want to retrieve return items.
+            key rmaId: object |  The RMA ID of the return items you want to list.
+            key status: object |  The status of return items you want to list. You can retrieve all new return items with the `CREATED` status.
+            key reverseTrackingId: object |  The reverse tracking ID of the return items you want to list.
+            key createdSince: object |  Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+            key createdUntil: object |  Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+            key lastUpdatedSince: object |  Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.
+            key lastUpdatedUntil: object |  Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply `returnLocationId` and `status`.
+            key lastUpdatedAfter: object |  DEPRECATED. Use the `createdSince` parameter.
+            key lastUpdatedBefore: object |  DEPRECATED. Use the `createdUntil` parameter.
+            key maxResults: object |  The number of return items you want to include in the response.
+                **Default:** 10
+                **Maximum:** 100
+            key nextToken: object |  A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/externalFulfillment/2024-09-11/returns/{}", method="GET")
+    def get_return_get(self, returnId, **kwargs) -> ApiResponse:
+        """
+        get_return_get(self, returnId, **kwargs) -> ApiResponse
+        
+        Retrieve the return item with the specified ID.
+        
+        Examples:
+            literal blocks::
+            
+                ExternalFulfillmentReturnsV20240911().get_return_get("value")
+        
+        Args:
+            returnId: object | required The ID of the return item you want.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), returnId), params=kwargs, add_marketplace=False)