python-amazon-sp-api 1.9.39__py3-none-any.whl → 2.0.10__py3-none-any.whl

sp_api/asyncio/api/reports/reports.py

@@ -0,0 +1,439 @@
+from datetime import datetime
+from typing import Optional, Union
+
+from sp_api.base import (
+    Client,
+    sp_endpoint,
+    fill_query_params,
+    ApiResponse,
+    Marketplaces,
+)
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.util import (
+    normalize_csv_param,
+    normalize_datetime_kwargs,
+    normalize_marketplace_ids,
+    should_add_marketplace,
+)
+from sp_api.util.report_document import (
+    decode_document,
+    decompress_bytes,
+    handle_file,
+    resolve_character_code,
+    stream_to_file_async,
+)
+
+
+class Reports(AsyncBaseClient):
+    """
+    Reports SP-API Client
+    :link:
+
+    The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses.
+    """
+
+    @sp_endpoint("/reports/2021-06-30/reports", method="GET")
+    async def get_reports(self, **kwargs) -> ApiResponse:
+        """
+        get_reports(self, **kwargs) -> ApiResponse
+
+        Returns report details for the reports 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::
+
+                report_types = ["FEE_DISCOUNTS_REPORT", "GET_AFN_INVENTORY_DATA"]
+                processing_status = ["IN_QUEUE", "IN_PROGRESS"]
+                res = Reports().get_reports(reportTypes=report_types, processingStatuses=processing_status)
+
+        Args:
+            key reportTypes: str[] or ReportType[] | optional  A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.
+            key processingStatuses: str[] or ProcessingStatus[] optional	A list of processing statuses used to filter reports.
+            key marketplaceIds: str[] or Marketplaces[] optional	A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.
+            key pageSize: int optional	The maximum number of reports to return in a single call.
+            key createdSince: str or datetime optional	The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.	string (date-time)	-
+            key	createdUntil: str or datetime optional	The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.	string (date-time)	-
+            key nextToken: str optional	A stringget_report_document 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 getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.	string	-
+
+
+        Returns:
+            ApiResponse
+        """
+        normalize_csv_param(kwargs, "reportTypes")
+        normalize_csv_param(kwargs, "processingStatuses")
+        normalize_marketplace_ids(kwargs, marketplace_cls=Marketplaces)
+        normalize_datetime_kwargs(kwargs, ["createdSince", "createdUntil"])
+        add_marketplace = should_add_marketplace(kwargs, "nextToken")
+        return await self._request(
+            kwargs.pop("path"),
+            params=kwargs,
+            add_marketplace=add_marketplace,
+        )
+
+    @sp_endpoint("/reports/2021-06-30/reports", method="POST")
+    async def create_report(self, **kwargs) -> ApiResponse:
+        """
+        create_report(self, **kwargs) -> ApiResponse
+
+        See report types at
+        :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/reports-api/reporttype-values.md
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0167                                  15
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                res = Reports().create_report(
+                    reportType=ReportType.GET_MERCHANT_LISTINGS_ALL_DATA,
+                    dataStartTime='2019-12-10T20:11:24.000Z',
+                    marketplaceIds=[
+                        "A1PA6795UKMFR9",
+                        "ATVPDKIKX0DER"
+                    ])
+
+        Args:
+            key reportOptions: optional	Additional information passed to reports. This varies by report type.	ReportOptions
+            key reportType: required	The report type. :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/reports-api/reporttype-values.md
+            key dataStartTime: optional	The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.	string (date-time)
+            key dataEndTime: optional	The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.	string (date-time)
+            key marketplaceIds: optional, defaults to the client's marketplace  A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.	< string > array
+
+        Returns:
+            ApiResponse
+        """
+        normalize_datetime_kwargs(kwargs, ["dataStartTime", "dataEndTime"])
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/reports/2021-06-30/reports/{}", method="DELETE")
+    async def cancel_report(self, reportId, **kwargs) -> ApiResponse:
+        """
+        cancel_report(self, reportId, **kwargs) -> ApiResponse
+
+        Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0022                                  10
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            reportId:string | * REQUIRED The identifier for the report. This identifier is unique only in combination with a seller ID.
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), reportId), data=kwargs
+        )
+
+    @sp_endpoint("/reports/2021-06-30/reports/{}", method="GET")
+    async def get_report(self, reportId, **kwargs) -> ApiResponse:
+        """
+        get_report(self, report_id, **kwargs)
+        Returns report details (including the reportDocumentId, if available) for the report 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::
+
+                Reports().get_report('ID323')
+
+        Args:
+            reportId: str
+
+        Returns:
+            ApiResponse
+
+        """
+
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), reportId), params=kwargs
+        )
+
+    @sp_endpoint("/reports/2021-06-30/schedules", method="GET")
+    async def get_report_schedules(self, **kwargs) -> ApiResponse:
+        """
+        Returns report schedule details 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.
+
+        Args:
+            key reportTypes: str[] or ReportType[] | required  A list of report types used to filter report schedules. Min count : 1. Max count : 10.
+
+        Returns:
+            ApiResponse
+        """
+        normalize_csv_param(kwargs, "reportTypes")
+
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @sp_endpoint("/reports/2021-06-30/schedules", method="POST")
+    async def create_report_schedule(self, **kwargs) -> ApiResponse:
+        """
+        create_report_schedule(self, **kwargs) -> ApiResponse
+
+        Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0222                                  10
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Reports().create_report_schedule(reportType='FEE_DISCOUNTS_REPORT',
+                                           period=Schedules.MINUTES_5.value,
+                                           nextReportCreationTime="2019-12-10T20:11:24.000Z",
+                                           marketplaceIds=["A1PA6795UKMFR9", "ATVPDKIKX0DER"])
+
+        Args:
+            key reportType: str
+            key marketplaceIds: str
+            key reportOptions: dict
+            key period: Schedules
+            key nextReportCreationTime: str datetime isoformat
+
+        Returns:
+            ApiResponse:
+        """
+
+        return await self._request(kwargs.pop("path"), data=kwargs)
+
+    @sp_endpoint("/reports/2021-06-30/schedules/{}", method="DELETE")
+    async def cancel_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse:
+        """
+        cancel_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse
+
+        Cancels the report schedule 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::
+
+                Reports().cancel_report_schedule('ID')
+
+        Args:
+            reportScheduleId: str
+            kwargs:
+
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), reportScheduleId), data=kwargs
+        )
+
+    def delete_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse:
+        """
+        cancel_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse
+
+        Cancels the report schedule 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::
+
+                Reports().cancel_report_schedule('ID')
+
+        Args:
+            reportScheduleId: str
+            kwargs:
+
+        Returns:
+            ApiResponse
+        """
+        return self.cancel_report_schedule(reportScheduleId)
+
+    @sp_endpoint("/reports/2021-06-30/schedules/{}", method="GET")
+    async def get_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse:
+        """
+        get_report_schedule(self, reportScheduleId, **kwargs) -> ApiResponse
+
+        Returns report schedule details for the report schedule 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::
+
+                Reports().get_report_schedule('ID323')
+
+        Args:
+            reportScheduleId: str | required The identifier for the report schedule. This identifier is unique only in combination with a seller ID.
+            kwargs:
+
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), reportScheduleId), params=kwargs
+        )
+
+    @sp_endpoint("/reports/2021-06-30/documents/{}", method="GET")
+    async def get_report_document(
+        self,
+        reportDocumentId,
+        download: bool = False,
+        file=None,
+        character_code: Optional[str] = None,
+        stream: bool = False,
+        timeout: Optional[Union[float,int]] = None,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        get_report_document(self, document_id, decrypt: bool = False, file=None, character_code: Optional[str] = None, **kwargs) -> ApiResponse
+        Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents.
+
+        If decrypt = True the report will automatically be loaded and decrypted/unpacked
+        If file is set to a file (or file like object), the report's contents are written to the file
+
+
+        **Usage Plan:**
+
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        0.0167                                  15
+        ======================================  ==============
+
+
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Examples:
+            literal blocks::
+
+                Reports().get_report_document('0356cf79-b8b0-4226-b4b9-0ee058ea5760', download=True, file=file)
+
+        Args:
+            reportDocumentId: str | the document to load
+            download: bool | flag to automatically download a report
+            file: If passed, will save the document to the file specified.
+                  Only valid if decrypt=True
+            character_code: If passed, will be a file with the specified character code.
+                            The default is the Content-Encoding in the response while
+                            obtaining the document from the document URL.
+                            It fallbacks to 'iso-8859-1' if no encoding was found.
+                            Only valid if decrypt=True.
+            stream: bool | if True and file is provided, stream the document to disk
+            timeout: int | optional, the timeout for the request to download the document
+
+        Returns:
+             ApiResponse
+        """  # noqa: E501
+        res = await self._request(
+            fill_query_params(kwargs.pop("path"), reportDocumentId),
+            add_marketplace=False,
+        )
+        if download or file or ("decrypt" in kwargs and kwargs["decrypt"]):
+            compression_algorithm = res.payload.get("compressionAlgorithm")
+            if stream and file:
+                async with self._transport.stream(
+                    "GET",
+                    res.payload.get("url"),
+                    timeout=timeout,
+                ) as document_response:
+                    if not character_code:
+                        character_code = resolve_character_code(
+                            document_response.encoding, fallback="iso-8859-1"
+                        )
+                    await stream_to_file_async(
+                        document_response,
+                        file,
+                        character_code,
+                        compression_algorithm,
+                    )
+            else:
+                document_response = await self._transport.request(
+                    "GET",
+                    res.payload.get("url"),
+                    timeout=timeout,
+                )
+                if not character_code:
+                    character_code = resolve_character_code(
+                        document_response.encoding, fallback="iso-8859-1"
+                    )
+                document = decompress_bytes(
+                    document_response.content, compression_algorithm
+                )
+                decoded_document = decode_document(document, character_code)
+                if download:
+                    res.payload.update(
+                        {
+                            "document": decoded_document,
+                        }
+                    )
+                if file:
+                    handle_file(file, decoded_document, character_code)
+        return res

sp_api/asyncio/api/sales/sales.py

@@ -0,0 +1,93 @@
+import urllib
+from datetime import datetime
+
+from sp_api.base import Client, Marketplaces, sp_endpoint, Granularity, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+import logging
+from sp_api.util import encode_kwarg
+
+
+class Sales(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/sales-api/sales.md#parameters
+    """
+
+    @sp_endpoint("/sales/v1/orderMetrics")
+    async def get_order_metrics(
+        self,
+        interval: tuple,
+        granularity: Granularity,
+        granularityTimeZone: str = None,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        get_order_metrics(self, interval: tuple, granularity: Granularity, granularityTimeZone: str = None, **kwargs) -> ApiResponse
+
+        Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type.
+
+        **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::
+
+                from sp_api.api import Sales
+                from sp_api.base import Granularity
+
+                Sales().get_order_metrics(interval, Granularity.TOTAL, granularityTimeZone='US/Central')
+                Sales().get_order_metrics(interval, Granularity.DAY, granularityTimeZone='US/Central')
+                Sales().get_order_metrics(interval, Granularity.TOTAL, granularityTimeZone='US/Central', asin='B008OLKVEW')
+                Sales().get_order_metrics(interval, Granularity.DAY, granularityTimeZone='US/Central', asin='B008OLKVEW')
+
+
+        Args:
+            key marketplaceIds: [str]
+            interval: tuple | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive).  Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.	string	-       Query	granularityTimeZone
+            granularity: Granularity | The granularity of the grouping of order metrics, based on a unit of time.         Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now.         For all other granularities, the interval specified must be less or equal to 2 years from now.         Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify.         If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data.         Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone.	enum (Granularity)	-
+            key buyerType: BuyerType | Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer).         Example: B2B, if you want the response to include order metrics for only B2B buyers.         Default: enum (BuyerType)	"All"
+            key fulfillmentNetwork: str | Filters the results by the fulfillment network that you specify,         MFN (merchant fulfillment network) or AFN (Amazon fulfillment network).         Do not include this filter if you want the response to include order metrics for all fulfillment networks.         Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network.	string -
+            key firstDayOfWeek: str |         Specifies the day that the week starts on when granularity=Week, either Monday or Sunday.         Default: Monday.         Example: Sunday, if you want the week to start on a Sunday.	enum (FirstDayOfWeek)	"Monday"
+            key asin: str |         Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error.         Do not include this filter if you want the response to include order metrics for all ASINs.         Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.	string	-
+            key sku: str | Filters the results by the SKU that you specify.         Specifying both ASIN and SKU returns an error.         Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+            granularityTimeZone: str
+
+
+        Returns:
+            ApiResponse
+        """
+        kwargs.update(
+            {
+                "interval": "--".join(
+                    [self._create_datetime_stamp(_interval) for _interval in interval]
+                ),
+                "granularity": granularity.value,
+            }
+        )
+        if granularityTimeZone:
+            kwargs.update({"granularityTimeZone": granularityTimeZone})
+        encode_kwarg(kwargs, "sku", lambda value: urllib.parse.quote(value, safe=""))
+        return await self._request(kwargs.pop("path"), params=kwargs)
+
+    @staticmethod
+    def _create_datetime_stamp(datetime_obj: datetime or str):
+        """
+        Create datetimestring
+
+        Args:
+            datetime_obj:
+
+        Returns:
+
+        """
+        if isinstance(datetime_obj, str):
+            return datetime_obj
+        fmt = "%Y-%m-%dT%H:%M:%S%z"
+        return datetime_obj.astimezone().isoformat(timespec="seconds")

sp_api/asyncio/api/sellers/sellers.py

@@ -0,0 +1,70 @@
+from sp_api.base.helpers import sp_endpoint
+from sp_api.base import Client, Marketplaces, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Sellers(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/sellers-api/sellers.md
+
+    """
+
+    @sp_endpoint("/sellers/v1/marketplaceParticipations")
+    async def get_marketplace_participation(self, **kwargs) -> ApiResponse:
+        """
+        get_marketplace_participation(self, **kwargs) -> ApiResponse
+        Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .016                                    15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Examples:
+            literal blocks::
+
+                res = Sellers().get_marketplace_participation()
+
+        Args:
+            **kwargs:
+
+        Returns:
+            GetMarketplaceParticipationsResponse:
+
+        """
+        return await self._request(kwargs.pop("path"), add_marketplace=False)
+
+    @sp_endpoint("/sellers/v1/account")
+    async def get_account(self, **kwargs) -> ApiResponse:
+        """
+        get_account(self, **kwargs) -> ApiResponse
+        Returns information about a seller account and its marketplaces.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        .016                                    15
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Examples:
+            literal blocks::
+
+                res = Sellers().get_account()
+
+        Args:
+            **kwargs:
+
+        Returns:
+            GetAccountResponse:
+
+        """
+        return await self._request(kwargs.pop("path"), add_marketplace=False)