python-amazon-sp-api 1.9.34__py3-none-any.whl → 2.0.7__py3-none-any.whl

sp_api/asyncio/api/notifications/notifications.py

@@ -0,0 +1,295 @@
+from sp_api.base.helpers import sp_endpoint, fill_query_params
+from sp_api.base import Client, Marketplaces, deprecated, NotificationType, ApiResponse
+from sp_api.asyncio.base import AsyncBaseClient
+
+
+class Notifications(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/notifications-api/notifications.md
+    """
+
+    grantless_scope = "sellingpartnerapi::notifications"
+
+    @deprecated
+    async def add_subscription(self, notification_type: NotificationType or str, **kwargs):
+        """deprecated, use create_subscription"""
+        return self.create_subscription(notification_type, **kwargs)
+
+    @sp_endpoint("/notifications/v1/subscriptions/{}", method="POST")
+    async def create_subscription(
+        self,
+        notification_type: NotificationType or str,
+        destination_id: str = None,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        create_subscription(self, notification_type: NotificationType or str, destination_id: str = None, **kwargs) -> ApiResponse
+        Creates a subscription for the specified notification type to be delivered to the specified destination.
+        Before you can subscribe, you must first create the destination by calling the createDestination operation.
+
+        **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::
+
+                Notifications().create_subscription(NotificationType.MFN_ORDER_STATUS_CHANGE, destination_id='dest_id')
+
+        Args:
+            notification_type: NotificationType or str
+            destination_id: str
+            **kwargs:
+
+
+        Returns:
+            ApiResponse:
+
+        """
+        data = {
+            "destinationId": kwargs.pop("destinationId", destination_id),
+            "payloadVersion": kwargs.pop("payload_version", "1.0"),
+        }
+        return await self._request(
+            fill_query_params(
+                kwargs.pop("path"),
+                (
+                    notification_type
+                    if isinstance(notification_type, str)
+                    else notification_type.value
+                ),
+            ),
+            data={**kwargs, **data},
+        )
+
+    @sp_endpoint("/notifications/v1/subscriptions/{}")
+    async def get_subscription(
+        self, notification_type: NotificationType or str, **kwargs
+    ) -> ApiResponse:
+        """
+        get_subscription(self, notification_type: NotificationType or str, **kwargs) -> ApiResponse
+        Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier.
+
+        **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::
+
+                Notifications().get_subscription(NotificationType.REPORT_PROCESSING_FINISHED)
+
+        Args:
+            notification_type: NotificationType or str
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        return await self._request(
+            fill_query_params(
+                kwargs.pop("path"),
+                (
+                    notification_type
+                    if isinstance(notification_type, str)
+                    else notification_type.value
+                ),
+            ),
+            params={**kwargs},
+        )
+
+    @sp_endpoint("/notifications/v1/subscriptions/{}/{}", method="DELETE")
+    async def delete_notification_subscription(
+        self, notification_type: NotificationType or str, subscription_id: str, **kwargs
+    ) -> ApiResponse:
+        """
+        delete_notification_subscription(self, notification_type: NotificationType or str, subscription_id: str, **kwargs) -> ApiResponse
+        Deletes the subscription indicated by the subscription identifier and notification type that you specify.
+        The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
+
+        **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:
+            Notifications().delete_notification_subscription(NotificationType.MFN_ORDER_STATUS_CHANGE, 'subscription_id')
+
+        Args:
+            notification_type: NotificationType or str
+            subscription_id: str
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        return await self._request(
+            fill_query_params(
+                kwargs.pop("path"),
+                (
+                    notification_type
+                    if isinstance(notification_type, str)
+                    else notification_type.value
+                ),
+                subscription_id,
+            ),
+            params={**kwargs},
+        )
+
+    @sp_endpoint(path="/notifications/v1/destinations", method="POST")
+    async def create_destination(
+        self,
+        name: str,
+        arn: str = None,
+        account_id: str = None,
+        region: str = None,
+        **kwargs
+    ) -> ApiResponse:
+        """
+        create_destination(self, name: str, arn: str, **kwargs) -> ApiResponse
+        Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        Examples:
+            literal blocks::
+
+                Notifications().create_destination(name='test', arn='arn:aws:sqs:us-east-2:444455556666:queue1')
+
+        Args:
+            account_id:
+            region:
+            name: str
+            arn: str
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        resource_name = "sqs" if not account_id else "eventBridge"
+        region = region if region else self.region
+
+        data = {
+            "resourceSpecification": {
+                resource_name: (
+                    {"arn": arn}
+                    if not account_id
+                    else {"region": region, "accountId": account_id}
+                )
+            },
+            "name": name,
+        }
+
+        return await self._request_grantless_operation(
+            kwargs.pop("path"), data={**kwargs, **data}
+        )
+
+    @sp_endpoint("/notifications/v1/destinations", method="GET")
+    async def get_destinations(self, **kwargs) -> ApiResponse:
+        """
+        get_destinations(self, **kwargs) -> ApiResponse
+        Returns information about all destinations. The getDestinations API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        return await self._request_grantless_operation(kwargs.pop("path"), params={**kwargs})
+
+    @sp_endpoint("/notifications/v1/destinations/{}", method="GET")
+    async def get_destination(self, destination_id: str, **kwargs) -> ApiResponse:
+        """
+        get_destination(self, destination_id: str, **kwargs) -> ApiResponse
+        Returns information about all destinations. The getDestinations API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+
+        Args:
+            destination_id: str
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+
+        """
+        return await self._request_grantless_operation(
+            fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
+        )
+
+    @sp_endpoint("/notifications/v1/destinations/{}", method="DELETE")
+    async def delete_destination(self, destination_id: str, **kwargs) -> ApiResponse:
+        """
+        delete_destination(self, destination_id: str, **kwargs) -> ApiResponse
+        Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       5
+        ======================================  ==============
+
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+
+        Args:
+            destination_id: str
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        return await self._request_grantless_operation(
+            fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
+        )

sp_api/asyncio/api/orders/orders.py

@@ -0,0 +1,362 @@
+from sp_api.base import sp_endpoint, fill_query_params, ApiResponse, deprecated
+from sp_api.asyncio.base import AsyncBaseClient
+from sp_api.util import normalize_csv_param
+
+
+class Orders(AsyncBaseClient):
+    """
+    :link: https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api
+    """
+
+    @sp_endpoint("/orders/v0/orders")
+    async def get_orders(self, **kwargs) -> ApiResponse:
+        """
+        get_orders(self, **kwargs) -> ApiResponse
+        Returns orders created or updated during the time frame indicated by the specified parameters.
+        You can also apply a range of filtering criteria to narrow the list of orders returned.
+        If NextToken is present, that will be used to retrieve the orders instead of other criteria.
+
+        **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::
+
+                Orders().get_orders(CreatedAfter='TEST_CASE_200', MarketplaceIds=["ATVPDKIKX0DER"])
+
+        Args:
+            key CreatedAfter: date
+            key CreatedBefore: date
+            key LastUpdatedAfter: date
+            key LastUpdatedBefore: date
+            key OrderStatuses: [str]
+            key MarketplaceIds: [str]
+            key FulfillmentChannels: [str]
+            key PaymentMethods: [str]
+            key BuyerEmail: str
+            key SellerOrderId: str
+            key MaxResultsPerPage: int
+            key EasyShipShipmentStatuses: [str]
+            key NextToken: str
+            key AmazonOrderIds: [str]
+            key RestrictedResources: [str]
+
+        Returns:
+            ApiResponse:
+
+
+        """
+        normalize_csv_param(kwargs, "OrderStatuses")
+        normalize_csv_param(kwargs, "MarketplaceIds")
+        normalize_csv_param(kwargs, "FulfillmentChannels")
+        normalize_csv_param(kwargs, "PaymentMethods")
+        normalize_csv_param(kwargs, "AmazonOrderIds")
+
+        if "RestrictedResources" in kwargs:
+            return self._access_restricted(kwargs)
+        return await self._request(kwargs.pop("path"), params={**kwargs})
+
+    @sp_endpoint("/orders/v0/orders/{}")
+    async def get_order(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        get_order(self, order_id: str, **kwargs) -> ApiResponse
+        Returns the order indicated by the specified order ID.
+
+        **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::
+
+                Orders().get_order('TEST_CASE_200')
+
+        Args:
+            order_id: str
+            key RestrictedResources: [str]
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+
+        """
+        if "RestrictedResources" in kwargs:
+            kwargs.update(
+                {"original_path": fill_query_params(kwargs.get("path"), order_id)}
+            )
+            return self._access_restricted(kwargs)
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            params={**kwargs},
+            add_marketplace=False,
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/orderItems")
+    async def get_order_items(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        get_order_items(self, order_id: str, **kwargs) -> ApiResponse
+
+        Returns detailed order item information for the order indicated by the specified order ID.
+        If NextToken is provided, it's used to retrieve the next page of order items.
+
+        Note: When an order is in the Pending state (the order has been placed but payment has not been authorized),
+        the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or
+        promotions for the order items in the order.
+        After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped,
+        Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes,
+        shipping charges, gift status and promotions for the order items in the order.
+
+
+        **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::
+
+                Orders().get_order_items('TEST_CASE_200')
+
+        Args:
+            order_id: str
+            key RestrictedResources: [str]
+            **kwargs:
+
+        Returns:
+            ApiResponse:
+
+        """
+        if "RestrictedResources" in kwargs:
+            kwargs.update(
+                {"original_path": fill_query_params(kwargs.get("path"), order_id)}
+            )
+            return self._access_restricted(kwargs)
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/address")
+    async def get_order_address(self, order_id, **kwargs) -> ApiResponse:
+        """
+        get_order_address(self, order_id, **kwargs) -> ApiResponse
+
+        Returns the shipping address for the order indicated by the specified order ID.
+
+        :note: To get useful information from this method, you need to have access to PII.
+
+        **Usage Plan:**
+
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        1                                       1
+        ======================================  ==============
+
+        Examples:
+            Orders().get_order_address('TEST_CASE_200')
+
+        Args:
+            order_id: str
+            **kwargs:
+
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/buyerInfo")
+    async def get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        get_order_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
+        Returns buyer information for the order indicated by the specified order ID.
+
+        :note: To get useful information from this method, you need to have access to PII.
+
+
+        **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:
+            Orders().get_order_buyer_info('TEST_CASE_200')
+
+        Args:
+            order_id: str
+            **kwargs:
+
+        Returns:
+            GetOrderBuyerInfoResponse:
+
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params={**kwargs}
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/orderItems/buyerInfo")
+    async def get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        get_order_items_buyer_info(self, order_id: str, **kwargs) -> ApiResponse
+
+        Returns buyer information in the order items of the order indicated by the specified order ID.
+
+        **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::
+
+                Orders().get_order_items_buyer_info('TEST_CASE_200')
+
+        Args:
+            order_id: str
+            key NextToken: str | retrieve data by next token
+
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params=kwargs
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/shipment", method="POST")
+    async def update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        update_shipment_status(self, order_id: str, **kwargs) -> ApiResponse
+        Update the shipment status.
+        **Usage Plan:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        5                                       15
+        ======================================  ==============
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        Examples:
+            literal blocks::
+                Orders().update_shipment_status(
+                    order_id='123-1234567-1234567',
+                    marketplaceId='ATVPDKIKX0DER',
+                    shipmentStatus='ReadyForPickup'
+                )
+        Args:
+            order_id: str
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            res_no_data=True,
+            data=kwargs,
+        )
+
+    @sp_endpoint("/orders/v0/orders/{}/shipmentConfirmation", method="POST")
+    async def confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse:
+        """
+        confirm_shipment(self, order_id: str, **kwargs) -> ApiResponse
+        Updates the shipment confirmation status for a specified order.
+        **Usage Plan:**
+        ======================================  ==============
+        Rate (requests per second)               Burst
+        ======================================  ==============
+        2                                       10
+        ======================================  ==============
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        Examples:
+            literal blocks::
+                Orders().confirm_shipment(
+                    order_id='123-1234567-1234567',
+                    marketplaceId='ATVPDKIKX0DER',
+                    packageDetail={
+                        'packageReferenceId': '0001',
+                        'carrierCode': 'DHL',
+                        "shippingMethod": 'Paket',
+                        'trackingNumber': '1234567890',
+                        'shipDate': '2023-03-19T12:00:00Z',
+                        'orderItems': [
+                            {
+                                'orderItemId': '123456789',
+                                'quantity': 1
+                            },
+                            {
+                                'orderItemId': '2345678901',
+                                'quantity': 2
+                            },
+                        ]
+                    }
+                )
+        Args:
+            order_id: str
+        Returns:
+            ApiResponse
+        """
+        return await self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            add_marketplace=False,
+            res_no_data=True,
+            data=kwargs,
+        )
+
+    @sp_endpoint("/tokens/2021-03-01/restrictedDataToken", method="POST")
+    async def _get_token(self, **kwargs):
+        data_elements = kwargs.pop("RestrictedResources")
+
+        restricted_resources = [
+            {
+                "method": "GET",
+                "path": kwargs.get("original_path"),
+                "dataElements": data_elements,
+            }
+        ]
+
+        return await self._request(
+            kwargs.pop("path"),
+            data={"restrictedResources": restricted_resources, **kwargs},
+        )
+
+    async def _access_restricted(self, kwargs):
+        if "original_path" not in kwargs:
+            kwargs.update({"original_path": kwargs["path"]})
+        token = self._get_token(**kwargs).payload
+        self.restricted_data_token = token["restrictedDataToken"]
+        r = await self._request(kwargs.pop("original_path"), params={**kwargs})
+        if not self.keep_restricted_data_token:
+            self.restricted_data_token = None
+        return r

sp_api/asyncio/api/overrides/__init__.py

@@ -0,0 +1 @@
+