python-amazon-sp-api 1.9.60__py3-none-any.whl → 2.0.2__py3-none-any.whl

sp_api/api/reports/reports.py

@@ -1,10 +1,7 @@
-import zlib
-from collections import abc
 from datetime import datetime
-from io import BytesIO, StringIO
 from typing import Optional, Union
 
-import requests
+import httpx
 
 from sp_api.base import (
     Client,
@@ -13,6 +10,19 @@ from sp_api.base import (
     ApiResponse,
     Marketplaces,
 )
+from sp_api.util import (
+    normalize_csv_param,
+    normalize_datetime_kwargs,
+    normalize_marketplace_ids,
+    should_add_marketplace,
+)
+from sp_api.util.report_document import (
+    decode_document,
+    decompress_bytes,
+    handle_file,
+    resolve_character_code,
+    stream_to_file_sync,
+)
 
 
 class Reports(Client):
@@ -60,42 +70,16 @@ class Reports(Client):
         Returns:
             ApiResponse
         """
-        if (
-            kwargs.get("reportTypes", None)
-            and isinstance(kwargs.get("reportTypes"), abc.Iterable)
-            and not isinstance(kwargs.get("reportTypes"), str)
-        ):
-            kwargs.update({"reportTypes": ",".join(kwargs.get("reportTypes"))})
-        if (
-            kwargs.get("processingStatuses", None)
-            and isinstance(kwargs.get("processingStatuses"), abc.Iterable)
-            and not isinstance(kwargs.get("processingStatuses"), str)
-        ):
-            kwargs.update(
-                {"processingStatuses": ",".join(kwargs.get("processingStatuses"))}
-            )
-        if (
-            kwargs.get("marketplaceIds", None)
-            and isinstance(kwargs.get("marketplaceIds"), abc.Iterable)
-            and not isinstance(kwargs.get("marketplaceIds"), str)
-        ):
-            marketplaces = kwargs.get("marketplaceIds")
-            kwargs.update(
-                {
-                    "marketplaceIds": ",".join(
-                        [
-                            m.marketplace_id if isinstance(m, Marketplaces) else m
-                            for m in marketplaces
-                        ]
-                    )
-                }
-            )
-        for k in ["createdSince", "createdUntil"]:
-            if kwargs.get(k, None) and isinstance(kwargs.get(k), datetime):
-                kwargs.update({k: kwargs.get(k).isoformat()})
-        if not kwargs.get("nextToken"):
-            return self._request(kwargs.pop("path"), params=kwargs)
-        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
+        normalize_csv_param(kwargs, "reportTypes")
+        normalize_csv_param(kwargs, "processingStatuses")
+        normalize_marketplace_ids(kwargs, marketplace_cls=Marketplaces)
+        normalize_datetime_kwargs(kwargs, ["createdSince", "createdUntil"])
+        add_marketplace = should_add_marketplace(kwargs, "nextToken")
+        return self._request(
+            kwargs.pop("path"),
+            params=kwargs,
+            add_marketplace=add_marketplace,
+        )
 
     @sp_endpoint("/reports/2021-06-30/reports", method="POST")
     def create_report(self, **kwargs) -> ApiResponse:
@@ -134,10 +118,7 @@ class Reports(Client):
         Returns:
             ApiResponse
         """
-        if isinstance(kwargs.get("dataStartTime", None), datetime):
-            kwargs.update({"dataStartTime": kwargs.get("dataStartTime").isoformat()})
-        if isinstance(kwargs.get("dataEndTime", None), datetime):
-            kwargs.update({"dataEndTime": kwargs.get("dataEndTime").isoformat()})
+        normalize_datetime_kwargs(kwargs, ["dataStartTime", "dataEndTime"])
         return self._request(kwargs.pop("path"), data=kwargs)
 
     @sp_endpoint("/reports/2021-06-30/reports/{}", method="DELETE")
@@ -223,12 +204,7 @@ class Reports(Client):
         Returns:
             ApiResponse
         """
-        if (
-            kwargs.get("reportTypes", None)
-            and isinstance(kwargs.get("reportTypes"), abc.Iterable)
-            and not isinstance(kwargs.get("reportTypes"), str)
-        ):
-            kwargs.update({"reportTypes": ",".join(kwargs.get("reportTypes"))})
+        normalize_csv_param(kwargs, "reportTypes")
 
         return self._request(kwargs.pop("path"), params=kwargs)
 
@@ -371,6 +347,7 @@ class Reports(Client):
         download: bool = False,
         file=None,
         character_code: Optional[str] = None,
+        stream: bool = False,
         timeout: Optional[Union[float,int]] = None,
         **kwargs
     ) -> ApiResponse:
@@ -410,6 +387,7 @@ class Reports(Client):
                             obtaining the document from the document URL.
                             It fallbacks to 'iso-8859-1' if no encoding was found.
                             Only valid if decrypt=True.
+            stream: bool | if True and file is provided, stream the document to disk
             timeout: int | optional, the timeout for the request to download the document
 
         Returns:
@@ -420,54 +398,40 @@ class Reports(Client):
             add_marketplace=False,
         )
         if download or file or ("decrypt" in kwargs and kwargs["decrypt"]):
-            document_response = requests.get(
-                res.payload.get("url"),
+            compression_algorithm = res.payload.get("compressionAlgorithm")
+            with httpx.Client(
                 proxies=self.proxies,
                 verify=self.verify,
                 timeout=timeout,
-            )
-            document = document_response.content
-            if not character_code:
-                character_code = (
-                    document_response.encoding
-                    if document_response and document_response.encoding
-                    else "iso-8859-1"
-                )
-                if character_code.lower() == "windows-31j":
-                    character_code = "cp932"
-            if "compressionAlgorithm" in res.payload:
-                try:
-                    document = zlib.decompress(bytearray(document), 15 + 32)
-                except Exception as e:
-                    print(e)
-                    pass
-
-            if character_code:
-                try:
-                    decoded_document = document.decode(character_code)
-                except Exception as e:
-                    decoded_document = document
-
-            if download:
-                res.payload.update(
-                    {
-                        "document": decoded_document,
-                    }
-                )
-            if file:
-                self._handle_file(file, decoded_document, character_code)
+            ) as client:
+                if stream and file:
+                    with client.stream("GET", res.payload.get("url")) as document_response:
+                        if not character_code:
+                            character_code = resolve_character_code(
+                                document_response.encoding, fallback="iso-8859-1"
+                            )
+                        stream_to_file_sync(
+                            document_response,
+                            file,
+                            character_code,
+                            compression_algorithm,
+                        )
+                else:
+                    document_response = client.get(res.payload.get("url"))
+                    if not character_code:
+                        character_code = resolve_character_code(
+                            document_response.encoding, fallback="iso-8859-1"
+                        )
+                    document = decompress_bytes(
+                        document_response.content, compression_algorithm
+                    )
+                    decoded_document = decode_document(document, character_code)
+                    if download:
+                        res.payload.update(
+                            {
+                                "document": decoded_document,
+                            }
+                        )
+                    if file:
+                        handle_file(file, decoded_document, character_code)
         return res
-
-    @staticmethod
-    def _handle_file(file, document, encoding):
-        if isinstance(file, str):
-            with open(file, "w+", encoding=encoding) as text_file:
-                text_file.write(document)
-        elif isinstance(file, BytesIO):
-            file.write(document.encode(encoding))
-            file.seek(0)
-        elif isinstance(file, StringIO):
-            file.write(document)
-            file.seek(0)
-        else:
-            file.write(document)

sp_api/api/sales/sales.py

@@ -3,6 +3,7 @@ from datetime import datetime
 
 from sp_api.base import Client, Marketplaces, sp_endpoint, Granularity, ApiResponse
 import logging
+from sp_api.util import encode_kwarg
 
 
 class Sales(Client):
@@ -71,8 +72,7 @@ class Sales(Client):
         )
         if granularityTimeZone:
             kwargs.update({"granularityTimeZone": granularityTimeZone})
-        if "sku" in kwargs:
-            kwargs.update({"sku": urllib.parse.quote(kwargs.pop("sku"), safe="")})
+        encode_kwarg(kwargs, "sku", lambda value: urllib.parse.quote(value, safe=""))
         return self._request(kwargs.pop("path"), params=kwargs)
 
     @staticmethod

sp_api/asyncio/api/__init__.py

@@ -0,0 +1,164 @@
+from .finances.finances import Finances, FinancesVersion
+from .notifications.notifications import Notifications
+from .orders.orders import Orders
+from .product_fees.product_fees import ProductFees
+from .sellers.sellers import Sellers
+from .reports.reports import Reports
+from .reports.reports import Reports as ReportsV2
+
+from .products.products import Products
+from .sales.sales import Sales
+from .catalog.catalog import Catalog
+from .feeds.feeds import Feeds
+from .feeds.feeds import Feeds as FeedsV2
+
+from .inventories.inventories import Inventories
+from .fulfillment_inbound.fulfillment_inbound import (
+    FulfillmentInbound,
+    FulfillmentInboundVersion,
+)
+from .upload.upload import Upload
+from .messaging.messaging import Messaging
+from .merchant_fulfillment.merchant_fulfillment import MerchantFulfillment
+
+##### DO NOT DELETE ########## INSERT IMPORT HERE #######
+from .application_integrations.application_integrations import ApplicationIntegrations
+
+from .easy_ship.easy_ship import EasyShip
+    
+from .customer_feedback.customer_feedback import CustomerFeedback
+
+from .listings_restrictions.listings_restrictions import ListingsRestrictions
+
+from .messaging.messaging import Messaging
+
+from .catalog_items.catalog_items import CatalogItems, CatalogItemsVersion
+
+from .product_type_definitions.product_type_definitions import ProductTypeDefinitions
+
+from .listings_items.listings_items import ListingsItems
+
+from .vendor_transaction_status.vendor_transaction_status import VendorTransactionStatus
+
+from .vendor_shipments.vendor_shipments import VendorShipments
+
+from .vendor_orders.vendor_orders import VendorOrders
+
+from .vendor_invoices.vendor_invoices import VendorInvoices
+
+from .vendor_direct_fulfillment_transactions.vendor_direct_fulfillment_transactions import (
+    VendorDirectFulfillmentTransactions,
+)
+
+from .vendor_direct_fulfillment_shipping.vendor_direct_fulfillment_shipping import (
+    VendorDirectFulfillmentShipping,
+)
+
+from .vendor_direct_fulfillment_payments.vendor_direct_fulfillment_payments import (
+    VendorDirectFulfillmentPayments,
+)
+
+from .vendor_direct_fulfillment_orders.vendor_direct_fulfillment_orders import (
+    VendorDirectFulfillmentOrders,
+)
+
+from .vendor_direct_fulfillment_inventory.vendor_direct_fulfillment_inventory import (
+    VendorDirectFulfillmentInventory,
+)
+
+from .tokens.tokens import Tokens
+
+from .solicitations.solicitations import Solicitations
+
+from .shipping.shipping import Shipping
+
+from .services.services import Services
+
+from .fba_small_and_light.fba_small_and_light import FbaSmallAndLight
+
+from .fba_inbound_eligibility.fba_inbound_eligibility import FbaInboundEligibility
+
+from .authorization.authorization import Authorization
+
+from .aplus_content.aplus_content import AplusContent
+
+from .fulfillment_outbound.fulfillment_outbound import FulfillmentOutbound
+
+from .replenishment.replenishment import Replenishment
+
+from .supply_sources.supply_sources import SupplySources
+
+from .data_kiosk.data_kiosk import DataKiosk
+
+from .application_management.application_management import ApplicationManagement
+
+from .amazon_warehousing_and_distribu.amazon_warehousing_and_distribu import (
+    AmazonWarehousingAndDistribution,
+    AmazonWarehousingAndDistributionVersion,
+)
+
+from .external_fulfillment.external_fulfillment import ExternalFulfillment
+
+__all__ = [
+    "Sales",
+    "Products",
+    "Reports",
+    "Orders",
+    "Sellers",
+    "Notifications",
+    "ProductFees",
+    "Finances",
+    "Catalog",
+    "Feeds",
+    "Inventories",
+    "FulfillmentInbound",
+    "Upload",
+    "Messaging",
+    "FulfillmentInbound",
+    "MerchantFulfillment",
+    ##### DO NOT DELETE ########## INSERT TITLE HERE #######
+    "ExternalFulfillment",
+    "ApplicationIntegrations",
+    "CustomerFeedback",
+    "FulfillmentInbound",
+    
+    "EasyShip",
+    
+
+    "FulfillmentInbound",
+    "FinancesVersion",
+    "ListingsRestrictions",
+    "CatalogItemsVersion",
+    "AmazonWarehousingAndDistributionVersion",
+    "FulfillmentInboundVersion",
+    "Feeds",
+    "FeedsV2",
+    "ReportsV2",
+    "Messaging",
+    "CatalogItems",
+    "ProductTypeDefinitions",
+    "ListingsItems",
+    "VendorTransactionStatus",
+    "VendorShipments",
+    "VendorOrders",
+    "VendorInvoices",
+    "VendorDirectFulfillmentTransactions",
+    "VendorDirectFulfillmentShipping",
+    "VendorDirectFulfillmentPayments",
+    "VendorDirectFulfillmentOrders",
+    "VendorDirectFulfillmentInventory",
+    "Tokens",
+    "Solicitations",
+    "Shipping",
+    "Services",
+    "FbaSmallAndLight",
+    "FbaInboundEligibility",
+    "Authorization",
+    "AplusContent",
+    "FulfillmentOutbound",
+    "Replenishment",
+    "SupplySources",
+    "DataKiosk",
+    "ApplicationManagement",
+    "AmazonWarehousingAndDistribution",
+]

sp_api/asyncio/api/amazon_warehousing_and_distribu/__init__.py

@@ -0,0 +1,9 @@
+from .amazon_warehousing_and_distribu import (
+    AmazonWarehousingAndDistribution,
+    AmazonWarehousingAndDistributionVersion,
+)
+
+__all__ = [
+    "AmazonWarehousingAndDistribution",
+    "AmazonWarehousingAndDistributionVersion",
+]

sp_api/asyncio/api/amazon_warehousing_and_distribu/amazon_warehousing_and_distribu.py

@@ -0,0 +1,130 @@
+import enum
+import urllib.parse
+
+from sp_api.base import ApiResponse, fill_query_params, sp_endpoint
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class AmazonWarehousingAndDistributionVersion(str, enum.Enum):
+    V_2024_05_09 = "2024-05-09"
+    LATEST = "2024-05-09"
+
+
+class AmazonWarehousingAndDistribution(AsyncBaseClient):
+    """
+    AmazonWarehousingAndDistribu SP-API Client
+    :link:
+
+    The Selling Partner API for Amazon Warehousing and Distribution (AWD).
+    """
+
+    version: AmazonWarehousingAndDistributionVersion = (
+        AmazonWarehousingAndDistributionVersion.V_2024_05_09
+    )
+
+    def __init__(self, *args, **kwargs):
+        if "version" in kwargs:
+            self.version = kwargs.get(
+                "version", AmazonWarehousingAndDistributionVersion.V_2024_05_09
+            )
+        super().__init__(*args, **{**kwargs, "version": self.version})
+
+    @sp_endpoint("/awd/<version>/inboundShipments/{}", method="GET")
+    async def get_inbound_shipment(self, shipmentId, **kwargs) -> ApiResponse:
+        """
+                get_inbound_shipment(self, shipmentId, **kwargs) -> ApiResponse
+
+                Retrieves an AWD inbound shipment.
+
+        **Usage Plan:**
+
+        | Rate (requests per second) | Burst |
+        | ---- | ---- |
+        | 2 | 2 |
+
+        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
+
+                Args:
+
+                    shipmentId:string | * REQUIRED ID for the shipment. A shipment contains the cases being inbounded.
+
+
+                Returns:
+                    ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), shipmentId), params=kwargs
+        )
+
+    @sp_endpoint("/awd/<version>/inboundShipments", method="GET")
+    async def list_inbound_shipments(self, **kwargs) -> ApiResponse:
+        """
+                list_inbound_shipments(self, **kwargs) -> ApiResponse
+
+                Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.
+
+        **Usage Plan:**
+
+        | Rate (requests per second) | Burst |
+        | ---- | ---- |
+        | 1 | 1 |
+
+        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+
+                Args:
+
+                    key sortBy:string |  Field to sort results by. Required if `sortOrder` is provided.
+
+                    key sortOrder:string |  Sort the response in `ASCENDING` or `DESCENDING` order.
+
+                    key shipmentStatus:string |  Filter by inbound shipment status.
+
+                    key updatedAfter:string |  List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
+
+                    key updatedBefore:string |  List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
+
+                    key maxResults:integer |  Maximum number of results to return.
+
+                    key nextToken:string |  Token to retrieve the next set of paginated results.
+
+
+                Returns:
+                    ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/awd/<version>/inventory", method="GET")
+    async def list_inventory(self, **kwargs) -> ApiResponse:
+        """
+                list_inventory(self, **kwargs) -> ApiResponse
+
+                Lists AWD inventory associated with a merchant with the ability to apply optional filters.
+
+        **Usage Plan:**
+
+        | Rate (requests per second) | Burst |
+        | ---- | ---- |
+        | 2 | 2 |
+
+        The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+
+                Args:
+
+                    key sku:string |  Filter by seller or merchant SKU for the item.
+
+                    key sortOrder:string |  Sort the response in `ASCENDING` or `DESCENDING` order.
+
+                    key details:string |  Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
+
+                    key nextToken:string |  Token to retrieve the next set of paginated results.
+
+                    key maxResults:integer |  Maximum number of results to return.
+
+
+                Returns:
+                    ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), params=kwargs)

sp_api/asyncio/api/aplus_content/__init__.py

@@ -0,0 +1,5 @@
+from .aplus_content import AplusContent
+
+__all__ = [
+    "AplusContent",
+]