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

sp_api/api/application_management/application_management.py

@@ -14,22 +14,29 @@ class ApplicationManagement(Client):
     def rotate_application_client_secret(self, **kwargs) -> ApiResponse:
         """
         rotate_application_client_secret(self, **kwargs) -> ApiResponse
-
-        Rotates application client secrets for a developer application. Developers must register a destination queue in the developer console before calling this operation. When this operation is called a new client secret is generated and sent to the developer-registered queue. For more information, refer to [Rotate your application client secret](https://developer-docs.amazon.com/sp-api/docs/application-management-api-v2023-11-30-use-case-guide).
-
+        
+        Rotates application client secrets for a developer application. Developers must register a destination queue in the developer console before calling this operation. When this operation is called a new client secret is generated and sent to the developer-registered queue. For more information, refer to [Rotate your application client secret](https://developer-docs.amazon.com/sp-api/v0/docs/application-management-api-v2023-11-30-use-case-guide#tutorial-rotate-your-applications-client-secret).
+        
         **Usage Plan:**
-
-        | Rate (requests per second) | Burst |
-        | ---- | ---- |
-        | 0.0167 | 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).
-
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0167                                  1
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                ApplicationManagement().rotate_application_client_secret()
+        
         Args:
-
-
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request_grantless_operation(kwargs.pop("path"), data=kwargs)

sp_api/api/authorization/authorization.py

@@ -17,37 +17,19 @@ class Authorization(Client):
     def get_authorization_code(self, **kwargs) -> ApiResponse:
         """
         get_authorization_code(self, **kwargs) -> ApiResponse
-
+        
         With the getAuthorizationCode operation, you can request a Login With Amazon (LWA) authorization code that will allow you to call a Selling Partner API on behalf of a seller who has already authorized you to call Amazon Marketplace Web Service (Amazon MWS). You specify a developer ID, an MWS auth token, and a seller ID. Taken together, these represent the Amazon MWS authorization that the seller previously granted you. The operation returns an LWA authorization code that can be exchanged for a refresh token and access token representing authorization to call the Selling Partner API on the seller's behalf. By using this API, sellers who have already authorized you for Amazon MWS do not need to re-authorize you for the Selling Partner API.
-
-        **Usage Plan:**
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       5
-        ======================================  ==============
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
         Examples:
             literal blocks::
-
-                res = Authorization().get_authorization_code(
-                    mwsAuthToken='test',
-                    developerId='test',
-                    sellingPartnerId='test'
-                )
-
-
+            
+                Authorization().get_authorization_code()
+        
         Args:
-            key sellingPartnerId:string | * REQUIRED The seller ID of the seller for whom you are requesting Selling Partner API authorization. This must be the seller ID of the seller who authorized your application on the Marketplace Appstore.
-            key developerId:string | * REQUIRED Your developer ID. This must be one of the developer ID values that you provided when you registered your application in Developer Central.
-            key mwsAuthToken:string | * REQUIRED The MWS Auth Token that was generated when the seller authorized your application on the Marketplace Appstore.
-
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request_grantless_operation(kwargs.pop("path"), params=kwargs)

sp_api/api/catalog/catalog.py

@@ -13,31 +13,21 @@ class Catalog(Client):
     @sp_endpoint("/catalog/v0/items/{}")
     def get_item(self, asin: str, **kwargs) -> ApiResponse:
         """
-        get_item(self, asin: str, **kwargs) -> ApiResponse
+        get_item(self, asin, **kwargs) -> ApiResponse
+        
         Returns a specified item and its attributes.
-
-        **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::
-
-                res = Catalog().get_item('ASIN_200', MarketplaceId='TEST_CASE_200')
-
+            
+                Catalog().get_item("value")
+        
         Args:
-            asin: str
-            key MarketplaceId: str
+            asin:  | required
             **kwargs:
-
+        
         Returns:
-            GetCatalogItemResponse:
+            ApiResponse
         """
         return self._request(fill_query_params(kwargs.pop("path"), asin), params=kwargs)
 
@@ -45,36 +35,19 @@ class Catalog(Client):
     def list_items(self, **kwargs) -> ApiResponse:
         """
         list_items(self, **kwargs) -> ApiResponse
+        
         Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required.
-
-        **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::
-
-                res = Catalog().list_items(MarketplaceId='TEST_CASE_200', SellerSKU='SKU_200')
-
+            
+                Catalog().list_items()
+        
         Args:
-            key MarketplaceId: str
-            key Query: str
-            key QueryContextId: str
-            key SellerSKU: str
-            key UPC: str
-            key EAN: str
-            key ISBN: str
-            key JAN: str
-
+            **kwargs:
+        
         Returns:
-            ListCatalogItemsResponse:
+            ApiResponse
         """
         encode_kwarg(kwargs, "Query", urllib.parse.quote_plus)
         return self._request(kwargs.pop("path"), params=kwargs)
@@ -83,26 +56,19 @@ class Catalog(Client):
     def list_categories(self, **kwargs) -> ApiResponse:
         """
         list_categories(self, **kwargs) -> ApiResponse
+        
         Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU
-
-        **Usage Plan:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       2
-        ======================================  ==============
-
-
-        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        Examples:
+            literal blocks::
+            
+                Catalog().list_categories()
+        
         Args:
-            key MarketplaceId: str
-            key ASIN: str
-            key SellerSKU: str
-
+            **kwargs:
+        
         Returns:
-            ListCatalogCategoriesResponse:
+            ApiResponse
         """
         encode_kwarg(kwargs, "Query", urllib.parse.quote_plus)
         return self._request(kwargs.pop("path"), params=kwargs)

sp_api/api/catalog_items/catalog_items.py

@@ -1,7 +1,13 @@
+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 sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
-from sp_api.util import normalize_included_data
+from .catalog_items_2020_12_01 import CatalogItemsV20201201
+from .catalog_items_2022_04_01 import CatalogItemsV20220401
 
 
 class CatalogItemsVersion(str, enum.Enum):
@@ -10,81 +16,105 @@ class CatalogItemsVersion(str, enum.Enum):
     LATEST = "2022-04-01"
 
 
-class CatalogItems(Client):
-    """
-    CatalogItems SP-API Client
-    :link:
-
-    The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.
+if TYPE_CHECKING:
+
+    class _CatalogItemsMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[
+                CatalogItemsVersion.V_2022_04_01,
+                CatalogItemsVersion.LATEST,
+                "2022-04-01",
+            ],
+            **kwargs: Any,
+        ) -> CatalogItemsV20220401: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[CatalogItemsVersion.V_2020_12_01, "2020-12-01"],
+            **kwargs: Any,
+        ) -> CatalogItemsV20201201: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> CatalogItemsV20201201: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | CatalogItemsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _CatalogItemsMeta = VersionedClientMeta
+
+
+class CatalogItems(Client, metaclass=_CatalogItemsMeta):
+    """Catalog Items API client.
+
+    This class dispatches to a versioned Catalog Items API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2020-12-01").
     """
 
-    version: CatalogItemsVersion = CatalogItemsVersion.V_2020_12_01
-
-    def __init__(self, *args, **kwargs):
-        if "version" in kwargs:
-            self.version = kwargs.get("version", CatalogItemsVersion.V_2020_12_01)
-        super().__init__(*args, **{**kwargs, "version": self.version})
-
-    @sp_endpoint("/catalog/<version>/items", method="GET")
-    def search_catalog_items(self, **kwargs) -> ApiResponse:
-        """
-        search_catalog_items(self, **kwargs) -> ApiResponse
-
-        Search for and return a list of Amazon catalog items and associated information.
-
-        **Usage Plans:**
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        1                                       5
-        ======================================  ==============
-
-        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.
-
-        Args:
-            key keywords:array | * REQUIRED A comma-delimited list of words or item identifiers to search the Amazon catalog for.
-            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.
-            key includedData:array |  A comma-delimited string or list of data sets to include in the response. Default: summaries.
-            key brandNames:array |  A comma-delimited list of brand names to limit the search to.
-            key classificationIds:array |  A comma-delimited list of classification identifiers to limit the search to.
-            key pageSize:integer |  Number of results to be returned per page.
-            key pageToken:string |  A token to fetch a certain page when there are multiple pages worth of results.
-            key keywordsLocale:string |  The language the keywords are provided in. Defaults to the primary locale of the marketplace.
-            key locale:string |  Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
-
-        Returns:
-            ApiResponse:
-        """
-
-        normalize_included_data(kwargs)
-        return self._request(kwargs.pop("path"), params=kwargs)
-
-    @sp_endpoint("/catalog/<version>/items/{}", method="GET")
-    def get_catalog_item(self, asin, **kwargs) -> ApiResponse:
-        """
-        get_catalog_item(self, asin, **kwargs) -> ApiResponse
-
-        Retrieves details for an item in the Amazon catalog.
-
-
-        ======================================  ==============
-        Rate (requests per second)               Burst
-        ======================================  ==============
-        5                                       5
-        ======================================  ==============
-
-        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.
-
-        Args:
-            asin:string | * REQUIRED The Amazon Standard Identification Number (ASIN) of the item.
-            key marketplaceIds:array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
-            key includedData:array |  A comma-delimited string or list of data sets to include in the response. Default: summaries.
-            key locale:string |  Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
-
-        Returns:
-            ApiResponse:
-        """
-
-        normalize_included_data(kwargs)
-        return self._request(fill_query_params(kwargs.pop("path"), asin), params=kwargs)
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[
+                CatalogItemsVersion.V_2022_04_01,
+                CatalogItemsVersion.LATEST,
+                "2022-04-01",
+            ],
+            **kwargs: Any,
+        ) -> CatalogItemsV20220401: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[CatalogItemsVersion.V_2020_12_01, "2020-12-01"],
+            **kwargs: Any,
+        ) -> CatalogItemsV20201201: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> CatalogItemsV20201201: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | CatalogItemsVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2020-12-01"
+
+    _VERSION_MAP = {
+        "2020-12-01": CatalogItemsV20201201,
+        "2022-04-01": CatalogItemsV20220401,
+    }
+
+    _VERSION_ALIASES = {
+        "2020-12-01": "2020-12-01",
+        "2022-04-01": "2022-04-01",
+    }

sp_api/api/catalog_items/catalog_items_2020_12_01.py

@@ -0,0 +1,86 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.util import normalize_included_data
+
+
+class CatalogItemsV20201201(Client):
+    """
+    CatalogItems SP-API Client
+    :link:
+
+    The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.
+    """
+
+    @sp_endpoint("/catalog/2020-12-01/items", method="GET")
+    def search_catalog_items(self, **kwargs) -> ApiResponse:
+        """
+        search_catalog_items(self, **kwargs) -> ApiResponse
+        
+        Search for and return a list of Amazon catalog items and associated information.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                CatalogItemsV20201201().search_catalog_items()
+        
+        Args:
+            key keywords: object | required A comma-delimited list of words or item identifiers to search the Amazon catalog for.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers for the request.
+            key includedData: object |  A comma-delimited list of data sets to include in the response. Default: summaries.
+            key brandNames: object |  A comma-delimited list of brand names to limit the search to.
+            key classificationIds: object |  A comma-delimited list of classification identifiers to limit the search to.
+            key pageSize: object |  Number of results to be returned per page.
+            key pageToken: object |  A token to fetch a certain page when there are multiple pages worth of results.
+            key keywordsLocale: object |  The language the keywords are provided in. Defaults to the primary locale of the marketplace.
+            key locale: object |  Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+        
+        Returns:
+            ApiResponse
+        """
+
+        normalize_included_data(kwargs)
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/catalog/2020-12-01/items/{}", method="GET")
+    def get_catalog_item(self, asin, **kwargs) -> ApiResponse:
+        """
+        get_catalog_item(self, asin, **kwargs) -> ApiResponse
+        
+        Retrieves details for an item in the Amazon catalog.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                CatalogItemsV20201201().get_catalog_item("value")
+        
+        Args:
+            asin: object | required The Amazon Standard Identification Number (ASIN) of the item.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
+            key includedData: object |  A comma-delimited list of data sets to include in the response. Default: summaries.
+            key locale: object |  Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+        
+        Returns:
+            ApiResponse
+        """
+
+        normalize_included_data(kwargs)
+        return self._request(fill_query_params(kwargs.pop("path"), asin), params=kwargs)

sp_api/api/catalog_items/catalog_items_2022_04_01.py

@@ -0,0 +1,89 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.util import normalize_included_data
+
+
+class CatalogItemsV20220401(Client):
+    """
+    CatalogItems SP-API Client
+    :link:
+
+    The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.
+    """
+
+    @sp_endpoint("/catalog/2022-04-01/items", method="GET")
+    def search_catalog_items(self, **kwargs) -> ApiResponse:
+        """
+        search_catalog_items(self, **kwargs) -> ApiResponse
+        
+        Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                CatalogItemsV20220401().search_catalog_items()
+        
+        Args:
+            key identifiers: object |  A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
+            key identifiersType: object |  The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+            key includedData: object |  A comma-delimited list of datasets to include in the response.
+            key locale: object |  The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
+            key sellerId: object |  A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`.
+            key keywords: object |  A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
+            key brandNames: object |  A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
+            key classificationIds: object |  A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
+            key pageSize: object |  The number of results to include on each page.
+            key pageToken: object |  A token that you can use to fetch a specific page when there are multiple pages of results.
+            key keywordsLocale: object |  The language of the keywords that are included in queries based on `keywords`. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
+        
+        Returns:
+            ApiResponse
+        """
+
+        normalize_included_data(kwargs)
+        return self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/catalog/2022-04-01/items/{}", method="GET")
+    def get_catalog_item(self, asin, **kwargs) -> ApiResponse:
+        """
+        get_catalog_item(self, asin, **kwargs) -> ApiResponse
+        
+        Retrieves details for an item in the Amazon catalog.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                CatalogItemsV20220401().get_catalog_item("value")
+        
+        Args:
+            asin: object | required The Amazon Standard Identification Number (ASIN) of the item.
+            key marketplaceIds: object | required A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+            key includedData: object |  A comma-delimited list of datasets to include in the response.
+            key locale: object |  The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
+        
+        Returns:
+            ApiResponse
+        """
+
+        normalize_included_data(kwargs)
+        return self._request(fill_query_params(kwargs.pop("path"), asin), params=kwargs)