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

sp_api/api/feeds/feeds_2021_06_30.py

@@ -0,0 +1,320 @@
+import zlib
+
+import httpx
+
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.util import should_add_marketplace
+
+
+class FeedsV20210630(Client):
+    """
+    Feeds SP-API Client
+    :link:
+
+    The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
+    """
+
+    @sp_endpoint("/feeds/2021-06-30/feeds", method="GET")
+    def get_feeds(self, **kwargs) -> ApiResponse:
+        """
+        get_feeds(self, **kwargs) -> ApiResponse
+        
+        Returns feed details for the feeds that match the filters that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0222                                  10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().get_feeds()
+        
+        Args:
+            key feedTypes: object |  A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
+            key marketplaceIds: object |  A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
+            key pageSize: object |  The maximum number of feeds to return in a single call.
+            key processingStatuses: object |  A list of processing statuses used to filter feeds.
+            key createdSince: object |  The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
+            key createdUntil: object |  The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.
+            key nextToken: object |  A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.
+        
+        Returns:
+            ApiResponse
+        """
+
+        add_marketplace = should_add_marketplace(kwargs, "nextToken")
+        return self._request(
+            kwargs.pop("path"), params=kwargs, add_marketplace=add_marketplace
+        )
+
+    def submit_feed(
+        self, feed_type, file, content_type="text/tsv", **kwargs
+    ) -> [ApiResponse, ApiResponse]:
+        """
+        submit_feed(self, feed_type, file, content_type, **kwargs) -> [ApiResponse, ApiResponse]
+        
+        Combines `create_feed_document` and `create_feed`, uploads the file and sends the feed to amazon.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().submit_feed("value", "value", "value")
+        
+        Args:
+            feed_type:  | required
+            file:  | required
+            content_type:  | required
+            **kwargs:
+        
+        Returns:
+            [ApiResponse, ApiResponse]
+        """
+        document_response = self.create_feed_document(file, content_type)
+        return document_response, self.create_feed(
+            feed_type, document_response.payload.get("feedDocumentId"), **kwargs
+        )
+
+    @sp_endpoint("/feeds/2021-06-30/feeds", method="POST")
+    def create_feed(self, feed_type, input_feed_document_id, **kwargs) -> ApiResponse:
+        """
+        create_feed(self, feed_type, input_feed_document_id, **kwargs) -> ApiResponse
+        
+        Creates a feed. Upload the contents of the feed document before calling this operation.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0083                                  15
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().create_feed("value", "value")
+        
+        Args:
+            body: CreateFeedSpecification | required Information required to create the feed.
+        
+        Returns:
+            ApiResponse
+        """
+        data = {
+            "feedType": feed_type,
+            "inputFeedDocumentId": input_feed_document_id,
+            **kwargs,
+        }
+        return self._request(kwargs.pop("path"), data=data)
+
+    @sp_endpoint("/feeds/2021-06-30/feeds/{}", method="DELETE")
+    def cancel_feed(self, feedId, **kwargs) -> ApiResponse:
+        """
+        cancel_feed(self, feedId, **kwargs) -> ApiResponse
+        
+        Cancels the feed that you specify. Only feeds with `processingStatus=IN_QUEUE` can be cancelled. Cancelled feeds are returned in subsequent calls to the [`getFeed`](https://developer-docs.amazon.com/sp-api/reference/getfeed) and [`getFeeds`](https://developer-docs.amazon.com/sp-api/reference/getfeeds) operations.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       15
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().cancel_feed("value")
+        
+        Args:
+            feedId: object | required The identifier for the feed. This identifier is unique only in combination with a seller ID.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(fill_query_params(kwargs.pop("path"), feedId), data=kwargs)
+
+    @sp_endpoint("/feeds/2021-06-30/feeds/{}", method="GET")
+    def get_feed(self, feedId, **kwargs) -> ApiResponse:
+        """
+        get_feed(self, feedId, **kwargs) -> ApiResponse
+        
+        Returns feed details (including the `resultDocumentId`, if available) for the feed that you specify.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       15
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().get_feed("value")
+        
+        Args:
+            feedId: object | required The identifier for the feed. This identifier is unique only in combination with a seller ID.
+        
+        Returns:
+            ApiResponse
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), feedId),
+            params=kwargs,
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/feeds/2021-06-30/documents", method="POST")
+    def create_feed_document(self, file, content_type, **kwargs) -> ApiResponse:
+        """
+        create_feed_document(self, file, content_type, **kwargs) -> ApiResponse
+        
+        Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a `feedDocumentId` value that you can pass in with a subsequent call to the [`createFeed`](https://developer-docs.amazon.com/sp-api/reference/createfeed) operation.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.5                                     15
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().create_feed_document("value", "value")
+        
+        Args:
+            body: CreateFeedDocumentSpecification | required Specifies the content type for the createFeedDocument operation.
+        
+        Returns:
+            ApiResponse
+        """
+        data = {"contentType": kwargs.get("contentType", content_type)}
+        response = self._request(kwargs.get("path"), data={**data, **kwargs})
+
+        if file is None:
+            return response
+
+        upload_data = file.read()
+        try:
+            upload_data = upload_data.encode("iso-8859-1")
+        except AttributeError:
+            pass
+        with httpx.Client() as client:
+            upload = client.put(
+                response.payload.get("url"),
+                content=upload_data,
+                headers={"Content-Type": content_type},
+            )
+        if 200 <= upload.status_code < 300:
+            return response
+        from sp_api.base.exceptions import SellingApiException
+
+        raise SellingApiException(
+            headers=upload.headers, error=upload.json().get("errors")
+        )
+
+    @sp_endpoint("/feeds/2021-06-30/documents/{}", method="GET")
+    def get_feed_document(self, feedDocumentId, **kwargs) -> str:
+        """
+        get_feed_document(self, feedDocumentId, **kwargs) -> str
+        
+        Returns the information required for retrieving a feed document's contents.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0222                                  10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().get_feed_document("value")
+        
+        Args:
+            feedDocumentId: object | required The identifier of the feed document.
+        
+        Returns:
+            str
+        """
+
+        return self.get_feed_result_document(feedDocumentId)
+
+    @sp_endpoint("/feeds/2021-06-30/documents/{}", method="GET")
+    def get_feed_result_document(self, feedDocumentId, **kwargs) -> str:
+        """
+        get_feed_result_document(self, feedDocumentId, **kwargs) -> str
+        
+        Returns the information required for retrieving a feed document's contents.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0222                                  10
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FeedsV20210630().get_feed_result_document("value")
+        
+        Args:
+            feedDocumentId: object | required The identifier of the feed document.
+        
+        Returns:
+            str
+        """
+        response = self._request(
+            fill_query_params(kwargs.pop("path"), feedDocumentId),
+            params=kwargs,
+            add_marketplace=False,
+        )
+        url = response.payload.get("url")
+        with httpx.Client() as client:
+            doc_response = client.get(url)
+
+        encoding = (
+            doc_response.encoding
+            if doc_response and doc_response.encoding
+            else "iso-8859-1"
+        )
+        if encoding.lower() == "windows-31j":
+            encoding = "cp932"
+
+        content = doc_response.content
+        if "compressionAlgorithm" in response.payload:
+            try:
+                return zlib.decompress(bytearray(content), 15 + 32).decode(encoding)
+            except Exception:
+                return content.decode(encoding)
+        return content.decode(encoding)

sp_api/api/finances/finances.py

@@ -1,99 +1,132 @@
+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 .finances_2024_06_01 import FinancesV20240601
+from .finances_2024_06_19 import FinancesV20240619
+from .finances_v0 import FinancesV0
 
-from sp_api.base import Client, Marketplaces, ApiResponse
-from sp_api.base import sp_endpoint, fill_query_params
 
 class FinancesVersion(str, enum.Enum):
     V_0 = "v0"
+    V_2024_06_01 = "2024-06-01"
     V_2024_06_19 = "2024-06-19"
     LATEST = "2024-06-19"
 
 
-class Finances(Client):
-    version: FinancesVersion = FinancesVersion.V_0
-
-    def __init__(self, *args, **kwargs):
-        if "version" in kwargs:
-            self.version = kwargs.get("version", FinancesVersion.V_0)
-        super().__init__(*args, **{**kwargs, "version": self.version})
-
-    @sp_endpoint("/finances/<version>/orders/{}/financialEvents")
-    def get_financial_events_for_order(self, order_id, **kwargs) -> ApiResponse:
-        """
-        get_financial_events_for_order(self, order_id, **kwargs) -> ApiResponse
-
-        Examples:
-            literal blocks::
-
-                Finances().get_financial_events_for_order('485-734-5434857', MaxResultsPerPage=10)
-
-        Args:
-            order_id:
-            **kwargs:
-
-        Returns:
-
-        """
-        return self._request(
-            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
-        )
-
-    @sp_endpoint("/finances/<version>/financialEvents")
-    def list_financial_events(self, **kwargs) -> ApiResponse:
-        """
-        list_financial_events(self, **kwargs) -> ApiResponse:
-
-
-        Args:
-            **kwargs:
-
-        Returns:
-
-        """
-        return self._request(fill_query_params(kwargs.pop("path")), params={**kwargs})
-
-    @sp_endpoint("/finances/<version>/financialEventGroups/{}/financialEvents")
-    def list_financial_events_by_group_id(
-        self, event_group_id, **kwargs
-    ) -> ApiResponse:
-        """
-        list_financial_events_by_groupid(self, event_group_id,  **kwargs) -> ApiResponse:
-
-
-        Args:
-            event_group_id
-            **kwargs:
-
-        Returns:
-
-        """
-        return self._request(
-            fill_query_params(kwargs.pop("path"), event_group_id), params={**kwargs}
-        )
-
-    @sp_endpoint("/finances/<version>/financialEventGroups")
-    def list_financial_event_groups(self, **kwargs) -> ApiResponse:
-        """
-        list_financial_event_groups(self, **kwargs) -> ApiResponse:
-
-
-        Args:
-            **kwargs:
-
-        Returns:
-
-        """
-        return self._request(kwargs.pop("path"), params={**kwargs})
-
-    @sp_endpoint("/finances/<version>/transactions")
-    def list_transactions(self, **kwargs) -> ApiResponse:
-        """
-        list_transactions(self, **kwargs) -> ApiResponse:
-
-        Args:
-            **kwargs:
-
-        Returns: ApiResponse
-        """
-
-        return self._request(kwargs.pop("path"), params={**kwargs})
+if TYPE_CHECKING:
+
+    class _FinancesMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_2024_06_19, FinancesVersion.LATEST, "2024-06-19"],
+            **kwargs: Any,
+        ) -> FinancesV20240619: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_2024_06_01, "2024-06-01"],
+            **kwargs: Any,
+        ) -> FinancesV20240601: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_0, "v0"],
+            **kwargs: Any,
+        ) -> FinancesV0: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> FinancesV0: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | FinancesVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _FinancesMeta = VersionedClientMeta
+
+
+class Finances(Client, metaclass=_FinancesMeta):
+    """Finances API client.
+
+    This class dispatches to a versioned Finances API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("v0").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_2024_06_19, FinancesVersion.LATEST, "2024-06-19"],
+            **kwargs: Any,
+        ) -> FinancesV20240619: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_2024_06_01, "2024-06-01"],
+            **kwargs: Any,
+        ) -> FinancesV20240601: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[FinancesVersion.V_0, "v0"],
+            **kwargs: Any,
+        ) -> FinancesV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> FinancesV0: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | FinancesVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "v0"
+
+    _VERSION_MAP = {
+        "v0": FinancesV0,
+        "2024-06-01": FinancesV20240601,
+        "2024-06-19": FinancesV20240619,
+    }
+
+    _VERSION_ALIASES = {
+        "v0": "v0",
+        "2024-06-01": "2024-06-01",
+        "2024-06-19": "2024-06-19",
+    }

sp_api/api/finances/finances_2024_06_01.py

@@ -0,0 +1,71 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class FinancesV20240601(Client):
+    """
+    Finances Transfers SP-API Client
+    :link:
+
+    The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
+    """
+
+    @sp_endpoint("/finances/transfers/2024-06-01/payouts", method="POST")
+    def initiate_payout(self, **kwargs) -> ApiResponse:
+        """
+        initiate_payout(self, **kwargs) -> ApiResponse
+        
+        Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.017                                   2
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FinancesV20240601().initiate_payout()
+        
+        Args:
+            body: InitiatePayoutRequest | required The request body for the `initiatePayout` operation.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), data=kwargs, add_marketplace=False)
+
+    @sp_endpoint("/finances/transfers/2024-06-01/paymentMethods", method="GET")
+    def get_payment_methods(self, **kwargs) -> ApiResponse:
+        """
+        get_payment_methods(self, **kwargs) -> ApiResponse
+        
+        Returns the list of payment methods for the seller, which can be filtered by method type.
+        
+        **Usage Plan:**
+        
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .5                                      30
+        ======================================  ==============
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                FinancesV20240601().get_payment_methods()
+        
+        Args:
+            key marketplaceId: object | required The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+            key paymentMethodTypes: object |  A comma-separated list of the payment method types you want to include in the response.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)