python-amazon-sp-api 1.9.39__py3-none-any.whl → 2.0.10__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}
+        )