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

sp_api/asyncio/api/messaging/messaging.py

@@ -16,25 +16,30 @@ class Messaging(AsyncBaseClient):
     async def get_messaging_actions_for_order(self, order_id, **kwargs) -> ApiResponse:
         """
         get_messaging_actions_for_order(self, order_id, **kwargs) -> ApiResponse
-
+        
         Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message.
-
+        
         **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::
+            
+                await Messaging().get_messaging_actions_for_order("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which you want a list of available message types.
-            key marketplaceIds:array | * REQUIRED A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
-
+            amazonOrderId: object | required An Amazon order identifier. This specifies the order for which you want a list of available message types.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -47,33 +52,31 @@ class Messaging(AsyncBaseClient):
     async def confirm_customization_details(self, order_id, **kwargs) -> ApiResponse:
         """
         confirm_customization_details(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc.
-
+        
         **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::
+            
+                await Messaging().confirm_customization_details("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body: {
-              "text": "string",
-              "attachments": [
-                {
-                  "uploadDestinationId": "string",
-                  "fileName": "string"
-                }
-              ]
-            }
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateConfirmCustomizationDetailsRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -91,28 +94,31 @@ class Messaging(AsyncBaseClient):
     async def create_confirm_delivery_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_delivery_details(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery.
-
+        
         **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::
+            
+                await Messaging().create_confirm_delivery_details("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body: {
-              "text": "string"
-            }
-
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateConfirmDeliveryDetailsRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -128,33 +134,31 @@ class Messaging(AsyncBaseClient):
     async def create_legal_disclosure(self, order_id, **kwargs) -> ApiResponse:
         """
         create_legal_disclosure(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law.
-
+        
         **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::
+            
+                await Messaging().create_legal_disclosure("value")
+        
         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"
-                }
-              ]
-            }
-
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateLegalDisclosureRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -172,24 +176,20 @@ class Messaging(AsyncBaseClient):
     async def create_negative_feedback_removal(self, order_id, **kwargs) -> ApiResponse:
         """
         create_negative_feedback_removal(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer's problem.
-
-        **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::
+            
+                await Messaging().create_negative_feedback_removal("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-
+            order_id:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -205,27 +205,31 @@ class Messaging(AsyncBaseClient):
     async def create_confirm_order_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_order_details(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message to ask a buyer an order-related question prior to shipping their order.
-
+        
         **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::
+            
+                await Messaging().create_confirm_order_details("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body:{
-              "text": "string"
-            }
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateConfirmOrderDetailsRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -243,28 +247,31 @@ class Messaging(AsyncBaseClient):
     async def create_confirm_service_details(self, order_id, **kwargs) -> ApiResponse:
         """
         create_confirm_service_details(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call.
-
+        
         **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::
+            
+                await Messaging().create_confirm_service_details("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body: {
-              "text": "string"
-            }
-
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateConfirmServiceDetailsRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -280,33 +287,20 @@ class Messaging(AsyncBaseClient):
     async def create_amazon_motors(self, order_id, **kwargs) -> ApiResponse:
         """
         create_amazon_motors(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers.
-
-        **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::
+            
+                await Messaging().create_amazon_motors("value")
+        
         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"
-                }
-              ]
-            }
-
-
+            order_id:  | required
+            **kwargs:
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -322,36 +316,31 @@ class Messaging(AsyncBaseClient):
     async def create_warranty(self, order_id, **kwargs) -> ApiResponse:
         """
         create_warranty(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a message to a buyer to provide details about warranty information on a purchase in their order.
-
+        
         **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::
+            
+                await Messaging().create_warranty("value")
+        
         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"
-                }
-              ],
-              "coverageStartDate": "2019-08-24T14:15:22Z",
-              "coverageEndDate": "2019-08-24T14:15:22Z"
-            }
-
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateWarrantyRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -367,22 +356,30 @@ class Messaging(AsyncBaseClient):
     async def get_attributes(self, order_id, **kwargs) -> ApiResponse:
         """
         get_attributes(self, order_id, **kwargs) -> ApiResponse
-
+        
         Returns a response containing attributes related to an order. This includes buyer preferences.
-
+        
         **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::
+            
+                await Messaging().get_attributes("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -393,34 +390,31 @@ class Messaging(AsyncBaseClient):
     async def create_digital_access_key(self, order_id, **kwargs) -> ApiResponse:
         """
         create_digital_access_key(self, order_id, **kwargs) -> ApiResponse
-
-        Sends a message to a buyer to share a digital access key needed to utilize digital content in their order.
-
+        
+        Sends a buyer a message to share a digital access key that is required to utilize digital content in their order.
+        
         **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::
+            
+                await Messaging().create_digital_access_key("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body: {
-              "text": "string",
-              "attachments": [
-                {
-                  "uploadDestinationId": "string",
-                  "fileName": "string"
-                }
-              ]
-            }
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateDigitalAccessKeyRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -436,27 +430,31 @@ class Messaging(AsyncBaseClient):
     async def create_unexpected_problem(self, order_id, **kwargs) -> ApiResponse:
         """
         create_unexpected_problem(self, order_id, **kwargs) -> ApiResponse
-
+        
         Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order.
-
+        
         **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::
+            
+                await Messaging().create_unexpected_problem("value")
+        
         Args:
-            order_id:string | * REQUIRED An Amazon order identifier. This specifies the order for which a message is sent.
-            body: {
-              "text": "string"
-            }
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: CreateUnexpectedProblemRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -472,33 +470,21 @@ class Messaging(AsyncBaseClient):
     async 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.
-
+        
+        Examples:
+            literal blocks::
+            
+                await Messaging().send_invoice("value")
+        
         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"
-                }
-              ]
-            }
-
-
+            amazonOrderId: object | required An Amazon order identifier. This identifies the order for which a message is sent.
+            key marketplaceIds: object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.
+            body: InvoiceRequest | required This contains the message body for a message.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return await self._request(
@@ -508,4 +494,4 @@ class Messaging(AsyncBaseClient):
                 "marketplaceIds": self.marketplace_id,
                 "method": kwargs.pop("method"),
             },
-        )
+        )