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

sp_api/api/product_type_definitions/product_type_definitions.py

@@ -15,25 +15,32 @@ class ProductTypeDefinitions(Client):
     def search_definitions_product_types(self, **kwargs) -> ApiResponse:
         """
         search_definitions_product_types(self, **kwargs) -> ApiResponse
-
+        
         Search for and return a list of Amazon product types that have definitions available.
-
+        
         **Usage Plans:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        5                                       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.
-
+        
+        | Plan type | Rate (requests per second) | Burst |
+        | ---- | ---- | ---- |
+        |Default| 5 | 10 |
+        |Selling partner specific| Variable | Variable |
+        
+        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](doc:usage-plans-and-rate-limits-in-the-sp-api).
+        
+        Examples:
+            literal blocks::
+            
+                ProductTypeDefinitions().search_definitions_product_types()
+        
         Args:
-            key keywords:array |  A comma-delimited list of keywords to search product types by.
-            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
-
+            key keywords: object |  A comma-delimited list of keywords to search product types. **Note:** Cannot be used with `itemName`.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers for the request.
+            key itemName: object |  The title of the ASIN to get the product type recommendation. **Note:** Cannot be used with `keywords`.
+            key locale: object |  The locale for the display names in the response. Defaults to the primary locale of the marketplace.
+            key searchLocale: object |  The locale used for the `keywords` and `itemName` parameters. Defaults to the primary locale of the marketplace.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), params=kwargs)
@@ -42,31 +49,35 @@ class ProductTypeDefinitions(Client):
     def get_definitions_product_type(self, productType, **kwargs) -> ApiResponse:
         """
         get_definitions_product_type(self, productType, **kwargs) -> ApiResponse
-
+        
         Retrieve an Amazon product type definition.
-
+        
         **Usage Plans:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        5                                       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.
-
+        
+        | Plan type | Rate (requests per second) | Burst |
+        | ---- | ---- | ---- |
+        |Default| 5 | 10 |
+        |Selling partner specific| Variable | Variable |
+        
+        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](doc:usage-plans-and-rate-limits-in-the-sp-api).
+        
+        Examples:
+            literal blocks::
+            
+                ProductTypeDefinitions().get_definitions_product_type("value")
+        
         Args:
-            productType:string | * REQUIRED The Amazon product type name.
-            key sellerId:string |  A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.
-            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
-            key productTypeVersion:string |  The version of the Amazon product type to retrieve. Defaults to "LATEST",. Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease version is currently available, the "LATEST" live version will be provided.
-            key requirements:string |  The name of the requirements set to retrieve requirements for.
-            key requirementsEnforced:string |  Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).
-            key locale:string |  Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.
-
+            productType: object | required The Amazon product type name.
+            key sellerId: object |  A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers for the request.
+                Note: This parameter is limited to one marketplaceId at this time.
+            key productTypeVersion: object |  The version of the Amazon product type to retrieve. Defaults to "LATEST",. Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease version is currently available, the "LATEST" live version will be provided.
+            key requirements: object |  The name of the requirements set to retrieve requirements for.
+            key requirementsEnforced: object |  Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).
+            key locale: object |  Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(

sp_api/api/products/products.py

@@ -1,404 +1,112 @@
-from typing import Optional, List, Dict, Union
+from __future__ import annotations
 
-from sp_api.base import ApiResponse, Client, fill_query_params, sp_endpoint
-from sp_api.api.products.products_definitions import (
-    GetCompetitiveSummaryBatch,
-    GetFeaturedOfferExpectedPriceBatch,
-    GetItemOffersBatchRequest,
-    GetListingOffersBatchRequest,
-)
-from sp_api.util import ensure_csv
+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 Products(Client):
-    """
-    :links:
-        https://github.com/amzn/selling-partner-api-docs/blob/main/references/product-pricing-api/productPricingV0.md
-        https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
-    """
-
-    @sp_endpoint("/products/pricing/v0/price", method="GET")
-    def get_product_pricing_for_skus(
-        self, seller_sku_list: [str], item_condition=None, offer_type=None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_product_pricing_for_skus(self, seller_sku_list: [str], item_condition: str = None, **kwargs) -> ApiResponse
-        Returns pricing information for a seller's offer listings based on SKU.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                      1
-        ======================================  ==============
-
-        Examples:
-            literal blocks::
-
-                Products().get_product_pricing_for_skus(['sku', 'sku1'], MarketplaceId="ATVPDKIKX0DER")
-
-        Args:
-            seller_sku_list: [str]
-            item_condition: str ("New", "Used", "Collectible", "Refurbished", "Club")
-            offer_type: str ("B2C" or "B2B") Default is B2C.
-            **kwargs:
-
-        Returns:
-            ApiResponse:
-        """
-        if item_condition is not None:
-            kwargs["ItemCondition"] = item_condition
-        if offer_type is not None:
-            kwargs["OfferType"] = offer_type
-
-        return self._create_get_pricing_request(seller_sku_list, "Sku", **kwargs)
-
-    @sp_endpoint("/products/pricing/v0/price", method="GET")
-    def get_product_pricing_for_asins(
-        self, asin_list: [str], item_condition=None, offer_type=None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_product_pricing_for_asins(self, asin_list: [str], item_condition=None, **kwargs) -> ApiResponse
-        Returns pricing information for a seller's offer listings based on ASIN.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                      1
-        ======================================  ==============
-
-        Examples:
-            literal blocks::
-
-                Products().get_product_pricing_for_asins(['asin1', 'asin2'], MarketplaceId="ATVPDKIKX0DER")
-
-        Args:
-            asin_list: [str]
-            item_condition: str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
-            offer_type: str ("B2C" or "B2B") Default is B2C.
-        Returns:
-            ApiResponse
-        """
-        if item_condition is not None:
-            kwargs["ItemCondition"] = item_condition
-        if offer_type is not None:
-            kwargs["OfferType"] = offer_type
-
-        return self._create_get_pricing_request(asin_list, "Asin", **kwargs)
-
-    @sp_endpoint("/products/pricing/v0/competitivePrice", method="GET")
-    def get_competitive_pricing_for_skus(
-        self, seller_sku_list: [str], customer_type=None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_competitive_pricing_for_skus(self, seller_sku_list, **kwargs) -> ApiResponse
-        Returns competitive pricing information for a seller's offer listings based on Seller Sku
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                      1
-        ======================================  ==============
-
-        Examples:
-            literal blocks::
-
-                Products().get_competitive_pricing_for_skus([], MarketplaceId="ATVPDKIKX0DER")
-
-        Args:
-            seller_sku_list: [str]
-            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
-
-        Returns:
-            ApiResponse
-        """
-
-        if customer_type is not None:
-            kwargs["CustomerType"] = customer_type
-
-        return self._create_get_pricing_request(seller_sku_list, "Sku", **kwargs)
-
-    @sp_endpoint("/products/pricing/v0/competitivePrice", method="GET")
-    def get_competitive_pricing_for_asins(
-        self, asin_list: [str], customer_type=None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_competitive_pricing_for_asins(self, asin_list, **kwargs) -> ApiResponse
-        Returns competitive pricing information for a seller's offer listings based on ASIN
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                      1
-        ======================================  ==============
-
-        Examples:
-            literal blocks::
-
-                Products().get_competitive_pricing_for_asins([], MarketplaceId="ATVPDKIKX0DER")
-
-        Args:
-            asin_list: [str]
-            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
-
-        Returns:
-            ApiResponse
-
-        """
-        if customer_type is not None:
-            kwargs["CustomerType"] = customer_type
-
-        return self._create_get_pricing_request(asin_list, "Asin", **kwargs)
+from .products_2022_05_01 import ProductsV20220501
+from .products_v0 import ProductsV0
 
-    @sp_endpoint("/products/pricing/v0/listings/{}/offers", method="GET")
-    def get_listings_offer(
-        self, seller_sku: str, item_condition: str, customer_type: str = None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_listings_offer(self, seller_sku: str, **kwargs) -> ApiResponse
-        Returns the lowest priced offers for a single SKU listing
 
-        **Usage Plan:**
+class ProductsVersion(str, enum.Enum):
+    V0 = "v0"
+    V_2022_05_01 = "2022-05-01"
+    LATEST = "2022-05-01"
 
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       2
-        ======================================  ==============
 
-        Args:
-            key MarketplaceId: Required (query) str
-            item_condition: Required (query) str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
-            seller_sku: Required (path) str
-            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+if TYPE_CHECKING:
 
+    class _ProductsMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[ProductsVersion.V_2022_05_01, ProductsVersion.LATEST, "2022-05-01"],
+            **kwargs: Any,
+        ) -> ProductsV20220501: ...
 
-        Returns:
-            ApiResponse
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[ProductsVersion.V0, "v0"],
+            **kwargs: Any,
+        ) -> ProductsV0: ...
 
-        """
-        kwargs["ItemCondition"] = item_condition
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ProductsV0: ...
 
-        if customer_type is not None:
-            kwargs["CustomerType"] = customer_type
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | ProductsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
 
-        return self._request(
-            fill_query_params(kwargs.pop("path"), seller_sku), params={**kwargs}
-        )
 
-    @sp_endpoint("/products/pricing/v0/items/{}/offers", method="GET")
-    def get_item_offers(
-        self, asin: str, item_condition: str, customer_type: str = None, **kwargs
-    ) -> ApiResponse:
-        """
-        get_item_offers(self, asin: str, **kwargs) -> ApiResponse
-        Returns the lowest priced offers for a single item based on ASIN
+else:
+    _ProductsMeta = VersionedClientMeta
 
-        **Usage Plan:**
 
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                      1
-        ======================================  ==============
+class Products(Client, metaclass=_ProductsMeta):
+    """Product Pricing API client.
 
-        Args:
-            key MarketplaceId: Required (query) str
-            item_condition: Required (query) str | ("New", "Used", "Collectible", "Refurbished", "Club") Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. Available values : New, Used, Collectible, Refurbished, Club
-            asin: Required (path) str
-            customer_type: Optional (query) str ("Consumer" or "Business") Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.
+    This class dispatches to a versioned Product Pricing API client.
 
+    If you do not pass a version, the constructor returns the oldest supported implementation ("v0").
+    """
 
-        Returns:
-            ApiResponse
-
-        """
-        kwargs["ItemCondition"] = item_condition
-
-        if customer_type is not None:
-            kwargs["CustomerType"] = customer_type
-
-        return self._request(
-            fill_query_params(kwargs.pop("path"), asin), params={**kwargs}
-        )
-
-    @sp_endpoint("/batches/products/pricing/v0/itemOffers", method="POST")
-    def get_item_offers_batch(
-        self,
-        requests_: Optional[Union[List[Dict], GetItemOffersBatchRequest]] = None,
-        **kwargs,
-    ) -> ApiResponse:
-        """
-        get_item_offers_batch(self, requests_: Optional[List[Union[Dict, ItemOffersRequest]]], **kwargs) -> ApiResponse
-        Returns the lowest priced offers for a batch of items based on ASIN.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                       1
-        ======================================  ==============
-
-        Args:
-            requests_: Optional (Body) [dict] The request associated with the getItemOffersBatch API call.
-
-
-        Returns:
-            ApiResponse
-
-        """
-        if isinstance(requests_, GetItemOffersBatchRequest):
-            get_item_offers_batch_request = requests_.to_dict()
-        else:
-            get_item_offers_batch_request = {"requests": requests_}
-
-        return self._request(
-            kwargs.pop("path"),
-            data=get_item_offers_batch_request,
-            params={**kwargs},
-            add_marketplace=False,
-        )
-
-    @sp_endpoint("/batches/products/pricing/v0/listingOffers", method="POST")
-    def get_listing_offers_batch(
-        self,
-        requests_: Optional[Union[List[Dict], GetListingOffersBatchRequest]] = None,
-        **kwargs,
-    ) -> ApiResponse:
-        """
-        get_listing_offers_batch(self, requests_: Optional[Union[List[Dict], GetListingOffersBatchRequest]], **kwargs) -> ApiResponse
-        Returns the lowest priced offers for a batch of listings based on ASIN.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .5                                       1
-        ======================================  ==============
-
-        Args:
-            requests_: Optional (Body) [dict] The request associated with the getListingOffersBatch API call.
-
-
-        Returns:
-            ApiResponse
-
-        """
-        if isinstance(requests_, GetListingOffersBatchRequest):
-            get_listing_offers_batch_request = requests_.to_dict()
-        else:
-            get_listing_offers_batch_request = {"requests": requests_}
-
-        return self._request(
-            kwargs.pop("path"),
-            data=get_listing_offers_batch_request,
-            params={**kwargs},
-            add_marketplace=False,
-        )
-
-    @sp_endpoint('/batches/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice', method='POST')
-    def get_featured_offer_expected_price_batch(self, requests_: Optional[
-        Union[List[Dict], GetFeaturedOfferExpectedPriceBatch]], **kwargs) -> ApiResponse:
-        """
-        get_featured_offer_expected_price_batch(self, **kwargs) -> ApiResponse
-
-        Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request
-        body. The response for each successful (HTTP status code 200) request in the set includes the computed listing
-        price at or below which a seller can expect to become the featured offer (before applicable promotions).
-        This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing
-        offers may change, and different offers may be featured based on other factors, including fulfillment
-        capabilities to a specific customer. The response to an unsuccessful request includes the available error text.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .033                                    1
-        ======================================  ==============
-
-        Args:
-            requests_: [dict] The request associated with the getFeaturedOfferExpectedPriceBatch API call.
-
-        Returns:
-            ApiResponse:
-        """
-        if isinstance(requests_, GetFeaturedOfferExpectedPriceBatch):
-            get_featured_offer_expected_price_batch_request = requests_.to_dict()
-        else:
-            get_featured_offer_expected_price_batch_request = {"requests": requests_}
-
-        return self._request(
-            kwargs.pop('path'),
-            data=get_featured_offer_expected_price_batch_request,
-            params={**kwargs},
-            add_marketplace=False
-        )
-
-    @sp_endpoint('/batches/products/pricing/2022-05-01/items/competitiveSummary', method='POST')
-    def get_competitive_summary_batch(self, requests_: Optional[Union[List[Dict], GetCompetitiveSummaryBatch]], **kwargs) -> ApiResponse:
-        """
-        get_competitive_summary(self, **kwargs) -> ApiResponse
-
-        Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination.
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        .033                                    1
-        ======================================  ==============
-
-        Args:
-            requests_: The request associated with the getCompetitiveSummary API call.
-
-        Returns:
-            ApiResponse:
-        """
-        if isinstance(requests_, GetCompetitiveSummaryBatch):
-            get_competitive_summary_batch_request = requests_.to_dict()
-        else:
-            get_competitive_summary_batch_request = {"requests": requests_}
-
-        return self._request(
-            kwargs.pop('path'),
-            data=get_competitive_summary_batch_request,
-            params={**kwargs},
-            add_marketplace=False
-        )
-
-    def _create_get_pricing_request(self, item_list, item_type, **kwargs):
-        items_csv = ensure_csv(item_list)
-        return self._request(
-            kwargs.pop("path"),
-            params={
-                **{f"{item_type}s": items_csv},
-                "ItemType": item_type,
-                **(
-                    {"ItemCondition": kwargs.pop("ItemCondition")}
-                    if "ItemCondition" in kwargs
-                    else {}
-                ),
-                **(
-                    {"CustomerType": kwargs.pop("CustomerType")}
-                    if "CustomerType" in kwargs
-                    else {}
-                ),
-                **(
-                    {"OfferType": kwargs.pop("OfferType")}
-                    if "OfferType" in kwargs
-                    else {}
-                ),
-                "MarketplaceId": kwargs.get("MarketplaceId", self.marketplace_id),
-            },
-        )
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[ProductsVersion.V_2022_05_01, ProductsVersion.LATEST, "2022-05-01"],
+            **kwargs: Any,
+        ) -> ProductsV20220501: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[ProductsVersion.V0, "v0"],
+            **kwargs: Any,
+        ) -> ProductsV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> ProductsV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | ProductsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "v0"
+
+    _VERSION_MAP = {
+        "v0": ProductsV0,
+        "2022-05-01": ProductsV20220501,
+    }
+
+    _VERSION_ALIASES = {
+        "v0": "v0",
+        "2022-05-01": "2022-05-01",
+    }