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

sp_api/api/solicitations/solicitations.py

@@ -17,25 +17,30 @@ class Solicitations(Client):
     ) -> ApiResponse:
         """
         get_solicitation_actions_for_order(self, amazonOrderId, **kwargs) -> ApiResponse
-
+        
         Returns a list of solicitation types that are available for an order that you specify. A solicitation 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 solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.
-
+        
         **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::
+            
+                Solicitations().get_solicitation_actions_for_order("value")
+        
         Args:
-            amazonOrderId:string | * REQUIRED An Amazon order identifier. This specifies the order for which you want a list of available solicitation 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 solicitation types.
+            key marketplaceIds: object | required A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -51,25 +56,30 @@ class Solicitations(Client):
     ) -> ApiResponse:
         """
         create_product_review_and_seller_feedback_solicitation(self, amazonOrderId, **kwargs) -> ApiResponse
-
+        
         Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per 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::
+            
+                Solicitations().create_product_review_and_seller_feedback_solicitation("value")
+        
         Args:
-            amazonOrderId:string | * REQUIRED An Amazon order identifier. This specifies the order for which a solicitation is sent.
-            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 a solicitation is sent.
+            key marketplaceIds: object | required A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(

sp_api/api/supply_sources/supply_sources.py

@@ -13,18 +13,20 @@ class SupplySources(Client):
     def get_supply_sources(self, **kwargs) -> ApiResponse:
         """
         get_supply_sources(self, **kwargs) -> ApiResponse
-
+        
         The path to retrieve paginated supply sources.
-
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().get_supply_sources()
+        
         Args:
-
-            key nextPageToken:string |  The pagination token to retrieve a specific page of results.
-
-            key pageSize:number |  The number of supply sources to return per paginated request.
-
-
+            key nextPageToken: object |  The pagination token to retrieve a specific page of results.
+            key pageSize: object |  The number of supply sources to return per paginated request.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), params=kwargs)
@@ -32,20 +34,20 @@ class SupplySources(Client):
     @sp_endpoint("/supplySources/2020-07-01/supplySources", method="POST")
     def create_supply_source(self, **kwargs) -> ApiResponse:
         """
-               create_supply_source(self, **kwargs) -> ApiResponse
-
-               Create a new supply source.
-
-               Args:
-
-                   payload: | * REQUIRED {'description': 'A request to create a supply source.',
-        'properties': {'address': {'$ref': '#/definitions/Address'}, 'alias': {'$ref': '#/definitions/SupplySourceAlias'}, 'supplySourceCode': {'$ref': '#/definitions/SupplySourceCode'}},
-        'required': ['address', 'supplySourceCode', 'alias'],
-        'type': 'object'}
-
-
-               Returns:
-                   ApiResponse:
+        create_supply_source(self, **kwargs) -> ApiResponse
+        
+        Create a new supply source.
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().create_supply_source()
+        
+        Args:
+            payload: CreateSupplySourceRequest | required A request to create a supply source.
+        
+        Returns:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs)
@@ -54,16 +56,19 @@ class SupplySources(Client):
     def get_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
         """
         get_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
-
+        
         Retrieve a supply source.
-
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().get_supply_source("value")
+        
         Args:
-
-            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
-
-
+            supplySourceId: object | required The unique identifier of a supply source.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -74,20 +79,20 @@ class SupplySources(Client):
     def update_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
         """
         update_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
-
+        
         Update the configuration and capabilities of a supply source.
-
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().update_supply_source("value")
+        
         Args:
-
-            supplySourceId:string | * REQUIRED The unique identitier of a supply source.
-
-            payload: |  {'description': 'A request to update the configuration and capabilities of a supply source.',
-                         'properties': {'alias': {'$ref': '#/definitions/SupplySourceAlias'}, 'capabilities': {'$ref': '#/definitions/SupplySourceCapabilities'}, 'configuration': {'$ref': '#/definitions/SupplySourceConfiguration'}},
-                         'type': 'object'}
-
-
+            supplySourceId: object | required The unique identitier of a supply source.
+            payload: UpdateSupplySourceRequest |
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -98,16 +103,19 @@ class SupplySources(Client):
     def archive_supply_source(self, supplySourceId, **kwargs) -> ApiResponse:
         """
         archive_supply_source(self, supplySourceId, **kwargs) -> ApiResponse
-
+        
         Archive a supply source, making it inactive. Cannot be undone.
-
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().archive_supply_source("value")
+        
         Args:
-
-            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
-
-
+            supplySourceId: object | required The unique identifier of a supply source.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(
@@ -118,18 +126,20 @@ class SupplySources(Client):
     def update_supply_source_status(self, supplySourceId, **kwargs) -> ApiResponse:
         """
         update_supply_source_status(self, supplySourceId, **kwargs) -> ApiResponse
-
+        
         Update the status of a supply source.
-
+        
+        Examples:
+            literal blocks::
+            
+                SupplySources().update_supply_source_status("value")
+        
         Args:
-
-            supplySourceId:string | * REQUIRED The unique identifier of a supply source.
-
-            payload: |  {'description': 'A request to update the status of a supply source.', 'properties': {'status': {'$ref': '#/definitions/SupplySourceStatus'}}, 'type': 'object'}
-
-
+            supplySourceId: object | required The unique identifier of a supply source.
+            payload: UpdateSupplySourceStatusRequest |
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(

sp_api/api/tokens/tokens.py

@@ -15,50 +15,29 @@ class Tokens(Client):
     def create_restricted_data_token(self, **kwargs) -> ApiResponse:
         """
         create_restricted_data_token(self, **kwargs) -> ApiResponse
-
-        Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.
-
-        The path of a restricted resource can be:
-        - A specific path containing a seller's order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```.
-        - A generic path that does not contain a seller's order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller's order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address```
-
-        **Usage Plans:**
-
+        
+        Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         1                                       10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
         Examples:
             literal blocks::
-
-                Tokens().create_restricted_data_token(restrictedResources=[
-                     {
-                         "method": "GET",
-                         "path": "/orders/v0/orders",
-                         "dataElements": ["buyerInfo", "shippingAddress"]
-                     }
-                  ])
-
+            
+                Tokens().create_restricted_data_token()
+        
         Args:
-            body: {
-              "targetApplication": "string",
-              "restrictedResources": [
-                {
-                  "method": "GET",
-                  "path": "string",
-                  "dataElements": [
-                    "string"
-                  ]
-                }
-              ]
-            }
-
+            body: CreateRestrictedDataTokenRequest | required The restricted data token request details.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(kwargs.pop("path"), data=kwargs)

sp_api/api/vehicles/vehicles.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import enum
+from typing import Any, Literal, TYPE_CHECKING, overload
+from sp_api.util.versioned_client import VersionedClientMeta
+
+from sp_api.base import Client
+
+from .vehicles_2024_11_01 import VehiclesV20241101
+
+
+class VehiclesVersion(str, enum.Enum):
+    V_2024_11_01 = "2024-11-01"
+    LATEST = "2024-11-01"
+
+
+if TYPE_CHECKING:
+
+    class _VehiclesMeta(VersionedClientMeta):
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: Literal[VehiclesVersion.V_2024_11_01, VehiclesVersion.LATEST, "2024-11-01"],
+            **kwargs: Any,
+        ) -> VehiclesV20241101: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VehiclesV20241101: ...
+
+        @overload
+        def __call__(
+            cls,
+            *args: Any,
+            version: str | VehiclesVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+
+else:
+    _VehiclesMeta = VersionedClientMeta
+
+
+class Vehicles(Client, metaclass=_VehiclesMeta):
+    """Vehicles API client.
+
+    This class dispatches to a versioned Vehicles API client.
+
+    If you do not pass a version, the constructor returns the oldest supported implementation ("2024-11-01").
+    """
+
+    if TYPE_CHECKING:
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: Literal[VehiclesVersion.V_2024_11_01, VehiclesVersion.LATEST, "2024-11-01"],
+            **kwargs: Any,
+        ) -> VehiclesV20241101: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: None = None,
+            **kwargs: Any,
+        ) -> VehiclesV20241101: ...
+
+        @overload
+        def __new__(
+            cls,
+            *args: Any,
+            version: str | VehiclesVersion,
+            **kwargs: Any,
+        ) -> Client: ...
+
+    _DISPATCH = True
+
+    _DEFAULT_VERSION = "2024-11-01"
+
+    _VERSION_MAP = {
+        "2024-11-01": VehiclesV20241101,
+    }
+
+    _VERSION_ALIASES = {
+        "2024-11-01": "2024-11-01",
+    }

sp_api/api/vehicles/vehicles_2024_11_01.py

@@ -0,0 +1,33 @@
+from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+
+
+class VehiclesV20241101(Client):
+    """
+    Vehicles SP-API Client
+    :link:
+
+    The Selling Partner API for Automotive provides programmatic access to information needed by selling partners to provide compatibility information about their listed products.
+    """
+
+    @sp_endpoint("/catalog/2024-11-01/automotive/vehicles", method="GET")
+    def get_vehicles(self, **kwargs) -> ApiResponse:
+        """
+        get_vehicles(self, **kwargs) -> ApiResponse
+        
+        Get the latest collection of vehicles
+        
+        Examples:
+            literal blocks::
+            
+                VehiclesV20241101().get_vehicles()
+        
+        Args:
+            key pageToken: object |  A token to fetch a certain page when there are multiple pages worth of results.
+            key marketplaceId: object | required An identifier for the marketplace in which the resource operates.
+            key vehicleType: object | required An identifier for vehicle type.
+            key updatedAfter: object |  Date in ISO 8601 format, if provided only vehicles which are modified/added to Amazon's catalog after this date will be returned.
+        
+        Returns:
+            ApiResponse
+        """
+        return self._request(kwargs.pop("path"), params=kwargs, add_marketplace=False)

sp_api/api/vendor_direct_fulfillment_inventory/vendor_direct_fulfillment_inventory.py

@@ -17,43 +17,30 @@ class VendorDirectFulfillmentInventory(Client):
     def submit_inventory_update(self, warehouseId, **kwargs) -> ApiResponse:
         """
         submit_inventory_update(self, warehouseId, **kwargs) -> ApiResponse
-
+        
         Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
-
-        **Usage Plans:**
-
+        
+        **Usage Plan:**
+        
         ======================================  ==============
         Rate (requests per second)               Burst
         ======================================  ==============
         10                                      10
         ======================================  ==============
-
-        The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
-
+        
+        For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
+        
+        Examples:
+            literal blocks::
+            
+                VendorDirectFulfillmentInventory().submit_inventory_update("value")
+        
         Args:
-            warehouseId:string | * REQUIRED Identifier for the warehouse for which to update inventory.
-            body: {
-              "inventory": {
-                "sellingParty": {
-                  "partyId": "string"
-                },
-                "isFullUpdate": true,
-                "items": [
-                  {
-                    "buyerProductIdentifier": "string",
-                    "vendorProductIdentifier": "string",
-                    "availableQuantity": {
-                      "amount": 0,
-                      "unitOfMeasure": "string"
-                    },
-                    "isObsolete": true
-                  }
-                ]
-              }
-            }
-
+            body: SubmitInventoryUpdateRequest | required The request body containing the inventory update data to submit.
+            warehouseId: object | required Identifier for the warehouse for which to update inventory.
+        
         Returns:
-            ApiResponse:
+            ApiResponse
         """
 
         return self._request(