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

sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders.py

@@ -1,195 +1,122 @@
-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 VendorDirectFulfillmentOrders(Client):
-    """
-    VendorDirectFulfillmentOrders SP-API Client
-    :link:
+from .vendor_direct_fulfillment_orders_2021_12_28 import (
+    VendorDirectFulfillmentOrdersV20211228,
+)
+from .vendor_direct_fulfillment_orders_v1 import VendorDirectFulfillmentOrdersV1
+
+
+class VendorDirectFulfillmentOrdersVersion(str, enum.Enum):
+    V1 = "v1"
+    V_2021_12_28 = "2021-12-28"
+    LATEST = "2021-12-28"
+
+
+if TYPE_CHECKING:
+
+    class _VendorDirectFulfillmentOrdersMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[
+                VendorDirectFulfillmentOrdersVersion.V_2021_12_28,
+                VendorDirectFulfillmentOrdersVersion.LATEST,
+                "2021-12-28",
+            ],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV20211228: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentOrdersVersion.V1, "v1"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV1: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV1: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentOrdersVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _VendorDirectFulfillmentOrdersMeta = VersionedClientMeta
+
+
+class VendorDirectFulfillmentOrders(Client, metaclass=_VendorDirectFulfillmentOrdersMeta):
+    """Vendor Direct Fulfillment Orders API client.
+
+    This class dispatches to a versioned Vendor Direct Fulfillment Orders API client.
 
-    The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.
+    If you do not pass a version, the constructor returns the oldest supported implementation ("v1").
     """
 
-    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders", method="GET")
-    def get_orders(self, **kwargs) -> ApiResponse:
-        """
-        get_orders(self, **kwargs) -> ApiResponse
-
-        Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.
-
-        **Usage Plans:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        10                                      10
-        ======================================  ==============
-
-        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.
-
-        Args:
-            key shipFromPartyId:string |  The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
-            key status:string |  Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
-            key limit:integer |  The limit to the number of purchase orders returned.
-            key createdAfter:string | * REQUIRED Purchase 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:string | * REQUIRED Purchase 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:string |  Sort the list in ascending or descending order by order creation date.
-            key nextToken:string |  Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
-            key includeDetails:string |  When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
-
-        Returns:
-            ApiResponse:
-        """
-
-        return self._request(kwargs.pop("path"), params=kwargs)
-
-    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders/{}", method="GET")
-    def get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
-        """
-        get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse
-
-        Returns purchase order information for the purchaseOrderNumber that you specify.
-
-        **Usage Plans:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        10                                       10
-        ======================================  ==============
-
-        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.
-
-        Args:
-            purchaseOrderNumber:string | * REQUIRED The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
-
-        Returns:
-            ApiResponse:
-        """
-
-        return self._request(
-            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
-        )
-
-    @sp_endpoint("/vendor/directFulfillment/orders/v1/acknowledgements", method="POST")
-    def submit_acknowledgement(self, **kwargs) -> ApiResponse:
-        """
-        submit_acknowledgement(self, **kwargs) -> ApiResponse
-
-        Submits acknowledgements for one or more purchase orders.
-
-        **Usage Plans:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        10                                      10
-        ======================================  ==============
-
-        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.
-
-        Args:
-            body: {
-              "orderAcknowledgements": [
-                {
-                  "purchaseOrderNumber": "string",
-                  "vendorOrderNumber": "string",
-                  "acknowledgementDate": "2019-08-24T14:15:22Z",
-                  "acknowledgementStatus": {
-                    "code": "string",
-                    "description": "string"
-                  },
-                  "sellingParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "attention": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalCode": "string",
-                      "countryCode": "string",
-                      "phone": "string"
-                    },
-                    "taxInfo": {
-                      "taxRegistrationType": "VAT",
-                      "taxRegistrationNumber": "string",
-                      "taxRegistrationAddress": {
-                        "name": "string",
-                        "attention": "string",
-                        "addressLine1": "string",
-                        "addressLine2": "string",
-                        "addressLine3": "string",
-                        "city": "string",
-                        "county": "string",
-                        "district": "string",
-                        "stateOrRegion": "string",
-                        "postalCode": "string",
-                        "countryCode": "string",
-                        "phone": "string"
-                      },
-                      "taxRegistrationMessages": "string"
-                    }
-                  },
-                  "shipFromParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "attention": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalCode": "string",
-                      "countryCode": "string",
-                      "phone": "string"
-                    },
-                    "taxInfo": {
-                      "taxRegistrationType": "VAT",
-                      "taxRegistrationNumber": "string",
-                      "taxRegistrationAddress": {
-                        "name": "string",
-                        "attention": "string",
-                        "addressLine1": "string",
-                        "addressLine2": "string",
-                        "addressLine3": "string",
-                        "city": "string",
-                        "county": "string",
-                        "district": "string",
-                        "stateOrRegion": "string",
-                        "postalCode": "string",
-                        "countryCode": "string",
-                        "phone": "string"
-                      },
-                      "taxRegistrationMessages": "string"
-                    }
-                  },
-                  "itemAcknowledgements": [
-                    {
-                      "itemSequenceNumber": "string",
-                      "buyerProductIdentifier": "string",
-                      "vendorProductIdentifier": "string",
-                      "acknowledgedQuantity": {
-                        "amount": 0,
-                        "unitOfMeasure": "Each"
-                      }
-                    }
-                  ]
-                }
-              ]
-            }
-
-        Returns:
-            ApiResponse:
-        """
-
-        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[
+                VendorDirectFulfillmentOrdersVersion.V_2021_12_28,
+                VendorDirectFulfillmentOrdersVersion.LATEST,
+                "2021-12-28",
+            ],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV20211228: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentOrdersVersion.V1, "v1"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV1: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentOrdersV1: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentOrdersVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "v1"
+
+    _VERSION_MAP = {
+        "v1": VendorDirectFulfillmentOrdersV1,
+        "2021-12-28": VendorDirectFulfillmentOrdersV20211228,
+    }
+
+    _VERSION_ALIASES = {
+        "v1": "v1",
+        "2021-12-28": "2021-12-28",
+    }

sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_2021_12_28.py

@@ -0,0 +1,114 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentOrdersV20211228(Client):
+    """
+    VendorDirectFulfillmentOrders SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.
+    """
+
+    @sp_endpoint("/vendor/directFulfillment/orders/2021-12-28/purchaseOrders", method="GET")
+    def get_orders(self, **kwargs) -> ApiResponse:
+        """
+        get_orders(self, **kwargs) -> ApiResponse
+        
+        Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.
+        
+        **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::
+            
+                VendorDirectFulfillmentOrdersV20211228().get_orders()
+        
+        Args:
+            key shipFromPartyId: object |  The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
+            key status: object |  Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
+            key limit: object |  The limit to the number of purchase orders returned.
+            key createdAfter: object | required Purchase 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 Purchase 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 the list in ascending or descending order 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.
+            key includeDetails: object |  When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/{}", method="GET")
+    def get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+        
+        Returns purchase order information 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::
+            
+                VendorDirectFulfillmentOrdersV20211228().get_order("value")
+        
+        Args:
+            purchaseOrderNumber: object | required The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )
+
+    @sp_endpoint("/vendor/directFulfillment/orders/2021-12-28/acknowledgements", method="POST")
+    def submit_acknowledgement(self, **kwargs) -> ApiResponse:
+        """
+        submit_acknowledgement(self, **kwargs) -> ApiResponse
+        
+        Submits acknowledgements for one or more purchase 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::
+            
+                VendorDirectFulfillmentOrdersV20211228().submit_acknowledgement()
+        
+        Args:
+            body: SubmitAcknowledgementRequest | required The request body containing the acknowledgement to an order
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)

sp_api/api/vendor_direct_fulfillment_orders/vendor_direct_fulfillment_orders_v1.py

@@ -0,0 +1,114 @@
+import urllib.parse
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentOrdersV1(Client):
+    """
+    VendorDirectFulfillmentOrders SP-API Client
+    :link:
+
+    The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.
+    """
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders", method="GET")
+    def get_orders(self, **kwargs) -> ApiResponse:
+        """
+        get_orders(self, **kwargs) -> ApiResponse
+        
+        Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order.
+        
+        **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::
+            
+                VendorDirectFulfillmentOrdersV1().get_orders()
+        
+        Args:
+            key shipFromPartyId: object |  The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
+            key status: object |  Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
+            key limit: object |  The limit to the number of purchase orders returned.
+            key createdAfter: object | required Purchase 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 Purchase 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 the list in ascending or descending order 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.
+            key includeDetails: object |  When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/purchaseOrders/{}", method="GET")
+    def get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse:
+        """
+        get_order(self, purchaseOrderNumber, **kwargs) -> ApiResponse
+        
+        Returns purchase order information 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::
+            
+                VendorDirectFulfillmentOrdersV1().get_order("value")
+        
+        Args:
+            purchaseOrderNumber: object | required The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), purchaseOrderNumber), params=kwargs
+        )
+
+    @sp_endpoint("/vendor/directFulfillment/orders/v1/acknowledgements", method="POST")
+    def submit_acknowledgement(self, **kwargs) -> ApiResponse:
+        """
+        submit_acknowledgement(self, **kwargs) -> ApiResponse
+        
+        Submits acknowledgements for one or more purchase 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::
+            
+                VendorDirectFulfillmentOrdersV1().submit_acknowledgement()
+        
+        Args:
+            body: SubmitAcknowledgementRequest | required The request body containing the acknowledgement to an order.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)