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

sp_api/api/vendor_direct_fulfillment_shipping/vendor_direct_fulfillment_shipping_v1.py

@@ -0,0 +1,320 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentShippingV1(Client):
+    """
+    VendorDirectFulfillmentShipping SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.
+    """
+
+    @sp_endpoint("/vendor/directFulfillment/shipping/v1/shippingLabels", method="GET")
+    def get_shipping_labels(self, **kwargs) -> ApiResponse:
+        """
+        get_shipping_labels(self, **kwargs) -> ApiResponse
+        
+        Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_shipping_labels()
+        
+        Args:
+            key shipFromPartyId: object |  The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
+            key limit: object |  The limit to the number of records returned.
+            key createdAfter: object | required Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore: object | required Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key sortOrder: object |  Sort ASC or DESC by order creation date.
+            key nextToken: object |  Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/shipping/v1/shippingLabels", method="POST")
+    def submit_shipping_label_request(self, **kwargs) -> ApiResponse:
+        """
+        submit_shipping_label_request(self, **kwargs) -> ApiResponse
+        
+        Creates a shipping label for a purchase order and returns a transactionId for reference.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().submit_shipping_label_request()
+        
+        Args:
+            body: SubmitShippingLabelsRequest | required Request body containing one or more shipping labels data.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/shipping/v1/shippingLabels/{}", method="GET"
+    )
+    def get_shipping_label(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_shipping_label(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+        
+        Returns a shipping label for the purchaseOrderNumber that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_shipping_label("value")
+        
+        Args:
+            purchaseOrderNumber: object | required The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/shipping/v1/shipmentConfirmations", method="POST"
+    )
+    def submit_shipment_confirmations(self, **kwargs) -> ApiResponse:
+        """
+        submit_shipment_confirmations(self, **kwargs) -> ApiResponse
+        
+        Submits one or more shipment confirmations for vendor orders.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().submit_shipment_confirmations()
+        
+        Args:
+            body: SubmitShipmentConfirmationsRequest | required Request body containing the shipment confirmations data.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates", method="POST"
+    )
+    def submit_shipment_status_updates(self, **kwargs) -> ApiResponse:
+        """
+        submit_shipment_status_updates(self, **kwargs) -> ApiResponse
+        
+        This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().submit_shipment_status_updates()
+        
+        Args:
+            body: SubmitShipmentStatusUpdatesRequest | required Request body containing the shipment status update data.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/shipping/v1/customerInvoices", method="GET")
+    def get_customer_invoices(self, **kwargs) -> ApiResponse:
+        """
+        get_customer_invoices(self, **kwargs) -> ApiResponse
+        
+        Returns a list of customer invoices created during a time frame that you specify. You define the  time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_customer_invoices()
+        
+        Args:
+            key shipFromPartyId: object |  The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
+            key limit: object |  The limit to the number of records returned
+            key createdAfter: object | required Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore: object | required Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key sortOrder: object |  Sort ASC or DESC by order creation date.
+            key nextToken: object |  Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/shipping/v1/customerInvoices/{}", method="GET"
+    )
+    def get_customer_invoice(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_customer_invoice(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+        
+        Returns a customer invoice based on the purchaseOrderNumber that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_customer_invoice("value")
+        
+        Args:
+            purchaseOrderNumber: object | required Purchase order number of the shipment for which to return the invoice.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )
+
+    @sp_endpoint("/vendor/directFulfillment/shipping/v1/packingSlips", method="GET")
+    def get_packing_slips(self, **kwargs) -> ApiResponse:
+        """
+        get_packing_slips(self, **kwargs) -> ApiResponse
+        
+        Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_packing_slips()
+        
+        Args:
+            key shipFromPartyId: object |  The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
+            key limit: object |  The limit to the number of records returned
+            key createdAfter: object | required Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key createdBefore: object | required Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
+            key sortOrder: object |  Sort ASC or DESC by packing slip creation date.
+            key nextToken: object |  Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/shipping/v1/packingSlips/{}", method="GET")
+    def get_packing_slip(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_packing_slip(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+        
+        Returns a packing slip based on the purchaseOrderNumber that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentShippingV1().get_packing_slip("value")
+        
+        Args:
+            purchaseOrderNumber: object | required The purchaseOrderNumber for the packing slip you want.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )

sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions.py

@@ -1,42 +1,126 @@
-import urllib.parse
+from __future__ import annotations
 
-from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+import enum
+from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
 
+from sp_api.base import Client
 
-class VendorDirectFulfillmentTransactions(Client):
-    """
-    VendorDirectFulfillmentTransactions SP-API Client
-    :link:
+from .vendor_direct_fulfillment_transactions_2021_12_28 import (
+    VendorDirectFulfillmentTransactionsV20211228,
+)
+from .vendor_direct_fulfillment_transactions_v1 import (
+    VendorDirectFulfillmentTransactionsV1,
+)
+
+
+class VendorDirectFulfillmentTransactionsVersion(str, enum.Enum):
+    V1 = "v1"
+    V_2021_12_28 = "2021-12-28"
+    LATEST = "2021-12-28"
+
+
+if TYPE_CHECKING:
+
+    class _VendorDirectFulfillmentTransactionsMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[
+                VendorDirectFulfillmentTransactionsVersion.V_2021_12_28,
+                VendorDirectFulfillmentTransactionsVersion.LATEST,
+                "2021-12-28",
+            ],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV20211228: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentTransactionsVersion.V1, "v1"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV1: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV1: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentTransactionsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _VendorDirectFulfillmentTransactionsMeta = VersionedClientMeta
+
+
+class VendorDirectFulfillmentTransactions(
+    Client, metaclass=_VendorDirectFulfillmentTransactionsMeta
+):
+    """Vendor Direct Fulfillment Transactions API client.
+
+    This class dispatches to a versioned Vendor Direct Fulfillment Transactions API client.
 
-    The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct fulfillment vendor's transaction status.
+    If you do not pass a version, the constructor returns the oldest supported implementation ("v1").
     """
 
-    @sp_endpoint(
-        "/vendor/directFulfillment/transactions/v1/transactions/{}", method="GET"
-    )
-    def get_transaction_status(self, transactionId, **kwargs) -> ApiResponse:
-        """
-        get_transaction_status(self, transactionId, **kwargs) -> ApiResponse
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[
+                VendorDirectFulfillmentTransactionsVersion.V_2021_12_28,
+                VendorDirectFulfillmentTransactionsVersion.LATEST,
+                "2021-12-28",
+            ],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV20211228: ...
 
-        Returns the status of the transaction indicated by the specified transactionId.
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentTransactionsVersion.V1, "v1"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV1: ...
 
-        **Usage Plans:**
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentTransactionsV1: ...
 
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        10                                      10
-        ======================================  ==============
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentTransactionsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
 
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+    _DISPATCH = True
 
-        Args:
-            transactionId:string | * REQUIRED Previously returned in the response to the POST request of a specific transaction.
+    _DEFAULT_VERSION = "v1"
 
-        Returns:
-            ApiResponse:
-        """
+    _VERSION_MAP = {
+        "v1": VendorDirectFulfillmentTransactionsV1,
+        "2021-12-28": VendorDirectFulfillmentTransactionsV20211228,
+    }
 
-        return self._request(
-            fill_query_params(kwargs.pop("path"), transactionId), params=kwargs
-        )
+    _VERSION_ALIASES = {
+        "v1": "v1",
+        "2021-12-28": "2021-12-28",
+    }

sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_2021_12_28.py

@@ -0,0 +1,47 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentTransactionsV20211228(Client):
+    """
+    VendorDirectFulfillmentTransactions SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct fulfillment vendor's transaction status.
+    """
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/transactions/2021-12-28/transactions/{}", method="GET"
+    )
+    def get_transaction_status(self, transactionId, **kwargs) -> ApiResponse:
+        """
+        get_transaction_status(self, transactionId, **kwargs) -> ApiResponse
+        
+        Returns the status of the transaction indicated by the specified transactionId.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentTransactionsV20211228().get_transaction_status("value")
+        
+        Args:
+            transactionId: object | required Previously returned in the response to the POST request of a specific transaction.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), transactionId), params=kwargs
+        )

sp_api/api/vendor_direct_fulfillment_transactions/vendor_direct_fulfillment_transactions_v1.py

@@ -0,0 +1,47 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentTransactionsV1(Client):
+    """
+    VendorDirectFulfillmentTransactions SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct fulfillment vendor's transaction status.
+    """
+
+    @sp_endpoint(
+        "/vendor/directFulfillment/transactions/v1/transactions/{}", method="GET"
+    )
+    def get_transaction_status(self, transactionId, **kwargs) -> ApiResponse:
+        """
+        get_transaction_status(self, transactionId, **kwargs) -> ApiResponse
+        
+        Returns the status of the transaction indicated by the specified transactionId.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        10                                      10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentTransactionsV1().get_transaction_status("value")
+        
+        Args:
+            transactionId: object | required Previously returned in the response to the POST request of a specific transaction.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), transactionId), params=kwargs
+        )