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

sp_api/api/shipment_invoicing/shipment_invoicing.py

@@ -0,0 +1,92 @@
+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 .shipment_invoicing_v0 import ShipmentInvoicingV0
+
+
+class ShipmentInvoicingVersion(str, enum.Enum):
+    V0 = "v0"
+    LATEST = "v0"
+
+
+if TYPE_CHECKING:
+
+    class _ShipmentInvoicingMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[ShipmentInvoicingVersion.V0, ShipmentInvoicingVersion.LATEST, "v0"],
+            **kwargs: Any,
+        ) -> ShipmentInvoicingV0: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ShipmentInvoicingV0: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | ShipmentInvoicingVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _ShipmentInvoicingMeta = VersionedClientMeta
+
+
+class ShipmentInvoicing(Client, metaclass=_ShipmentInvoicingMeta):
+    """ShipmentInvoicing API client.
+
+    This class dispatches to a versioned ShipmentInvoicing API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("v0").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[ShipmentInvoicingVersion.V0, ShipmentInvoicingVersion.LATEST, "v0"],
+            **kwargs: Any,
+        ) -> ShipmentInvoicingV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ShipmentInvoicingV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | ShipmentInvoicingVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "v0"
+
+    _VERSION_MAP = {
+        "v0": ShipmentInvoicingV0,
+    }
+
+    _VERSION_ALIASES = {
+        "v0": "v0",
+    }

sp_api/api/shipment_invoicing/shipment_invoicing_v0.py

@@ -0,0 +1,101 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class ShipmentInvoicingV0(Client):
+    """
+    ShipmentInvoicing SP-API Client
+    :link:
+
+    The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.
+    """
+
+    @sp_endpoint("/fba/outbound/brazil/v0/shipments/{shipmentId}", method="GET")
+    def get_shipment_details(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        get_shipment_details(self, shipmentId, **kwargs) -> ApiResponse
+        
+        Returns the shipment details required to issue an invoice for the specified shipment.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1.133                                   25
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                ShipmentInvoicingV0().get_shipment_details("value")
+        
+        Args:
+            shipmentId: object | required The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc:notifications-api-v1-use-case-guide).
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), shipmentId), params=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice", method="POST")
+    def submit_invoice(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        submit_invoice(self, shipmentId, **kwargs) -> ApiResponse
+        
+        Submits a shipment invoice document for a given shipment.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1.133                                   25
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                ShipmentInvoicingV0().submit_invoice("value")
+        
+        Args:
+            shipmentId: object | required The identifier for the shipment.
+            body: SubmitInvoiceRequest | required
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), shipmentId), data=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/fba/outbound/brazil/v0/shipments/{shipmentId}/invoice/status", method="GET")
+    def get_invoice_status(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+        get_invoice_status(self, shipmentId, **kwargs) -> ApiResponse
+        
+        Returns the invoice status for the shipment you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1.133                                   25
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                ShipmentInvoicingV0().get_invoice_status("value")
+        
+        Args:
+            shipmentId: object | required The shipment identifier for the shipment.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), shipmentId), params=kwargs, add_marketplace=False)