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

sp_api/api/customer_feedback/customer_feedback.py

@@ -15,7 +15,22 @@ class CustomerFeedback(Client):
         self, asin, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_item_review_topics(self, asin, *args, **kwargs) -> ApiResponse
+        
         Retrieve an item's ten most positive and ten most negative review topics.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_item_review_topics("value")
+        
+        Args:
+            asin: object | required The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+            key sortBy: object | required The metric by which to sort data in the response.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -25,7 +40,21 @@ class CustomerFeedback(Client):
     @sp_endpoint("/customerFeedback/2024-06-01/items/{}/browseNode", method="GET")
     def get_item_browse_node(self, asin, *args, **kwargs) -> ApiResponse:
         """
+        get_item_browse_node(self, asin, *args, **kwargs) -> ApiResponse
+        
         This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_item_browse_node("value")
+        
+        Args:
+            asin: object | required The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -41,7 +70,22 @@ class CustomerFeedback(Client):
         self, browseNodeId, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_browse_node_review_topics(self, browseNodeId, *args, **kwargs) -> ApiResponse
+        
         Retrieve a browse node's ten most positive and ten most negative review topics.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_browse_node_review_topics("value")
+        
+        Args:
+            browseNodeId: object | required The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+            key sortBy: object | required The metric by which to sort the data in the response.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -56,7 +100,21 @@ class CustomerFeedback(Client):
         self, asin, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_item_review_trends(self, asin, *args, **kwargs) -> ApiResponse
+        
         Retrieve an item's positive and negative review trends for the past six months.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_item_review_trends("value")
+        
+        Args:
+            asin: object | required The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -72,7 +130,21 @@ class CustomerFeedback(Client):
         self, browseNodeId, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_browse_node_review_trends(self, browseNodeId, *args, **kwargs) -> ApiResponse
+        
         Retrieve the positive and negative review trends of items in a browse node for the past six months.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_browse_node_review_trends("value")
+        
+        Args:
+            browseNodeId: object | required A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+            key marketplaceId: object | required The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -87,7 +159,21 @@ class CustomerFeedback(Client):
         self, browseNodeId, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_browse_node_return_topics(self, browseNodeId, *args, **kwargs) -> ApiResponse
+        
         Retrieve the topics that customers mention when they return items in a browse node.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_browse_node_return_topics("value")
+        
+        Args:
+            browseNodeId: object | required A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(
@@ -102,7 +188,21 @@ class CustomerFeedback(Client):
         self, browseNodeId, *args, **kwargs
     ) -> ApiResponse:
         """
+        get_browse_node_return_trends(self, browseNodeId, *args, **kwargs) -> ApiResponse
+        
         Retrieve the trends of topics that customers mention when they return items in a browse node.
+        
+        Examples:
+            literal blocks::
+            
+                CustomerFeedback().get_browse_node_return_trends("value")
+        
+        Args:
+            browseNodeId: object | required A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+            key marketplaceId: object | required The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(

sp_api/api/data_kiosk/data_kiosk.py

@@ -18,35 +18,33 @@ class DataKiosk(Client):
     def get_queries(self, **kwargs) -> ApiResponse:
         """
         get_queries(self, **kwargs) -> ApiResponse
-
+        
         Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention.
-
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         0.0222                                  10
         ======================================  ==============
-
-
-        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).
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DataKiosk().get_queries()
+        
         Args:
-
-            key processingStatuses:array |  A list of processing statuses used to filter queries.
-
-            key pageSize:integer |  The maximum number of queries to return in a single call.
-
-            key createdSince:string |  The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
-
-            key createdUntil:string |  The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
-
-            key paginationToken:string |  A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
-
-
+            key processingStatuses: object |  A list of processing statuses used to filter queries.
+            key pageSize: object |  The maximum number of queries to return in a single call.
+            key createdSince: object |  The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.
+            key createdUntil: object |  The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.
+            key paginationToken: object |  A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)
@@ -54,31 +52,32 @@ class DataKiosk(Client):
     @sp_endpoint("/dataKiosk/2023-11-15/queries", method="POST")
     def create_query(self, query, pagination_token=None, **kwargs) -> ApiResponse:
         """
-        create_query(self, query, pagination_token=None, **kwargs) -> ApiResponse
-
+        create_query(self, query, pagination_token, **kwargs) -> ApiResponse
+        
         Creates a Data Kiosk query request.
-
+        
         **Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query's resulting documents always matches the retention of the query.
-
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         0.0167                                  15
         ======================================  ==============
-
-
-        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).
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DataKiosk().create_query("value", "value")
+        
         Args:
-
-            query:string | * REQUIRED The query to submit. The query must be a valid GraphQL query in the schema specified by the `schema` parameter.
-            pagination_token:string |  A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.
-
-
+            body: CreateQuerySpecification | required The body of the request.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
         kwargs["query"] = query
         if pagination_token:
@@ -88,27 +87,30 @@ class DataKiosk(Client):
     @sp_endpoint("/dataKiosk/2023-11-15/queries/{}", method="DELETE")
     def cancel_query(self, query_id, **kwargs) -> ApiResponse:
         """
-        cancel_query(self, queryId, **kwargs) -> ApiResponse
-
+        cancel_query(self, query_id, **kwargs) -> ApiResponse
+        
         Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.
-
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         0.0222                                  10
         ======================================  ==============
-
-        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).
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DataKiosk().cancel_query("value")
+        
         Args:
-
-            query_id:string | * REQUIRED The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
-
-
+            queryId: object | required The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -120,27 +122,30 @@ class DataKiosk(Client):
     @sp_endpoint("/dataKiosk/2023-11-15/queries/{}", method="GET")
     def get_query(self, query_id, **kwargs) -> ApiResponse:
         """
-        get_query(self, queryId, **kwargs) -> ApiResponse
-
+        get_query(self, query_id, **kwargs) -> ApiResponse
+        
         Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention.
-
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
-        2                                       15
+        2.0                                     15
         ======================================  ==============
-
-        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).
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DataKiosk().get_query("value")
+        
         Args:
-
-            query_id:string | * REQUIRED The query identifier.
-
-
+            queryId: object | required The query identifier.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -159,30 +164,30 @@ class DataKiosk(Client):
         **kwargs
     ) -> ApiResponse:
         """
-        get_document(self, document_id, download: bool = False, file: Union[BytesIO, str, BinaryIO, TextIO] = None, encoding='utf-8', **kwargs) -> ApiResponse
-
+        get_document(self, document_id, download, file, encoding, **kwargs) -> ApiResponse
+        
         Returns the information required for retrieving a Data Kiosk document's contents. See the `createQuery` operation for details about document retention.
-
+        
         **Usage Plan:**
-
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         0.0167                                  15
         ======================================  ==============
-
-        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).
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DataKiosk().get_document("value", "value", "value", "value")
+        
         Args:
-
-            document_id:string | * REQUIRED The identifier for the Data Kiosk document.
-            file: | * OPTIONAL The file to write the response to.
-            download: | * OPTIONAL If True, the file will be downloaded and returned in the payload.
-            encoding: | * OPTIONAL The encoding to use when writing the file. Defaults to utf-8, binary data is written if applicable filemode is passed.
-
-
+            documentId: object | required The identifier for the Data Kiosk document.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         res = self._request(

sp_api/api/delivery_by_amazon/delivery_by_amazon.py

@@ -0,0 +1,92 @@
+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 .delivery_by_amazon_2022_07_01 import DeliveryByAmazonV20220701
+
+
+class DeliveryByAmazonVersion(str, enum.Enum):
+    V_2022_07_01 = "2022-07-01"
+    LATEST = "2022-07-01"
+
+
+if TYPE_CHECKING:
+
+    class _DeliveryByAmazonMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[DeliveryByAmazonVersion.V_2022_07_01, DeliveryByAmazonVersion.LATEST, "2022-07-01"],
+            **kwargs: Any,
+        ) -> DeliveryByAmazonV20220701: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> DeliveryByAmazonV20220701: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | DeliveryByAmazonVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _DeliveryByAmazonMeta = VersionedClientMeta
+
+
+class DeliveryByAmazon(Client, metaclass=_DeliveryByAmazonMeta):
+    """DeliveryByAmazon API client.
+
+    This class dispatches to a versioned DeliveryByAmazon API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2022-07-01").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[DeliveryByAmazonVersion.V_2022_07_01, DeliveryByAmazonVersion.LATEST, "2022-07-01"],
+            **kwargs: Any,
+        ) -> DeliveryByAmazonV20220701: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> DeliveryByAmazonV20220701: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | DeliveryByAmazonVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2022-07-01"
+
+    _VERSION_MAP = {
+        "2022-07-01": DeliveryByAmazonV20220701,
+    }
+
+    _VERSION_ALIASES = {
+        "2022-07-01": "2022-07-01",
+    }

sp_api/api/delivery_by_amazon/delivery_by_amazon_2022_07_01.py

@@ -0,0 +1,81 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class DeliveryByAmazonV20220701(Client):
+    """
+    DeliveryByAmazon SP-API Client
+    :link:
+
+    The Selling Partner API for Delivery Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s orders.
+    """
+
+    @sp_endpoint("/delivery/2022-07-01/invoice", method="POST")
+    def submit_invoice(self, **kwargs) -> ApiResponse:
+        """
+        submit_invoice(self, **kwargs) -> ApiResponse
+        
+        Submits a shipment invoice for a given order or shipment. You must specify either an `orderId` or `shipmentId` as query parameter. If both parameters are supplied, `orderId` takes precedence over `shipmentId`.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1.133                                   25
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DeliveryByAmazonV20220701().submit_invoice()
+        
+        Args:
+            key orderId: object |  The identifier for the order.
+            key shipmentId: object |  The identifier for the shipment.
+            body: SubmitInvoiceRequest | required The request body that specifies invoice, program and marketplace values.
+        
+        Returns:
+            ApiResponse
+        """
+        params = {}
+        if "orderId" in kwargs:
+            params["orderId"] = kwargs.pop("orderId")
+        if "shipmentId" in kwargs:
+            params["shipmentId"] = kwargs.pop("shipmentId")
+        return self._request(kwargs.pop("path"), params=params, data=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/delivery/2022-07-01/invoice/status", method="GET")
+    def get_invoice_status(self, **kwargs) -> ApiResponse:
+        """
+        get_invoice_status(self, **kwargs) -> ApiResponse
+        
+        Returns the invoice status for the order or shipment you specify. You must specify either an `orderId` or `shipmentId` as query parameter. If both parameters are supplied, `orderId` takes precedence over `shipmentId`.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1.133                                   25
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                DeliveryByAmazonV20220701().get_invoice_status()
+        
+        Args:
+            key orderId: object |  The order identifier.
+            key shipmentId: object |  The shipment identifier.
+            key marketplaceId: object | required The marketplace identifier.
+            key invoiceType: object | required The invoice's type.
+            key programType: object | required The Amazon program that seller is currently enrolled.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)