python-amazon-sp-api 1.9.26__tar.gz → 1.9.27__tar.gz

{python_amazon_sp_api-1.9.26/python_amazon_sp_api.egg-info → python_amazon_sp_api-1.9.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-sp-api
-Version: 1.9.26
+Version: 1.9.27
 Summary: Python wrapper for the Amazon Selling-Partner API
 Home-page: https://github.com/saleweaver/python-amazon-sp-api
 Author: Michael

{python_amazon_sp_api-1.9.26 → python_amazon_sp_api-1.9.27/python_amazon_sp_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-sp-api
-Version: 1.9.26
+Version: 1.9.27
 Summary: Python wrapper for the Amazon Selling-Partner API
 Home-page: https://github.com/saleweaver/python-amazon-sp-api
 Author: Michael

python_amazon_sp_api-1.9.27/sp_api/__version__.py

@@ -0,0 +1 @@
+__version__ = '1.9.27'

{python_amazon_sp_api-1.9.26 → python_amazon_sp_api-1.9.27}/sp_api/api/products/products.py

@@ -2,6 +2,8 @@ from typing import Optional, List, Dict, Union
 
 from sp_api.base import ApiResponse, Client, fill_query_params, sp_endpoint
 from sp_api.api.products.products_definitions import (
+    GetCompetitiveSummaryBatch,
+    GetFeaturedOfferExpectedPriceBatch,
     GetItemOffersBatchRequest,
     GetListingOffersBatchRequest,
 )
@@ -9,7 +11,9 @@ from sp_api.api.products.products_definitions import (
 
 class Products(Client):
     """
-    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/product-pricing-api/productPricingV0.md
+    :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")
@@ -300,6 +304,78 @@ class Products(Client):
             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):
         return self._request(
             kwargs.pop("path"),

python_amazon_sp_api-1.9.27/sp_api/api/products/products_definitions.py

@@ -0,0 +1,169 @@
+from enum import Enum
+from typing import Optional, List, Dict, Union
+from dataclasses import dataclass, asdict
+
+
+class CompetitiveSummaryIncludedData(Enum):
+    FEATURED_BUYING_OPTIONS = "featuredBuyingOptions"
+    LOWEST_PRICED_OFFERS = "lowestPricedOffers"
+    REFERENCE_PRICES = "referencePrices"
+
+
+@dataclass
+class ItemOffersRequest:
+    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
+    #itemoffersrequest"""
+
+    uri: str
+    method: str
+    MarketplaceId: str
+    ItemCondition: str = None
+    CustomerType: str = None
+    headers: Dict = None
+
+
+@dataclass
+class GetItemOffersBatchRequest:
+    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
+    #getitemoffersbatchrequest"""
+
+    requests: Optional[List[Union[ItemOffersRequest, Dict]]] = None
+
+    def __post_init__(self):
+        self.requests = self.parse_requests(self.requests)
+
+    def to_dict(self):
+        return asdict(self)
+
+    @staticmethod
+    def parse_requests(requests) -> List[ItemOffersRequest]:
+        parsed_requestes = []
+
+        for request in requests:
+            if isinstance(request, Dict):
+                request = ItemOffersRequest(**request)
+
+            if not isinstance(request, ItemOffersRequest):
+                raise TypeError
+
+            parsed_requestes.append(request)
+
+        return parsed_requestes
+
+
+@dataclass
+class ListingOffersRequest:
+    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
+    #listingoffersrequest"""
+
+    uri: str
+    MarketplaceId: str
+    ItemCondition: str
+    method: str = "GET"
+    CustomerType: str = "Consumer"
+
+
+@dataclass
+class GetListingOffersBatchRequest:
+    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
+    #getlistingoffersbatchrequest"""
+
+    requests: Optional[List[Union[ListingOffersRequest, Dict]]] = None
+
+    def __post_init__(self):
+        self.requests = self.parse_requests(self.requests)
+
+    def to_dict(self):
+        return asdict(self)
+
+    @staticmethod
+    def parse_requests(requests) -> List[ListingOffersRequest]:
+        parsed_requestes = []
+
+        for request in requests:
+            if isinstance(request, Dict):
+                request = ListingOffersRequest(**request)
+
+            if not isinstance(request, ListingOffersRequest):
+                raise TypeError
+
+            parsed_requestes.append(request)
+
+        return parsed_requestes
+
+
+@dataclass
+class FeaturedOfferExpectedPriceRequest:
+    """ Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
+        #FeaturedOfferExpectedPriceRequest """
+    marketplaceId: str
+    sku: str
+    uri: str = "/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice"
+    method: str = "GET"
+
+
+@dataclass
+class GetFeaturedOfferExpectedPriceBatch:
+    """ Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
+        #getFeaturedOfferExpectedPriceBatch """
+    requests: Optional[List[Union[FeaturedOfferExpectedPriceRequest, Dict]]] = None
+
+    def __post_init__(self):
+        self.requests = self.parse_requests(self.requests)
+
+    def to_dict(self):
+        return asdict(self)
+
+    @staticmethod
+    def parse_requests(requests) -> List[FeaturedOfferExpectedPriceRequest]:
+        parsed_requests = []
+
+        for request in requests:
+            if isinstance(request, Dict):
+                request = FeaturedOfferExpectedPriceRequest(**request)
+
+            if not isinstance(request, FeaturedOfferExpectedPriceRequest):
+                raise TypeError
+
+            parsed_requests.append(request)
+
+        return parsed_requests
+
+
+@dataclass
+class CompetitiveSummaryRequest:
+    """ Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
+        #FeaturedOfferExpectedPriceRequest """
+    marketplaceId: str
+    asin: str
+    includedData: List[CompetitiveSummaryIncludedData]
+    uri: str = "/products/pricing/2022-05-01/items/competitiveSummary"
+    method: str = "GET"
+
+
+@dataclass
+class GetCompetitiveSummaryBatch:
+    """ Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-reference
+        #getCompetitiveSummary """
+    requests: Optional[List[Union[CompetitiveSummaryRequest, Dict]]] = None
+
+    def __post_init__(self):
+        self.requests = self.parse_requests(self.requests)
+
+    def to_dict(self):
+        return asdict(self)
+
+    @staticmethod
+    def parse_requests(requests) -> List[CompetitiveSummaryRequest]:
+        parsed_requests = []
+
+        for request in requests:
+            if isinstance(request, Dict):
+                request = CompetitiveSummaryRequest(**request)
+
+            if not isinstance(request, CompetitiveSummaryRequest):
+                raise TypeError
+
+            parsed_requests.append(request)
+
+        return parsed_requests

python_amazon_sp_api-1.9.26/sp_api/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.9.26'

python_amazon_sp_api-1.9.26/sp_api/api/products/products_definitions.py

@@ -1,85 +0,0 @@
-from typing import Optional, List, Dict, Union
-from dataclasses import dataclass, asdict
-
-
-@dataclass
-class ItemOffersRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #itemoffersrequest"""
-
-    uri: str
-    method: str
-    MarketplaceId: str
-    ItemCondition: str = None
-    CustomerType: str = None
-    headers: Dict = None
-
-
-@dataclass
-class GetItemOffersBatchRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #getitemoffersbatchrequest"""
-
-    requests: Optional[List[Union[ItemOffersRequest, Dict]]] = None
-
-    def __post_init__(self):
-        self.requests = self.parse_requests(self.requests)
-
-    def to_dict(self):
-        return asdict(self)
-
-    @staticmethod
-    def parse_requests(requests) -> List[ItemOffersRequest]:
-        parsed_requestes = []
-
-        for request in requests:
-            if isinstance(request, Dict):
-                request = ItemOffersRequest(**request)
-
-            if not isinstance(request, ItemOffersRequest):
-                raise TypeError
-
-            parsed_requestes.append(request)
-
-        return parsed_requestes
-
-
-@dataclass
-class ListingOffersRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #listingoffersrequest"""
-
-    uri: str
-    MarketplaceId: str
-    ItemCondition: str
-    method: str = "GET"
-    CustomerType: str = "Consumer"
-
-
-@dataclass
-class GetListingOffersBatchRequest:
-    """Implements definition: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference
-    #getlistingoffersbatchrequest"""
-
-    requests: Optional[List[Union[ListingOffersRequest, Dict]]] = None
-
-    def __post_init__(self):
-        self.requests = self.parse_requests(self.requests)
-
-    def to_dict(self):
-        return asdict(self)
-
-    @staticmethod
-    def parse_requests(requests) -> List[ListingOffersRequest]:
-        parsed_requestes = []
-
-        for request in requests:
-            if isinstance(request, Dict):
-                request = ListingOffersRequest(**request)
-
-            if not isinstance(request, ListingOffersRequest):
-                raise TypeError
-
-            parsed_requestes.append(request)
-
-        return parsed_requestes