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

sp_api/api/messaging/messaging.py

@@ -6,12 +6,12 @@ from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
 class Messaging(Client):
     """
     Messaging SP-API Client
-    :link: 
+    :link:
 
     With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.
     """
 
-    @sp_endpoint('/messaging/v1/orders/{}', method='GET')
+    @sp_endpoint("/messaging/v1/orders/{}", method="GET")
     def get_messaging_actions_for_order(self, order_id, **kwargs) -> ApiResponse:
         """
         get_messaging_actions_for_order(self, order_id, **kwargs) -> ApiResponse
@@ -36,9 +36,13 @@ class Messaging(Client):
             ApiResponse:
         """
 
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params=kwargs)
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params=kwargs
+        )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/confirmCustomizationDetails', method='POST')
+    @sp_endpoint(
+        "/messaging/v1/orders/{}/messages/confirmCustomizationDetails", method="POST"
+    )
     def confirm_customization_details(self, order_id, **kwargs) -> ApiResponse:
         """
         confirm_customization_details(self, order_id, **kwargs) -> ApiResponse
@@ -72,10 +76,17 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/confirmDeliveryDetails', method='POST')
+    @sp_endpoint(
+        "/messaging/v1/orders/{}/messages/confirmDeliveryDetails", method="POST"
+    )
     def create_confirm_delivery_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_delivery_details(self, order_id, **kwargs) -> ApiResponse
@@ -104,10 +115,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/legalDisclosure', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/legalDisclosure", method="POST")
     def create_legal_disclosure(self, order_id, **kwargs) -> ApiResponse:
         """
         create_legal_disclosure(self, order_id, **kwargs) -> ApiResponse
@@ -141,10 +157,17 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/negativeFeedbackRemoval', method='POST')
+    @sp_endpoint(
+        "/messaging/v1/orders/{}/messages/negativeFeedbackRemoval", method="POST"
+    )
     def create_negative_feedback_removal(self, order_id, **kwargs) -> ApiResponse:
         """
         create_negative_feedback_removal(self, order_id, **kwargs) -> ApiResponse
@@ -169,10 +192,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/confirmOrderDetails', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/confirmOrderDetails", method="POST")
     def create_confirm_order_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_order_details(self, order_id, **kwargs) -> ApiResponse
@@ -200,10 +228,17 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/confirmServiceDetails', method='POST')
+    @sp_endpoint(
+        "/messaging/v1/orders/{}/messages/confirmServiceDetails", method="POST"
+    )
     def create_confirm_service_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_service_details(self, order_id, **kwargs) -> ApiResponse
@@ -232,10 +267,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/amazonMotors', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/amazonMotors", method="POST")
     def create_amazon_motors(self, order_id, **kwargs) -> ApiResponse:
         """
         create_amazon_motors(self, order_id, **kwargs) -> ApiResponse
@@ -269,10 +309,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/warranty', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/warranty", method="POST")
     def create_warranty(self, order_id, **kwargs) -> ApiResponse:
         """
         create_warranty(self, order_id, **kwargs) -> ApiResponse
@@ -309,10 +354,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/attributes', method='GET')
+    @sp_endpoint("/messaging/v1/orders/{}/attributes", method="GET")
     def get_attributes(self, order_id, **kwargs) -> ApiResponse:
         """
         get_attributes(self, order_id, **kwargs) -> ApiResponse
@@ -334,9 +384,11 @@ class Messaging(Client):
             ApiResponse:
         """
 
-        return self._request(fill_query_params(kwargs.pop('path'), order_id), params=kwargs)
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id), params=kwargs
+        )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/digitalAccessKey', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/digitalAccessKey", method="POST")
     def create_digital_access_key(self, order_id, **kwargs) -> ApiResponse:
         """
         create_digital_access_key(self, order_id, **kwargs) -> ApiResponse
@@ -371,10 +423,15 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )
 
-    @sp_endpoint('/messaging/v1/orders/{}/messages/unexpectedProblem', method='POST')
+    @sp_endpoint("/messaging/v1/orders/{}/messages/unexpectedProblem", method="POST")
     def create_unexpected_problem(self, order_id, **kwargs) -> ApiResponse:
         """
         create_unexpected_problem(self, order_id, **kwargs) -> ApiResponse
@@ -402,5 +459,52 @@ class Messaging(Client):
         """
 
         return self._request(
-            fill_query_params(kwargs.pop('path'), order_id), data=kwargs.pop("body"), params={"marketplaceIds": self.marketplace_id, "method": kwargs.pop('method')}
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
+        )
+
+    @sp_endpoint("/messaging/v1/orders/{}/messages/invoice", method="POST")
+    def send_invoice(self, order_id, **kwargs) -> ApiResponse:
+        """
+        send_invoice(self, order_id, **kwargs) -> ApiResponse
+
+        Sends a message providing the buyer an invoice
+
+        **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:
+            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
+            body: {
+              "attachments": [
+                {
+                  "uploadDestinationId": "string",
+                  "fileName": "string"
+                }
+              ]
+            }
+
+
+        Returns:
+            ApiResponse:
+        """
+
+        return self._request(
+            fill_query_params(kwargs.pop("path"), order_id),
+            data=kwargs.pop("body"),
+            params={
+                "marketplaceIds": self.marketplace_id,
+                "method": kwargs.pop("method"),
+            },
         )

sp_api/api/notifications/notifications.py

@@ -6,16 +6,21 @@ class Notifications(Client):
     """
     :link: https://github.com/amzn/selling-partner-api-docs/blob/main/references/notifications-api/notifications.md
     """
-    grantless_scope = 'sellingpartnerapi::notifications'
+
+    grantless_scope = "sellingpartnerapi::notifications"
 
     @deprecated
     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')
-    def create_subscription(self, notification_type: NotificationType or str, destination_id: str = None,
-                            **kwargs) -> ApiResponse:
+    @sp_endpoint("/notifications/v1/subscriptions/{}", method="POST")
+    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.
@@ -47,16 +52,25 @@ class Notifications(Client):
 
         """
         data = {
-            'destinationId': kwargs.pop('destinationId', destination_id),
-            'payloadVersion': kwargs.pop('payload_version', '1.0')
+            "destinationId": kwargs.pop("destinationId", destination_id),
+            "payloadVersion": kwargs.pop("payload_version", "1.0"),
         }
-        return 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/{}')
-    def get_subscription(self, notification_type: NotificationType or str, **kwargs) -> ApiResponse:
+        return 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/{}")
+    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.
@@ -84,13 +98,22 @@ class Notifications(Client):
             ApiResponse:
 
         """
-        return 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')
-    def delete_notification_subscription(self, notification_type: NotificationType or str, subscription_id: str,
-                                         **kwargs) -> ApiResponse:
+        return 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")
+    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.
@@ -119,13 +142,27 @@ class Notifications(Client):
 
         """
         return 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')
-    def create_destination(self, name: str, arn: str = None, account_id: str = None, region: str = None, **kwargs) -> ApiResponse:
+            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")
+    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.
@@ -154,24 +191,25 @@ class Notifications(Client):
             ApiResponse:
 
         """
-        resource_name = 'sqs' if not account_id else 'eventBridge'
+        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
-                }
+            "resourceSpecification": {
+                resource_name: (
+                    {"arn": arn}
+                    if not account_id
+                    else {"region": region, "accountId": account_id}
+                )
             },
-            'name': name,
+            "name": name,
         }
 
-        return self._request_grantless_operation(kwargs.pop('path'), data={**kwargs, **data})
+        return self._request_grantless_operation(
+            kwargs.pop("path"), data={**kwargs, **data}
+        )
 
-    @sp_endpoint('/notifications/v1/destinations', method='GET')
+    @sp_endpoint("/notifications/v1/destinations", method="GET")
     def get_destinations(self, **kwargs) -> ApiResponse:
         """
         get_destinations(self, **kwargs) -> ApiResponse
@@ -195,9 +233,9 @@ class Notifications(Client):
             ApiResponse:
 
         """
-        return self._request_grantless_operation(kwargs.pop('path'), params={**kwargs})
+        return self._request_grantless_operation(kwargs.pop("path"), params={**kwargs})
 
-    @sp_endpoint('/notifications/v1/destinations/{}', method='GET')
+    @sp_endpoint("/notifications/v1/destinations/{}", method="GET")
     def get_destination(self, destination_id: str, **kwargs) -> ApiResponse:
         """
         get_destination(self, destination_id: str, **kwargs) -> ApiResponse
@@ -223,10 +261,11 @@ class Notifications(Client):
 
 
         """
-        return self._request_grantless_operation(fill_query_params(kwargs.pop('path'), destination_id),
-                                                 params={**kwargs})
+        return self._request_grantless_operation(
+            fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
+        )
 
-    @sp_endpoint('/notifications/v1/destinations/{}', method='DELETE')
+    @sp_endpoint("/notifications/v1/destinations/{}", method="DELETE")
     def delete_destination(self, destination_id: str, **kwargs) -> ApiResponse:
         """
         delete_destination(self, destination_id: str, **kwargs) -> ApiResponse
@@ -250,5 +289,6 @@ class Notifications(Client):
             ApiResponse:
 
         """
-        return self._request_grantless_operation(fill_query_params(kwargs.pop('path'), destination_id),
-                                                 params={**kwargs})
+        return self._request_grantless_operation(
+            fill_query_params(kwargs.pop("path"), destination_id), params={**kwargs}
+        )