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

sp_api/api/vendor_direct_fulfillment_payments/vendor_direct_fulfillment_payments.py

@@ -15,239 +15,29 @@ class VendorDirectFulfillmentPayments(Client):
     def submit_invoice(self, **kwargs) -> ApiResponse:
         """
         submit_invoice(self, **kwargs) -> ApiResponse
-
+        
         Submits one or more invoices for a vendor's direct fulfillment orders.
-
-        **Usage Plans:**
-
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         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.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentPayments().submit_invoice()
+        
         Args:
-            body: {
-              "invoices": [
-                {
-                  "invoiceNumber": "string",
-                  "invoiceDate": "2019-08-24T14:15:22Z",
-                  "referenceNumber": "string",
-                  "remitToParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalCode": "string",
-                      "countryCode": "string",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string",
-                        "taxRegistrationAddress": {
-                          "name": "string",
-                          "addressLine1": "string",
-                          "addressLine2": "string",
-                          "addressLine3": "string",
-                          "city": "string",
-                          "county": "string",
-                          "district": "string",
-                          "stateOrRegion": "string",
-                          "postalCode": "string",
-                          "countryCode": "string",
-                          "phone": "string"
-                        },
-                        "taxRegistrationMessage": "string"
-                      }
-                    ]
-                  },
-                  "shipFromParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalCode": "string",
-                      "countryCode": "string",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string",
-                        "taxRegistrationAddress": {
-                          "name": "string",
-                          "addressLine1": "string",
-                          "addressLine2": "string",
-                          "addressLine3": "string",
-                          "city": "string",
-                          "county": "string",
-                          "district": "string",
-                          "stateOrRegion": "string",
-                          "postalCode": "string",
-                          "countryCode": "string",
-                          "phone": "string"
-                        },
-                        "taxRegistrationMessage": "string"
-                      }
-                    ]
-                  },
-                  "billToParty": {
-                    "partyId": "string",
-                    "address": {
-                      "name": "string",
-                      "addressLine1": "string",
-                      "addressLine2": "string",
-                      "addressLine3": "string",
-                      "city": "string",
-                      "county": "string",
-                      "district": "string",
-                      "stateOrRegion": "string",
-                      "postalCode": "string",
-                      "countryCode": "string",
-                      "phone": "string"
-                    },
-                    "taxRegistrationDetails": [
-                      {
-                        "taxRegistrationType": "VAT",
-                        "taxRegistrationNumber": "string",
-                        "taxRegistrationAddress": {
-                          "name": "string",
-                          "addressLine1": "string",
-                          "addressLine2": "string",
-                          "addressLine3": "string",
-                          "city": "string",
-                          "county": "string",
-                          "district": "string",
-                          "stateOrRegion": "string",
-                          "postalCode": "string",
-                          "countryCode": "string",
-                          "phone": "string"
-                        },
-                        "taxRegistrationMessage": "string"
-                      }
-                    ]
-                  },
-                  "shipToCountryCode": "string",
-                  "paymentTermsCode": "string",
-                  "invoiceTotal": {
-                    "currencyCode": "string",
-                    "amount": "string"
-                  },
-                  "taxTotals": [
-                    {
-                      "taxType": "CGST",
-                      "taxRate": "string",
-                      "taxAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "taxableAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      }
-                    }
-                  ],
-                  "additionalDetails": [
-                    {
-                      "type": "SUR",
-                      "detail": "string",
-                      "languageCode": "string"
-                    }
-                  ],
-                  "chargeDetails": [
-                    {
-                      "type": "GIFTWRAP",
-                      "chargeAmount": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "taxDetails": [
-                        {
-                          "taxType": "CGST",
-                          "taxRate": "string",
-                          "taxAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxableAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          }
-                        }
-                      ]
-                    }
-                  ],
-                  "items": [
-                    {
-                      "itemSequenceNumber": "string",
-                      "buyerProductIdentifier": "string",
-                      "vendorProductIdentifier": "string",
-                      "invoicedQuantity": {
-                        "amount": 0,
-                        "unitOfMeasure": "string"
-                      },
-                      "netCost": {
-                        "currencyCode": "string",
-                        "amount": "string"
-                      },
-                      "purchaseOrderNumber": "string",
-                      "vendorOrderNumber": "string",
-                      "hsnCode": "string",
-                      "taxDetails": [
-                        {
-                          "taxType": "CGST",
-                          "taxRate": "string",
-                          "taxAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxableAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          }
-                        }
-                      ],
-                      "chargeDetails": [
-                        {
-                          "type": "GIFTWRAP",
-                          "chargeAmount": {
-                            "currencyCode": "string",
-                            "amount": "string"
-                          },
-                          "taxDetails": [
-                            {
-                              "taxType": "CGST",
-                              "taxRate": "string",
-                              "taxAmount": {},
-                              "taxableAmount": {}
-                            }
-                          ]
-                        }
-                      ]
-                    }
-                  ]
-                }
-              ]
-            }
-
+            body: SubmitInvoiceRequest | required The request body containing one or more invoices for vendor orders.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)

sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data.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 .vendor_direct_fulfillment_sandbox_test_data_2021_10_28 import VendorDirectFulfillmentSandboxTestDataV20211028
+
+
+class VendorDirectFulfillmentSandboxTestDataVersion(str, enum.Enum):
+    V_2021_10_28 = "2021-10-28"
+    LATEST = "2021-10-28"
+
+
+if TYPE_CHECKING:
+
+    class _VendorDirectFulfillmentSandboxTestDataMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentSandboxTestDataVersion.V_2021_10_28, VendorDirectFulfillmentSandboxTestDataVersion.LATEST, "2021-10-28"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentSandboxTestDataV20211028: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentSandboxTestDataV20211028: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentSandboxTestDataVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _VendorDirectFulfillmentSandboxTestDataMeta = VersionedClientMeta
+
+
+class VendorDirectFulfillmentSandboxTestData(Client, metaclass=_VendorDirectFulfillmentSandboxTestDataMeta):
+    """VendorDirectFulfillmentSandboxTestData API client.
+
+    This class dispatches to a versioned VendorDirectFulfillmentSandboxTestData API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2021-10-28").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[VendorDirectFulfillmentSandboxTestDataVersion.V_2021_10_28, VendorDirectFulfillmentSandboxTestDataVersion.LATEST, "2021-10-28"],
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentSandboxTestDataV20211028: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VendorDirectFulfillmentSandboxTestDataV20211028: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | VendorDirectFulfillmentSandboxTestDataVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2021-10-28"
+
+    _VERSION_MAP = {
+        "2021-10-28": VendorDirectFulfillmentSandboxTestDataV20211028,
+    }
+
+    _VERSION_ALIASES = {
+        "2021-10-28": "2021-10-28",
+    }

sp_api/api/vendor_direct_fulfillment_sandbox_test_data/vendor_direct_fulfillment_sandbox_test_data_2021_10_28.py

@@ -0,0 +1,50 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VendorDirectFulfillmentSandboxTestDataV20211028(Client):
+    """
+    VendorDirectFulfillmentSandboxTestData SP-API Client
+    :link:
+
+    The Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data provides programmatic access to vendor direct fulfillment sandbox test data.
+    """
+
+    @sp_endpoint("/vendor/directFulfillment/sandbox/2021-10-28/orders", method="POST")
+    def generate_order_scenarios(self, **kwargs) -> ApiResponse:
+        """
+        generate_order_scenarios(self, **kwargs) -> ApiResponse
+        
+        Submits a request to generate test order data for Vendor Direct Fulfillment API entities.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentSandboxTestDataV20211028().generate_order_scenarios()
+        
+        Args:
+            body: GenerateOrderScenarioRequest | required The request payload containing parameters for generating test order data scenarios.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/vendor/directFulfillment/sandbox/2021-10-28/transactions/{transactionId}", method="GET")
+    def get_order_scenarios(self, transactionId, **kwargs) -> ApiResponse:
+        """
+        get_order_scenarios(self, transactionId, **kwargs) -> ApiResponse
+        
+        Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentSandboxTestDataV20211028().get_order_scenarios("value")
+        
+        Args:
+            transactionId: object | required The transaction identifier returned in the response to the generateOrderScenarios operation.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(fill_query_params(kwargs.pop("path"), transactionId), params=kwargs, add_marketplace=False)