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

sp_api/api/fba_inbound_eligibility/fba_inbound_eligibility.py

@@ -21,28 +21,31 @@ class FbaInboundEligibility(Client):
     def get_item_eligibility_preview(self, **kwargs) -> ApiResponse:
         """
         get_item_eligibility_preview(self, **kwargs) -> ApiResponse
-
+        
         This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.
-
+        
         **Usage Plan:**
-
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       1
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaInboundEligibility().get_item_eligibility_preview()
+        
         Args:
-            key marketplaceIds:array |  The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
-            key asin:string | * REQUIRED The ASIN of the item for which you want an eligibility preview.
-            key program:string | * REQUIRED The program that you want to check eligibility against.
-
-
+            key marketplaceIds: object |  The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
+            key asin: object | required The ASIN of the item for which you want an eligibility preview.
+            key program: object | required The program that you want to check eligibility against.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         return self._request(kwargs.pop("path"), params=kwargs)
 
@@ -50,28 +53,31 @@ class FbaInboundEligibility(Client):
     def get_item_eligibility_preview_extended(self, **kwargs) -> ApiResponse:
         """
         get_item_eligibility_preview_extended(self, **kwargs) -> ApiResponse
-
+        
         This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.
-
+        
         **Usage Plan:**
-
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       1
         ======================================  ==============
-
+        
         For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaInboundEligibility().get_item_eligibility_preview_extended()
+        
         Args:
-            key marketplaceIds:array |  The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
-            key asin:string | * REQUIRED The ASIN of the item for which you want an eligibility preview.
-            key program:string | * REQUIRED The program that you want to check eligibility against.
-
-
+            key marketplaceIds: object |  The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
+            key asin: object | required The ASIN of the item for which you want an eligibility preview.
+            key program: object | required The program that you want to check eligibility against.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         api_response = self._request(kwargs.pop("path"), params=kwargs)

sp_api/api/fba_small_and_light/fba_small_and_light.py

@@ -22,26 +22,21 @@ class FbaSmallAndLight(Client):
         self, seller_sku, **kwargs
     ) -> ApiResponse:
         """
-        get_small_and_light_enrollment_by_seller_s_k_u(self, sellerSKU, **kwargs) -> ApiResponse
-
+        get_small_and_light_enrollment_by_seller_sku(self, seller_sku, **kwargs) -> ApiResponse
+        
         Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        2                                       10
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaSmallAndLight().get_small_and_light_enrollment_by_seller_sku("value")
+        
         Args:
-            seller_sku:string | * REQUIRED The seller SKU that identifies the item.
-            key marketplaceIds:array | * REQUIRED The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only.
-
+            seller_sku:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -59,33 +54,28 @@ class FbaSmallAndLight(Client):
         self, seller_sku, **kwargs
     ) -> ApiResponse:
         """
-        put_small_and_light_enrollment_by_seller_s_k_u(self, sellerSKU, **kwargs) -> ApiResponse
-
+        put_small_and_light_enrollment_by_seller_sku(self, seller_sku, **kwargs) -> ApiResponse
+        
         Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned.
-
-        **Usage Plan:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        2                                       5
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaSmallAndLight().put_small_and_light_enrollment_by_seller_sku("value")
+        
         Args:
-            seller_sku:string | * REQUIRED The seller SKU that identifies the item.
-            key marketplaceIds:array | * REQUIRED The marketplace in which to enroll the item. Note: Accepts a single marketplace only.
-
+            seller_sku:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
             fill_query_params(kwargs.pop("path"), seller_sku),
             params={
-                "marketplaceIds": kwargs.get("marketplaceIds", self.marketplace_id)
+                "marketplaceIds": kwargs.get("marketplaceIds", self.marketplace_id),
+                "method": kwargs.get("method", "PUT"),
             },
         )
 
@@ -100,26 +90,21 @@ class FbaSmallAndLight(Client):
         self, seller_sku, **kwargs
     ) -> ApiResponse:
         """
-        delete_small_and_light_enrollment_by_seller_s_k_u(self, sellerSKU, **kwargs) -> ApiResponse
-
+        delete_small_and_light_enrollment_by_seller_sku(self, seller_sku, **kwargs) -> ApiResponse
+        
         Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        2                                       5
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaSmallAndLight().delete_small_and_light_enrollment_by_seller_sku("value")
+        
         Args:
-            seller_sku:string | * REQUIRED The seller SKU that identifies the item.
-            key marketplaceIds:array | * REQUIRED The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only.
-
+            seller_sku:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -137,27 +122,21 @@ class FbaSmallAndLight(Client):
         self, seller_sku, **kwargs
     ) -> ApiResponse:
         """
-        get_small_and_light_eligibility_by_seller_s_k_u(self, sellerSKU, **kwargs) -> ApiResponse
-
+        get_small_and_light_eligibility_by_seller_sku(self, seller_sku, **kwargs) -> ApiResponse
+        
         Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned.
-
-        **Usage Plan:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        2                                       10
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaSmallAndLight().get_small_and_light_eligibility_by_seller_sku("value")
+        
         Args:
-            seller_sku:string | * REQUIRED The seller SKU that identifies the item.
-            key marketplaceIds:array | * REQUIRED The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only.
-
+            seller_sku:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -168,37 +147,19 @@ class FbaSmallAndLight(Client):
     def get_small_and_light_fee_preview(self, **kwargs) -> ApiResponse:
         """
         get_small_and_light_fee_preview(self, **kwargs) -> ApiResponse
-
+        
         Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed.
-
-        **Usage Plan:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       3
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                FbaSmallAndLight().get_small_and_light_fee_preview()
+        
         Args:
-            body:  REQUIRED
-            {
-              "marketplaceId": "string",
-              "items": [
-                {
-                  "asin": "string",
-                  "price": {
-                    "currencyCode": "string",
-                    "amount": 0
-                  }
-                }
-              ]
-            }
-
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs)

sp_api/api/feeds/feeds.py

@@ -1,262 +1,92 @@
-import zlib
+from __future__ import annotations
 
-import httpx
+import enum
+from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
 
-from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
-from sp_api.util import should_add_marketplace
+from sp_api.base import Client
 
+from .feeds_2021_06_30 import FeedsV20210630
 
-class Feeds(Client):
-    """
-    Feeds SP-API Client
-    :link:
-
-    The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
-    """
-
-    @sp_endpoint("/feeds/2021-06-30/feeds", method="GET")
-    def get_feeds(self, **kwargs) -> ApiResponse:
-        """
-        get_feeds(self, **kwargs) -> ApiResponse
-
-        Returns feed details for the feeds that match the filters that you specify.
-
-        Args:
-            key feedTypes:array |  A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
-            key marketplaceIds:array |  A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
-            key pageSize:integer |  The maximum number of feeds to return in a single call.
-            key processingStatuses:array |  A list of processing statuses used to filter feeds.
-            key createdSince:string |  The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
-            key createdUntil:string |  The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
-            key nextToken:string |  A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
-
-
-        Returns:
-            ApiResponse:
-        """
-
-        add_marketplace = should_add_marketplace(kwargs, "nextToken")
-        return self._request(
-            kwargs.pop("path"), params=kwargs, add_marketplace=add_marketplace
-        )
-
-    def submit_feed(
-        self, feed_type, file, content_type="text/tsv", **kwargs
-    ) -> [ApiResponse, ApiResponse]:
-        """
-        submit_feed(self, feed_type: str, file: File or File like, content_type='text/tsv', **kwargs) -> [ApiResponse, ApiResponse]
-        Combines `create_feed_document` and `create_feed`, uploads the file and sends the feed to amazon.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        0.0083                                  15
-        ======================================  ==============
-
-        Examples:
-            literal blocks::
-
-                feed = BytesIO
-                feed.write(<your feed>)
-                feed.seek(0)
-                Feeds().submit_feed('POST_FBA_INBOUND_CARTON_CONTENTS', feed, 'text/xml')
-
-
-        Args:
-            feed_type:
-            file:
-            content_type:
-            **kwargs:
-
-        Returns:
-            [ApiResponse:, ApiResponse:]
-        """
-        document_response = self.create_feed_document(file, content_type)
-        return document_response, self.create_feed(
-            feed_type, document_response.payload.get("feedDocumentId"), **kwargs
-        )
-
-    @sp_endpoint("/feeds/2021-06-30/feeds", method="POST")
-    def create_feed(self, feed_type, input_feed_document_id, **kwargs) -> ApiResponse:
-        """
-        create_feed(self, feed_type: str, input_feed_document_id: str, **kwargs) -> ApiResponse
-
-        Creates a feed. Call `create_feed_document` to upload the feed first.
-        `submit_feed` combines both.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        0.0083                                  15
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
-        Examples:
-            literal blocks::
-
-                Feeds().create_feed('POST_PRODUCT_DATA', '3d4e42b5-1d6e-44e8-a89c-2abfca0625bb',
-                              marketplaceIds=["ATVPDKIKX0DER", "A1F83G8C2ARO7P"])
-
-        Args:
-            feed_type: https://github.com/amzn/selling-partner-api-docs/blob/main/references/feeds-api/feedtype-values.md
-            input_feed_document_id: str
-            **kwargs:
-
-        Returns:
-            ApiResponse:
-        """
-        data = {
-            "feedType": feed_type,
-            "inputFeedDocumentId": input_feed_document_id,
-            **kwargs,
-        }
-        return self._request(kwargs.pop("path"), data=data)
 
-    @sp_endpoint("/feeds/2021-06-30/feeds/{}", method="DELETE")
-    def cancel_feed(self, feedId, **kwargs) -> ApiResponse:
-        """
-        cancel_feed(self, feedId, **kwargs) -> ApiResponse
+class FeedsVersion(str, enum.Enum):
+    V_2021_06_30 = "2021-06-30"
+    LATEST = "2021-06-30"
 
-        Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.
 
-        Args:
+if TYPE_CHECKING:
 
-            feedId:string | * REQUIRED The identifier for the feed. This identifier is unique only in combination with a seller ID.
+    class _FeedsMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[FeedsVersion.V_2021_06_30, FeedsVersion.LATEST, "2021-06-30"],
+            **kwargs: Any,
+        ) -> FeedsV20210630: ...
 
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> FeedsV20210630: ...
 
-        Returns:
-            ApiResponse:
-        """
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | FeedsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
 
-        return self._request(fill_query_params(kwargs.pop("path"), feedId), data=kwargs)
 
-    @sp_endpoint("/feeds/2021-06-30/feeds/{}", method="GET")
-    def get_feed(self, feedId, **kwargs) -> ApiResponse:
-        """
-        get_feed(self, feedId, **kwargs) -> ApiResponse
+else:
+    _FeedsMeta = VersionedClientMeta
 
-        Returns feed details (including the resultDocumentId, if available) for the feed that you specify.
 
-        Args:
+class Feeds(Client, metaclass=_FeedsMeta):
+    """Feeds API client.
 
-            feedId:string | * REQUIRED The identifier for the feed. This identifier is unique only in combination with a seller ID.
+    This class dispatches to a versioned Feeds API client.
 
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2021-06-30").
+    """
 
-        Returns:
-            ApiResponse:
-        """
-
-        return self._request(
-            fill_query_params(kwargs.pop("path"), feedId),
-            params=kwargs,
-            add_marketplace=False,
-        )
-
-    @sp_endpoint("/feeds/2021-06-30/documents", method="POST")
-    def create_feed_document(self, file, content_type, **kwargs) -> ApiResponse:
-        """
-        create_feed_document(self, **kwargs) -> ApiResponse
-
-        Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
-        Args:
-            file: File or File like object. Setting this to None will skip the upload.
-            content_type: str
-            body: | * REQUIRED {'description': 'Specifies the content type for the createFeedDocument operation.', 'properties': {'contentType': {'description': 'The content type of the feed.', 'type': 'string'}}, 'required': ['contentType'], 'type': 'object'}
-
-
-        Returns:
-            ApiResponse:
-        """
-        data = {"contentType": kwargs.get("contentType", content_type)}
-        response = self._request(kwargs.get("path"), data={**data, **kwargs})
-
-        if file is None:
-            return response
-
-        upload_data = file.read()
-        try:
-            upload_data = upload_data.encode("iso-8859-1")
-        except AttributeError:
-            pass
-        with httpx.Client() as client:
-            upload = client.put(
-                response.payload.get("url"),
-                content=upload_data,
-                headers={"Content-Type": content_type},
-            )
-        if 200 <= upload.status_code < 300:
-            return response
-        from sp_api.base.exceptions import SellingApiException
-
-        raise SellingApiException(
-            headers=upload.headers, error=upload.json().get("errors")
-        )
-
-    @sp_endpoint("/feeds/2021-06-30/documents/{}", method="GET")
-    def get_feed_document(self, feedDocumentId, **kwargs) -> str:
-        """
-        get_feed_document(self, feedDocumentId, **kwargs) -> ApiResponse
-
-        Returns the information required for retrieving a feed document's contents.
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
-        Args:
-
-            feedDocumentId:string | * REQUIRED The identifier of the feed document.
-
-
-        Returns:
-            ApiResponse:
-        """
-
-        return self.get_feed_result_document(feedDocumentId)
-
-    @sp_endpoint("/feeds/2021-06-30/documents/{}", method="GET")
-    def get_feed_result_document(self, feedDocumentId, **kwargs) -> str:
-        """
-        get_feed_result_document(self, feedDocumentId, **kwargs) -> str
-
-        Returns the feed result document's contents. First fetches from `getFeedDocument` endpont and then fetchs from the URL returned from it.
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
-        Args:
-            feedDocumentId: str
-            **kwargs:
-
-        Returns:
-            str:
-        """
-        response = self._request(
-            fill_query_params(kwargs.pop("path"), feedDocumentId),
-            params=kwargs,
-            add_marketplace=False,
-        )
-        url = response.payload.get("url")
-        with httpx.Client() as client:
-            doc_response = client.get(url)
-
-        encoding = (
-            doc_response.encoding
-            if doc_response and doc_response.encoding
-            else "iso-8859-1"
-        )
-        if encoding.lower() == "windows-31j":
-            encoding = "cp932"
-
-        content = doc_response.content
-        if "compressionAlgorithm" in response.payload:
-            try:
-                return zlib.decompress(bytearray(content), 15 + 32).decode(encoding)
-            except Exception:
-                return content.decode(encoding)
-        return content.decode(encoding)
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[FeedsVersion.V_2021_06_30, FeedsVersion.LATEST, "2021-06-30"],
+            **kwargs: Any,
+        ) -> FeedsV20210630: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> FeedsV20210630: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | FeedsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2021-06-30"
+
+    _VERSION_MAP = {
+        "2021-06-30": FeedsV20210630,
+    }
+
+    _VERSION_ALIASES = {
+        "2021-06-30": "2021-06-30",
+    }